diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..b06f74a7d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,8 +1,13 @@ from flask import Flask from .db import db, migrate from .models import task, goal +from .routes.task_routes import bp as tasks_bp +from .routes.goal_routes import bp as goals_bp +from dotenv import load_dotenv import os +load_dotenv() + def create_app(config=None): app = Flask(__name__) @@ -18,5 +23,7 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here + app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 44282656b..1c4c0fad7 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,5 +1,29 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from ..db import db +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from .task import Task class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + tasks: Mapped[list["Task"]] = relationship(back_populates="goal") + + def to_dict(self, with_tasks=False): + goal_dict = { + "goal": { + "id": self.id, + "title": self.title + } + } + + if with_tasks: + goal_dict["tasks"] = [task.to_dict()["task"] for task in self.tasks] + + return goal_dict + + @classmethod + def from_dict(cls, goal_data): + return cls( + title=goal_data["title"] + ) diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..011c33690 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,45 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey +from datetime import datetime +from typing import Optional from ..db import db +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from .goal import Goal class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + description: Mapped[str] + completed_at: Mapped[datetime] = mapped_column(nullable=True) + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") + + + def to_dict(self): + task_dict = { + "task": { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.is_complete() + } + } + + if self.goal_id: + task_dict["task"]["goal_id"]= self.goal_id + + return task_dict + + def is_complete(self): + return bool(self.completed_at) + + + @classmethod + def from_dict(cls, task_data): + return cls( + goal_id=task_data.get("goal_id"), + title=task_data["title"], + description=task_data["description"], + completed_at=task_data["completed_at"] + ) \ No newline at end of file diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..7c619a44c 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,80 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, Response, request, jsonify +import requests +from app.models.goal import Goal +from .route_utilities import validate_model, create_model, get_models_with_filters, get_validated_tasks_from_request_body +from ..db import db + +bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + + +@bp.post("") +def create_goal(): + request_body = request.get_json() + return create_model(Goal, request_body) + +@bp.get("") +def get_all_goals(): + return get_models_with_filters(Goal,request.args) + +@bp.get("/") +def get_one_goal(id): + goal = validate_model(Goal, id) + return goal.to_dict() + + +@bp.put("/") +def update_goal(id): + goal = validate_model(Goal, id) + request_body = request.get_json() + + for attribute, value in request_body.items(): + if hasattr(Goal, attribute): + setattr(goal, attribute, value) + + db.session.commit() + return Response(status=204, mimetype="application/json") + +@bp.delete("/") +def delete_goal(id): + goal = validate_model(Goal, id) + + db.session.delete(goal) + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@bp.post("//tasks") +def add_tasks_to_goal(id): + goal = validate_model(Goal, id) + request_body = request.get_json() + + tasks_to_add = get_validated_tasks_from_request_body(request_body) + goal.tasks = tasks_to_add + + db.session.commit() + + response = { + "id": goal.id, + "task_ids": [task.id for task in tasks_to_add] + } + + return jsonify(response), 200 + +@bp.get("//tasks") +def get_tasks_of_one_goal(id): + goal = validate_model(Goal, id) + + tasks_response_list = [] + for task in goal.tasks: + tasks_response_list.append(task.to_dict()["task"]) + + response_body = { + "id": goal.id, + "title": goal.title, + "tasks": tasks_response_list + } + + return jsonify(response_body), 200 + + + diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py new file mode 100644 index 000000000..845308ffa --- /dev/null +++ b/app/routes/route_utilities.py @@ -0,0 +1,110 @@ +from flask import abort, make_response, jsonify +from sqlalchemy import asc, desc +from app.models.task import Task +import requests +from ..db import db + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except ValueError: + invalid = {"details": f"{cls.__name__} id {model_id} is invalid."} + abort(make_response(invalid,400)) + + query = db.select(cls).where(cls.id == model_id) + model = db.session.scalar(query) + + if not model: + not_found = {"details": f"{cls.__name__} with id {model_id} was not found."} + abort(make_response(not_found, 404)) + + return model + + + +def create_model(cls, model_data): + try: + new_model = cls.from_dict(model_data) + except KeyError as e: + response = {"details": "Invalid data"} + abort(make_response(response,400)) + + db.session.add(new_model) + db.session.commit() + + return new_model.to_dict(), 201 + +def get_models_with_filters(cls, filters=None, to_dict_options=None): + query = db.select(cls) + order_by_clause = cls.id + + if filters: + for parameter, value in filters.items(): + if parameter == "sort": + if value == "asc": + order_by_clause = asc("title") + elif value == "desc": + order_by_clause = desc("title") + elif hasattr(cls, parameter): + query = query.where(getattr(cls,parameter).ilike(f"%{value}%")) + + models = db.session.scalars(query.order_by(order_by_clause)) + + + models_response = [] + to_dict_options = to_dict_options if to_dict_options is not None else {} + for model in models: + model_dict = model.to_dict(**to_dict_options) + inner_key = cls.__name__.lower() + + if inner_key in model_dict: + models_response.append(model_dict[inner_key]) + else: + models_response.append(model_dict) + + return models_response + +def call_slackbot(task_title): + url = "https://hooks.slack.com/services/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" + text = f"Someone just completed the task: {task_title}" + + try: + response = requests.post(url=url,json={"text": text},timeout=5.0) + response.raise_for_status() + except Exception: + response = f"An unexpected error occured." + abort(make_response(response,400)) + + + +def get_validated_tasks_from_request_body(request_body): + try: + if not request_body: + response = {"details": "Request body is empty."} + abort(make_response(jsonify(response), 400)) + + task_ids_from_request = request_body["task_ids"] + + if not isinstance(task_ids_from_request, list): + response = {"details": "'task_ids' must be a list."} + abort(make_response(jsonify(response), 400)) + + validated_task_objects = [] + for task_id in task_ids_from_request: + if not isinstance(task_id, int): + response = {"details": f"Each task ID must be an integer, but received {task_id}."} + abort(make_response(jsonify(response), 400)) + + task_instance = validate_model(Task, task_id) + validated_task_objects.append(task_instance) + + return validated_task_objects + + except KeyError: + response = {"details": "Request body must contain 'task_ids'."} + abort(make_response(jsonify(response), 400)) + except Exception as e: + response = {"details": f"An unexpected error occured: {e}."} + abort(make_response(jsonify(response), 400)) + + diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..66bab6042 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,64 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, Response, abort, make_response, request +import requests +from datetime import datetime +from app.models.task import Task +from .route_utilities import validate_model, create_model, get_models_with_filters, call_slackbot +from ..db import db + +bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + +@bp.post("") +def create_task(): + request_body = request.get_json() + return create_model(Task, request_body) + + +@bp.get("") +def get_all_tasks(): + return get_models_with_filters(Task, request.args) + +@bp.get("/") +def get_one_task(id): + task = validate_model(Task, id) + + return task.to_dict() + + +@bp.put("/") +def update_task(id): + task = validate_model(Task, id) + request_body = request.get_json() + + for attribute, value in request_body.items(): + if hasattr(Task, attribute): + setattr(task, attribute, value) + + db.session.commit() + return Response(status=204, mimetype="application/json") + +@bp.delete("/") +def delete_task(id): + task = validate_model(Task, id) + + db.session.delete(task) + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@bp.patch("/") +def modify_task_completion_status(id, completion_status): + task = validate_model(Task, id) + + if completion_status == 'mark_incomplete': + task.completed_at = None + + elif completion_status == 'mark_complete': + task.completed_at = datetime.now() + call_slackbot(task.title) + else: + response = {"details": f"Route {completion_status} not recognized"} + abort(make_response(response,400)) + + db.session.commit() + + return Response(status=204, mimetype="application/json") diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# 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,flask_migrate + +[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 + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[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..4c9709271 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,113 @@ +import logging +from logging.config import fileConfig + +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') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except (TypeError, AttributeError): + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# 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', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# 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 get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +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=get_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.') + + conf_args = current_app.extensions['migrate'].configure_args + if conf_args.get("process_revision_directives") is None: + conf_args["process_revision_directives"] = process_revision_directives + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + **conf_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/5582fb314426_adds_a_goal_model_with_id_and_title_.py b/migrations/versions/5582fb314426_adds_a_goal_model_with_id_and_title_.py new file mode 100644 index 000000000..604e35b42 --- /dev/null +++ b/migrations/versions/5582fb314426_adds_a_goal_model_with_id_and_title_.py @@ -0,0 +1,33 @@ +"""Adds a Goal model with id and title attributes + + +Revision ID: 5582fb314426 +Revises: 715a63be17d0 +Create Date: 2025-05-16 11:58:12.943036 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '5582fb314426' +down_revision = '715a63be17d0' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('goal', schema=None) as batch_op: + batch_op.add_column(sa.Column('title', sa.String(), nullable=False)) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('goal', schema=None) as batch_op: + batch_op.drop_column('title') + + # ### end Alembic commands ### diff --git a/migrations/versions/715a63be17d0_adds_the_task_list_development_and_task_.py b/migrations/versions/715a63be17d0_adds_the_task_list_development_and_task_.py new file mode 100644 index 000000000..71d497351 --- /dev/null +++ b/migrations/versions/715a63be17d0_adds_the_task_list_development_and_task_.py @@ -0,0 +1,39 @@ +"""Adds the task_list_development and task_list_api_test schema + +Revision ID: 715a63be17d0 +Revises: +Create Date: 2025-05-07 09:26:14.741305 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '715a63be17d0' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('task', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('completed_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('task') + op.drop_table('goal') + # ### end Alembic commands ### diff --git a/migrations/versions/d7b3593add7a_sets_up_a_one_to_many_relationship_.py b/migrations/versions/d7b3593add7a_sets_up_a_one_to_many_relationship_.py new file mode 100644 index 000000000..3f00b6131 --- /dev/null +++ b/migrations/versions/d7b3593add7a_sets_up_a_one_to_many_relationship_.py @@ -0,0 +1,34 @@ +"""Sets up a one to many relationship between Task Model and Goal Model, + +Revision ID: d7b3593add7a +Revises: 5582fb314426 +Create Date: 2025-05-22 17:17:46.760560 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'd7b3593add7a' +down_revision = '5582fb314426' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.add_column(sa.Column('goal_id', sa.Integer(), nullable=True)) + batch_op.create_foreign_key(None, 'goal', ['goal_id'], ['id']) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.drop_constraint(None, type_='foreignkey') + batch_op.drop_column('goal_id') + + # ### end Alembic commands ### diff --git a/tests/conftest.py b/tests/conftest.py index a01499583..0333a95b7 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -45,6 +45,7 @@ def one_task(app): new_task = Task(title="Go on my daily walk 🏞", description="Notice something new every day", completed_at=None) + db.session.add(new_task) db.session.commit() diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 55475db79..2f8b3b393 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -1,9 +1,13 @@ +#from app.models.task import Task from app.models.task import Task from app.db import db import pytest +import sys +print(sys.path) -@pytest.mark.skip(reason="No way to test this feature yet") + +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_no_saved_tasks(client): # Act response = client.get("/tasks") @@ -14,7 +18,7 @@ def test_get_tasks_no_saved_tasks(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_one_saved_tasks(client, one_task): # Act response = client.get("/tasks") @@ -33,7 +37,7 @@ def test_get_tasks_one_saved_tasks(client, one_task): ] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_task(client, one_task): # Act response = client.get("/tasks/1") @@ -52,7 +56,7 @@ def test_get_task(client, one_task): } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_not_found(client): # Act response = client.get("/tasks/1") @@ -60,19 +64,19 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert "details" in response_body + assert response_body == { + "details": "Task with id 1 was not found." + } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ "title": "A Brand New Task", "description": "Test Description", + "completed_at": None }) response_body = response.get_json() @@ -97,7 +101,7 @@ def test_create_task(client): assert new_task.completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_update_task(client, one_task): # Act response = client.put("/tasks/1", json={ @@ -117,7 +121,7 @@ def test_update_task(client, one_task): -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_update_task_not_found(client): # Act response = client.put("/tasks/1", json={ @@ -128,14 +132,12 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == { + "details": "Task with id 1 was not found." + } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -146,7 +148,7 @@ def test_delete_task(client, one_task): query = db.select(Task).where(Task.id == 1) assert db.session.scalar(query) == None -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task_not_found(client): # Act response = client.delete("/tasks/1") @@ -154,16 +156,13 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - + assert response_body == { + "details": "Task with id 1 was not found." + } assert db.session.scalars(db.select(Task)).all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_title(client): # Act response = client.post("/tasks", json={ @@ -180,7 +179,7 @@ def test_create_task_must_contain_title(client): assert db.session.scalars(db.select(Task)).all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_description(client): # Act response = client.post("/tasks", json={ diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..c9a76e6b1 100644 --- a/tests/test_wave_02.py +++ b/tests/test_wave_02.py @@ -1,7 +1,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_sorted_asc(client, three_tasks): # Act response = client.get("/tasks?sort=asc") @@ -29,7 +29,7 @@ def test_get_tasks_sorted_asc(client, three_tasks): ] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_sorted_desc(client, three_tasks): # Act response = client.get("/tasks?sort=desc") diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index d7d441695..c878f3a7a 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -6,27 +6,16 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +#.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_incomplete_task(client, one_task): # Arrange - """ - The future Wave 4 adds special functionality to this route, - so for this test, we need to set-up "mocking." - Mocking will help our tests work in isolation, which is a - good thing! - - We need to mock any POST requests that may occur during this - test (due to Wave 4). - - There is no action needed here, the tests should work as-is. - """ with patch("requests.post") as mock_get: mock_get.return_value.status_code = 200 # Act - response = client.patch("/tasks/1/mark_complete") - + response = client.patch("/tasks/1/mark_complete", headers={"Content-Type": "application/json"}) + print(response.status_code, response.text) # Assert assert response.status_code == 204 @@ -34,7 +23,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): assert db.session.scalar(query).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_complete_task(client, completed_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -46,7 +35,7 @@ def test_mark_incomplete_on_complete_task(client, completed_task): assert db.session.scalar(query).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_completed_task(client, completed_task): # Arrange """ @@ -74,7 +63,7 @@ def test_mark_complete_on_completed_task(client, completed_task): query = db.select(Task).where(Task.id == 1) assert db.session.scalar(query).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_incomplete_task(client, one_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -86,7 +75,7 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): assert db.session.scalar(query).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_missing_task(client): # Act response = client.patch("/tasks/1/mark_complete") @@ -95,13 +84,12 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == { + "details": "Task with id 1 was not found." + } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_missing_task(client): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -110,7 +98,6 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response_body == { + "details": "Task with id 1 was not found." + } diff --git a/tests/test_wave_04.py b/tests/test_wave_04.py index d0b26b2d1..e69de29bb 100644 --- a/tests/test_wave_04.py +++ b/tests/test_wave_04.py @@ -1 +0,0 @@ -# There are no tests for wave 4. diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 222d10cf0..292859a92 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,9 @@ +from app.models.goal import Goal +from app.db import db import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +14,7 @@ def test_get_goals_no_saved_goals(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_one_saved_goal(client, one_goal): # Act response = client.get("/goals") @@ -29,7 +31,7 @@ def test_get_goals_one_saved_goal(client, one_goal): ] -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_goal(client, one_goal): # Act response = client.get("/goals/1") @@ -46,22 +48,23 @@ def test_get_goal(client, one_goal): } -@pytest.mark.skip(reason="test to be completed by student") +#@pytest.mark.skip(reason="test to be completed by student") def test_get_goal_not_found(client): - pass # Act response = client.get("/goals/1") response_body = response.get_json() - raise Exception("Complete test") # Assert # ---- Complete Test ---- - # assertion 1 goes here + assert response.status_code == 404 # assertion 2 goes here + assert response.get_json() == { + "details": "Goal with id 1 was not found." + } # ---- Complete Test ---- -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal(client): # Act response = client.post("/goals", json={ @@ -80,34 +83,40 @@ def test_create_goal(client): } -@pytest.mark.skip(reason="test to be completed by student") +#@pytest.mark.skip(reason="test to be completed by student") def test_update_goal(client, one_goal): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal title" + }) # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 204 + + query = db.select(Goal).where(Goal.id == 1) + goal = db.session.scalar(query) + + assert goal.title == "Updated Goal title" -@pytest.mark.skip(reason="test to be completed by student") +#@pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal title" + }) + + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == { + "details": "Goal with id 1 was not found." + } + -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -119,30 +128,24 @@ def test_delete_goal(client, one_goal): response = client.get("/goals/1") assert response.status_code == 404 - response_body = response.get_json() - assert "message" in response_body - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + query = db.select(Goal).where(Goal.id == 1) + assert db.session.scalar(query) == None - -@pytest.mark.skip(reason="test to be completed by student") +#@pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - raise Exception("Complete test") - # Act - # ---- Complete Act Here ---- + response = client.delete("/goals/1") + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert "details" in response_body + assert response_body == { + "details": "Goal with id 1 was not found." + } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal_missing_title(client): # Act response = client.post("/goals", json={}) diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 0317f835a..4e4d1601c 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -3,7 +3,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal(client, one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -25,7 +25,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(db.session.scalar(query).tasks) == 3 -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -45,7 +45,7 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on assert len(db.session.scalar(query).tasks) == 2 -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_goal(client): # Act response = client.get("/goals/1/tasks") @@ -53,14 +53,13 @@ def test_get_tasks_for_specific_goal_no_goal(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert "details" in response_body + assert response_body == { + "details": "Goal with id 1 was not found." + } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): # Act response = client.get("/goals/1/tasks") @@ -77,7 +76,7 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -102,7 +101,7 @@ def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +#@pytest.mark.skip(reason="No way to test this feature yet") def test_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): response = client.get("/tasks/1") response_body = response.get_json()