diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..031556078 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") + + from app.models.planet import Planet + + db.init_app(app) + migrate.init_app(app, db) + + 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..661769527 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,15 @@ +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.Text, nullable=False) + rings = db.Column(db.Boolean, nullable=False) + + def build_planet_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "rings": self.rings + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..206786438 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,81 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response, request +from app.models.planet import Planet +from app import db +planet_bp = Blueprint("planets", __name__, url_prefix="/planets") + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({"message":f"Planet #{planet_id} invalid"}, 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + abort(make_response({"message":f"Planet #{planet_id} not found"}, 404)) + + return planet + +@planet_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], + description=request_body["description"], + rings=request_body["rings"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + +@planet_bp.route("", methods=["GET"]) +def get_all_planets(): + name_query = request.args.get("name") + rings_query = request.args.get("rings") + limit_query = request.args.get("limit") + + planet_query = Planet.query + + if name_query: + planet_query = planet_query.filter_by(name=name_query) + if rings_query: + planet_query = planet_query.filter_by(rings=rings_query) + if limit_query: + planet_query = planet_query.limit(limit=limit_query) + + planets = planet_query.all() + planets_response = [] + + for planet in planets: + planets_response.append(planet.build_planet_dict()) + + return jsonify(planets_response) + +@planet_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + + return jsonify(planet.build_planet_dict()) + +@planet_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.rings = request_body["rings"] + + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully updated", 200) + +@planet_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully deleted", 200) \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..a3eabd89d --- /dev/null +++ b/migrations/README @@ -0,0 +1,5 @@ +<<<<<<< HEAD +Single-database configuration for Flask. +======= +Generic single-database configuration. +>>>>>>> 6090479c75453dcce233fbba05263a13891da630 diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..5150058e1 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,57 @@ +# 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] +<<<<<<< HEAD +keys = root,sqlalchemy,alembic,flask_migrate +======= +keys = root,sqlalchemy,alembic +>>>>>>> 6090479c75453dcce233fbba05263a13891da630 + +[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 + +<<<<<<< HEAD +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +======= +>>>>>>> 6090479c75453dcce233fbba05263a13891da630 +[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..b0fd4a684 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,108 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +<<<<<<< HEAD +======= +from sqlalchemy import engine_from_config +from sqlalchemy import pool +>>>>>>> 6090479c75453dcce233fbba05263a13891da630 +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', +<<<<<<< HEAD + str(current_app.extensions['migrate'].db.get_engine().url).replace( + '%', '%%')) +======= + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +>>>>>>> 6090479c75453dcce233fbba05263a13891da630 +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.') + +<<<<<<< HEAD + connectable = current_app.extensions['migrate'].db.get_engine() +======= + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) +>>>>>>> 6090479c75453dcce233fbba05263a13891da630 + + 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/f361a1882d05_adds_book_model.py b/migrations/versions/f361a1882d05_adds_book_model.py new file mode 100644 index 000000000..d4918c865 --- /dev/null +++ b/migrations/versions/f361a1882d05_adds_book_model.py @@ -0,0 +1,34 @@ +"""adds Book model + +Revision ID: f361a1882d05 +Revises: +Create Date: 2022-10-29 19:51:40.904287 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'f361a1882d05' +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.Text(), nullable=False), + sa.Column('rings', sa.Boolean(), 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..03932f1e0 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,32 @@ +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 Book + + from .routes import books_bp + app.register_blueprint(books_bp) + + return app \ No newline at end of file diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 000000000..176183d89 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,50 @@ +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_saved_planet(): + planet = Planet(name='Earth', description='The blue marble', rings=False) + db.session.add(planet) + db.session.commit() + return planet + +@pytest.fixture +def all_planets(): + planets = [ + Planet(name="Mercury", description="The smallest planet", rings=False), + Planet(name="Venus", description="The hottest planet", rings=False), + Planet(name="Earth", description="The blue marble", rings=False), + Planet(name="Mars", description="The red planet", rings=False), + Planet(name="Jupiter", description="The gas giant", rings=False), + Planet(name="Saturn", description="The second largest planet", rings=True), + Planet(name="Uranus", description="This planet spins on its side", rings=True), + Planet(name="Neptune", description="The most distant planet from the sun", rings=False) + ] + + db.session.add_all(planets) + db.session.commit() + return planets diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..46f4f0c96 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,48 @@ +from app.models.planet import Planet + +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_one_planet_returns_planet(client, one_saved_planet): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body["id"] == one_saved_planet.id + assert response_body["name"] == one_saved_planet.name + assert response_body["rings"] == one_saved_planet.rings + assert response_body["description"] == one_saved_planet.description + +def test_get_one_planet_with_no_records(client): + response = client.get("/planets/1") + + assert response.status_code == 404 + +def test_get_all_planets_returns_all_planets(client, all_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert len(response_body) == 8 + +def test_create_planet_path(client): + EXPECTED_PLANET = { + "name": "Pluto", + "description": "Not a planet :(", + "rings": False + } + + response = client.post("/planets", json=EXPECTED_PLANET) + response_body = response.get_data(as_text=True) + planet = Planet.query.get(1) + + assert response.status_code == 201 + assert response_body == f"Planet {EXPECTED_PLANET['name']} successfully created" + assert planet.name == EXPECTED_PLANET["name"] + assert planet.description == EXPECTED_PLANET["description"] + assert planet.rings == EXPECTED_PLANET["rings"]