diff --git a/.gitignore b/.gitignore index 4e9b18359..72d16b84c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.env .vscode .DS_Store diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..b4844024b 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,33 @@ 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 planets_bp + app.register_blueprint(planets_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..8843c4043 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,7 @@ +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) + \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..6b6f3363f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,101 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, request +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + + +@planets_bp.route("", methods=["POST", "GET"]) +def handle_planets(): + if request.method == "POST": + request_body = request.get_json() + if "name" not in request_body or "description" not in request_body: + return jsonify("Invalid request"), 404 + + new_planet = Planet( + name=request_body["name"], + description=request_body["description"] + ) + db.session.add(new_planet) + db.session.commit() + + return jsonify(f"Planet {new_planet.name} created successfully"), 201 + + elif request.method == "GET": + name_query = request.args.get("name") + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "name": planet.name, + "description": planet.description + }) + + return jsonify(planets_response) + + +@planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_planet(planet_id): + + planet = Planet.query.get(planet_id) + + if planet is None: + return jsonify("Not Found"), 404 + + if request.method == "GET": + return { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + + elif request.method == "PUT": + form_data = request.get_json() + + planet.name = form_data["name"] + planet.description = form_data["description"] + + db.session.commit() + + return jsonify(f"Planet #{planet.id} sucessfully updated"), 200 + + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + return jsonify(f"Planet #{planet.id} sucessfully deleted"), 200 + +# class Planet: +# def __init__(self, id, name, description): +# self.id = id +# self.name = name +# self.description = description + + +# # list of planet +# planets = [ +# Planet(1, "Saturn", "Six planet from the Sun and a gas giant."), +# Planet(2, "Venus", "Second planet from the Sun and the hottest planet in our solar system."), +# Planet(3, "Mars", "Fourth planet from the Sun and it is the second smallest planet in our solar system.") + +# ] + +# planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + + +# @planets_bp.route("", methods=["GET"]) +# def get_list_planets(): +# planets_list = [] +# for planet in planets: +# planets_list.append({ +# "id": planet.id, +# "name": planet.name, +# "description": planet.description + +# }) + +# return jsonify(planets_list) 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/47a38ad4ce75_.py b/migrations/versions/47a38ad4ce75_.py new file mode 100644 index 000000000..1ac88f6b8 --- /dev/null +++ b/migrations/versions/47a38ad4ce75_.py @@ -0,0 +1,33 @@ +"""empty message + +Revision ID: 47a38ad4ce75 +Revises: +Create Date: 2021-10-22 14:30:38.038421 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '47a38ad4ce75' +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.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..10ae051c5 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,27 @@ +import pytest +from app import db +from app import create_app +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + 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): + mars = Planet(name = "Mars", description="Red planet") + saturn = Planet(name = "Saturn", description="Lots of rings!") + + db.session.add_all([mars, saturn]) + 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..e2a2a1921 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,54 @@ +def test_get_list_of_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_response_body_of_fixture_planet(client, two_saved_planets): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response_body == { + "id": 1, + "name": "Mars", + "description": "Red planet" + } + +def test_get_response_body_of_planet_with_no_data(client): + # Act + response = client.get("/planets/1") + + # Assert + assert response.status_code == 404 + +def test_get_list_of_planets_in_test_db(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [ + { + "id": 1, + "name": "Mars", + "description": "Red planet" + }, + { + "id": 2, + "name": "Saturn", + "description": "Lots of rings!" + } + ] + +def test_post_new_planet_returns_status_code(client): + # Act + request = client.post("/planets", json = {"name": "Venus", "description": "Test"}) + + # Assert + assert request.status_code == 201 \ No newline at end of file