diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..ffd8974d4 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,32 @@ 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): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + + if not test_config: + 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") + + from app.models.planet import Planet + + db.init_app(app) + migrate.init_app(app, db) + + from .routes import planet_bp + app.register_blueprint(planet_bp) + return app 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..7db535541 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,25 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String, nullable=False) + description = db.Column(db.String, nullable=False) + has_moon = db.Column(db.Boolean, nullable=False, default=False) + + def to_dict(self): + return dict( + id = self.id, + name = self.name, + description = self.description, + has_moon = self.has_moon,) + + @classmethod + def from_dict(cls, data_dict): + return cls(name=data_dict["name"], + description=data_dict["description"], + has_moon=data_dict["has_moon"],) + + def replace_details(self, data_dict): + self.name = data_dict["name"] + self.description = data_dict["description"] + self.has_moon = data_dict["has_moon"] diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..30465bb57 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,88 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response, request +from .models.planet import Planet +from app import db +def error_message(message, status_code): + abort(make_response(jsonify(dict(details=message)), status_code)) + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + error_message(f"planet {planet_id} invalid", 400) + + planet = Planet.query.get(planet_id) + + if not planet: + error_message(f"planet {planet_id} not found", 404) + + return planet + +def create_planet_safely(data_dict): + try: + return Planet.from_dict(data_dict) + except KeyError as err: + error_message(f"Missing key: {err}", 400) + +def replace_planet_safely(planet, data_dict): + try: + planet.replace_details(data_dict) + except KeyError as err: + error_message(f"Missing key: {err}", 400) + + +planet_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=("GET",)) +def get_planets(): + description_query = request.args.get("description") + has_moon_query = request.args.get("has_moon") + + if description_query: + planets = Planet.query.filter_by(description=description_query) + elif has_moon_query: + planets = Planet.query.filter_by(has_moon=has_moon_query) + else: + planets = Planet.query.all() + + result_list = [planet.to_dict() for planet in planets] + + return jsonify(result_list), 200 + +@planet_bp.route("", methods=("POST",)) +def post_one_planet(): + request_body = request.get_json() + + new_planet = create_planet_safely(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response(jsonify(f"Planet {new_planet.name} successfully created")), 201 + +@planet_bp.route("/", methods=("GET",)) +def get_individual_planet(planet_id): + planet = validate_planet(planet_id) + + return jsonify(planet.to_dict()), 200 + +@planet_bp.route("/", methods=("PUT",)) +def put_planet(planet_id): + planet = validate_planet(planet_id) + + request_body = request.get_json() + + replace_planet_safely(planet, request_body) + + db.session.commit() + + return make_response(jsonify(f"Planet #{planet.id} successfully updated")), 200 + +@planet_bp.route("/", methods=("DELETE",)) +def delete_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(jsonify(f"Planet {planet.id} successfully deleted")), 200 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/91b40f34c954_added_planet_model.py b/migrations/versions/91b40f34c954_added_planet_model.py new file mode 100644 index 000000000..4630b932b --- /dev/null +++ b/migrations/versions/91b40f34c954_added_planet_model.py @@ -0,0 +1,34 @@ +"""Added planet model + +Revision ID: 91b40f34c954 +Revises: +Create Date: 2022-05-12 09:42:22.183892 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '91b40f34c954' +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=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('has_moon', sa.Boolean(), nullable=False), + 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/requirements.txt b/requirements.txt index a506b4d12..aa3718365 100644 --- a/requirements.txt +++ b/requirements.txt @@ -12,7 +12,7 @@ itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 -psycopg2-binary==2.8.6 +psycopg2-binary==2.9.3 pycodestyle==2.6.0 pytest==6.2.3 pytest-cov==2.12.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..cbfd880be --- /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): + + mercury = Planet(name="Mercury", + description="terrestrial", + has_moon = False) + saturn = Planet(name="Saturn", + description="gas giants", + has_moon = True) + + db.session.add_all([mercury, saturn]) + db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..567349113 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,63 @@ +def test_get_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_individual_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": "Mercury", + "description": "terrestrial", + "has_moon": False + } + +def test_get_individual_planet_with_no_data(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + +def test_get_planets(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [{ + "id": 1, + "name": "Mercury", + "description": "terrestrial", + "has_moon": False + }, + { + "id": 2, + "name": "Saturn", + "description": "gas giants", + "has_moon": True + }] + +def test_post_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Earth", + "description": "terrestrial", + "has_moon": True + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Earth successfully created"