From 36bf88177a930da5f2b377216120e7109fda13cf Mon Sep 17 00:00:00 2001 From: DC Date: Sun, 20 Oct 2024 18:30:31 -0400 Subject: [PATCH 1/8] Wave 1 and 2 of Solar System Complete --- app/__init__.py | 9 ++++-- app/models/__init__.py | 0 app/models/planet.py | 17 ++++++++++ app/routes.py | 2 -- app/routes/__init__.py | 0 app/routes/planet_routes.py | 62 +++++++++++++++++++++++++++++++++++++ 6 files changed, 85 insertions(+), 5 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py delete mode 100644 app/routes.py create mode 100644 app/routes/__init__.py create mode 100644 app/routes/planet_routes.py diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..dcf163b19 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,10 @@ from flask import Flask +from .routes.planet_routes import planets_bp - -def create_app(test_config=None): +def create_app(): app = Flask(__name__) - return app + # Register Blueprints here + app.register_blueprint(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..41e16a37c --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,17 @@ +class Planet: + def __init__(self, id, name, description): + self.id = id + self.name = name + self.description = description + +planets = [ + Planet(1, "Neptune", "Giant and icy planet"), + Planet(2, "Uranus", "Rotates on its side"), + Planet(3, "Saturn", "Has beautiful rings"), + Planet(4, "Jupiter", "Largest planet in the solar system"), + Planet(5, "Mars", "The red planet"), + Planet(6, "Earth", "Our home planet"), + Planet(7, "Venus", "Second planet from the sun"), + Planet(8, "Mercury", "Smallest and hottest planet"), + Planet(6, "Pluto", "The planet they declassified as a planet") +] 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..18e57937c --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,62 @@ +from flask import Blueprint, abort, make_response, request +from app.models.planet import planets +# from ..db import db + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.get("") +def get_all_planets(): + + planets_response = [] + for planet in planets: + planets_response.append( + { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + ) + return planets_response + +@planets_bp.get("/") +def get_one_planet(planet_id): + planet = validate_planet(planet_id) + + for planet in planets: + if planet.id == planet_id: + return { + "id": planet.id, + "title": planet.title, + "description": planet.description, + } + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + response = {"message": f"planet {planet_id} invalid"} + abort(make_response(response, 400)) + + for planet in planets: + if planet.id == planet_id: + return planet + + response = {"message": f"planet {planet_id} not found"} + abort(make_response(response, 404)) + +# @planets_bp.post("") +# def create_planet(): +# request_body = request.get_json() +# title = request_body["title"] +# description = request_body["description"] + +# new_book = Planet(title=title, description=description) +# db.session.add(new_planet) +# db.session.commit() + +# response = { +# "id": new_planet.id, +# "title": new_planet.name, +# "description": new_planet.description, +# } +# return response, 201 From 03def41f58310feee97d460031eb8b59d797e2e6 Mon Sep 17 00:00:00 2001 From: DC Date: Sun, 20 Oct 2024 18:56:54 -0400 Subject: [PATCH 2/8] Refactored Wave 1 and Wave 2 of Solar System --- app/routes/planet_routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 18e57937c..837e3cc52 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -23,10 +23,10 @@ def get_one_planet(planet_id): planet = validate_planet(planet_id) for planet in planets: - if planet.id == planet_id: + if planet.id == int(planet_id): return { "id": planet.id, - "title": planet.title, + "name": planet.name, "description": planet.description, } From 36bd4ad38d8d8a6fb9ab73ab65ab4ce179e675dc Mon Sep 17 00:00:00 2001 From: lioliadoc Date: Fri, 25 Oct 2024 12:43:29 -0700 Subject: [PATCH 3/8] commit get, put, post, delete (wave 3, wave 4) --- app/__init__.py | 8 ++ app/db.py | 6 + app/models/base.py | 4 + app/models/planet.py | 23 ++-- app/routes/planet_routes.py | 111 +++++++++++------ migrations/README | 1 + migrations/alembic.ini | 50 ++++++++ migrations/env.py | 113 ++++++++++++++++++ migrations/script.py.mako | 24 ++++ .../versions/2716e01399aa_planet_model.py | 34 ++++++ 10 files changed, 321 insertions(+), 53 deletions(-) create mode 100644 app/db.py create mode 100644 app/models/base.py create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/2716e01399aa_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index dcf163b19..abd484307 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +1,17 @@ from flask import Flask +from .db import db, migrate +from .models import planet from .routes.planet_routes import planets_bp def create_app(): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + db.init_app(app) + migrate.init_app(app, db) + # Register Blueprints here app.register_blueprint(planets_bp) diff --git a/app/db.py b/app/db.py new file mode 100644 index 000000000..3ada8d10c --- /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() \ No newline at end of file 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 index 41e16a37c..1078a9da1 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,17 +1,8 @@ -class Planet: - def __init__(self, id, name, description): - self.id = id - self.name = name - self.description = description +from sqlalchemy.orm import Mapped, mapped_column +from ..db import db -planets = [ - Planet(1, "Neptune", "Giant and icy planet"), - Planet(2, "Uranus", "Rotates on its side"), - Planet(3, "Saturn", "Has beautiful rings"), - Planet(4, "Jupiter", "Largest planet in the solar system"), - Planet(5, "Mars", "The red planet"), - Planet(6, "Earth", "Our home planet"), - Planet(7, "Venus", "Second planet from the sun"), - Planet(8, "Mercury", "Smallest and hottest planet"), - Planet(6, "Pluto", "The planet they declassified as a planet") -] +class Planet(db.Model): + id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + name: Mapped[str] + description: Mapped[str] + diameter: Mapped[int] \ No newline at end of file diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 837e3cc52..e07cb005c 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,34 +1,86 @@ -from flask import Blueprint, abort, make_response, request -from app.models.planet import planets -# from ..db import db +from flask import Blueprint, abort, make_response, Response, request +from app.models.planet import Planet +from ..db import db + planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + @planets_bp.get("") def get_all_planets(): + query = db.select(Planet).order_by(Planet.id) + planets = db.session.scalars(query) + # We could also write the line above as: + # books = db.session.execute(query).scalars() - planets_response = [] + planet_response = [] for planet in planets: - planets_response.append( + planet_response.append( { "id": planet.id, "name": planet.name, - "description": planet.description + "description": planet.description, + "diameter": planet.diameter } ) - return planets_response + return planet_response + + +@planets_bp.post("") +def create_planet(): + request_body = request.get_json() + name = request_body["name"] + description = request_body["description"] + diameter = request_body["diameter"] + + new_planet = Planet(name=name, description=description, diameter=diameter) + db.session.add(new_planet) + db.session.commit() + + response = { + + "id": new_planet.id, + "name": new_planet.name, + "description": new_planet.description, + "diameter": new_planet.diameter + } + return response, 201 + @planets_bp.get("/") def get_one_planet(planet_id): planet = validate_planet(planet_id) - for planet in planets: - if planet.id == int(planet_id): - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - } + return { + + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } + + +@planets_bp.put("/") +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + name = request_body["name"] + description = request_body["description"] + diameter = request_body["diameter"] + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +@planets_bp.delete("/") +def delete_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: @@ -37,26 +89,11 @@ def validate_planet(planet_id): response = {"message": f"planet {planet_id} invalid"} abort(make_response(response, 400)) - for planet in planets: - if planet.id == planet_id: - return planet - - response = {"message": f"planet {planet_id} not found"} - abort(make_response(response, 404)) - -# @planets_bp.post("") -# def create_planet(): -# request_body = request.get_json() -# title = request_body["title"] -# description = request_body["description"] - -# new_book = Planet(title=title, description=description) -# db.session.add(new_planet) -# db.session.commit() - -# response = { -# "id": new_planet.id, -# "title": new_planet.name, -# "description": new_planet.description, -# } -# return response, 201 + 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 \ No newline at end of file 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/2716e01399aa_planet_model.py b/migrations/versions/2716e01399aa_planet_model.py new file mode 100644 index 000000000..ad75babbb --- /dev/null +++ b/migrations/versions/2716e01399aa_planet_model.py @@ -0,0 +1,34 @@ +"""Planet model + +Revision ID: 2716e01399aa +Revises: +Create Date: 2024-10-24 21:23:49.859622 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '2716e01399aa' +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.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### From 71447d2a0a987f382cc7513656e8fd0cdf8b14f2 Mon Sep 17 00:00:00 2001 From: DC Date: Fri, 25 Oct 2024 17:12:41 -0400 Subject: [PATCH 4/8] Fixes PUT bug and lists TABLE descriptions --- app/models/planet.py | 20 ++++++++++++++++++- app/routes/planet_routes.py | 6 +++--- .../versions/2716e01399aa_planet_model.py | 2 +- 3 files changed, 23 insertions(+), 5 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 1078a9da1..43b176cb9 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -5,4 +5,22 @@ class Planet(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) name: Mapped[str] description: Mapped[str] - diameter: Mapped[int] \ No newline at end of file + diameter: Mapped[int] + +# class Planet: +# def __init__(self, id, name, description): +# self.id = id +# self.name = name +# self.description = description + +# planets = [ +# Planet(1, "Neptune", "Giant and icy planet", 49244), +# Planet(2, "Uranus", "Rotates on its side", 50724), +# Planet(3, "Saturn", "Has beautiful rings", 116460), +# Planet(4, "Jupiter", "Largest planet in the solar system", 139820), +# Planet(5, "Mars", "The red planet", 6779), +# Planet(6, "Earth", "Our home planet", 12742), +# Planet(7, "Venus", "Second planet from the sun", 12104), +# Planet(8, "Mercury", "Smallest and hottest planet", 4879), +# Planet(6, "Pluto", "The planet they declassified as a planet", 2377) +# ] \ No newline at end of file diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index e07cb005c..1778e140e 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -65,9 +65,9 @@ def update_planet(planet_id): planet = validate_planet(planet_id) request_body = request.get_json() - name = request_body["name"] - description = request_body["description"] - diameter = request_body["diameter"] + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.diameter = request_body["diameter"] db.session.commit() return Response(status=204, mimetype="application/json") diff --git a/migrations/versions/2716e01399aa_planet_model.py b/migrations/versions/2716e01399aa_planet_model.py index ad75babbb..5c6368d6c 100644 --- a/migrations/versions/2716e01399aa_planet_model.py +++ b/migrations/versions/2716e01399aa_planet_model.py @@ -31,4 +31,4 @@ def upgrade(): def downgrade(): # ### commands auto generated by Alembic - please adjust! ### op.drop_table('planet') - # ### end Alembic commands ### + # ### end Alembic commands ### \ No newline at end of file From ed9bbab513c95b82b58fa90889316af4e97c11bc Mon Sep 17 00:00:00 2001 From: DC Date: Fri, 25 Oct 2024 18:35:33 -0400 Subject: [PATCH 5/8] Adds query filters for name, description, and diameter. --- app/routes/planet_routes.py | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 1778e140e..8ca8b6cbf 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -8,12 +8,26 @@ @planets_bp.get("") def get_all_planets(): - query = db.select(Planet).order_by(Planet.id) + query = db.select(Planet) planets = db.session.scalars(query) - # We could also write the line above as: - # books = db.session.execute(query).scalars() + + name_query = request.args.get("name") + if name_query: + planets = Planet.query.filter_by(name=name_query) + + description_query = request.args.get("description") + if description_query: + planets = Planet.query.filter_by(description=description_query) + + diameter_query = request.args.get("diameter") + if diameter_query: + planets = Planet.query.filter_by(diameter=diameter_query) + + else: + planets = Planet.query.all() planet_response = [] + for planet in planets: planet_response.append( { From 76828e988406e7284047499935dbff1f7965c99b Mon Sep 17 00:00:00 2001 From: DC Date: Tue, 29 Oct 2024 14:19:39 -0400 Subject: [PATCH 6/8] Adds where and ilike methods to solar system. --- app/models/planet.py | 18 +++++++++--------- app/routes/planet_routes.py | 11 +++++------ 2 files changed, 14 insertions(+), 15 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 43b176cb9..4cb26d2f0 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -14,13 +14,13 @@ class Planet(db.Model): # self.description = description # planets = [ -# Planet(1, "Neptune", "Giant and icy planet", 49244), -# Planet(2, "Uranus", "Rotates on its side", 50724), -# Planet(3, "Saturn", "Has beautiful rings", 116460), -# Planet(4, "Jupiter", "Largest planet in the solar system", 139820), -# Planet(5, "Mars", "The red planet", 6779), -# Planet(6, "Earth", "Our home planet", 12742), -# Planet(7, "Venus", "Second planet from the sun", 12104), -# Planet(8, "Mercury", "Smallest and hottest planet", 4879), -# Planet(6, "Pluto", "The planet they declassified as a planet", 2377) +# Planet(1, "Mercury", "Hottest planet", 4879), +# Planet(2, "Venus", "Second planet from the sun", 12104), +# Planet(3, "Earth", "Our home planet", 12742), +# Planet(4, "Mars", "The red planet", 6779), +# Planet(5, "Jupiter", "Largest planet in the solar system", 139820), +# Planet(6, "Saturn", "Has beautiful rings", 116460), +# Planet(7, "Uranus", "Rotates on its side", 50724), +# Planet(8, "Neptune", "Giant and icy planet", 49244), +# Planet(9, "Pluto", "The planet they declassified as a planet", 2377) # ] \ No newline at end of file diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 8ca8b6cbf..84f8deaa5 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -9,22 +9,21 @@ @planets_bp.get("") def get_all_planets(): query = db.select(Planet) - planets = db.session.scalars(query) name_query = request.args.get("name") if name_query: - planets = Planet.query.filter_by(name=name_query) + query = query.where(Planet.name.ilike(f"%{name_query}%")) description_query = request.args.get("description") if description_query: - planets = Planet.query.filter_by(description=description_query) + query = query.where(Planet.description.ilike(f"%{description_query}%")) diameter_query = request.args.get("diameter") if diameter_query: - planets = Planet.query.filter_by(diameter=diameter_query) + query = query.where(Planet.diameter.ilike(f"%{diameter_query}%")) - else: - planets = Planet.query.all() + query = query.order_by(Planet.id) + planets = db.session.scalars(query) planet_response = [] From 4dbec01134f3194e9ed713faef511e3439bbbf58 Mon Sep 17 00:00:00 2001 From: lioliadoc Date: Thu, 31 Oct 2024 11:47:46 -0700 Subject: [PATCH 7/8] adds tests --- app/__init__.py | 9 ++++-- app/routes/planet_routes.py | 3 +- migrations/env.py | 2 ++ test_fixtures.py | 46 ++++++++++++++++++++++++++++ tests/__init__.py | 0 tests/conftest.py | 51 +++++++++++++++++++++++++++++++ tests/test_planet_routes.py | 61 +++++++++++++++++++++++++++++++++++++ 7 files changed, 169 insertions(+), 3 deletions(-) create mode 100644 test_fixtures.py create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_planet_routes.py diff --git a/app/__init__.py b/app/__init__.py index abd484307..207899127 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -2,12 +2,17 @@ from .db import db, migrate from .models import planet from .routes.planet_routes import planets_bp +import os -def create_app(): + +def create_app(config=None): app = Flask(__name__) app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + 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) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 84f8deaa5..7b528df06 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,5 +1,6 @@ from flask import Blueprint, abort, make_response, Response, request from app.models.planet import Planet +from sqlalchemy import desc from ..db import db @@ -22,7 +23,7 @@ def get_all_planets(): if diameter_query: query = query.where(Planet.diameter.ilike(f"%{diameter_query}%")) - query = query.order_by(Planet.id) + query = query.order_by(desc(Planet.diameter)) planets = db.session.scalars(query) planet_response = [] diff --git a/migrations/env.py b/migrations/env.py index 4c9709271..69de0dd3e 100644 --- a/migrations/env.py +++ b/migrations/env.py @@ -5,6 +5,8 @@ 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 diff --git a/test_fixtures.py b/test_fixtures.py new file mode 100644 index 000000000..1d904c716 --- /dev/null +++ b/test_fixtures.py @@ -0,0 +1,46 @@ +import pytest + + +@pytest.fixture +def empty_list(): + return [] + +def test_len_of_empty_list(empty_list): + assert isinstance(empty_list, list) + assert len(empty_list) == 0 + + +@pytest.fixture +def one_item(empty_list): + empty_list.append("item") + return empty_list + +def test_len_of_unary_list(one_item): + assert isinstance(one_item, list) + assert len(one_item) == 1 + assert one_item[0] == "item" + +class FancyObject: + def __init__(self): + self.fancy = True + print(f"\nFancyObject: {self.fancy}") + + def or_is_it(self): + self.fancy = not self.fancy + + def cleanup(self): + print(f"\ncleanup: {self.fancy}") + + +@pytest.fixture +def so_fancy(): + fancy_object = FancyObject() + + yield fancy_object + + fancy_object.cleanup() + +def test_so_fancy(so_fancy): + assert so_fancy.fancy + so_fancy.or_is_it() + assert not so_fancy.fancy \ No newline at end of file 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..bf1908fdb --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,51 @@ +import pytest +from app import create_app +from app.db import db +from flask.signals import request_finished +from dotenv import load_dotenv +from app.models.planet import Planet +import os + + +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_saved_planets(app): + with app.app_context(): + + mercury_planet = Planet(name="Mercury", + description="Hottest planet", + diameter=4879) + + neptune_planet = Planet(name="Neptune", + description="Giant and icy planet", + diameter=49244) + + db.session.add_all([mercury_planet, neptune_planet]) + db.session.commit() \ No newline at end of file diff --git a/tests/test_planet_routes.py b/tests/test_planet_routes.py new file mode 100644 index 000000000..ce95d76f5 --- /dev/null +++ b/tests/test_planet_routes.py @@ -0,0 +1,61 @@ +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_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Mercury", + "description": "Hottest planet", + "diameter": 4879 + } + + +def test_get_one_planet_succeeds(client, two_saved_planets): + # Act + response = client.get("/planets/2") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id":2, + "name": "Neptune", + "description": "Giant and icy planet", + "diameter": 49244 + } + + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "New Planet", + "description": "The Best Planet!", + "diameter": 98000 + + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "id": 1, + "name": "New Planet", + "description": "The Best Planet!", + "diameter": 98000 + + } + + From fbf10d79b92318314fd36530e769545ed5a01c26 Mon Sep 17 00:00:00 2001 From: lioliadoc Date: Mon, 4 Nov 2024 11:27:09 -0800 Subject: [PATCH 8/8] code refractoring --- app/models/planet.py | 18 ++++++++++++++++++ app/routes/planet_routes.py | 1 + app/routes/route_utilities.py | 18 ++++++++++++++++++ 3 files changed, 37 insertions(+) create mode 100644 app/routes/route_utilities.py diff --git a/app/models/planet.py b/app/models/planet.py index 4cb26d2f0..7f987f8ee 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -7,6 +7,24 @@ class Planet(db.Model): description: Mapped[str] diameter: Mapped[int] + + + def to_dict(self): + planet_as_dict = {} + planet_as_dict["id"] = self.id + planet_as_dict["name"] = self.name + planet_as_dict["description"] = self.description + planet_as_dict.diameter["diameter"] = self.diameter + + return planet_as_dict + + @classmethod + def from_dict(cls, planet_data): + new_planet = cls(title=planet_data["title"], + description=planet_data["description"]) + + return new_planet + # class Planet: # def __init__(self, id, name, description): # self.id = id diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 7b528df06..f7f15df12 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,6 +1,7 @@ from flask import Blueprint, abort, make_response, Response, request from app.models.planet import Planet from sqlalchemy import desc +from .route_utilities import validate_model from ..db import db diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py new file mode 100644 index 000000000..2dc8ede2d --- /dev/null +++ b/app/routes/route_utilities.py @@ -0,0 +1,18 @@ +from flask import abort, make_response +from ..db import db + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + response = {"message": f"{cls.__name__} {model_id} invalid"} + abort(make_response(response , 400)) + + query = db.select(cls).where(cls.id == model_id) + model = db.session.scalar(query) + + if not model: + response = {"message": f"{cls.__name__} {model_id} not found"} + abort(make_response(response, 404)) + + return model \ No newline at end of file