diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..80eec2ced 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,33 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from dotenv import load_dotenv +import os + +db = SQLAlchemy() +migrate = Migrate() +load_dotenv() def create_app(test_config=None): + # __name__ stores the name of the module we're in app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + + if not test_config: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "RENDER_DATABASE_URI") + # app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + # "SQLALCHEMY_DATABASE_URI") + else: + app.config['TESTING'] = True + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") + + db.init_app(app) + migrate.init_app(app, db) + + from .routes import bp + app.register_blueprint(bp) - return app + return app \ No newline at end of file diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..008a9d00a --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,24 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + description = db.Column(db.String) + position = db.Column(db.String) + + def to_dict(self): + planet_as_dic = {} + planet_as_dic["id"] = self.id + planet_as_dic["name"] = self.name + planet_as_dic["description"] = self.description + planet_as_dic["position"] = self.position + + return planet_as_dic + + @classmethod + def from_dict(cls, planet_data): + new_planet = Planet(name=planet_data["name"], + description=planet_data["description"], + position=planet_data["position"]) + + return new_planet diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..0a2fd49f3 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,76 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +bp = Blueprint("planets", __name__, url_prefix="/planets") + +# VALIDATE PLANET HELPER FUNCTIONS +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + abort(make_response({"message":f"{cls.__name__} {model_id} invalid"}, 400)) + + model = cls.query.get(model_id) + + if not model: + abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404)) + + return model + +# CREATE A PLANET +@bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response(jsonify(f"Planet {new_planet.name} successfully created")), 201 + +# READ ALL PLANETS +@bp.route("", methods=["GET"]) +def read_all_planets(): + name_query = request.args.get("name") + + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + + planets_response = [] + for planet in planets: + planets_response.append(planet.to_dict()) + return jsonify(planets_response) + + +# READ ONE PLANET +@bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_model(Planet, planet_id) + return planet.to_dict() + +# UPDATE ONE PLANET +@bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_model(Planet, planet_id) + request_body = request.get_json() + + planet.name=request_body["name"], + planet.description=request_body["description"], + planet.position=request_body["position"] + + db.session.commit() + + return make_response(jsonify(f"Planet {planet.name} successfully updated")) + +# DELETE A PLANET +@bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_model(Planet, planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(jsonify(f"Planet {planet.name} successfully deleted")) \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/ad6d66314fdb_.py b/migrations/versions/ad6d66314fdb_.py new file mode 100644 index 000000000..3b4e2ef5a --- /dev/null +++ b/migrations/versions/ad6d66314fdb_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: ad6d66314fdb +Revises: +Create Date: 2023-05-01 20:08:16.355443 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'ad6d66314fdb' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('planet', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('position', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### diff --git a/project-directions/wave_02.md b/project-directions/wave_02.md index 7ae9ac268..1cf000528 100644 --- a/project-directions/wave_02.md +++ b/project-directions/wave_02.md @@ -9,3 +9,4 @@ As a client, I want to send a request... 1. ... such that trying to get one non-existing `planet` responds with get a `404` response, so that I know the `planet` resource was not found. 1. ... such that trying to get one `planet` with an invalid `planet_id` responds with get a `400` response, so that I know the `planet_id` was invalid. + diff --git a/requirements.txt b/requirements.txt index ae59e7b55..f4ff77124 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,14 +4,20 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==7.2.3 +exceptiongroup==1.1.1 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==2.0.0 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==23.1 +pluggy==1.0.0 psycopg2-binary==2.9.5 pycodestyle==2.6.0 pytest==7.3.1 @@ -23,5 +29,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.0.1 diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 000000000..daff08d18 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,39 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + + +@pytest.fixture +def client(app): + return app.test_client() + + +@pytest.fixture +def two_saved_planets(app): + # Arrange + test_blue_planet = Planet(name="Blueto", + description="Watr 4evr", + position="#100") + test_purple_planet = Planet(name="Purpley", + description="Ice 4evr", + position="#70") + + db.session.add_all([test_blue_planet, test_purple_planet]) + db.session.commit() diff --git a/tests/test_models.py b/tests/test_models.py new file mode 100644 index 000000000..ec0766c79 --- /dev/null +++ b/tests/test_models.py @@ -0,0 +1,121 @@ +from app.models.planet import Planet +import pytest + +def test_to_dict_no_missing_data(): + # Arrange + test_data = Planet(id = 2, + name="Arrakis", + description="Spicy", + position="#82") + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 4 + assert result["id"] == 2 + assert result["name"] == "Arrakis" + assert result["description"] == "Spicy" + assert result["position"] == "#82" + +def test_to_dict_missing_id(): + # Arrange + test_data = Planet(name="Arrakis", + description="Spicy", + position="#82") + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 4 + assert result["id"] is None + assert result["name"] == "Arrakis" + assert result["description"] == "Spicy" + assert result["position"] == "#82" + +def test_to_dict_missing_name(): + # Arrange + test_data = Planet(id=1, + description="Spicy", + position="#82") + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 4 + assert result["id"] == 1 + assert result["name"] is None + assert result["description"] == "Spicy" + assert result["position"] == "#82" + +def test_to_dict_missing_description(): + # Arrange + test_data = Planet(id = 1, + name="Arrakis") + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 4 + assert result["id"] == 1 + assert result["name"] == "Arrakis" + assert result["description"] is None + assert result["position"] == None + + +# new tests for from_dict +def test_from_dict_returns_planet(): + # Arrange + planet_data = { + "name": "New Planet", + "description": "The mild planet", + "position": "#91" + } + + # Act + new_planet = Planet.from_dict(planet_data) + + # Assert + assert new_planet.name == "New Planet" + assert new_planet.description == "The mild planet" + assert new_planet.position == "#91" + +def test_from_dict_with_no_name(): + # Arrange + planet_data = { + "description": "The mild planet" + } + + # Act & Assert + with pytest.raises(KeyError, match = 'name'): + new_planet = Planet.from_dict(planet_data) + +def test_from_dict_with_no_description(): + # Arrange + planet_data = { + "name": "New planet" + } + + # Act & Assert + with pytest.raises(KeyError, match = 'description'): + new_planet = Planet.from_dict(planet_data) + +def test_from_dict_with_extra_keys(): + # Arrange + planet_data = { + "extra": "some stuff", + "name": "New planet", + "description": "The mild planet", + "position": "#40" + } + + # Act + new_planet = Planet.from_dict(planet_data) + + # Assert + assert new_planet.name == "New planet" + assert new_planet.description == "The mild planet" + assert new_planet.position == "#40" \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..e729eed71 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,142 @@ +import pytest + +# TEST GET ALL PLANETS +def test_get_all_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +# TEST ONE PLANET +def test_get_one_planet(client, two_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Blueto", + "description": "Watr 4evr", + "position": "#100" + } + +# TEST CREATE ONE PLANET +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Pink Star", + "description": "Surface made of pink glitter", + "position": "#68" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Pink Star successfully created" + + +def test_get_all_planets_with_three_records(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body[0] == { + "id": 1, + "name": "Blueto", + "description": "Watr 4evr", + "position": "#100" + } + assert response_body[1] == { + "id": 2, + "name": "Purpley", + "description": "Ice 4evr", + "position": "#70" + } + +def test_get_all_planets_with_name_query_matching_none(client, two_saved_planets): + # Act + data = {'name': 'Pluto'} + response = client.get("/planets", query_string = data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_all_planets_with_name_query_matching_one(client, two_saved_planets): + # Act + data = {'name': 'Blueto'} + response = client.get("/planets", query_string = data) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 1 + assert response_body[0] == { + "id": 1, + "name": "Blueto", + "description": "Watr 4evr", + "position": "#100" + } + +def test_get_one_planet_id_not_found(client, two_saved_planets): + # Act + response = client.get("/planets/10") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message":"Planet 10 not found"} + +def test_get_one_planet_id_invalid(client, two_saved_planets): + # Act + response = client.get("/planets/pluto") + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message":"Planet pluto invalid"} + + +# new test cases for create_planet + +def test_create_one_planet_no_name(client): + # Arrange + test_data = {"description": "The mild planet"} + + # Act & Assert + with pytest.raises(KeyError, match='name'): + response = client.post("/planets", json=test_data) + +def test_create_one_planet_no_description(client): + # Arrange + test_data = {"name": "New planet"} + + # Act & Assert + with pytest.raises(KeyError, match = 'description'): + response = client.post("/planets", json=test_data) + +def test_create_one_planet_with_extra_keys(client, two_saved_planets): + # Arrange + test_data = { + "extra": "some stuff", + "name": "New planet", + "description": "The mild planet", + "position": "#87", + } + + # Act + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet New planet successfully created" \ No newline at end of file