diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..549d3da09 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,30 @@ 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) + + from app.models.planet import Planet + + from .routes import planet_bp + app.register_blueprint(planet_bp) + return app diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..3426cce40 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,23 @@ +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) + radius = db.Column(db.String) + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "desription": self.description, + "radius": self.radius + } + + @classmethod + def from_dict(cls, data_dict): + return cls( + name = data_dict["name"], + description = data_dict["description"], + radius = data_dict["radius"] + ) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..d8ec3f6f8 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,78 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +planet_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + try: + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + + message = f"Planet {new_planet.name} successfully created." + + return make_response(jsonify(message), 201) + except KeyError as e: + abort(make_response({"message": f"Missing required value {e}"}, 400)) + + +@planet_bp.route("", methods=["GET"]) +def get_all_planets(): + name_query = request.args.get("name") + radius_query = request.args.get("radius") + if name_query: + planets = Planet.query.filter_by(name=name_query) + elif radius_query: + planets = Planet.query.filter_by(radius=radius_query) + else: + planets = Planet.query.all() + + results = [planet.to_dict() for planet in planets] + + return jsonify(results) + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + message = f"{cls.__name__} {model_id} is invalid" + abort(make_response({"message": message}, 400)) + + model = cls.query.get(model_id) + + if not model: + message = f"{cls.__name__} {model_id} is not found" + abort(make_response({"message": message}, 404)) + + return model + +@planet_bp.route("/", methods=["GET"]) +def get_planet(id): + planet = validate_model(Planet, id) + + return planet.to_dict() + +@planet_bp.route("/", methods=["PUT"]) +def update_planet(id): + planet_data = request.get_json() + planet_to_update = validate_model(Planet, id) + + planet_to_update.name = planet_data["name"] + planet_to_update.description = planet_data["description"] + planet_to_update.radius = planet_data["radius"] + + db.session.commit() + return make_response(jsonify(f"Planet {planet_to_update.name} updated"), 200) + +@planet_bp.route("/", methods=["DELETE"]) +def delete_planet(id): + planet_to_delete = validate_model(Planet, id) + + db.session.delete(planet_to_delete) + db.session.commit() + + return make_response(jsonify(f"Planet {planet_to_delete.name} deleted"), 200) \ 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/e219ffd97a6a_adds_planet_model.py b/migrations/versions/e219ffd97a6a_adds_planet_model.py new file mode 100644 index 000000000..341570a49 --- /dev/null +++ b/migrations/versions/e219ffd97a6a_adds_planet_model.py @@ -0,0 +1,34 @@ +"""Adds Planet model + +Revision ID: e219ffd97a6a +Revises: +Create Date: 2023-04-28 13:08:17.487290 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e219ffd97a6a' +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('radius', 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/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..7849a81ee --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,58 @@ +import pytest +from app import create_app, 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 one_planet(app): + # Arrange + planet = Planet( + name="Mercury", + description="Mercury is the smallest planet in our solar system.", + radius="1,516 mi" + ) + + db.session.add(planet) + db.session.commit() + return planet + +@pytest.fixture +def multiple_planets(app): + # Arrange + planet1 = Planet( + name="Venus", + description="Venus is extremely hot.", + radius="3,760.4 mi" + ) + planet2 = Planet( + name="Earth", + description="Earth is the third planet from the Sun.", + radius="3,958.8 mi" + ) + + planets = [planet1, planet2] + + db.session.add_all(planets) + db.session.commit() + return planets \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..3fb4d5ee0 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,51 @@ +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 == [] + +def test_get_one_planet(client, one_planet): + response = client.get(f"/planets/{one_planet.id}") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body["id"] == one_planet.id + assert response_body["name"] == one_planet.name + assert response_body["description"] == one_planet.description + assert response_body["radius"] == one_planet.radius + +def test_get_planet_with_no_data(client): + response = client.get(f"/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + +def test_get_all_planets_with_valid_data(client, multiple_planets): + response = client.get(f"/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body[0]["id"] == multiple_planets[0].id + assert response_body[0]["name"] == multiple_planets[0].name + assert response_body[0]["description"] == multiple_planets[0].description + assert response_body[0]["radius"] == multiple_planets[0].radius + assert response_body[1]["id"] == multiple_planets[1].id + assert response_body[1]["name"] == multiple_planets[1].name + assert response_body[1]["description"] == multiple_planets[1].description + assert response_body[1]["radius"] == multiple_planets[1].radius + +def test_create_one_planet(client): + response = client.post("/planets", json={ + "name": "Yoshi", + "description": "Adorable and egg filled planet.", + "radius": "7,156.9 mi" + }) + + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == "Planet Yoshi successfully created."