From a1b788037812fdb51f168b640f3e236e0e974947 Mon Sep 17 00:00:00 2001 From: Aisha Date: Thu, 28 Oct 2021 11:04:35 -0500 Subject: [PATCH 01/11] get all endpoint complete, import class not working --- README.md | 16 +++++++++++++++- app/__init__.py | 2 ++ app/planets.py | 8 ++++++++ app/routes.py | 40 +++++++++++++++++++++++++++++++++++++++- 4 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 app/planets.py diff --git a/README.md b/README.md index 5b9896a79..f6d660a8b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # Solar System API -Here is a minimal setup for a Flask API. +# Build +Clone the forked repo and cd into it + +Recreate the following setup steps of the Solar System API repo: + + Create a virtual environment and activate it + Install the dependencies + Define a Planet class with the attributes id, name, and description, and one additional attribute + Create a list of Planet instances + +Create the following endpoints, with similar functionality presented in the Hello Books API: + + As a client, I want to send a request to get all existing planets, so that I can see a list of planets, with their id, name, description, and other data of the planet. + As a client, I want to send a request to get one existing planet, so that I can see the id, name, description, and other data of the planet. + Here is a minimal setup for a Flask API. ## Github Setup diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..3675c9309 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,6 @@ def create_app(test_config=None): app = Flask(__name__) + from .routes import planets_bp + app.register_blueprint(planets_bp) return app diff --git a/app/planets.py b/app/planets.py new file mode 100644 index 000000000..45d2b879c --- /dev/null +++ b/app/planets.py @@ -0,0 +1,8 @@ +class Planet: + def __init__(self, id, name, description, oxygen): + self.id = id + self.name = name + self.description = description + self.oxygen = oxygen + + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..fdb190fb0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,40 @@ -from flask import Blueprint +from flask import Blueprint, jsonify +#from planets import Planet + + +class Planet: + def __init__(self, id, name, description, oxygen): + self.id = id + self.name = name + self.description = description + self.oxygen = oxygen + + +planet1 = Planet(1, "mecury", "its a pretty planet", 0.2) +planet2 = Planet(2, "sun", "its friggin hot", 0) +planet3 = Planet(3, "moon", "its pretty at night", 2) + + +list_of_planets = [planet1, planet2, planet3] + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planets_bp.route("", methods = ["GET"]) +def get_all_planets(): + books_response = [] + + for planet in list_of_planets: + books_response.append( + { + "id" : planet.id, + "name": planet.name, + "description": planet.description, + "oxygen": planet.oxygen + } + ) + + return jsonify(books_response) + + + From 91b644d3dfeffefe9e5597f0334d64a540833b63 Mon Sep 17 00:00:00 2001 From: Aisha Date: Thu, 28 Oct 2021 19:26:31 -0500 Subject: [PATCH 02/11] second end point created, able to import from planets.py --- app/routes.py | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/app/routes.py b/app/routes.py index fdb190fb0..61670da61 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,13 +1,13 @@ from flask import Blueprint, jsonify -#from planets import Planet +from planets import Planet -class Planet: - def __init__(self, id, name, description, oxygen): - self.id = id - self.name = name - self.description = description - self.oxygen = oxygen +# class Planet: +# def __init__(self, id, name, description, oxygen): +# self.id = id +# self.name = name +# self.description = description +# self.oxygen = oxygen planet1 = Planet(1, "mecury", "its a pretty planet", 0.2) @@ -35,6 +35,15 @@ def get_all_planets(): return jsonify(books_response) - +@planets_bp.route("/", methods = ["GET"]) +def get_planet_by_name(planet_name): + for planet in list_of_planets: + if planet.name == planet_name: + return { + "id" : planet.id, + "name": planet.name, + "description" : planet.description, + "oxygen_level" : planet.oxygen + } From 84f62cc80568df49667c7556524d1bef65604ef7 Mon Sep 17 00:00:00 2001 From: Aisha Date: Wed, 17 Nov 2021 12:00:43 -0600 Subject: [PATCH 03/11] end point to retrieve info of one planet created --- app/routes.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/app/routes.py b/app/routes.py index 61670da61..09decd90b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,13 +1,13 @@ from flask import Blueprint, jsonify -from planets import Planet +#from planets import Planet -# class Planet: -# def __init__(self, id, name, description, oxygen): -# self.id = id -# self.name = name -# self.description = description -# self.oxygen = oxygen +class Planet: + def __init__(self, id, name, description, oxygen): + self.id = id + self.name = name + self.description = description + self.oxygen = oxygen planet1 = Planet(1, "mecury", "its a pretty planet", 0.2) From 01aa4400e194f44cc95b9117f5561a61b6f0c681 Mon Sep 17 00:00:00 2001 From: Aisha Date: Fri, 19 Nov 2021 15:07:24 -0600 Subject: [PATCH 04/11] models created and migrated no tests written --- app/__init__.py | 15 +++ app/models/__init__.py | 0 app/models/planets.py | 14 +++ app/planets.py | 8 -- app/routes.py | 97 ++++++++++++------- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 ++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../66bb5f0b92c3_adds_planets_model.py | 34 +++++++ 10 files changed, 290 insertions(+), 44 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planets.py delete mode 100644 app/planets.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/66bb5f0b92c3_adds_planets_model.py diff --git a/app/__init__.py b/app/__init__.py index 3675c9309..acfd1a3ea 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +1,24 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +db = SQLAlchemy() # why is this outside the create app funtion +migrate = Migrate() 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" + + db.init_app(app) + migrate.init_app(app, db) + + #from .routes import planets_bp + # import model + from app.models.planets import Planet + from .routes import planets_bp app.register_blueprint(planets_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/planets.py b/app/models/planets.py new file mode 100644 index 000000000..87d2cd102 --- /dev/null +++ b/app/models/planets.py @@ -0,0 +1,14 @@ +from app import db +# class Planet: +# def __init__(self, id, name, description, oxygen): +# self.id = id +# self.name = name +# self.description = description +# self.oxygen = oxygen + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True ) + name = db.Column(db.String) + description = db.Column(db.String) + oxygen_level = db.Column(db.String) + #__tablename__ = "planets" we can reset the default table name SQLA sets using this line diff --git a/app/planets.py b/app/planets.py deleted file mode 100644 index 45d2b879c..000000000 --- a/app/planets.py +++ /dev/null @@ -1,8 +0,0 @@ -class Planet: - def __init__(self, id, name, description, oxygen): - self.id = id - self.name = name - self.description = description - self.oxygen = oxygen - - diff --git a/app/routes.py b/app/routes.py index 09decd90b..bdb09abad 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,49 +1,74 @@ -from flask import Blueprint, jsonify -#from planets import Planet +from flask import Blueprint, jsonify, make_response, request +from app import db +from app.models.planets import Planet -class Planet: - def __init__(self, id, name, description, oxygen): - self.id = id - self.name = name - self.description = description - self.oxygen = oxygen +# class Planet: +# def __init__(self, id, name, description, oxygen): +# self.id = id +# self.name = name +# self.description = description +# self.oxygen = oxygen -planet1 = Planet(1, "mecury", "its a pretty planet", 0.2) -planet2 = Planet(2, "sun", "its friggin hot", 0) -planet3 = Planet(3, "moon", "its pretty at night", 2) +# planet1 = Planet(1, "mecury", "its a pretty planet", 0.2) +# planet2 = Planet(2, "sun", "its friggin hot", 0) +# planet3 = Planet(3, "moon", "its pretty at night", 2) -list_of_planets = [planet1, planet2, planet3] +# list_of_planets = [planet1, planet2, planet3] planets_bp = Blueprint("planets", __name__, url_prefix="/planets") -@planets_bp.route("", methods = ["GET"]) -def get_all_planets(): - books_response = [] - - for planet in list_of_planets: - books_response.append( - { - "id" : planet.id, - "name": planet.name, - "description": planet.description, - "oxygen": planet.oxygen - } +@planets_bp.route("", methods = ["GET", "POST"]) +def handle_planets(): + request_body = request.get_json() + + if request.method == "GET": + planet_response = [] + list_of_planets = Planet.query.all() + for planet in list_of_planets: + planet_response.append( + { + "id" : planet.id, + "name": planet.name, + "description": planet.description, + "oxygen_level": planet.oxygen_level + } + ) + + return jsonify(planet_response) + elif request.method == "POST": + if "name" not in request_body or "description" not in request_body or "oxygen_level" not in request_body: + return make_response("Invalid request", 400) + + new_planet = Planet( + name = request_body["name"], + description = request_body["description"], + oxygen_level = request_body["oxygen_level"] ) - return jsonify(books_response) - -@planets_bp.route("/", methods = ["GET"]) -def get_planet_by_name(planet_name): - for planet in list_of_planets: - if planet.name == planet_name: - return { - "id" : planet.id, - "name": planet.name, - "description" : planet.description, - "oxygen_level" : planet.oxygen - } + db.session.add(new_planet) + db.session.commit() + + return make_response( + f"Planet {new_planet.name} created", 200 + ) +#@planets_bp.route("/", methods = ["GET"]) +@planets_bp.route("/", methods = ["GET"]) +def get_planet_by_name(planet_id): + planet = Planet.query.get(planet_id) + #for planet in list_of_planets: + #if planet.title == planet_name: + try: + return { + "id" : planet.id, + "name": planet.name, + "description" : planet.description, + "oxygen_level" : planet.oxygen_level + } + except: + planet is None + return make_response(f"planet {planet_id} is not found", 404) 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/66bb5f0b92c3_adds_planets_model.py b/migrations/versions/66bb5f0b92c3_adds_planets_model.py new file mode 100644 index 000000000..bdcece8ea --- /dev/null +++ b/migrations/versions/66bb5f0b92c3_adds_planets_model.py @@ -0,0 +1,34 @@ +"""adds planets model + +Revision ID: 66bb5f0b92c3 +Revises: +Create Date: 2021-11-19 11:38:37.835475 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '66bb5f0b92c3' +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('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('oxygen_level', 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 1cb13c0b5d794bf8187a41bd0ef4aff219740c46 Mon Sep 17 00:00:00 2001 From: Aisha Date: Sat, 20 Nov 2021 16:53:01 -0600 Subject: [PATCH 05/11] adds search with planet name --- app/routes.py | 80 +++++++++++++++++++++++++++++++++------------------ 1 file changed, 52 insertions(+), 28 deletions(-) diff --git a/app/routes.py b/app/routes.py index bdb09abad..88913c1e0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -3,21 +3,6 @@ from app.models.planets import Planet -# class Planet: -# def __init__(self, id, name, description, oxygen): -# self.id = id -# self.name = name -# self.description = description -# self.oxygen = oxygen - - -# planet1 = Planet(1, "mecury", "its a pretty planet", 0.2) -# planet2 = Planet(2, "sun", "its friggin hot", 0) -# planet3 = Planet(3, "moon", "its pretty at night", 2) - - -# list_of_planets = [planet1, planet2, planet3] - planets_bp = Blueprint("planets", __name__, url_prefix="/planets") @planets_bp.route("", methods = ["GET", "POST"]) @@ -26,7 +11,15 @@ def handle_planets(): if request.method == "GET": planet_response = [] - list_of_planets = Planet.query.all() + + #name_query_param = request.args.get("name") + name_query_param = request.args.get("name") + + if name_query_param is not None: + list_of_planets = Planet.query.filter_by(name = name_query_param) + + else: + list_of_planets = Planet.query.all() for planet in list_of_planets: planet_response.append( { @@ -54,21 +47,52 @@ def handle_planets(): return make_response( f"Planet {new_planet.name} created", 200 ) + # planet.query.filter_by(param) # use to filter query results + # planet.query.limit(100).all() limit number of results #@planets_bp.route("/", methods = ["GET"]) -@planets_bp.route("/", methods = ["GET"]) -def get_planet_by_name(planet_id): +@planets_bp.route("/", methods = ["GET", "PUT", "DELETE"]) +def get_planet_by_id(planet_id): planet = Planet.query.get(planet_id) #for planet in list_of_planets: #if planet.title == planet_name: - try: - return { - "id" : planet.id, - "name": planet.name, - "description" : planet.description, - "oxygen_level" : planet.oxygen_level - } - except: - planet is None - return make_response(f"planet {planet_id} is not found", 404) + if request.method == "GET": + try: + return { + "id" : planet.id, + "name": planet.name, + "description" : planet.description, + "oxygen_level" : planet.oxygen_level + } + except: + planet is None + return make_response(f"planet {planet_id} is not found", 404) + + elif request.method == "PUT": + form_data = request.get_json() + + if "name" not in form_data or "description" not in form_data or "oxygen_level" not in form_data: + return make_response(f"you must include a name, description and oxygen_level for your planet", 400) + + try: + planet.name = form_data["name"] + planet.description = form_data["description"] + planet.oxygen_level = form_data["oxygen_level"] + + return make_response(f"{planet.name} successfully updated", 200) + except: + planet is None + return make_response(f"planet {planet.id} does not exist") + + elif request.method == "DELETE": + planet_to_delete = planet + try: + db.session.delete(planet_to_delete) + db.session.commit() + + return make_response(f"planet {planet.name} successfully deleted", 200) + except: + planet_to_delete is None + return make_response(f"planet {planet_id} does not exsist", 404) + From ac82447c3d77bfedb4c999962418e3dcc04cb389 Mon Sep 17 00:00:00 2001 From: Aisha Date: Tue, 23 Nov 2021 10:48:54 -0600 Subject: [PATCH 06/11] adds tests files, config, test for routes, test get all books EP --- app/__init__.py | 12 +++++++++--- app/models/planets.py | 6 ------ requirements.txt | 7 +++++++ tests/__init__.py | 0 tests/conftest.py | 23 +++++++++++++++++++++++ tests/test_routes.py | 12 ++++++++++++ 6 files changed, 51 insertions(+), 9 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 acfd1a3ea..3726919ed 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,6 +1,9 @@ -from flask import Flask +from flask import Flask, config from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate +from dotenv import load_dotenv +import os +load_dotenv() db = SQLAlchemy() # why is this outside the create app funtion migrate = Migrate() @@ -9,12 +12,15 @@ 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_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') db.init_app(app) migrate.init_app(app, db) - #from .routes import planets_bp # import model from app.models.planets import Planet diff --git a/app/models/planets.py b/app/models/planets.py index 87d2cd102..ec7057017 100644 --- a/app/models/planets.py +++ b/app/models/planets.py @@ -1,10 +1,4 @@ from app import db -# class Planet: -# def __init__(self, id, name, description, oxygen): -# self.id = id -# self.name = name -# self.description = description -# self.oxygen = oxygen class Planet(db.Model): id = db.Column(db.Integer, primary_key=True, autoincrement=True ) diff --git a/requirements.txt b/requirements.txt index fd90fffa8..d66c610f0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ alembic==1.5.4 +attrs==21.2.0 autopep8==1.5.5 certifi==2020.12.5 chardet==4.0.0 @@ -7,12 +8,18 @@ Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 idna==2.10 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.3 +pluggy==1.0.0 psycopg2-binary==2.8.6 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.6 +pytest==6.2.5 python-dateutil==2.8.1 python-dotenv==0.15.0 python-editor==1.0.4 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..d1cf523ca --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,23 @@ +import pytest +from app import db +from app import create_app + +# Arrange + +@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() + + diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..066cef7f7 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,12 @@ +# Act Arrage + +import json + +from flask.globals import request + +def test_route_gets_planets_in_database_returns_empty_list(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] \ No newline at end of file From 3c60dd2f4f4992b849d69c6d7a669cd39baeda8d Mon Sep 17 00:00:00 2001 From: Aisha Date: Tue, 23 Nov 2021 13:02:31 -0600 Subject: [PATCH 07/11] get by name not fixed yet --- app/__init__.py | 2 ++ tests/conftest.py | 17 +++++++++++++++ tests/test_routes.py | 50 +++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 68 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 3726919ed..88a305ae1 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -15,9 +15,11 @@ def create_app(test_config=None): if not test_config: app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + app.config['SQLALCHEMY_ECHO'] = True else: app.config['TESTING'] = True app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') + app.config['SQLALCHEMY_ECHO'] = True db.init_app(app) migrate.init_app(app, db) diff --git a/tests/conftest.py b/tests/conftest.py index d1cf523ca..262df2143 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,6 +1,7 @@ import pytest from app import db from app import create_app +from app.models.planets import Planet # Arrange @@ -21,3 +22,19 @@ def client(app): return app.test_client() +@pytest.fixture +def two_saved_planets(app): + planet1 = Planet( + name = "Earth", + description = "blue and green", + oxygen_level = "21%" + ) + planet2 = Planet( + name = "Saturn", + description = "a ball of gas", + oxygen_level = "little to none" + ) + + db.session.add_all([planet1, planet2]) + db.session.commit() + diff --git a/tests/test_routes.py b/tests/test_routes.py index 066cef7f7..ab25d175f 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -9,4 +9,52 @@ def test_route_gets_planets_in_database_returns_empty_list(client): response_body = response.get_json() assert response.status_code == 200 - assert response_body == [] \ No newline at end of file + assert response_body == [] + +def test_route_returns_all_available_planets_returns_all_planets(client, two_saved_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id" : 1, + "name" :"Earth", + "description" : "blue and green", + "oxygen_level" : "21%" + }, { + "id" : 2, + "name" : "Saturn", + "description" : "a ball of gas", + "oxygen_level" : "little to none"} + ] + +def test_route_gets_planet_by_id_returns_planet_with_matching_id(client, two_saved_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id" : 1, + "name" :"Earth", + "description" : "blue and green", + "oxygen_level" : "21%" + } + +def test_route_returns_404_for_unavailable_planet_id(client, two_saved_planets): + response = client.get("/planets/3") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == None + +def test_route_gets_planet_by_name_returns_planet_with_matching_name(client, two_saved_planets): + response = client.get("/planets", json = {"name":"Earth"}) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id" : 1, + "name" :"Earth", + "description" : "blue and green", + "oxygen_level" : "21%" + }] \ No newline at end of file From b817230ecba0dc5299797caea8fb4d1ab38816dc Mon Sep 17 00:00:00 2001 From: Aisha Date: Tue, 23 Nov 2021 15:51:33 -0600 Subject: [PATCH 08/11] test for search with name not written --- tests/test_routes.py | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/tests/test_routes.py b/tests/test_routes.py index ab25d175f..c7029376a 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -47,14 +47,35 @@ def test_route_returns_404_for_unavailable_planet_id(client, two_saved_planets): assert response.status_code == 404 assert response_body == None -def test_route_gets_planet_by_name_returns_planet_with_matching_name(client, two_saved_planets): - response = client.get("/planets", json = {"name":"Earth"}) +def test_route_returns_404_for_no_book_in_dabatase(client): + response = client.get("/planets/1") response_body = response.get_json() - assert response.status_code == 200 - assert response_body == [{ + assert response.status_code == 404 + assert response_body == None + +# def test_route_gets_planet_by_name_returns_planet_with_matching_name(client, two_saved_planets): +# response = client.get("/planets", json = {"name":"Earth"}) +# response_body = response.get_json() + +# assert response.status_code == 200 +# assert response_body == [{ +# "id" : 1, +# "name" :"Earth", +# "description" : "blue and green", +# "oxygen_level" : "21%" +# }] + +def test_route_posts_data_to_database(client): + data = { "id" : 1, "name" :"Earth", "description" : "blue and green", "oxygen_level" : "21%" - }] \ No newline at end of file + } + + response = client.post("/planets", json = data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == None \ No newline at end of file From 43935d00f74bee4d1bf689a7869c0c058239fafa Mon Sep 17 00:00:00 2001 From: Aisha Date: Wed, 24 Nov 2021 14:16:45 -0600 Subject: [PATCH 09/11] fixes test for get planet by name endpoint --- tests/test_routes.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/tests/test_routes.py b/tests/test_routes.py index c7029376a..565590773 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -54,17 +54,17 @@ def test_route_returns_404_for_no_book_in_dabatase(client): assert response.status_code == 404 assert response_body == None -# def test_route_gets_planet_by_name_returns_planet_with_matching_name(client, two_saved_planets): -# response = client.get("/planets", json = {"name":"Earth"}) -# response_body = response.get_json() - -# assert response.status_code == 200 -# assert response_body == [{ -# "id" : 1, -# "name" :"Earth", -# "description" : "blue and green", -# "oxygen_level" : "21%" -# }] +def test_route_gets_planet_by_name_returns_planet_with_matching_name(client, two_saved_planets): #figure out testing with search for name + response = client.get("/planets?name=Earth") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id" : 1, + "name" :"Earth", + "description" : "blue and green", + "oxygen_level" : "21%" + }] def test_route_posts_data_to_database(client): data = { From a25dd2a6abe4f0566b0872332f77c378e8c6d27d Mon Sep 17 00:00:00 2001 From: Aisha Date: Wed, 24 Nov 2021 18:40:38 -0600 Subject: [PATCH 10/11] adds gunicorn to requirements modifies comment on test_route --- requirements.txt | 1 + tests/test_routes.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d66c610f0..899afa4ac 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ click==7.1.2 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 iniconfig==1.1.1 itsdangerous==1.1.0 diff --git a/tests/test_routes.py b/tests/test_routes.py index 565590773..f8e92aa65 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -54,7 +54,7 @@ def test_route_returns_404_for_no_book_in_dabatase(client): assert response.status_code == 404 assert response_body == None -def test_route_gets_planet_by_name_returns_planet_with_matching_name(client, two_saved_planets): #figure out testing with search for name +def test_route_gets_planet_by_name_returns_planet_with_matching_name(client, two_saved_planets): response = client.get("/planets?name=Earth") response_body = response.get_json() From 95443c6cbdd744089a69596d0f8590a7805136c6 Mon Sep 17 00:00:00 2001 From: Aisha Date: Wed, 24 Nov 2021 18:42:32 -0600 Subject: [PATCH 11/11] adds Procfile and points gunicorn to app --- Procfile | 1 + 1 file changed, 1 insertion(+) create mode 100644 Procfile diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..066ed31d9 --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()'