diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..ccd78b165 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,6 +1,9 @@ from flask import Flask from .db import db, migrate -from .models import task, goal +from .models.task import Task +from .models.goal import Goal +from .routes.task_routes import bp as tasks_bp +from .routes.goal_routes import bp as goals_bp import os def create_app(config=None): @@ -10,13 +13,13 @@ def create_app(config=None): app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') if config: - # Merge `config` into the app's configuration - # to override the app's default settings for testing app.config.update(config) db.init_app(app) migrate.init_app(app, db) # Register Blueprints here + app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) - return app + return app \ No newline at end of file diff --git a/app/models/goal.py b/app/models/goal.py index 44282656b..883b9a7fe 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,5 +1,14 @@ -from sqlalchemy.orm import Mapped, mapped_column -from ..db import db +from sqlalchemy.orm import Mapped, mapped_column, relationship +from app.db import db 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): + return {"id": self.id, "title": self.title} + + @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..a6f805191 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,30 @@ -from sqlalchemy.orm import Mapped, mapped_column +from datetime import datetime +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey +from typing import Optional from ..db import db class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + description: Mapped[str] + completed_at: Mapped[Optional[datetime]] + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") + + def to_dict(self): + task_to_dict = { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": True if self.completed_at else False + } + + if self.goal_id: + task_to_dict["goal_id"] = self.goal_id + + return task_to_dict + + @classmethod + def from_dict(cls, task_dict): + return Task(title=task_dict["title"] , description=task_dict["description"]) \ No newline at end of file diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..2619da5ee 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,84 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request, abort, make_response +from app.models.goal import Goal +from app.models.task import Task +from app.routes.route_utilities import create_model, validate_model +from app.db import db + +bp = Blueprint("goal_bp", __name__, url_prefix="/goals") + +@bp.post("") +def create_goal(): + response = create_model(Goal, request.get_json()) + return {"goal": response}, 201 + + +@bp.post("//tasks") +def add_tasks_to_goal(goal_id): + request_body = request.get_json() + goal = validate_model(Goal, goal_id) + + try: + task_ids = request_body["task_ids"] + for task_id in task_ids: + task = validate_model(Task, task_id) + goal.tasks.append(task) + + db.session.commit() + + except KeyError as error: + response = {"details": f"Invalid request: missing {error.args[0]}"} + abort(make_response(response, 400)) + + return {"id": goal.id, "task_ids": task_ids} + + +@bp.get("") +def view_goals(): + query = db.select(Goal).order_by(Goal.id) + goals = db.session.scalars(query) + + return [goal.to_dict() for goal in goals] + + +@bp.get("/") +def view_goal(goal_id): + goal = validate_model(Goal, goal_id) + return {"goal": goal.to_dict()} + + +@bp.get("//tasks") +def view_tasks_by_goal(goal_id): + goal = validate_model(Goal, goal_id) + + goal_dict = goal.to_dict() + goal_dict["tasks"] = [task.to_dict() for task in goal.tasks] + + return goal_dict + + +@bp.put("/") +def update_goal(goal_id): + goal = validate_model(Goal, goal_id) + + request_body = request.get_json() + try: + goal.title = request_body["title"] + db.session.commit() + + except KeyError as error: + response = {"details": f"Invalid request: missing {error.args[0]}"} + abort(make_response(response, 400)) + + return {"goal": goal.to_dict()} + + +@bp.delete("/") +def delete_goal(goal_id): + goal = validate_model(Goal, goal_id) + + db.session.delete(goal) + db.session.commit() + + response = f"Goal {goal_id} \"{goal.title}\" successfully deleted" + + return {"details": response} \ No newline at end of file diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py new file mode 100644 index 000000000..a88d2f545 --- /dev/null +++ b/app/routes/route_utilities.py @@ -0,0 +1,58 @@ +from flask import abort, make_response +from app.db import db +import os, requests +from dotenv import load_dotenv + +load_dotenv() + +API_KEY = os.environ.get("API_KEY") +CHANNEL_ID = os.environ.get("CHANNEL_ID") + +def create_model(cls, model_data): + try: + model = cls.from_dict(model_data) + + except KeyError as error: + response = {"details": f"Invalid data"} + abort(make_response(response, 400)) + + db.session.add(model) + db.session.commit() + + return model.to_dict() + + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + + except ValueError: + response = {"message": f"Invalid request: {cls.__name__} id {model_id} invalid"} + abort(make_response(response, 400)) + + query = db.select(cls).where(cls.id == model_id) + model = db.session.scalar(query) + if model: + return model + + response = {"message": f"Invalid request: {cls.__name__} {model_id} not found"} + abort(make_response(response, 404)) + + +def send_slack_message(task_title): + url = "https://slack.com/api/chat.postMessage" + headers = {"Authorization": f"Bearer {API_KEY}"} + request_body = { + "channel": CHANNEL_ID, + "text": f"Someone just completed the task {task_title}" + } + + try: + response = requests.post(url=url, headers=headers, json=request_body) + response.raise_for_status() + return response.json() + + except: + abort(make_response({"message": "Unknkown request"}, 400)) + + \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..4ef0f8b4a 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,78 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, request +from sqlalchemy import desc +from datetime import datetime +from app.routes.route_utilities import create_model, validate_model, send_slack_message +from app.models.task import Task +from app.db import db + + +bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + +@bp.post("") +def create_task(): + response = create_model(Task, request.get_json()) + return {"task": response}, 201 + + +@bp.get("") +def get_tasks(): + sort_param = request.args.get("sort") + query = db.select(Task) + + if sort_param == "desc": + query = query.order_by(desc(Task.title)) + else: + query = query.order_by(Task.title) + + tasks = db.session.scalars(query) + + return [task.to_dict() for task in tasks] + + +@bp.get("/") +def get_task_by_id(task_id): + task = validate_model(Task, task_id) + return {"task": task.to_dict()} + + +@bp.put("/") +def update_task(task_id): + task = validate_model(Task, task_id) + request_body = request.get_json() + + task.title = request_body.get("title", task.title) + task.description = request_body.get("description", task.description) + + db.session.commit() + + return {"task": task.to_dict()} + + +@bp.patch("//mark_complete") +def update_task_as_complete(task_id): + task = validate_model(Task, task_id) + task.completed_at = datetime.now() + db.session.commit() + + send_slack_message(task.title) + + return {"task": task.to_dict()} + + +@bp.patch("//mark_incomplete") +def update_task_as_incomplete(task_id): + task = validate_model(Task, task_id) + task.completed_at = None + db.session.commit() + + return {"task": task.to_dict()} + + +@bp.delete("/") +def delete_task(task_id): + task = validate_model(Task, task_id) + + db.session.delete(task) + db.session.commit() + + return {"details": f"Task {task_id} \"{task.title}\" successfully deleted"} 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/117660d70636_add_task_model.py b/migrations/versions/117660d70636_add_task_model.py new file mode 100644 index 000000000..4b11e7eb5 --- /dev/null +++ b/migrations/versions/117660d70636_add_task_model.py @@ -0,0 +1,39 @@ +"""Add Task model + +Revision ID: 117660d70636 +Revises: +Create Date: 2024-10-31 18:45:44.798098 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '117660d70636' +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/457a80026c3f_update_task_model.py b/migrations/versions/457a80026c3f_update_task_model.py new file mode 100644 index 000000000..4abcae8bf --- /dev/null +++ b/migrations/versions/457a80026c3f_update_task_model.py @@ -0,0 +1,38 @@ +"""Update Task model + +Revision ID: 457a80026c3f +Revises: 117660d70636 +Create Date: 2024-11-05 18:52:18.807853 + +""" +from alembic import op +import sqlalchemy as sa +from sqlalchemy.dialects import postgresql + +# revision identifiers, used by Alembic. +revision = '457a80026c3f' +down_revision = '117660d70636' +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.alter_column('completed_at', + existing_type=postgresql.TIMESTAMP(), + type_=sa.Date(), + existing_nullable=True) + + # ### 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.alter_column('completed_at', + existing_type=sa.Date(), + type_=postgresql.TIMESTAMP(), + existing_nullable=True) + + # ### end Alembic commands ### diff --git a/migrations/versions/8607dc03f9f9_revert_changes_to_task_model.py b/migrations/versions/8607dc03f9f9_revert_changes_to_task_model.py new file mode 100644 index 000000000..7e13029ef --- /dev/null +++ b/migrations/versions/8607dc03f9f9_revert_changes_to_task_model.py @@ -0,0 +1,38 @@ +"""Revert changes to Task model + +Revision ID: 8607dc03f9f9 +Revises: 457a80026c3f +Create Date: 2024-11-05 19:24:17.030192 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '8607dc03f9f9' +down_revision = '457a80026c3f' +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.alter_column('completed_at', + existing_type=sa.DATE(), + type_=sa.DateTime(), + existing_nullable=True) + + # ### 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.alter_column('completed_at', + existing_type=sa.DateTime(), + type_=sa.DATE(), + existing_nullable=True) + + # ### end Alembic commands ### diff --git a/migrations/versions/90d5f7e5da48_add_relationship_between_task_and_goal_.py b/migrations/versions/90d5f7e5da48_add_relationship_between_task_and_goal_.py new file mode 100644 index 000000000..a829e18c4 --- /dev/null +++ b/migrations/versions/90d5f7e5da48_add_relationship_between_task_and_goal_.py @@ -0,0 +1,34 @@ +"""Add relationship between task and goal models + +Revision ID: 90d5f7e5da48 +Revises: e1b19a6219cf +Create Date: 2024-11-06 17:40:55.357341 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '90d5f7e5da48' +down_revision = 'e1b19a6219cf' +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/migrations/versions/e1b19a6219cf_add_goal_model.py b/migrations/versions/e1b19a6219cf_add_goal_model.py new file mode 100644 index 000000000..718e400ad --- /dev/null +++ b/migrations/versions/e1b19a6219cf_add_goal_model.py @@ -0,0 +1,32 @@ +"""Add Goal model + +Revision ID: e1b19a6219cf +Revises: 8607dc03f9f9 +Create Date: 2024-11-06 06:10:46.839843 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e1b19a6219cf' +down_revision = '8607dc03f9f9' +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/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..6e658e266 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -1,25 +1,22 @@ from app.models.task import Task +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_tasks_no_saved_tasks(client): - # Act response = client.get("/tasks") response_body = response.get_json() - # Assert assert response.status_code == 200 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert len(response_body) == 1 assert response_body == [ @@ -32,13 +29,11 @@ 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert "task" in response_body assert response_body == { @@ -51,31 +46,24 @@ 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") response_body = response.get_json() - # Assert assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": f"Invalid request: Task 1 not found"} - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about 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_create_task(client): - # Act response = client.post("/tasks", json={ "title": "A Brand New Task", "description": "Test Description", }) response_body = response.get_json() - # Assert assert response.status_code == 201 assert "task" in response_body assert response_body == { @@ -86,23 +74,21 @@ def test_create_task(client): "is_complete": False } } - new_task = Task.query.get(1) + new_task = db.session.get(Task,1) assert new_task assert new_task.title == "A Brand New Task" assert new_task.description == "Test Description" 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={ "title": "Updated Task Title", "description": "Updated Test Description", }) response_body = response.get_json() - # Assert assert response.status_code == 200 assert "task" in response_body assert response_body == { @@ -113,91 +99,68 @@ def test_update_task(client, one_task): "is_complete": False } } - task = Task.query.get(1) + task = db.session.get(Task, 1) assert task.title == "Updated Task Title" assert task.description == "Updated Test Description" assert 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_not_found(client): - # Act response = client.put("/tasks/1", json={ "title": "Updated Task Title", "description": "Updated Test Description", }) response_body = response.get_json() - # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert "message" in response_body + assert response_body == {"message": f"Invalid request: Task 1 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert "details" in response_body - assert response_body == { - "details": 'Task 1 "Go on my daily walk 🏞" successfully deleted' - } - assert Task.query.get(1) == None + assert response_body == {"details": 'Task 1 "Go on my daily walk 🏞" successfully deleted'} + assert db.session.get(Task, 1) == 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") response_body = response.get_json() - # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** - + assert "message" in response_body + assert response_body == {"message": f"Invalid request: Task 1 not found"} assert Task.query.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={ "description": "Test Description" }) response_body = response.get_json() - # Assert assert response.status_code == 400 assert "details" in response_body - assert response_body == { - "details": "Invalid data" - } + assert response_body == {"details": "Invalid data"} assert Task.query.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={ "title": "A Brand New Task" }) response_body = response.get_json() - # Assert assert response.status_code == 400 assert "details" in response_body - assert response_body == { - "details": "Invalid data" - } + assert response_body == {"details": "Invalid data"} assert Task.query.all() == [] diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..d41f0297d 100644 --- a/tests/test_wave_02.py +++ b/tests/test_wave_02.py @@ -1,13 +1,11 @@ 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert len(response_body) == 3 assert response_body == [ @@ -29,13 +27,11 @@ 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert len(response_body) == 3 assert response_body == [ diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..ee6f00dd9 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -2,32 +2,17 @@ from unittest.mock import Mock, patch from datetime import datetime from app.models.task import Task +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_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_body = response.get_json() - # Assert assert response.status_code == 200 assert "task" in response_body assert response_body["task"]["is_complete"] == True @@ -39,16 +24,14 @@ def test_mark_complete_on_incomplete_task(client, one_task): "is_complete": True } } - assert Task.query.get(1).completed_at + assert db.session.get(Task, 1).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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert response_body["task"]["is_complete"] == False assert response_body == { @@ -59,32 +42,17 @@ def test_mark_incomplete_on_complete_task(client, completed_task): "is_complete": False } } - assert Task.query.get(1).completed_at == None + assert db.session.get(Task, 1).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 - """ - 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_body = response.get_json() - # Assert assert response.status_code == 200 assert "task" in response_body assert response_body["task"]["is_complete"] == True @@ -96,16 +64,14 @@ def test_mark_complete_on_completed_task(client, completed_task): "is_complete": True } } - assert Task.query.get(1).completed_at + assert db.session.get(Task, 1).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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert response_body["task"]["is_complete"] == False assert response_body == { @@ -116,34 +82,24 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): "is_complete": False } } - assert Task.query.get(1).completed_at == None + assert db.session.get(Task, 1).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") response_body = response.get_json() - # Assert assert response.status_code == 404 + assert not "task" in response_body + assert response_body == {"message": f"Invalid request: Task 1 not found"} + - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about 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_mark_incomplete_missing_task(client): - # Act response = client.patch("/tasks/1/mark_incomplete") response_body = response.get_json() - # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert not "task" in response_body + assert response_body == {"message": f"Invalid request: Task 1 not found"} \ No newline at end of file diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index aee7c52a1..aeaefc1fd 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,24 +1,22 @@ import pytest +from app.models.goal import Goal +from app.db import db -@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") response_body = response.get_json() - # Assert assert response.status_code == 200 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert len(response_body) == 1 assert response_body == [ @@ -29,13 +27,11 @@ 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert "goal" in response_body assert response_body == { @@ -46,24 +42,19 @@ 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 - # assertion 2 goes here - # ---- Complete Test ---- + assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Invalid request: Goal 1 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(client): - # Act response = client.post("/goals", json={ "title": "My New Goal" }) @@ -80,78 +71,66 @@ 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": "Grab broccoli on the way home" + }) + response_body = response.get_json() - # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 200 + assert "goal" in response_body + assert response_body == {"goal": {"title": "Grab broccoli on the way home", "id": 1}} + goal = db.session.get(Goal, 1) + assert goal.title == "Grab broccoli on the way home" -@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": "Send invitations" + }) + 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 "message" in response_body + assert response_body == {"message": "Invalid request: Goal 1 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert "details" in response_body - assert response_body == { - "details": 'Goal 1 "Build a habit of going outside daily" successfully deleted' - } + assert response_body == {"details": 'Goal 1 "Build a habit of going outside daily" successfully deleted'} # Check that the goal was deleted response = client.get("/goals/1") - assert response.status_code == 404 + response_body = response.get_json() - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about response body*************** - # ***************************************************************** + assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Invalid request: Goal 1 not found"} -@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") + response = client.delete("/goals/1") + response_body = response.get_json() - # Act - # ---- Complete Act Here ---- + assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Invalid request: Goal 1 not found"} - # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- -@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={}) response_body = response.get_json() - # Assert assert response.status_code == 400 - assert response_body == { - "details": "Invalid data" - } + assert response_body == {"details": "Invalid data"} diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..1120e8a28 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -1,16 +1,15 @@ 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_post_task_ids_to_goal(client, one_goal, three_tasks): - # Act response = client.post("/goals/1/tasks", json={ "task_ids": [1, 2, 3] }) response_body = response.get_json() - # Assert assert response.status_code == 200 assert "id" in response_body assert "task_ids" in response_body @@ -20,18 +19,16 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): } # Check that Goal was updated in the db - assert len(Goal.query.get(1).tasks) == 3 + assert len(db.session.get(Goal, 1).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={ "task_ids": [1, 4] }) response_body = response.get_json() - # Assert assert response.status_code == 200 assert "id" in response_body assert "task_ids" in response_body @@ -39,31 +36,24 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on "id": 1, "task_ids": [1, 4] } - assert len(Goal.query.get(1).tasks) == 2 + assert len(db.session.get(Goal, 1).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") response_body = response.get_json() - # Assert assert response.status_code == 404 + assert "message" in response_body + assert response_body == {"message": "Invalid request: Goal 1 not found"} - raise Exception("Complete test with assertion about response body") - # ***************************************************************** - # **Complete test with assertion about 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_for_specific_goal_no_tasks(client, one_goal): - # Act response = client.get("/goals/1/tasks") response_body = response.get_json() - # Assert assert response.status_code == 200 assert "tasks" in response_body assert len(response_body["tasks"]) == 0 @@ -74,13 +64,11 @@ 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") response_body = response.get_json() - # Assert assert response.status_code == 200 assert "tasks" in response_body assert len(response_body["tasks"]) == 1 @@ -99,7 +87,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()