diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..f29fb6122 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..95b76ba93 --- /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, nullable=False) + description=db.Column(db.String, nullable=False) + solar_day=db.Column(db.Float, nullable=False) + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "solar_day": self.solar_day + } + + @classmethod + def from_dict(cls, planet_data): + return Planet( + name=planet_data["name"], + description=planet_data["description"], + solar_day=planet_data["solar_day"] + ) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..5c30c4003 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,64 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + abort(make_response(jsonify({"message":f"{cls.__name__} {model_id} invalid"}), 400)) + + model = cls.query.get(model_id) + if not model: + abort(make_response(jsonify({"message":f"{cls.__name__} {model_id} not found"}), 404)) + + return model + + + +@planets_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} created successfully."), 201) + +@planets_bp.route("", methods=["GET"]) +def get_all_planets(): + 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 replace_planet(planet_id): + planet = validate_model(Planet, planet_id) + planet_to_update = request.get_json() + + planet.name = planet_to_update["name"] + planet.description = planet_to_update["description"] + planet.solar_day = planet_to_update["solar_day"] + + db.session.commit() + + return make_response(jsonify(f"Planet {planet.name} updated successfully.")) + + +@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} was deleted.")) diff --git a/app/seed.py b/app/seed.py new file mode 100644 index 000000000..f81bb5940 --- /dev/null +++ b/app/seed.py @@ -0,0 +1,11 @@ +# planets = [ +# Planet(1, "Mercury", "smallest planet", 176.0), +# Planet(2, "Venus", "planet of love", 243.0), +# Planet(3, "Earth", "home planet", 1.0), +# Planet(4, "Mars", "red planet", 1.25), +# Planet(5, "Jupiter", "largest planet", 0.42), +# Planet(6, "Saturn", "ring planet", .45), +# Planet(7, "Uranus", "coldest planet", .71), +# Planet(8, "Neptune", "not visible to the naked eye", .67), +# Planet(9, "Pluto", "unqualified planet", 6.375) +# ] \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# 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,flask_migrate + +[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 + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[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..68feded2a --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,91 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +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.get_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 = current_app.extensions['migrate'].db.get_engine() + + 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/595fe7f869fa_adds_planet_model.py b/migrations/versions/595fe7f869fa_adds_planet_model.py new file mode 100644 index 000000000..ff034719c --- /dev/null +++ b/migrations/versions/595fe7f869fa_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: 595fe7f869fa +Revises: +Create Date: 2023-04-28 13:12:50.013892 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '595fe7f869fa' +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('solar_day', sa.Float(), 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..6b1e2ef10 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,51 @@ +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): + nebula = Planet( + name="Nebula", + description="Fake planet for testing purposes", + solar_day=420.0 + ) + + gamora = Planet( + name="Gamora", + description="Do not visit. Not a real place.", + solar_day=666.0 + ) + + db.session.add_all([nebula, gamora]) + db.session.commit() + +@pytest.fixture +def walla_walla(): + return { + "name": "Walla-Walla", + "description": "A bad place.", + "solar_day": 0.5 + } \ No newline at end of file diff --git a/tests/test_models.py b/tests/test_models.py new file mode 100644 index 000000000..fa01ccfdc --- /dev/null +++ b/tests/test_models.py @@ -0,0 +1,19 @@ +from app.models.planet import Planet + +def test_to_dict_no_missing_data(): + #arrange + test_data = Planet( + id=1, + name="testopolis", + description="a testing place", + solar_day=300 + ) + #act + result = test_data.to_dict() + + #assert + assert len(result) == 4 + assert result["id"] == 1 + assert result["name"] == "testopolis" + assert result["solar_day"] == 300 + assert result["description"] == "a testing place" diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..f9f190dd1 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,54 @@ +def test_get_all_planets_with_no_records(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + +def test_get_one_planet(client, two_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Nebula", + "description": "Fake planet for testing purposes", + "solar_day": 420.0 + } + +def test_get_one_planet_no_data_404(client): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body["message"] == "Planet 1 not found" + +def test_get_one_planet_invalid_id_400(client): + response = client.get("/planets/WALLA-WALLA") + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body["message"] == "Planet WALLA-WALLA invalid" + +def test_post_one_planet(client, walla_walla): + response = client.post("/planets", json=walla_walla) + + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == "Planet Walla-Walla created successfully." + +def test_delete_one_planet(client, two_planets): + response = client.delete("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == "Planet Nebula was deleted." + +def test_update_one_planet(client, two_planets, walla_walla): + response = client.put("/planets/1", json=walla_walla) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == "Planet Walla-Walla updated successfully."