From 4c8696892d7e53c7a7a522b85d9408d45fa6c91c Mon Sep 17 00:00:00 2001 From: Veronica Osei Date: Mon, 18 Oct 2021 15:23:40 -0500 Subject: [PATCH 1/4] complete solar-system --- app/__init__.py | 8 +++++++- app/routes.py | 40 +++++++++++++++++++++++++++++++++++++++- 2 files changed, 46 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..cc26c73a0 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,13 @@ -from flask import Flask +from flask import Flask, jsonify def create_app(test_config=None): app = Flask(__name__) + from .routes import planet_system_bp + app.register_blueprint(planet_system_bp) + + from .routes import planets_bp + app.register_blueprint(planets_bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..f472c9301 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,40 @@ -from flask import Blueprint +from flask import Blueprint,jsonify + +class Planet: + def __init__(self,id,name,description): + self.id = id + self.name = name + self.description = description + +planets = [ + Planet(1, "Mercury", "Very windy."), + Planet(2, "Venus", "Brightest planet."), + Planet(3, "Saturn", "Icy rings.") +] + +planet_system_bp = Blueprint("planet_system", __name__) +planets_bp = Blueprint("planets_py", __name__, url_prefix= "/planets") + +@planets_bp.route("/", methods=["GET"]) +def handle_planets(planet_id): + + for planet in planets: + if planet.id == int(planet_id): + return { + "id" : planet.id, + "name" : planet.name, + "description" : planet.description + } + + +@planet_system_bp.route("/planets", methods= ['GET']) +def get_planet_system_json(): + return { + "planet_1" : "Mercury", + "planet_2" : "Venus", + "planet_3" : "Saturn" + } + + + From 727eabff713db308a84eb3011adc0a14f883dcd9 Mon Sep 17 00:00:00 2001 From: Veronica Osei Date: Wed, 27 Oct 2021 13:05:24 -0500 Subject: [PATCH 2/4] create .env file --- app/__init__.py | 16 +++- app/models/__init__.py | 0 app/models/solar.py | 12 +++ app/models/workspace.code-workspace | 8 ++ app/routes.py | 92 ++++++++++++------ app/workspace.code-workspace | 8 ++ migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../a59abbfa2378_adds_a_planet_model.py | 33 +++++++ 11 files changed, 304 insertions(+), 31 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/solar.py create mode 100644 app/models/workspace.code-workspace create mode 100644 app/workspace.code-workspace 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/a59abbfa2378_adds_a_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index cc26c73a0..b7a4b8eb4 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,11 +1,23 @@ from flask import Flask, jsonify +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +db = SQLAlchemy() +migrate = Migrate() def create_app(test_config=None): app = Flask(__name__) - from .routes import planet_system_bp - app.register_blueprint(planet_system_bp) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + from app.models.solar import Planet + db.init_app(app) + migrate.init_app(app,db) + + + # from .routes import planet_system_bp + # app.register_blueprint(planet_system_bp) from .routes import planets_bp app.register_blueprint(planets_bp) diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/solar.py b/app/models/solar.py new file mode 100644 index 000000000..009b2c43c --- /dev/null +++ b/app/models/solar.py @@ -0,0 +1,12 @@ +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) + + def to_string(self): + return f'{self.id}: {self.name} Description: {self.description}' + + diff --git a/app/models/workspace.code-workspace b/app/models/workspace.code-workspace new file mode 100644 index 000000000..407c76059 --- /dev/null +++ b/app/models/workspace.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "../.." + } + ], + "settings": {} +} \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index f472c9301..e6e2d3613 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,40 +1,74 @@ -from flask import Blueprint,jsonify +from app import db +from app.models.solar import Planet +from flask import Blueprint,jsonify, make_response, request -class Planet: - def __init__(self,id,name,description): - self.id = id - self.name = name - self.description = description -planets = [ - Planet(1, "Mercury", "Very windy."), - Planet(2, "Venus", "Brightest planet."), - Planet(3, "Saturn", "Icy rings.") -] - -planet_system_bp = Blueprint("planet_system", __name__) planets_bp = Blueprint("planets_py", __name__, url_prefix= "/planets") -@planets_bp.route("/", methods=["GET"]) -def handle_planets(planet_id): +@planets_bp.route("", methods=["GET","POST"]) +def handle_planets(): + if request.method == "GET": + planets = Planet.query.all() + planets_response = [] + for planet in planets: + planets_response.append( + { + "id": planet.id, + "name": planet.name, + "description": planet.description + }) + return make_response(f"All the planet {planets_response}" , 201) + elif request.method == "POST": + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], + description=request_body["description"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + +@planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_planet(planet_id): + # planet_id = int(planet_id) + planet = Planet.query.get(planet_id) + + if planet == None: + return make_response("", 404) + + if request.method == "GET": + return { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + + elif request.method == "PUT": + request_body = request.get_json() - for planet in planets: - if planet.id == int(planet_id): - return { - "id" : planet.id, - "name" : planet.name, - "description" : planet.description - } + planet.name = request_body["name"] + planet.description = request_body["description"] + db.session.commit() -@planet_system_bp.route("/planets", methods= ['GET']) -def get_planet_system_json(): - return { - "planet_1" : "Mercury", - "planet_2" : "Venus", - "planet_3" : "Saturn" - } + return make_response(f"Planet #{planet.id} successfully updated") + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + return make_response(f"Planet #{planet.id} successfully deleted") + # elif request.method == "GET": + # 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) \ No newline at end of file diff --git a/app/workspace.code-workspace b/app/workspace.code-workspace new file mode 100644 index 000000000..bab1b7f61 --- /dev/null +++ b/app/workspace.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": ".." + } + ], + "settings": {} +} \ No newline at end of file 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/a59abbfa2378_adds_a_planet_model.py b/migrations/versions/a59abbfa2378_adds_a_planet_model.py new file mode 100644 index 000000000..ade307d3a --- /dev/null +++ b/migrations/versions/a59abbfa2378_adds_a_planet_model.py @@ -0,0 +1,33 @@ +"""adds a Planet model + +Revision ID: a59abbfa2378 +Revises: +Create Date: 2021-10-25 01:06:40.555308 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a59abbfa2378' +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 ### From 005e0e63b62454795ce67ef061030f6cf74f580d Mon Sep 17 00:00:00 2001 From: Veronica Osei Date: Thu, 28 Oct 2021 09:41:40 -0500 Subject: [PATCH 3/4] Almost complete Solar System project --- tests/test_routes.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 tests/test_routes.py diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..9d06b3179 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,26 @@ +def test_get_all_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == [] + +def test_get_one_planet(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": "", + "title": "", + "description": "" + } +def test_get_one_planet(client, two_saved_planets): + # Act + response = client.get("/planets/1") + # ... + From 70388f0847eb0c62f4aedc687ca09df586a830bd Mon Sep 17 00:00:00 2001 From: Veronica Osei Date: Thu, 28 Oct 2021 09:42:31 -0500 Subject: [PATCH 4/4] Semi-complete solar-system --- app/__init__.py | 14 ++++++++++++-- app/routes.py | 16 ++-------------- test_fixtures.py | 43 +++++++++++++++++++++++++++++++++++++++++++ tests/__init__.py | 0 tests/conftest.py | 37 +++++++++++++++++++++++++++++++++++++ 5 files changed, 94 insertions(+), 16 deletions(-) create mode 100644 test_fixtures.py create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py diff --git a/app/__init__.py b/app/__init__.py index b7a4b8eb4..25957eb55 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,15 +1,25 @@ from flask import Flask, jsonify 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") - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' from app.models.solar import Planet db.init_app(app) diff --git a/app/routes.py b/app/routes.py index e6e2d3613..49991d938 100644 --- a/app/routes.py +++ b/app/routes.py @@ -17,7 +17,7 @@ def handle_planets(): "name": planet.name, "description": planet.description }) - return make_response(f"All the planet {planets_response}" , 201) + return jsonify(planets_response) elif request.method == "POST": request_body = request.get_json() new_planet = Planet(name=request_body["name"], @@ -30,7 +30,6 @@ def handle_planets(): @planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_planet(planet_id): - # planet_id = int(planet_id) planet = Planet.query.get(planet_id) if planet == None: @@ -60,15 +59,4 @@ def handle_planet(planet_id): - # elif request.method == "GET": - # 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) \ No newline at end of file + \ No newline at end of file diff --git a/test_fixtures.py b/test_fixtures.py new file mode 100644 index 000000000..3c8968ff8 --- /dev/null +++ b/test_fixtures.py @@ -0,0 +1,43 @@ +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..cde425d18 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,37 @@ +from os import name +import pytest +from app import create_app +from app import db +from app.models.solar 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() + +# from app.models.solar import Planet + +@pytest.fixture +def two_saved_planets(app): + # Arrange + saturn_planet = Planet(name="Saturn",description="Icy rings") + pluto_planet = Planet(name="Pluto",description="reallly small") + + db.session.add_all([saturn_planet, pluto_planet]) + # Alternatively, we could do + # db.session.add(ocean_book) + # db.session.add(mountain_book) + db.session.commit() + + \ No newline at end of file