diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..315dbed4f 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,35 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from dotenv import load_dotenv +import os +#postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development +db = SQLAlchemy() +migrate = Migrate(compare_type=True) +load_dotenv() def create_app(test_config=None): app = Flask(__name__) + app.config['JSON_SORT_KEYS'] = False # Don't sort keys alphabetically + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + + if test_config: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") + app.config["Testing"] = True + else: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + + db.init_app(app) + migrate.init_app(app, db) + + from app.models.planet import Planet + from app.models.moon import Moon + from .routes.planet_routes import planets_bp + from .routes.moon_routes import moon_bp + + app.register_blueprint(planets_bp) + app.register_blueprint(moon_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/moon.py b/app/models/moon.py new file mode 100644 index 000000000..1b8771031 --- /dev/null +++ b/app/models/moon.py @@ -0,0 +1,16 @@ +from app import db + +class Moon(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + planet_id = db.Column(db.Integer, db.ForeignKey("planet.id")) + planet = db.relationship("Planet", back_populates = "moons") + + def to_dict(self): + return{ + "id" : self.id, + "name" : self.name, + "planet_id" : self.planet.id, + "planet" : self.planet.name + } + \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..1df3eac8e --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,37 @@ +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) + gravity = db.Column(db.Float) + distance_from_earth = db.Column(db.Float) + moons = db.relationship("Moon", back_populates = "planet") + + 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["gravity"] = self.gravity + planet_as_dict["distance_from_earth"] = self.distance_from_earth + + moon_names = [] + for moon in self.moons: + moon_names.append(moon.name) + planet_as_dict["moons"] = [moon.name for moon in self.moons] + + return planet_as_dict + + @classmethod + def from_dict(cls, planet_data): + new_planet = Planet( + name=planet_data["name"], + description=planet_data["description"], + gravity = planet_data['gravity'], + distance_from_earth = planet_data['distance_from_earth'] + ) + + return new_planet \ No newline at end of file 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/moon_routes.py b/app/routes/moon_routes.py new file mode 100644 index 000000000..0f147883c --- /dev/null +++ b/app/routes/moon_routes.py @@ -0,0 +1,64 @@ +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.moon import Moon +from app.models.planet import Planet +from app.routes.planet_routes import validate_model + +moon_bp = Blueprint("moons_bp", __name__, url_prefix="/moons") + + +@moon_bp.route("", methods=["POST"]) +def create_new_moon(): + request_body = request.get_json() + new_moon = Moon(name=request_body["name"], ) + + db.session.add(new_moon) + db.session.commit() + + return make_response(jsonify(f"Moon {new_moon.name} successfully created."), 201) + + +@moon_bp.route("/", methods=["GET"]) +def read_moon_by_id(moon_id): + moon_response = validate_model(Moon, moon_id) + + return make_response(jsonify(moon_response.to_dict()), 200) + + +@moon_bp.route("", methods=["GET"]) +def read_all_moons(): + all_moon = Moon.query.all() + + moons_response = [] + for moon in all_moon: + moons_response.append({ + "id": moon.id, + "name": moon.name, + } + ) + return make_response(jsonify(moons_response), 200) + + +@moon_bp.route("//moon", methods=["POST"]) +def create_moon_to_planet_by_planet_id(planet_id): + new_planet = validate_model(Planet, planet_id) + + request_body = request.get_json() + new_moon = Moon( + name=request_body["name"], + planet_id=new_planet.id, + planet=new_planet + ) + + db.session.add(new_moon) + db.session.commit() + + return make_response(jsonify(new_moon.to_dict()), 201) + + +@moon_bp.route("//moons", methods=["GET"]) +def get_moons_by_planet_id(planet_id): + planet = validate_model(Planet, planet_id) + + response = planet.to_dict() + return make_response(jsonify(response), 200) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..a8102262b --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,143 @@ +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet +from app.models.moon import Moon + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +# ---------------------------------------------- Route Functions ---------------------------------------------- +@planets_bp.route("", methods = ["POST"]) +def create_planet(): + request_body = request.get_json() + validate_request_body(request_body) + #use from_dict function to simplfied code + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response(jsonify(f"Planet: {new_planet.name} created successfully."), 201) + +@planets_bp.route("", methods = ["GET"]) +def read_planets(): + + planet_query = Planet.query # Get a query object for later use + + # Query planets use name argument + name_query = request.args.get("name") + distance_query = request.args.get("distance_from_earth") + gravity_query = request.args.get("gravity") + # Sort argument passed by client + is_sort = request.args.get("sort") + + if name_query: + planet_query = planet_query.filter_by(name = name_query) + + if distance_query: + planet_query = planet_query.filter_by(distance_from_earth = distance_query) + + if gravity_query: + planet_query = planet_query.filter_by(gravity = gravity_query) + + if is_sort: + attribute = None + sort_method = is_sort + + split_sort = is_sort.split(":") + + if len(split_sort) == 2: # Case: ?sort=attribute:asc + attribute = split_sort[0] + sort_method = split_sort[1] + if len(split_sort) > 2: + abort(make_response("Too many parameters", 400)) + + # Sort records by client's request + if attribute == "distance_from_earth": + planet_query = sort_helper(planet_query, Planet.distance_from_earth, sort_method) + elif attribute == "gravity": + planet_query = sort_helper(planet_query, Planet.gravity, sort_method) + else: # If user don't specify any attribute, we would sort by name + planet_query = sort_helper(planet_query, Planet.name, sort_method) + else: + # Sort by id asc if no sort param porvided + planet_query = sort_helper(planet_query, Planet.id, "asc") + + planets = planet_query.all() + + planet_response = [] + for planet in planets: + planet_response.append(planet.to_dict()) #use to_dict function to make code more readable + + return make_response(jsonify(planet_response), 200) + +@planets_bp.route("/", methods = ["GET"]) +def read_one_planet_by_id(planet_id): + planet = validate_model(Planet, planet_id) + #use to_dict function to make code more readable + return (planet.to_dict(), 200) + +@planets_bp.route("/", methods = ["PUT"]) +def update_planet_by_id(planet_id): + planet = validate_model(Planet, planet_id) + + request_body = request.get_json() + validate_request_body(request_body) + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.gravity = request_body["gravity"] + planet.distance_from_earth = request_body["distance_from_earth"] + + db.session.commit() + + return make_response(jsonify(f"Planet: {planet_id} has been updated successfully."), 200) + +@planets_bp.route("/", methods = ["DELETE"]) +def delete_planet_by_id(planet_id): + planet = validate_model(Planet, planet_id) + + # Delete moon when we delete the planet they associate to to avoid having dangling nodes + moons_query = Moon.query.all() + if moons_query: + for moon in moons_query: + if moon.planet_id == planet.id: + db.session.delete(moon) + db.session.commit() + + db.session.delete(planet) + db.session.commit() + + return make_response(jsonify(f"Planet: {planet_id} has been deleted successfully."), 200) + + +#---------------------------------------------- Helper Functions---------------------------------------------- +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + abort(make_response({"message":f"{cls.__name__} {model_id} is invalid"}, 400)) + + model = cls.query.get(model_id) + + if not model: + abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404)) + return model + +def validate_request_body(request_body): + + if "name" not in request_body or "description" not in request_body or "gravity" \ + not in request_body or "distance_from_earth" not in request_body: + abort(make_response("Invalid Request", 400)) + +def sort_helper(planet_query, atr = None, sort_method = "asc"): + if sort_method == "asc" and atr: + planet_query = planet_query.order_by(atr.asc()) + elif sort_method == "desc" and atr: + planet_query = planet_query.order_by(atr.desc()) + elif sort_method == "desc": + planet_query = planet_query.order_by(Planet.name.desc()) + else: + #Sort by name in ascending order by default + planet_query = planet_query.order_by(Planet.name.asc()) + + return planet_query 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/c9a0888f7e70_.py b/migrations/versions/c9a0888f7e70_.py new file mode 100644 index 000000000..f93eb38dc --- /dev/null +++ b/migrations/versions/c9a0888f7e70_.py @@ -0,0 +1,43 @@ +"""empty message + +Revision ID: c9a0888f7e70 +Revises: +Create Date: 2023-01-05 11:26:58.114514 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'c9a0888f7e70' +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('gravity', sa.Float(), nullable=True), + sa.Column('distance_from_earth', sa.Float(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('moon', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('planet_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['planet_id'], ['planet.id'], ), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('moon') + op.drop_table('planet') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index fba2b3e38..545a38efa 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,19 +1,28 @@ alembic==1.5.4 +attrs==22.2.0 autopep8==1.5.5 blinker==1.4 certifi==2020.12.5 chardet==4.0.0 +charset-normalizer==2.1.1 click==7.1.2 +coverage==7.0.0 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 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==22.0 +pluggy==1.0.0 psycopg2-binary==2.9.4 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==2.4.7 pytest==7.1.1 pytest-cov==2.12.1 python-dateutil==2.8.1 @@ -23,5 +32,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.0.1 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..44a489fba --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,92 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet +from app.models.moon import Moon + + +@pytest.fixture +def app(): + app = create_app({"TEST": 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 saved_two_planets(app): + mars = Planet(name="Mars", + description="This is planet: Mars", + gravity=3.721, + distance_from_earth=60.81, + moons = [] + ) + + jupiter = Planet(name="Jupiter", + description="This is planet: Jupiter", + gravity=24.79, + distance_from_earth=467.64, + moons = [], + ) + + db.session.add_all([mars, jupiter]) + db.session.commit() + db.session.refresh(mars, ["id"]) + db.session.refresh(jupiter, ["id"]) + +@pytest.fixture +def saved_three_planets_with_duplicate_planet_name(app): + mars = Planet(name="Mars", + description="This is planet: Mars", + gravity=3.721, + distance_from_earth=60.81, + moons = [] + ) + + mars2 = Planet(name="Mars", + description="This is planet: Mars2", + gravity=4.721, + distance_from_earth=60.81, + moons = [] + ) + + jupiter = Planet(name="Jupiter", + description="This is planet: Jupiter", + gravity=24.79, + distance_from_earth=467.64, + moons = [], + ) + + db.session.add_all([mars, mars2, jupiter]) + db.session.commit() + db.session.refresh(mars, ["id"]) + db.session.refresh(mars2, ["id"]) + db.session.refresh(jupiter, ["id"]) + + +@pytest.fixture +def saved_two_moons(app): + moon1 = Moon(name="Moon1") + + moon2 = Moon(name="Moon2") + + + db.session.add_all([moon1, moon2]) + db.session.commit() + db.session.refresh(moon1, ["id"]) + db.session.refresh(moon2, ["id"]) + diff --git a/tests/test_models.py b/tests/test_models.py new file mode 100644 index 000000000..a32ea0fae --- /dev/null +++ b/tests/test_models.py @@ -0,0 +1,150 @@ +from app.models.planet import Planet +from app.models.moon import Moon +from app.routes.planet_routes import validate_model +import pytest + +def test_to_dict_no_missing_data(): + # Arrange + test_data = Planet(id = 1, + name="Mars", + description="This is planet: Mars", + gravity=3.721, + distance_from_earth=60.81) + + # Act + result = test_data.to_dict() + print(result) + + # Assert + assert len(result) == 6 + assert result["id"] == 1 + assert result["name"] == "Mars" + assert result["description"] == "This is planet: Mars" + assert result["gravity"] == 3.721 + assert result["distance_from_earth"] == 60.81 + assert result["moons"] == [] + +def test_to_dict_missing_id(): + # Arrange + test_data = Planet(name="Mars", + description="This is planet: Mars", + gravity=3.721, + distance_from_earth=60.81) + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 6 + assert result["id"] is None + assert result["name"] == "Mars" + assert result["description"] == "This is planet: Mars" + assert result["gravity"] == 3.721 + assert result["distance_from_earth"] == 60.81 + assert result["moons"] == [] + +def test_to_dict_missing_name(): + # Arrange + test_data = Planet(id=1, + description="This is planet: Mars", + gravity=3.721, + distance_from_earth=60.81) + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 6 + assert result["id"] == 1 + assert result["name"] is None + assert result["description"] == "This is planet: Mars" + assert result["gravity"] == 3.721 + assert result["distance_from_earth"] == 60.81 + +def test_to_dict_missing_description(): + # Arrange + test_data = Planet(id = 1, + name="Mars", + gravity=3.721, + distance_from_earth=60.81) + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 6 + assert result["id"] == 1 + assert result["name"] == "Mars" + assert result["description"] is None + assert result["gravity"] == 3.721 + assert result["distance_from_earth"] == 60.81 + + +def test_from_dict_returns_book(): + # Arrange + planet_data = { + "id":1, + "name": "Mars", + "description": "This is planet: Mars", + "gravity" : 3.721, + "distance_from_earth" : 60.81 + } + + # Act + new_planet = Planet.from_dict(planet_data) + + # Assert + assert new_planet.name == "Mars" + assert new_planet.description == "This is planet: Mars" + assert new_planet.gravity == 3.721 + assert new_planet.distance_from_earth == 60.81 + +def test_from_dict_with_no_name(): + # Arrange + planet_data = { + "description": "This is planet: Mars!", + "gravity" : 3.721, + "distance_from_earth" : 60.81 + } + + # Act & Assert + with pytest.raises(KeyError, match = 'name'): + new_planet = Planet.from_dict(planet_data) + +def test_from_dict_with_no_description(): + # Arrange + planet_data = { + "name": "Mars", + "gravity" : 3.721, + "distance_from_earth" : 60.81 + } + + # Act & Assert + with pytest.raises(KeyError, match = 'description'): + new_planet = Planet.from_dict(planet_data) + +def test_from_dict_with_extra_keys(): + # Arrange + planet_data = { + "extra": "some stuff", + "name": "Mars", + "description": "This is planet: Mars", + "gravity" : 3.721, + "distance_from_earth" : 60.81, + "another": "last value" + } + + # Act + new_planet = Planet.from_dict(planet_data) + + # Assert + assert new_planet.name == "Mars" + assert new_planet.description == "This is planet: Mars" + assert new_planet.gravity == 3.721 + assert new_planet.distance_from_earth == 60.81 + +def test_validate_moon_model(saved_two_moons): + result_moon = validate_model(Moon, 1) + + assert result_moon.id == 1 + assert result_moon.name == "Moon1" \ No newline at end of file diff --git a/tests/test_moon_routes b/tests/test_moon_routes new file mode 100644 index 000000000..13332a228 --- /dev/null +++ b/tests/test_moon_routes @@ -0,0 +1,124 @@ +# --------------------------------------- +# --------------------------------------- +# ---------Moon route tests-------------- +# --------------------------------------- +# --------------------------------------- + +def test_get_moon_by_id_return_200_successful_code(client, saved_two_moons): + response = client.get("/moons/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body["name"] == "Moon1" + + +def test_get_moon_by_not_exist_id_return_404(client): + response = client.get("/moons/1") + response_body = response.get_json() + + assert response.status_code == 404 + + +def test_get_moon_by_invalid_moon_id_return_400_bad_request_error(client, saved_two_moons): + response = client.get("/moons/hello") + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body == {"message": "Moon hello is invalid"} + + +def test_get_all_moons_with_no_records_return_empty_array(client): + response = client.get("/moons") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + + +def test_get_all_moons_with_two_records_return_array_with_size_2(client, saved_two_moons): + response = client.get("/moons") + response_body = response.get_json() + + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Moon1" + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Moon2" + + +def test_create_one_moon_return_201_successfully_created(client): + response = client.post("/moons", + json={"name": "Moon3"}) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == "Moon Moon3 successfully created." + + +def test_create_moon_to_planet_by_planet_id(client, saved_two_planets): + response = client.post("/moons/1/moon", + json={ + "name": "planet1_moon"}) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body["name"] == "planet1_moon" + assert response_body["planet_id"] == 1 + assert response_body["planet"] == "Mars" + + +def test_get_moons_by_planet_id_return_empty_list_of_moons(client, saved_two_planets): + response = client.get("moons/1/moons") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body["id"] == 1 + assert response_body["name"] == "Mars" + assert response_body["description"] == "This is planet: Mars" + assert response_body["gravity"] == 3.721 + assert response_body["distance_from_earth"] == 60.81 + assert response_body["moons"] == [] + + +def test_get_moons_by_planet_id_return_list_of_two_moons(client, saved_two_planets): + post_response = client.post("/moons/1/moon", + json={"name": "Moon1" + }) + post_response = client.post("/moons/1/moon", + json={"name": "Moon2" + }) + response = client.get("moons/1/moons") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body["id"] == 1 + assert response_body["name"] == "Mars" + assert response_body["description"] == "This is planet: Mars" + assert response_body["gravity"] == 3.721 + assert response_body["distance_from_earth"] == 60.81 + assert response_body["moons"] == ["Moon1", "Moon2"] + + +def test_create_moons_by_invalid_planet_id(client, saved_two_planets): + response = client.post("/moons/invalid/moon", json={"name": "Moon1"}) + assert response.status_code == 400 + assert response.get_json() == {"message": "Planet invalid is invalid"} + + +def test_create_moons_by_a_non_existing_planet_id(client, saved_two_planets): + response = client.post("/moons/100/moon",json={"name": "Moon1"}) + assert response.status_code == 404 + assert response.get_json() == {"message": "Planet 100 not found"} + + +def test_validate_model_missing_moon_record(saved_two_moons): + # Calling `validate_model` without being invoked by a route will + # cause an `HTTPException` when an `abort` statement is reached + with pytest.raises(HTTPException): + result_planet = validate_model(Moon, "3") + + +def test_validate_model_invalid_moon_id(saved_two_moons): + with pytest.raises(HTTPException): + result_planet = validate_model(Moon, "invalid_id") diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..a8d9704a9 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,448 @@ +import pytest +from werkzeug.exceptions import HTTPException +from app.routes.planet_routes import validate_model +from app.models.planet import Planet +from app.models.moon import Moon + +# --------------------------------------- +# --------------------------------------- +# ---------Planet route tests-------------- +# --------------------------------------- +# --------------------------------------- + + +def test_get_planet_by_id_return_200_successful_code(client, saved_two_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body["name"] == "Mars" + + +def test_get_planet_by_not_exist_id_return_404(client): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + + +def test_get_planet_by_invalid_planet_id_return_400_bad_request_error(client, saved_two_planets): + response = client.get("/planets/hello") + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body == {"message": "Planet hello is invalid"} + + +def test_get_all_planets_with_no_records_return_empty_array(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + + +def test_get_all_planets_with_two_records_return_array_with_size_2(client, saved_two_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert len(response_body) == 2 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Jupiter" + assert response_body[1]["description"] == "This is planet: Jupiter" + assert response_body[1]["gravity"] == 24.79 + assert response_body[1]["distance_from_earth"] == 467.64 + + +def test_get_planets_no_param_sort_by_id_asc(saved_two_planets, client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Jupiter" + assert response_body[1]["description"] == "This is planet: Jupiter" + assert response_body[1]["gravity"] == 24.79 + assert response_body[1]["distance_from_earth"] == 467.64 + + +def test_get_planets_sort_desc_param_sort_by_name_desc(saved_two_planets, client): + response = client.get("/planets?sort=desc") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Jupiter" + assert response_body[1]["description"] == "This is planet: Jupiter" + assert response_body[1]["gravity"] == 24.79 + assert response_body[1]["distance_from_earth"] == 467.64 + + +def test_get_planets_sort_desc_param_sort_by_name_asc(saved_two_planets, client): + response = client.get("/planets?sort=asc") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 2 + assert response_body[0]["name"] == "Jupiter" + assert response_body[0]["description"] == "This is planet: Jupiter" + assert response_body[0]["gravity"] == 24.79 + assert response_body[0]["distance_from_earth"] == 467.64 + assert response_body[1]["id"] == 1 + assert response_body[1]["name"] == "Mars" + assert response_body[1]["description"] == "This is planet: Mars" + assert response_body[1]["gravity"] == 3.721 + assert response_body[1]["distance_from_earth"] == 60.81 + + +def test_get_planets_sort_by_gravity_desc(saved_two_planets, client): + data = {"sort": "gravity:desc"} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 2 + assert response_body[0]["name"] == "Jupiter" + assert response_body[0]["description"] == "This is planet: Jupiter" + assert response_body[0]["gravity"] == 24.79 + assert response_body[0]["distance_from_earth"] == 467.64 + assert response_body[1]["id"] == 1 + assert response_body[1]["name"] == "Mars" + assert response_body[1]["description"] == "This is planet: Mars" + assert response_body[1]["gravity"] == 3.721 + assert response_body[1]["distance_from_earth"] == 60.81 + + +def test_get_planets_sort_planets_by_name_desc_order(saved_two_planets, client): + data = {"sort": "name:desc"} + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Jupiter" + assert response_body[1]["description"] == "This is planet: Jupiter" + assert response_body[1]["gravity"] == 24.79 + assert response_body[1]["distance_from_earth"] == 467.64 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + + +def test_get_planets_sort_by_distance_from_earth_asc(saved_two_planets, client): + data = {"sort": "distance_from_earth:asc"} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Jupiter" + assert response_body[1]["description"] == "This is planet: Jupiter" + assert response_body[1]["gravity"] == 24.79 + assert response_body[1]["distance_from_earth"] == 467.64 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + + +def test_get_planets_sort_planets_by_distance_from_earth_desc(saved_two_planets, client): + data = {"sort": "distance_from_earth:desc"} + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Jupiter" + assert response_body[1]["description"] == "This is planet: Jupiter" + assert response_body[1]["gravity"] == 24.79 + assert response_body[1]["distance_from_earth"] == 467.64 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + + +def test_get_planets_filter_by_planet_name_return_Mars_only(saved_two_planets, client): + data = {"name": "Mars"} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + + +def test_get_planets_filter_by_gravity_return_Mars_only(saved_two_planets, client): + data = {"gravity": 3.721} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + + +def test_get_planets_filter_by_distance_from_earth_return_Jupiter_only(saved_two_planets, client): + data = {"distance_from_earth": 467.64} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 2 + assert response_body[0]["name"] == "Jupiter" + assert response_body[0]["description"] == "This is planet: Jupiter" + assert response_body[0]["gravity"] == 24.79 + assert response_body[0]["distance_from_earth"] == 467.64 + + +def test_get_planets_filter_by_planet_Jupiter_return_Jupiter_only(saved_two_planets, client): + data = {"name": "Jupiter"} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 2 + assert response_body[0]["name"] == "Jupiter" + assert response_body[0]["description"] == "This is planet: Jupiter" + assert response_body[0]["gravity"] == 24.79 + assert response_body[0]["distance_from_earth"] == 467.64 + + +def test_get_planets_filter_by_planet_Mars_sort_by_id_asc(saved_three_planets_with_duplicate_planet_name, client): + data = {"name": "Mars"} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Mars" + assert response_body[1]["description"] == "This is planet: Mars2" + assert response_body[1]["gravity"] == 4.721 + assert response_body[1]["distance_from_earth"] == 60.81 + + +def test_get_planets_filter_by_planet_Mars_sort_by_gravity_asc(saved_three_planets_with_duplicate_planet_name, client): + data = {"name": "Mars", "sort": "gravity"} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[0]["id"] == 1 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars" + assert response_body[0]["gravity"] == 3.721 + assert response_body[0]["distance_from_earth"] == 60.81 + assert response_body[1]["id"] == 2 + assert response_body[1]["name"] == "Mars" + assert response_body[1]["description"] == "This is planet: Mars2" + assert response_body[1]["gravity"] == 4.721 + assert response_body[1]["distance_from_earth"] == 60.81 + + +def test_get_planets_filter_by_planet_Mars_sort_by_gravity_desc(saved_three_planets_with_duplicate_planet_name, client): + data = {"name": "Mars", "sort": "gravity:desc"} + response = client.get("/planets", query_string=data) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body[1]["id"] == 1 + assert response_body[1]["name"] == "Mars" + assert response_body[1]["description"] == "This is planet: Mars" + assert response_body[1]["gravity"] == 3.721 + assert response_body[1]["distance_from_earth"] == 60.81 + assert response_body[0]["id"] == 2 + assert response_body[0]["name"] == "Mars" + assert response_body[0]["description"] == "This is planet: Mars2" + assert response_body[0]["gravity"] == 4.721 + assert response_body[0]["distance_from_earth"] == 60.81 + + +def test_create_one_planet_return_201_successfully_created(client): + response = client.post("/planets", + json={"name": "Venus", + "description": "This is planet: Venus", + "gravity": 9.87, + "distance_from_earth": 67.685}) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == "Planet: Venus created successfully." + +# edge cases for create one planet + + +def test_create_one_planet_no_name_return_400(client): + + response = client.post("/planets", + json={"description": "This is planet: Venus", + "gravity": 9.87, + "distance_from_earth": 67.685}) + + assert response.status_code == 400 + + +def test_create_one_planet_no_description_return_400(client): + response = client.post("/planets", + json={"name": "Mars", + "gravity": 9.87, + "distance_from_earth": 67.685}) + + assert response.status_code == 400 + + +def test_create_one_planet_no_gravity_return_400(client): + test_data = {"name": "Mars", + "description": "This is planet: Venus", + "distance_from_earth": 67.685 + } + response = client.post("/planets", json=test_data) + assert response.status_code == 400 + + +def test_create_one_planet_with_extra_keys_return_201(client, saved_two_planets): + test_data = { + "extra": "some stuff", + "name": "Venus", + "description": "This is planet: Venus", + "gravity": 9.87, + "distance_from_earth": 67.685, + "another": "last value" + } + + response = client.post("/planets", json=test_data) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == "Planet: Venus created successfully." + + +def test_put_planet_with_id_1_return_200_planet_successfully_replaced(client, saved_two_planets): + resposne = client.put("/planets/1", + json={"name": "New Planet", + "description": "This a New Planet", + "gravity": 20.0, + "distance_from_earth": 55.99}) + response_body = resposne.get_json() + + assert resposne.status_code == 200 + assert response_body == "Planet: 1 has been updated successfully." + + +def test_put_non_existing_planet_return_404_not_found_error(client, saved_two_planets): + resposne = client.put("/planets/9", + json={"name": "New Planet", + "description": "This a New Planet", + "gravity": 20.0, + "distance_from_earth": 55.99}) + response_body = resposne.get_json() + + assert resposne.status_code == 404 + assert response_body == {"message": "Planet 9 not found"} + + +def test_put_invalid_planet__id_return_400_invalid_error(client, saved_two_planets): + resposne = client.put("/planets/invalid_id", + json={"name": "New Planet", + "description": "This a New Planet", + "gravity": 20.0, + "distance_from_earth": 55.99}) + response_body = resposne.get_json() + + assert resposne.status_code == 400 + assert response_body == {"message": "Planet invalid_id is invalid"} + + +def test_delete_planet_with_id_1_return_200_planet_successfully_deleted(client, saved_two_planets): + response = client.delete("planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == "Planet: 1 has been deleted successfully." + + +def test_delete_planet_with_non_exist_id_return_404_not_found_error(client, saved_two_planets): + response = client.delete("planets/10") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == {"message": "Planet 10 not found"} + + +def test_delete_planet_with_invalid_id_return_400_invalid_error(client, saved_two_planets): + response = client.delete("planets/invalid_id") + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body == {"message": "Planet invalid_id is invalid"} + + +def test_delete_exist_planet_associate_moons_also_delete(client, saved_two_planets): + create_moon_to_planet = client.post("/moons/1/moon", + json={"name": "Moon1" + }) + delete_planet = client.delete("/planets/1") + delete_planet_response_body = delete_planet.get_json() + + get_moons = client.get("/moons") + get_moons_response_body = get_moons.get_json() + + assert delete_planet.status_code == 200 + assert delete_planet_response_body == "Planet: 1 has been deleted successfully." + assert get_moons.status_code == 200 + assert get_moons_response_body == [] + + +def test_validate_model(saved_two_planets): + result_planet = validate_model(Planet, 1) + + assert result_planet.id == 1 + assert result_planet.name == "Mars" + assert result_planet.description == "This is planet: Mars" + assert result_planet.gravity == 3.721 + assert result_planet.distance_from_earth == 60.81 + assert result_planet.moons == [] + + +def test_validate_model_missing_record(saved_two_planets): + # Calling `validate_model` without being invoked by a route will + # cause an `HTTPException` when an `abort` statement is reached + with pytest.raises(HTTPException): + result_planet = validate_model(Planet, "3") + + +def test_validate_model_invalid_id(saved_two_planets): + with pytest.raises(HTTPException): + result_planet = validate_model(Planet, "invalid_id") +