From 0c0b600681d70d665c362bfc9d0c925a1b67ab97 Mon Sep 17 00:00:00 2001 From: brew doctor <> Date: Tue, 19 Oct 2021 01:24:14 +0400 Subject: [PATCH 1/4] Completed assignment --- app/__init__.py | 6 +++++- app/routes.py | 48 +++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 52 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..b86c96c45 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,8 @@ def create_app(test_config=None): app = Flask(__name__) - return app + # Register Blueprints here + from .routes import planets_bp + app.register_blueprint(planets_bp) + + return app \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..1af6c11b2 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,48 @@ -from flask import Blueprint +from flask import Blueprint, jsonify +class Planets: + def __init__(self, id, name, description, attribute): + self.id = id + self.name = name + self.description = description + self.add_attribute = attribute + +planets_list = [ + +Planets(1,"Saturn","Ring System: Yes", "AVG Temp = -140C"), +Planets(2,"Venus","Ring System: No", "AVG Temp = 464C"), +Planets(3,"Uranus","Ring System: Yes", "AVG Temp = -195C"), +Planets(4,"Earth","Ring System: Yes", "AVG Temp = 15C"), +Planets(5,"Mars","Ring System: No", "AVG Temp = -65C"), +Planets(6,"Jupiter","Ring System: Yes", "AVG Temp = -110C"), +Planets(7,"Neptune","Ring System: Yes", "AVG Temp = -200C") + +] + +planets_bp = Blueprint('planets',__name__, url_prefix="/planets") + +@planets_bp.route("", methods=["GET"]) +def handle_planets(): + planets_response=[] + for planet in planets_list: + planets_response.append( + {"id": planet.id, + "name": planet.name, + "description":planet.description, + "additional_attribute":planet.add_attribute + } + ) + return jsonify(planets_response) + +@planets_bp.route("/", methods=["GET"]) +def handle_planet(planet_id): + planet_id=int(planet_id) + + for planet in planets_list: + if planet.id==planet_id: + return{ + "id": planet.id, + "name": planet.name, + "description":planet.description, + "additional_attribute":planet.add_attribute + } \ No newline at end of file From 71f97b0ac0247bf31d6a6b5144a0674ed004c2d9 Mon Sep 17 00:00:00 2001 From: brew doctor <> Date: Fri, 22 Oct 2021 22:14:21 +0400 Subject: [PATCH 2/4] completed until CREATE on learn but facing a programming error --- app/__init__.py | 14 ++++- app/models/__init__.py | 0 app/models/planet.py | 7 +++ app/routes.py | 104 +++++++++++++++++++++----------------- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++++++ migrations/env.py | 96 +++++++++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++++ 8 files changed, 245 insertions(+), 46 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.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 diff --git a/app/__init__.py b/app/__init__.py index b86c96c45..00b93e638 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,10 +1,22 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate + +db = SQLAlchemy() +migrate = Migrate() def create_app(test_config=None): app = Flask(__name__) - # Register Blueprints here + 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) + + from app.models.planet import Planet + 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/planet.py b/app/models/planet.py new file mode 100644 index 000000000..ac239b65f --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,7 @@ +from app import db + + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String) + description = db.Column(db.String) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 1af6c11b2..066517052 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,48 +1,62 @@ -from flask import Blueprint, jsonify - -class Planets: - def __init__(self, id, name, description, attribute): - self.id = id - self.name = name - self.description = description - self.add_attribute = attribute - -planets_list = [ - -Planets(1,"Saturn","Ring System: Yes", "AVG Temp = -140C"), -Planets(2,"Venus","Ring System: No", "AVG Temp = 464C"), -Planets(3,"Uranus","Ring System: Yes", "AVG Temp = -195C"), -Planets(4,"Earth","Ring System: Yes", "AVG Temp = 15C"), -Planets(5,"Mars","Ring System: No", "AVG Temp = -65C"), -Planets(6,"Jupiter","Ring System: Yes", "AVG Temp = -110C"), -Planets(7,"Neptune","Ring System: Yes", "AVG Temp = -200C") - -] +from app import db +from app.models.planet import Planet +from flask import request, Blueprint, make_response, jsonify planets_bp = Blueprint('planets',__name__, url_prefix="/planets") - -@planets_bp.route("", methods=["GET"]) +@planets_bp.route("", methods=["POST"]) def handle_planets(): - planets_response=[] - for planet in planets_list: - planets_response.append( - {"id": planet.id, - "name": planet.name, - "description":planet.description, - "additional_attribute":planet.add_attribute - } - ) - return jsonify(planets_response) - -@planets_bp.route("/", methods=["GET"]) -def handle_planet(planet_id): - planet_id=int(planet_id) - - for planet in planets_list: - if planet.id==planet_id: - return{ - "id": planet.id, - "name": planet.name, - "description":planet.description, - "additional_attribute":planet.add_attribute - } \ No newline at end of file + request_body = request.get_json() + new_planet = Planet(title=request_body["title"], + description=request_body["description"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.title} successfully created", 201) + +# class Planets: +# def __init__(self, id, name, description, attribute): +# self.id = id +# self.name = name +# self.description = description +# self.add_attribute = attribute + +# planets_list = [ + +# Planets(1,"Saturn","Ring System: Yes", "AVG Temp = -140C"), +# Planets(2,"Venus","Ring System: No", "AVG Temp = 464C"), +# Planets(3,"Uranus","Ring System: Yes", "AVG Temp = -195C"), +# Planets(4,"Earth","Ring System: Yes", "AVG Temp = 15C"), +# Planets(5,"Mars","Ring System: No", "AVG Temp = -65C"), +# Planets(6,"Jupiter","Ring System: Yes", "AVG Temp = -110C"), +# Planets(7,"Neptune","Ring System: Yes", "AVG Temp = -200C") + +# ] + + + +# @planets_bp.route("", methods=["GET"]) +# def handle_planets(): +# planets_response=[] +# for planet in planets_list: +# planets_response.append( +# {"id": planet.id, +# "name": planet.name, +# "description":planet.description, +# "additional_attribute":planet.add_attribute +# } +# ) +# return jsonify(planets_response) + +# @planets_bp.route("/", methods=["GET"]) +# def handle_planet(planet_id): +# planet_id=int(planet_id) + +# for planet in planets_list: +# if planet.id==planet_id: +# return{ +# "id": planet.id, +# "name": planet.name, +# "description":planet.description, +# "additional_attribute":planet.add_attribute +# } \ 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"} From 61d4e96263484277c51c1472cca0159f7a8db48c Mon Sep 17 00:00:00 2001 From: brew doctor <> Date: Tue, 26 Oct 2021 22:40:21 +0400 Subject: [PATCH 3/4] this is the completed project --- app/models/planet.py | 2 +- app/routes.py | 105 +++++++++--------- .../3473a8fd07e3_adds_planet_model.py | 33 ++++++ 3 files changed, 84 insertions(+), 56 deletions(-) create mode 100644 migrations/versions/3473a8fd07e3_adds_planet_model.py diff --git a/app/models/planet.py b/app/models/planet.py index ac239b65f..eb74308a6 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -3,5 +3,5 @@ class Planet(db.Model): id = db.Column(db.Integer, primary_key=True, autoincrement=True) - title = db.Column(db.String) + name = db.Column(db.String) description = db.Column(db.String) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 066517052..1f66fa470 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,61 +2,56 @@ from app.models.planet import Planet from flask import request, Blueprint, make_response, jsonify -planets_bp = Blueprint('planets',__name__, url_prefix="/planets") -@planets_bp.route("", methods=["POST"]) + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + + +@planets_bp.route("", methods=["GET","POST"]) def handle_planets(): - request_body = request.get_json() - new_planet = Planet(title=request_body["title"], + 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 jsonify(planets_response) + 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.title} successfully created", 201) - -# class Planets: -# def __init__(self, id, name, description, attribute): -# self.id = id -# self.name = name -# self.description = description -# self.add_attribute = attribute - -# planets_list = [ - -# Planets(1,"Saturn","Ring System: Yes", "AVG Temp = -140C"), -# Planets(2,"Venus","Ring System: No", "AVG Temp = 464C"), -# Planets(3,"Uranus","Ring System: Yes", "AVG Temp = -195C"), -# Planets(4,"Earth","Ring System: Yes", "AVG Temp = 15C"), -# Planets(5,"Mars","Ring System: No", "AVG Temp = -65C"), -# Planets(6,"Jupiter","Ring System: Yes", "AVG Temp = -110C"), -# Planets(7,"Neptune","Ring System: Yes", "AVG Temp = -200C") - -# ] - - - -# @planets_bp.route("", methods=["GET"]) -# def handle_planets(): -# planets_response=[] -# for planet in planets_list: -# planets_response.append( -# {"id": planet.id, -# "name": planet.name, -# "description":planet.description, -# "additional_attribute":planet.add_attribute -# } -# ) -# return jsonify(planets_response) - -# @planets_bp.route("/", methods=["GET"]) -# def handle_planet(planet_id): -# planet_id=int(planet_id) - -# for planet in planets_list: -# if planet.id==planet_id: -# return{ -# "id": planet.id, -# "name": planet.name, -# "description":planet.description, -# "additional_attribute":planet.add_attribute -# } \ No newline at end of file + 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= Planet.query.get(planet_id) + if planet is None: + return make_response("", 404) + + if request.method == "GET": + return { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + elif request.method == "PUT": + form_data = request.get_json() + + planet.name = form_data["name"] + planet.description = form_data["description"] + + db.session.commit() + + return make_response(f"Planet #{planet.id} changed successfully!") + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + return make_response(f"Planet #{planet.id} deleted successfully!") + \ No newline at end of file diff --git a/migrations/versions/3473a8fd07e3_adds_planet_model.py b/migrations/versions/3473a8fd07e3_adds_planet_model.py new file mode 100644 index 000000000..da762b40a --- /dev/null +++ b/migrations/versions/3473a8fd07e3_adds_planet_model.py @@ -0,0 +1,33 @@ +"""adds Planet model + +Revision ID: 3473a8fd07e3 +Revises: +Create Date: 2021-10-26 22:31:05.559637 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '3473a8fd07e3' +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 e06f1db1ae80920cdd6166d79f51da4a468accec Mon Sep 17 00:00:00 2001 From: Edmine Date: Wed, 27 Oct 2021 15:00:47 -0400 Subject: [PATCH 4/4] created test cases --- app/__init__.py | 16 +++++++++++++--- tests/__init__.py | 0 tests/conftest.py | 33 +++++++++++++++++++++++++++++++++ tests/test_routes.py | 22 ++++++++++++++++++++++ 4 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index 00b93e638..8324b00c5 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,16 +1,26 @@ 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 - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + 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) 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..3025c435c --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,33 @@ +import pytest +from app import create_app +from app import db +from app.models.planet 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() + + +@pytest.fixture +def two_saved_planets(app): + # Arrange + Jupiter = Planet(name="Jupiter", + description="whatever") + Saturn = Planet(name="Saturn", + description="another planet") + + db.session.add_all([Jupiter, Saturn]) + db.session.commit() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..7e0c96bd0 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,22 @@ +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": "Jupiter", + "description": "whatever" + } \ No newline at end of file