diff --git a/.gitignore b/.gitignore index 4e9b18359..577f9295e 100644 --- a/.gitignore +++ b/.gitignore @@ -89,6 +89,7 @@ ipython_config.py # For a library or package, you might want to ignore these files since the code is # intended to run in multiple environments; otherwise, check them in: # .python-version +.env # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..8d62712be 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 + + 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") - return app + 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 \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..7c50ec5d3 --- /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) + description = db.Column(db.String) + flag = db.Column(db.Boolean) + + @classmethod + def from_dict(cls,input_data): + return cls( + name=input_data["name"], + description=input_data["description"], + flag=input_data["flag"] + ) + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + flag=self.flag + ) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..32d099808 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,53 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet +planet_bp = Blueprint("planets", __name__, url_prefix="/planets") + +def validate_planet(id): + try: + id = int(id) + except: + abort(make_response({"message": f"planet '{id}' is invalid"}, 400)) + + planet = Planet.query.get(id) + + if not planet: + abort(make_response({"message": f"Planet {id} not found"}, 404)) + + return planet + +@planet_bp.route("", methods=["GET", "POST"]) +def handle_planets(): + if request.method == "POST": + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], + description=request_body["description"], + flag=request_body["flag"]) + db.session.add(new_planet) + db.session.commit() + return make_response(f"planet {new_planet.name} successfully created!", 201) + + elif request.method == "GET": + name_query = request.args.get("name") + flag_query = request.args.get("flag") + + planet_query = Planet.query + + if name_query: + planet_query = planet_query.filter_by(name=name_query) + if flag_query: + planet_query = planet_query.filter_by(flag=flag_query) + + planets = planet_query.all() + planets_response = [planet.to_dict() for planet in planets] + return jsonify(planets_response) + +@planet_bp.route("/", methods=["GET"]) +def get_one_planet(id): + validate_planet(id) + planet = Planet.query.get(id) + return {"id": planet.id, + "name": planet.name, + "description": planet.description, + "flag": planet.flag} 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/5b317c8c141e_removed_flag.py b/migrations/versions/5b317c8c141e_removed_flag.py new file mode 100644 index 000000000..5cc6b7344 --- /dev/null +++ b/migrations/versions/5b317c8c141e_removed_flag.py @@ -0,0 +1,28 @@ +"""removed flag + +Revision ID: 5b317c8c141e +Revises: dc8232bcbf6e +Create Date: 2022-10-31 16:20:55.928060 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '5b317c8c141e' +down_revision = 'dc8232bcbf6e' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('planet', 'flag') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('flag', sa.BOOLEAN(), autoincrement=False, nullable=True)) + # ### end Alembic commands ### diff --git a/migrations/versions/dc8232bcbf6e_adds_planet_model.py b/migrations/versions/dc8232bcbf6e_adds_planet_model.py new file mode 100644 index 000000000..ca68b33bb --- /dev/null +++ b/migrations/versions/dc8232bcbf6e_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds planet model + +Revision ID: dc8232bcbf6e +Revises: +Create Date: 2022-10-31 16:12:09.052492 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'dc8232bcbf6e' +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('flag', sa.Boolean(), 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/migrations/versions/eaeb0e236b3c_re_added_flag.py b/migrations/versions/eaeb0e236b3c_re_added_flag.py new file mode 100644 index 000000000..2f1cdff94 --- /dev/null +++ b/migrations/versions/eaeb0e236b3c_re_added_flag.py @@ -0,0 +1,28 @@ +"""re-added flag + +Revision ID: eaeb0e236b3c +Revises: 5b317c8c141e +Create Date: 2022-10-31 16:30:08.673148 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'eaeb0e236b3c' +down_revision = '5b317c8c141e' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('flag', sa.Boolean(), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('planet', 'flag') + # ### 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..21eeaa71d --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,48 @@ +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 one_planet(app): + planet = Planet(name="venus", + description="doesn't have any moons, 2nd largest planet.", + flag=False) + + db.session.add(planet) + db.session.commit() + return planet + +@pytest.fixture +def multi_planets(app): + planet_one = Planet(name="venus", + description="doesn't have any moons, 2nd largest planet.", + flag=False) + planet_two = Planet(name="Neptune", + description="one of two ice giant planets.", + flag=False) + + planet_list = [planet_one, planet_two] + + db.session.add_all(planet_list) + db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..e6ed4716b --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,67 @@ +from app.models.planet import Planet + + +def test_get_all_planets_with_no_records_returns_empty(client): + #act + response = client.get('/planets') + response_body = response.get_json() + + # assert + assert response.status_code == 200 + assert response_body == [] + + +def test_get_first_planet(client, one_planet): + # act + response = client.get('/planets/1') + response_body = response.get_json() + + # assert + assert response.status_code == 200 + assert response_body["id"] == one_planet.id + assert response_body["name"] == one_planet.name + assert response_body["description"] == one_planet.description + assert response_body["flag"] == one_planet.flag + + +def test_get_empty_database_returns_404(client): + # act + response = client.get('/planets/1') + # assert + assert response.status_code == 404 + + + +def test_planets_with_data_return_200_with_valid_data(client, multi_planets): + # act + response = client.get('/planets') + response_body = response.get_json() + # assert + assert response.status_code == 200 + assert response_body == [ { + 'name': 'venus', + 'description': "doesn't have any moons, 2nd largest planet.", + 'flag': False, + 'id': 1 + }, + { + 'name': 'Neptune', + 'description': 'one of two ice giant planets.', + 'flag': False, + 'id': 2 + } + ] + + +def test_save_planet(client): + # arrange + NEW_PLANET ={"name": "Mercury", + "description": "planet closest to the sun.", + "flag": False} + # act + response = client.post('/planets', json=NEW_PLANET) + response_body = response.get_data(as_text=True) + + # assert + assert response.status_code == 201 + assert response_body == f"planet {NEW_PLANET['name']} successfully created!" \ No newline at end of file