diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..8381cfaed 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,21 @@ from flask import Flask +from app.db import db, migrate +from app.routes.planets_routes import planet_bp +import os -def create_app(test_config=None): +def create_app(config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + + if config: + app.config.update(config) + + + db.init_app(app) + migrate.init_app(app, db) + + app.register_blueprint(planet_bp) return app diff --git a/app/db.py b/app/db.py new file mode 100644 index 000000000..6266713f2 --- /dev/null +++ b/app/db.py @@ -0,0 +1,6 @@ +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from .models.base import Base + +db = SQLAlchemy(model_class=Base) +migrate = Migrate() diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/base.py b/app/models/base.py new file mode 100644 index 000000000..227841686 --- /dev/null +++ b/app/models/base.py @@ -0,0 +1,4 @@ +from sqlalchemy.orm import DeclarativeBase + +class Base(DeclarativeBase): + pass \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..b73100275 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,24 @@ +from sqlalchemy.orm import Mapped, mapped_column +from app.db import db + +class Planet(db.Model): + id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + name: Mapped[str] + description: Mapped[str] + diameter: Mapped[int] #in kilometers + number_of_moons: Mapped[int] + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + diameter=self.diameter, + number_of_moons=self.number_of_moons + ) + + + + + + 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/planets_routes.py b/app/routes/planets_routes.py new file mode 100644 index 000000000..c70dd6bc2 --- /dev/null +++ b/app/routes/planets_routes.py @@ -0,0 +1,93 @@ +from flask import Blueprint, abort, make_response, request, Response +from app.models.planet import Planet +from ..db import db + +planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") + +@planet_bp.post("") +def create_planet(): + request_body = request.get_json() + + name = request_body["name"] + description = request_body["description"] + diameter = request_body["diameter"] + number_of_moons = request_body["number_of_moons"] + + new_planet = Planet(name=name, description=description, diameter=diameter, number_of_moons=number_of_moons) + db.session.add(new_planet) + db.session.commit() + + response = new_planet.to_dict() + return response, 201 + +@planet_bp.get("") +def get_all_planets(): + query = db.select(Planet) + + description_param = request.args.get("description") + if description_param: + query = query.where(Planet.description.ilike(f"%{description_param}%")) + + number_of_moons_param = request.args.get("number_of_moons") + if number_of_moons_param: + query = query.where(Planet.number_of_moons == number_of_moons_param) + + query = query.order_by(Planet.id) + + planets = db.session.scalars(query) + + response_body = [planet.to_dict() for planet in planets] + + return response_body + +@planet_bp.get("/") +def get_single_planet(planet_id): + planet = validate_planet(planet_id) + + return planet.to_dict() + +@planet_bp.put("/") +def update_single_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.diameter = request_body["diameter"] + planet.number_of_moons = request_body["number_of_moons"] + + db.session.commit() + + return Response(status=204, mimetype='application/json') + +@planet_bp.delete("/") +def delete_single_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return Response(status=204, mimetype='application/json') + + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + response = { + "message": f"Planet {planet_id} invalid" + } + abort(make_response(response, 400)) + + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + if not planet: + response = { + "message": f"Planet {planet_id} not found" + } + abort(make_response(response, 404)) + + return planet + + diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# 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,flask_migrate + +[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 + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[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..4c9709271 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,113 @@ +import logging +from logging.config import fileConfig + +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') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except (TypeError, AttributeError): + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# 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', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# 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 get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +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=get_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.') + + conf_args = current_app.extensions['migrate'].configure_args + if conf_args.get("process_revision_directives") is None: + conf_args["process_revision_directives"] = process_revision_directives + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + **conf_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/b0952940e36d_adds_planet_model.py b/migrations/versions/b0952940e36d_adds_planet_model.py new file mode 100644 index 000000000..7be24ffe3 --- /dev/null +++ b/migrations/versions/b0952940e36d_adds_planet_model.py @@ -0,0 +1,36 @@ +"""adds +Planet model + +Revision ID: b0952940e36d +Revises: +Create Date: 2024-10-25 14:26:03.446066 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'b0952940e36d' +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.String(), nullable=False), + sa.Column('diameter', sa.Integer(), nullable=False), + sa.Column('number_of_moons', sa.Integer(), 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/requirements.txt b/requirements.txt index 24c7e56f8..f8803b28f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,17 +1,22 @@ alembic==1.13.1 autopep8==1.5.5 -blinker==1.7 +blinker==1.7.0 certifi==2020.12.5 chardet==4.0.0 click==8.1.7 +coverage==7.6.3 Flask==3.0.2 Flask-Migrate==4.0.5 Flask-SQLAlchemy==3.1.1 +gunicorn==23.0.0 idna==2.10 +iniconfig==2.0.0 itsdangerous==2.1.2 Jinja2==3.1.3 Mako==1.1.4 MarkupSafe==2.1.5 +packaging==24.1 +pluggy==1.5.0 psycopg2-binary==2.9.9 pycodestyle==2.6.0 pytest==8.0.0 @@ -23,5 +28,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==2.0.25 toml==0.10.2 +typing_extensions==4.12.2 urllib3==1.26.4 -Werkzeug==3.0.1 \ No newline at end of file +Werkzeug==3.0.1 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..367530c02 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,42 @@ +import pytest +from app import create_app +from app.db import db +from flask.signals import request_finished +from dotenv import load_dotenv +import os +from app.models.planet import Planet + +load_dotenv() + +@pytest.fixture +def app(): + test_config = { + "TESTING": True, + "SQLALCHEMY_DATABASE_URI": os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') + } + app = create_app(test_config) + + @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_save_planets(app): + planet_1 = Planet(name="Pluto", description="Dwarf planet known for its complex orbit and atmosphere.", diameter=2376, number_of_moons=5) + planet_2 = Planet(name="Neptune", description="The farthest planet, known for strong winds", diameter=49244, number_of_moons=14) + + db.session.add_all([planet_1, planet_2]) + db.session.commit() + + return [planet_1, planet_2] diff --git a/tests/test_planets_routes.py b/tests/test_planets_routes.py new file mode 100644 index 000000000..a368e092b --- /dev/null +++ b/tests/test_planets_routes.py @@ -0,0 +1,63 @@ +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(client, two_save_planets): + #Act + response = client.get(f"/planets/{two_save_planets[0].id}") + response_body = response.get_json() + + #Assert + assert response.status_code == 200 + assert response_body == { + "id": two_save_planets[0].id, + "name": "Pluto", + "description": "Dwarf planet known for its complex orbit and atmosphere.", + "diameter": 2376, + "number_of_moons": 5 + } + +def test_create_one_planet_in_empty_database(client): + #Act + response = client.post("/planets", json={ + "name": "Pluto", + "description": "Dwarf planet known for its complex orbit and atmosphere.", + "diameter": 2376, + "number_of_moons": 5 + }) + + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == { + "id": 1, + "name": "Pluto", + "description": "Dwarf planet known for its complex orbit and atmosphere.", + "diameter": 2376, + "number_of_moons": 5 + } + +def test_create_one_planet_already_in_database(client, two_save_planets): + #Act + response = client.post("/planets", json={ + "name": "Pluto", + "description": "Dwarf planet known for its complex orbit and atmosphere.", + "diameter": 2376, + "number_of_moons": 5 + }) + + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == { + "id": 3, + "name": "Pluto", + "description": "Dwarf planet known for its complex orbit and atmosphere.", + "diameter": 2376, + "number_of_moons": 5 + } \ No newline at end of file