diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..9de6db63a 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["TESTING"] = True and test_config + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = \ + os.environ.get("SQLALCHEMY_DATABASE_URI") if not test_config \ + else 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/__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..b5e46e4d3 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,16 @@ +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) + mass = db.Column(db.String) + + def planet_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "mass": self.mass, + } diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..3b323d736 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,53 @@ +from app import db +from app.models.planet import Planet from flask import Blueprint +from flask import request, make_response, jsonify + + +planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + + +@planet_bp.route("/", methods=["GET", "POST"]) +def handle_all_planets(): + if request.method == "GET": + name_query = request.args.get("name") + if name_query: + planets_result = Planet.query.filter_by(name=name_query) + else: + planets_result = Planet.query.all() + return jsonify([p.planet_dict() for p in planets_result]), 200 + elif request.method == "POST": + request_body = request.get_json() + new_planet = Planet( + name=request_body["name"], + description=request_body["description"], + mass=request_body["mass"], + ) + db.session.add(new_planet) + db.session.commit() + return {"success": f"Planet {new_planet.name} is now in orbit"}, 201 + + +@planet_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_planet(planet_id): + if not planet_id.isnumeric(): + return {"error": f"Planet #{planet_id} Invalid id"}, 400 + + planet = Planet.query.get(planet_id) + if not planet: + return {"error": f"Planet #{planet_id} No planet found"}, 404 + + elif request.method == "GET": + return planet.planet_dict() + elif request.method == "PUT": + form_data = request.get_json() + planet.name = form_data["name"] + planet.description = form_data["description"] + planet.mass = form_data["mass"] + db.session.commit() + return {"success": f"Planet #{planet_id} successfully updated"}, 200 + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + return {"success": f"Planet #{planet_id} successfully deleted"}, 200 diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 000000000..13daddae3 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,35 @@ +import pytest +from app import create_app, db +from app.models.planet import Planet +from flask.signals import request_finished + + +@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): + # Arrange + venus_planet = Planet(name="Venus", description="Hot mama", mass="The bigger the better.") + earth_planet = Planet(name="Earth", description="There are bugs here", mass="normal") + + db.session.add_all([venus_planet, earth_planet]) + db.session.commit() diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..bc3fa77c6 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,88 @@ +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_all_planets(client, two_saved_planets): + response = client.get("/planets/") + response_body = response.get_json() + assert response.status_code == 200 + assert response_body == [ + { + "id": 1, + "name": "Venus", + "description": "Hot mama", + "mass": "The bigger the better.", + }, + { + "id": 2, + "name": "Earth", + "description": "There are bugs here", + "mass": "normal", + }, + ] + + +def test_get_one_planet(client, two_saved_planets): + response = client.get("/planets/1") + response_body = response.get_json() + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Venus", + "description": "Hot mama", + "mass": "The bigger the better.", + } + + +def test_get_one_planet_no_data_returns_404(client): + response = client.get("/planets/3") + assert response.status_code == 404 + + +def test_post_planet_returns_201(client): + response = client.post("/planets/", json={ + "name": "Earth II", + "description": "If Earth is so good why isn't there... oh", + "mass": "Better than normal" + }) + response_body = response.get_json() + assert response.status_code == 201 + assert response_body == {"success": "Planet Earth II is now in orbit"} + + +def test_invalid_planet_id_returns_400(client): + response = client.get("/planets/invalid") + assert response.status_code == 400 + + +def test_delete_planet(client, two_saved_planets): + response = client.delete("/planets/1") + response_body = response.get_json() + assert response.status_code == 200 + assert response_body == {"success": "Planet #1 successfully deleted"} + + +def test_update_planet(client, two_saved_planets): + response = client.put("/planets/1", json={ + "name": "Mercury", + "description": "Actually, Planet 1 is totally mercury. What are you doing here Venus", + "mass": "Correct" + }) + response_body = response.get_json() + assert response.status_code == 200 + assert response_body == {"success": "Planet #1 successfully updated"} + + +def test_name_query(client, two_saved_planets): + response = client.get("/planets/?name=Venus") + response_body = response.get_json() + assert response.status_code == 200 + assert response_body == [{ + "id": 1, + "name": "Venus", + "description": "Hot mama", + "mass": "The bigger the better.", + }] 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/cebd768ade25_add_planet_model.py b/migrations/versions/cebd768ade25_add_planet_model.py new file mode 100644 index 000000000..42cbe9057 --- /dev/null +++ b/migrations/versions/cebd768ade25_add_planet_model.py @@ -0,0 +1,34 @@ +"""add planet model + +Revision ID: cebd768ade25 +Revises: +Create Date: 2022-11-01 10:44:14.114515 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'cebd768ade25' +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('mass', 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/requirements.txt b/requirements.txt index fba2b3e38..661db4e37 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,19 +1,31 @@ alembic==1.5.4 +attrs==22.1.0 autopep8==1.5.5 +black==22.10.0 blinker==1.4 certifi==2020.12.5 chardet==4.0.0 -click==7.1.2 +click==8.1.3 +coverage==6.5.0 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +mypy-extensions==0.4.3 +packaging==21.3 +pathspec==0.10.1 +platformdirs==2.5.2 +pluggy==1.0.0 psycopg2-binary==2.9.4 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.9 pytest==7.1.1 pytest-cov==2.12.1 python-dateutil==2.8.1 @@ -23,5 +35,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.0.1