diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..dc9f62853 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,31 @@ 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 - return app + 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") + + db.init_app(app) + migrate.init_app(app, db) + + from app.models.planet import Planet + + from .routes import planets_bp + app.register_blueprint(planets_bp) + + 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..583fd1622 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,35 @@ +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) + size = db.Column(db.String, nullable=False) + moon_of_planet = db.Column(db.String, nullable=True) + habitable = db.Column(db.Boolean) + gravity = db.Column(db.String) + nickname = db.Column(db.String, nullable=True) + + def to_dict(self): + return dict( + name=self.name, + description=self.description, + size=self.size, + moon_of_planet=self.moon_of_planet, + habitable=self.habitable, + id=self.id, + gravity=self.gravity, + nickname=self.nickname + ) + + @classmethod + def from_dict(cls, planet_data): + return cls( + name = planet_data["name"], + description = planet_data["description"], + size = planet_data["size"], + moon_of_planet = planet_data["moon_of_planet"], + habitable = planet_data["habitable"], + gravity = planet_data["gravity"], + nickname = planet_data["nickname"] + ) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..5264e011f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,81 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request , abort +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +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} not found" + abort(make_response({"message": message}, 404)) + + return model + +@planets_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)) + +@planets_bp.route("", methods=["GET"]) +def get_all_planets(): + name_query = request.args.get("name") + nickname_query = request.args.get("nickname") + if name_query: + planets = Planet.query.filter_by(name = name_query) + + if nickname_query: + planets = Planet.query.filter_by(nickname = nickname_query) + + planets = Planet.query.all() + + results= [planet.to_dict()for planet in planets] + + return jsonify(results) + +@planets_bp.route("/", methods=["GET"]) +def get_one_planet(planet_id): + planet = validate_model(Planet, planet_id) + return planet.to_dict() + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet_to_update= validate_model(Planet, planet_id) + planet_data= request.get_json() + + planet_to_update.name = planet_data["name"] + planet_to_update.description = planet_data["description"] + planet_to_update.size= planet_data["size"] + planet_to_update.moon_of_planet = planet_data["moon_of_planet"] + planet_to_update.habitable = planet_data["habitable"] + planet_to_update.gravity = planet_data["gravity"] + planet_to_update.nickname = planet_data["nickname"] + + db.session.commit() + + return make_response(jsonify(f"Planet { planet_to_update.name} updated"), 200) + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet_to_delete = validate_model(Planet, planet_id) + + db.session.delete(planet_to_delete) + db.session.commit() + + return make_response(jsonify(f"Planet {planet_to_delete.name} 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/d12b70d81f7f_.py b/migrations/versions/d12b70d81f7f_.py new file mode 100644 index 000000000..086c90e85 --- /dev/null +++ b/migrations/versions/d12b70d81f7f_.py @@ -0,0 +1,30 @@ +"""empty message + +Revision ID: d12b70d81f7f +Revises: f6f9b34297e7 +Create Date: 2023-05-02 12:53:46.210669 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'd12b70d81f7f' +down_revision = 'f6f9b34297e7' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('moon_of_planet', sa.String(), nullable=True)) + op.drop_column('planet', 'parent_planet') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('parent_planet', sa.VARCHAR(), autoincrement=False, nullable=True)) + op.drop_column('planet', 'moon_of_planet') + # ### end Alembic commands ### diff --git a/migrations/versions/f6f9b34297e7_adds_planet_model.py b/migrations/versions/f6f9b34297e7_adds_planet_model.py new file mode 100644 index 000000000..79c0b6907 --- /dev/null +++ b/migrations/versions/f6f9b34297e7_adds_planet_model.py @@ -0,0 +1,38 @@ +"""adds Planet model + +Revision ID: f6f9b34297e7 +Revises: +Create Date: 2023-04-28 14:38:53.218761 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'f6f9b34297e7' +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('size', sa.String(), nullable=False), + sa.Column('parent_planet', sa.String(), nullable=True), + sa.Column('habitable', sa.Boolean(), nullable=True), + sa.Column('gravity', sa.String(), nullable=True), + sa.Column('nickname', 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/test_fixtures.py b/test_fixtures.py new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/test_fixtures.py @@ -0,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..4ce93de27 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,61 @@ +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 multiple_planets(app): + planet_1 = Planet( + description="A dusty, cold, desert world with a very thin atmosphere", + gravity="3.721 m/s²", + habitable=False, + id=1, + moon_of_planet="Phobos & Deimos", + name="Mars", + nickname="Red Planet", + size="6,792 km" + ) + planet_2= Planet( + name="Saturn", + description="The second-largest planet in solar system.", + size="36,183.7 miles", + moon_of_planet="Iapetus, Rhea, Dione, and Tethys", + habitable=False, + id=2, + gravity="10.44 m/s²", + nickname="Ringed Planet" + ) + planet_3 = Planet( + name="Neptune", + description="Dark, cold, and whipped by supersonic winds, ice giant.", + size="24,622 km", + moon_of_planet="Triton", + habitable=False, + id=3, + gravity="11.15 m/s²", + nickname="Ice Giant" + ) + db.session.add_all([planet_1, planet_2, planet_3]) + 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..e5023a942 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,132 @@ +from app.models.planet import Planet + + +def test_get_all_planets_returns_empty_list_when_db_is_empty(client): + #act + response = client.get("/planets") + + #assert + assert response.status_code == 200 + assert response.get_json() == [] + +def test_get_one_planet_by_id(client, multiple_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "description": "A dusty, cold, desert world with a very thin atmosphere", + "gravity": "3.721 m/s²", + "habitable": False, + "id": 1, + "moon_of_planet": "Phobos & Deimos", + "name": "Mars", + "nickname": "Red Planet", + "size": "6,792 km" + } + +def test_get_one_planet_with_no_data(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 1 not found"} + +def test_get_one_planet_with_id_not_found(client, multiple_planets): + # Act + response = client.get("/planets/5") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 5 not found"} + +def test_get_list_of_all_planets(client, multiple_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [{ + "description": "A dusty, cold, desert world with a very thin atmosphere", + "gravity": "3.721 m/s²", + "habitable": False, + "id": 1, + "moon_of_planet": "Phobos & Deimos", + "name": "Mars", + "nickname": "Red Planet", + "size": "6,792 km" + }, { + "name": "Saturn", + "description": "The second-largest planet in solar system.", + "size": "36,183.7 miles", + "moon_of_planet": "Iapetus, Rhea, Dione, and Tethys", + "habitable": False, + "id": 2, + "gravity": "10.44 m/s²", + "nickname": "Ringed Planet" + }, { + "name": "Neptune", + "description": "Dark, cold, and whipped by supersonic winds, ice giant.", + "size": "24,622 km", + "moon_of_planet": "Triton", + "habitable": False, + "id": 3, + "gravity": "11.15 m/s²", + "nickname": "Ice Giant" + }] + +def test_creates_one_planet(client): + #Arrange + Expected_planet = { + "name": "Venus", + "description": "It is the brightest object in the skynafter the Sun and the Moon", + "size": "12,104km", + "moon_of_planet": None, + "habitable": False, + "gravity": "8.87 m/s²", + "nickname": "Morning Star, Evening Star" +} + + # Act + response = client.post("/planets", json=Expected_planet) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Venus successfully created" + + +def test_replace_planet_returns_seeded_planet(client, multiple_planets): + replaced_planet = { + "name": "Earth", + "description": "A rocky, terrestrial planet.", + "size": "12,756 km", + "parent_planet": None, + "moon_of_planet": "The moon", + "habitable": True, + "gravity": "9.807 m/s²", + "nickname": "Blue Planet, Gaia, Terra" +} + response=client.put("/planets/1", json= replaced_planet) + actual_planet = Planet.query.get(1) + response_body = response.get_json() + assert response.status_code == 200 + assert response_body == "Planet Earth updated" + assert actual_planet.name == replaced_planet["name"] + +def test_delete_planet(client, multiple_planets): + # Act + response = client.delete("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == "Planet Mars successfully deleted" + +