diff --git a/.env b/.env new file mode 100644 index 000000000..0473e465d --- /dev/null +++ b/.env @@ -0,0 +1,2 @@ +SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system +SQLALCHEMY_TEST_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_test \ No newline at end of file diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..7cfc90917 --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn --log-level=DEBUG 'app:create_app()' diff --git a/README.md b/README.md index f9d17f77c..eb646e344 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Solar System API +test line in readme + ## Goal diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..8b678db06 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,36 @@ 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__) - return app + 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") + + # Import models here + from app.models.planet import Planet + + db.init_app(app) + migrate.init_app(app, db) + + # 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/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/model.py b/app/models/model.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..e8a7ac106 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,29 @@ +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) + color = db.Column(db.String) + + + def to_dict(self): + + return { + "name": self.name, + "color": self.color, + "description": self.description, + "id": self.id + } + @classmethod + def from_json(cls, req_body): + return cls( + name= req_body["name"], + color= req_body["color"], + description= req_body["description"] + ) + + def update(self, req_body): + self.name= req_body["name"], + self.color= req_body["color"], + self.description= req_body["description"] \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..7c30ccf71 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,75 @@ -from flask import Blueprint +from os import abort +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +def validate_planet(class_obj, planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({"message": f"planet {planet_id} has an invalid planet_id"}, 400)) + + query_result = class_obj.query.get(planet_id) + + if not query_result: + abort(make_response({"message": f"planet {planet_id} not found"}, 404)) + + return query_result + +@planets_bp.route("", methods=["GET"]) +def read_all_planets(): + color_param =request.args.get("color") + name_param = request.args.get("name") + + if color_param: + planets = Planet.query.filter_by(color=color_param) + elif name_param: + planets = Planet.query.filter_by(name=name_param) + else: + planets = Planet.query.all() + planets_response = [] + + for planet in planets: + planets_response.append(planet.to_dict()) + + return jsonify(planets_response), 200 + +@planets_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet.from_json(request_body) + db.session.add(new_planet) + db.session.commit() + + return make_response(f"planet {new_planet.name} successfully created"), 201 + +@planets_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(Planet, planet_id) + return jsonify(planet.to_dict()), 200 + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.update(request_body) + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.color = request_body["color"] + + db.session.commit() + + return make_response (f"Planet #{planet.id} successfully updated") + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully deleted") 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/02f11d17edc5_planet_model.py b/migrations/versions/02f11d17edc5_planet_model.py new file mode 100644 index 000000000..abf0ef352 --- /dev/null +++ b/migrations/versions/02f11d17edc5_planet_model.py @@ -0,0 +1,34 @@ +"""planet model + +Revision ID: 02f11d17edc5 +Revises: +Create Date: 2022-10-30 17:42:31.089244 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '02f11d17edc5' +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.Column('color', 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 ### diff --git a/requirements.txt b/requirements.txt index fba2b3e38..83515424a 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 idna==2.10 itsdangerous==1.1.0 Jinja2==2.11.3 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..20c2d2fd9 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,57 @@ +import pytest +from app import create_app, db +from flask.signals import request_finished +from app.models.planet import Planet + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @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 one_planet(app): + test_planet = Planet(name="Planet number one", + description="watr 4evr", + color = "color") + + + db.session.add(test_planet) + db.session.commit() + db.session.refresh(test_planet, ["id"]) + + return test_planet + +@pytest.fixture +def many_planets(app): + apes_planet = Planet(name="Planet of apes", + description="Only apes live there", + color = "Grey") + crocodile_planet = Planet(name="Planet crocodiles", + description="Only crocodiles live there", + color = "Green") + butterfly_planet = Planet(name="Planet of butterflies", + description="Butterflies and unicorns live there", + color = "Rainbow") + orange_planet = Planet(name="Planet of oranges", + description="It's full of oranges", + color = "Orange") + + db.session.add_all([apes_planet, crocodile_planet, butterfly_planet, orange_planet]) + + 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..dfaa222cd --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,126 @@ +from app.models.planet import Planet + +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_all_planets_with_fixture_records(client, many_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 4 + #assert + + +def test_get_one_planet_no_fixture(client): + # Act + response = client.get("/books/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body is None + +def test_get_one_planet(client, one_planet): + # Act + response = client.get(f"/planets/{one_planet.id}") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Planet number one", + "description": "watr 4evr", + "color": "color" + } + +def test_get_one_planet_from_many_planets_valid_id(client, many_planets): + #Arrange + EXPECTED_ID = 3 + + # Act + response = client.get(f"/planets/{EXPECTED_ID}") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 3, + "name": "Planet of butterflies", + "description": "Butterflies and unicorns live there", + "color": "Rainbow" + } + +def test_get_one_planet_from_many_planets_non_existing_id_returns_404(client, many_planets): + #Arrange + NON_EXISTING_ID = 7 + + # Act + response = client.get(f"/planets/{NON_EXISTING_ID}") + response_body = response.get_data(as_text=True) + + # Assert + assert response.status_code == 404 + assert response_body == "{\"message\":\"planet 7 not found\"}\n" + +def test_get_one_planet_from_many_planets_invalid_id_returns_400(client, many_planets): + #Arrange + INVALID_ID = "ABC" + + # Act + response = client.get(f"/planets/{INVALID_ID}") + response_body = response.get_data(as_text=True) + + # Assert + assert response.status_code == 400 + assert response_body == "{\"message\":\"planet ABC has an invalid planet_id\"}\n" + +def test_create_planet_can_create_planet_in_empty_db(client): + #arrange + EXPECTED_PLANET = { + "name": "Created Planet", + "description": "New watr 4evr", + "color": "New color" + } + + #act + response = client.post("/planets", json = EXPECTED_PLANET) + response_body = response.get_data(as_text=True) + + assert response.status_code == 201 + assert response_body == f"planet {EXPECTED_PLANET['name']} successfully created" + + +def test_create_one_planet_if_there_are_planets_in_db(client, many_planets): + #arrange + EXPECTED_PLANET = { + "name": "Created Planet", + "description": "New watr 4evr", + "color": "New color" + } + + #act + response = client.post("/planets", json = EXPECTED_PLANET) + response_body = response.get_data(as_text=True) + + + all_planets = Planet.query.all() + planets_response = [] + + for planet in all_planets: + planets_response.append(planet.to_dict()) + + # Assert + assert response.status_code == 201 + assert response_body == "planet Created Planet successfully created" + assert len(all_planets) == 5 + assert EXPECTED_PLANET["name"] == planets_response[4]["name"] \ No newline at end of file