diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..56c8a1107 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,29 @@ 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__) + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + else: + app.config["TESTING"] = True + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") + + db.init_app(app) + migrate.init_app(app, db) + + # Register Blueprints + from .routes import planet_routes + app.register_blueprint(planet_routes.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..dbe59bbe3 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,39 @@ +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) + + def make_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + has_moon=self.has_moon, + ) + + def replace_all_details(self, data_dict): + self.name = data_dict["name"] + self.description = data_dict["description"] + self.has_moon = data_dict["has_moon"] + + def replace_some_details(self, data_dict): + planet_keys = data_dict.keys() + + if "name" in planet_keys: + self.name = data_dict["name"] + if "description" in planet_keys: + self.description = data_dict["description"] + if "has_moon" in planet_keys: + self.has_moon = data_dict["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"] + ) diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index 8e9dfe684..000000000 --- a/app/routes.py +++ /dev/null @@ -1,2 +0,0 @@ -from flask import Blueprint - diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..283875598 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,101 @@ +from flask import Blueprint, jsonify, abort, make_response, request +from app.models.planet import Planet +from app import db + +bp = Blueprint("planets_bp",__name__, url_prefix="/planets") + +# helper functions +def get_planet_record_by_id(id): + try: + id = int(id) + except ValueError: + error_message(f"Invalid planet id {id}", 400) + + planet = Planet.query.get(id) + + if planet: + return planet + + error_message(f"No planet with id {id} found", 404) + +def error_message(message, status_code): + abort(make_response(jsonify(dict(details=message)), status_code)) + +# POST /planets +@bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + + try: + planet = Planet.from_dict(request_body) + except KeyError as error: + error_message(f"Missing key: {error}", 400) + + db.session.add(planet) + db.session.commit() + + return jsonify(planet.make_dict()), 201 + +# GET /planets +@bp.route("", methods=["GET"]) +def list_planets(): + description_param = request.args.get("description") + name_param = request.args.get("name") + has_moon_param = request.args.get("has_moon") + + if description_param: + planets = Planet.query.filter_by(description=description_param) + elif name_param: + planets = Planet.query.filter_by(name=name_param) + elif has_moon_param: + planets = Planet.query.filter_by(has_moon=has_moon_param) + else: + planets = Planet.query.all() + + list_of_planets = [planet.make_dict() for planet in planets] + + return jsonify(list_of_planets) + + +# GET /planets/ +@bp.route("/", methods=["GET"]) +def get_planet_by_id(planet_id): + planet = get_planet_record_by_id(planet_id) + + return jsonify(planet.make_dict()) + +# PUT /planets/ +@bp.route("/", methods=["PUT"]) +def replace_planet_by_id(planet_id): + request_body = request.get_json() + planet = get_planet_record_by_id(planet_id) + + try: + planet.replace_all_details(request_body) + except KeyError as error: + error_message(f"Missing key: {error}", 400) + + db.session.commit() + + return jsonify(planet.make_dict()) + +# DELETE /planets/ +@bp.route("/", methods=["DELETE"]) +def delete_planet_by_id(planet_id): + planet = get_planet_record_by_id(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet with id {planet_id} successfully deleted") + +# PATCH /planets/ +@bp.route("/", methods=["PATCH"]) +def update_planet_by_id(planet_id): + request_body = request.get_json() + planet = get_planet_record_by_id(planet_id) + planet.replace_some_details(request_body) + + db.session.commit() + + return jsonify(planet.make_dict()) \ 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/0909b759653b_add_planet_model.py b/migrations/versions/0909b759653b_add_planet_model.py new file mode 100644 index 000000000..d856186a3 --- /dev/null +++ b/migrations/versions/0909b759653b_add_planet_model.py @@ -0,0 +1,34 @@ +"""add planet model + +Revision ID: 0909b759653b +Revises: +Create Date: 2022-04-30 22:05:20.168921 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0909b759653b' +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/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..8c34ea1c9 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,35 @@ +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_planets(app): + tatooine = Planet(id=1, name="Tatooine", description="desert", has_moon=True) + hoth = Planet(id=2, name="Hoth", description="icy tundra", has_moon=True) + + db.session.add(tatooine) + db.session.add(hoth) + db.session.commit() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..95b15e096 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,64 @@ +# Test GET /planets +def test_get_all_planets_with_empty_db_return_empty_list(client): + response = client.get('/planets') + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + +# Test GET /planets +def test_get_all_planets_using_fixture(client, two_planets): + response = client.get('/planets') + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id": 1, + "name": "Tatooine", + "description": "desert", + "has_moon": True}, + {"id": 2, + "name": "Hoth", + "description": "icy tundra", + "has_moon": True + }] + +# Test GET /planets/ +def test_get_one_planet_using_fixture(client, two_planets): + response = client.get("/planets/1") + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Tatooine", + "description": "desert", + "has_moon": True + } + +# Test GET /planets/ +def test_get_one_planet_no_db_data_return_404(client): + response = client.get("/planets/1") + + assert response.status_code == 404 + +# Test POST /planets +def test_post_one_planet(client): + response = client.post("/planets", json={ + "name": "Endor", + "description": "Blue gas giant", + "has_moon": True + }) + + response_body=response.get_json() + + assert response.status_code == 201 + assert response_body == { + "id": 1, + "name": "Endor", + "description": "Blue gas giant", + "has_moon": True + } \ No newline at end of file