diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..a2d99bcf3 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,35 @@ +from dotenv import load_dotenv from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +import os + +db = SQLAlchemy() +migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) - return app + 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 app.routes import planet_routes + app.register_blueprint(planet_routes.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..a3dd5f347 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,33 @@ +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) + life = db.Column(db.Boolean) + moons = db.Column(db.Integer) + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + life=self.life, + moons=self.moons, + ) + + @classmethod + def from_dict(cls, data_dict): + return cls( + name=data_dict["name"], + description=data_dict["description"], + life=data_dict["life"], + moons=data_dict["moons"] + ) + + def replace_details(self, data_dict): + self.name=data_dict["name"] + self.description=data_dict["description"] + self.life=data_dict["life"] + self.moons=data_dict["moons"] + return self.to_dict() 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..74b2d9264 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,93 @@ +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request +from app.routes.routes_helper import error_message + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +def make_planet_safely(data_dict): + try: + return Planet.from_dict(data_dict) + except KeyError as err: + error_message(f"Missing key: {err}", 400) + +def replace_planet_safely(planet, data_dict): + try: + return planet.replace_details(data_dict) + except KeyError as err: + error_message(f"Missing key: {err}", 400) + +@planets_bp.route("", methods=["POST"]) +def handle_planets(): + request_body = request.get_json() + new_planet = make_planet_safely(request_body) + + db.session.add(new_planet) + db.session.commit() + + return jsonify(new_planet.to_dict()), 201 + +@planets_bp.route("", methods=["GET"]) +def index_planets(): + name_param = request.args.get("name") + + if name_param: + planets = Planet.query.filter_by(name=name_param) + else: + planets = Planet.query.all() + + result_list = [planet.to_dict() for planet in planets] + return jsonify(result_list) + +@planets_bp.route("/", methods=["GET"]) +def get_planet(id): + planet = validate_planet(id) + return jsonify(planet.to_dict()) + +def validate_planet(id): + try: + id = int(id) + except ValueError: + error_message(f"Invalid id {id}", 400) + + planet = Planet.query.get(id) + + if planet: + return planet + error_message(f'No planet with id {id} found', 404) + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(id): + planet = validate_planet(id) + request_body = request.get_json() + result = replace_planet_safely(planet, request_body) + db.session.commit() + return jsonify(result) + +@planets_bp.route("/", methods=["PATCH"]) +def upgrade_planet_with_id(id): + planet = validate_planet(id) + request_body = request.get_json() + planet_keys = request_body.keys() + + if "name" in planet_keys: + planet.name = request_body["name"] + if "description" in planet_keys: + planet.description = request_body["description"] + if "life" in planet_keys: + planet.life = request_body["life"] + if "moons" in planet_keys: + planet.moons = request_body["moons"] + + db.session.commit() + return jsonify(planet.to_dict()) + + + + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(id): + planet = validate_planet(id) + db.session.delete(planet) + db.session.commit() + return make_response('*** You have successfully destroyed Earth ! ***') \ No newline at end of file diff --git a/app/routes/routes_helper.py b/app/routes/routes_helper.py new file mode 100644 index 000000000..4482f0442 --- /dev/null +++ b/app/routes/routes_helper.py @@ -0,0 +1,4 @@ +from flask import jsonify, abort, make_response + +def error_message(message, status_code): + abort(make_response(jsonify(dict(details=message)), status_code)) \ 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/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..712caa3fb --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,34 @@ +import pytest +from flask.signals import request_finished +from app import db +from app import create_app +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): + Earth = Planet(id=1, name="Earth", description="home", life=True, moons=1) + Mars = Planet(id=2, name="Mars", description="1st Colony", life=True, moons=0) + + db.session.add(Earth) + db.session.add(Mars) + 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..c214329da --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,211 @@ +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_all_planets(client, two_planets): + response = client.get('/planets') + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{"id":1, + "name": "Earth", + "description": "home", + "moons": 1, + "life": True}, + {"id":2, + "name": "Mars", + "description": "1st Colony", + "moons": 0, + "life": True}] + +def test_get_planet_by_id(client, two_planets): + response = client.get("planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id":1, + "name": "Earth", + "description": "home", + "moons": 1, + "life": True + } + +def test_get_planet_by_name(client, two_planets): + response = client.get("planets?name=Earth") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id":1, + "name": "Earth", + "description": "home", + "moons": 1, + "life": True + }] + +def test_get_planet_by_invalid_id(client): + response = client.get("planets/a") + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body == {"details":"Invalid id a"} + +def test_create_one_planet(client): + + response = client.post("/planets", json={ + "name": "Pluto", + "description": "A real planet!", + "moons": 0, + "life": False + }) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == { + "id":1, + "name": "Pluto", + "description": "A real planet!", + "moons": 0, + "life": False + } + +def test_create_planet_with_a_missing_key(client): + + response = client.post("/planets", json={ + "description": "A big blue planet!", + "moons": 1, + "life": True + }) + + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body == {"details":"Missing key: 'name'"} + + +def test_delete_planet(client, two_planets): + + response = client.delete("/planets/1") + response_body = response.get_data(as_text=True) + + assert response.status_code == 200 + assert response_body == '*** You have successfully destroyed Earth ! ***' + + +def test_get_planet_id_not_found(client): + + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == {'details': 'No planet with id 1 found'} + + + +def test_update_planet_description(client, two_planets): + + response = client.patch("/planets/1", json={ + "description": "A big blue planet!", + }) + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id" : 1, + "name": "Earth", + "description": "A big blue planet!", + "moons": 1, + "life": True + } + +def test_update_planet_name(client, two_planets): + + response = client.patch("/planets/1", json={ + "name": "Earth 2.0", + }) + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id" : 1, + "name": "Earth 2.0", + "description": "home", + "moons": 1, + "life": True + } + +def test_update_planet_life(client, two_planets): + + response = client.patch("/planets/1", json={ + "life": False, + }) + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id" : 1, + "name": "Earth", + "description": "home", + "moons": 1, + "life": False + } + +def test_update_planet_moons(client, two_planets): + + response = client.patch("/planets/1", json={ + "moons":0, + }) + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id" : 1, + "name": "Earth", + "description": "home", + "moons":0, + "life": True + } + +def test_update_planet_with_a_put(client, two_planets): + + response = client.put("/planets/1", json={ + "name": "Earth", + "description": "A big blue planet!", + "moons": 1, + "life": True + }) + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id" : 1, + "name": "Earth", + "description": "A big blue planet!", + "moons": 1, + "life": True + } + +def test_update_planet_with_a_put_missing_key(client, two_planets): + + response = client.put("/planets/1", json={ + "description": "A big blue planet!", + "moons": 1, + "life": True + }) + + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body == {"details":"Missing key: 'name'"} \ No newline at end of file