From 73864329355984a2cc10bc373489e1759d67a59e Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 16:24:33 +1300 Subject: [PATCH 01/29] Initial project set up --- migrations/README | 1 + migrations/alembic.ini | 50 +++++++++++++++++ migrations/env.py | 113 ++++++++++++++++++++++++++++++++++++++ migrations/script.py.mako | 24 ++++++++ 4 files changed, 188 insertions(+) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako 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"} From be9c751a91eab1b0faca25c8bf3459735d48429d Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 16:36:19 +1300 Subject: [PATCH 02/29] Mapped attributes for Task class. --- app/models/task.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..85219d5ec 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,11 @@ from sqlalchemy.orm import Mapped, mapped_column from ..db import db +from typing import Optional +from datetime import datetime + 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]] From 690c40befac85e814b3a241de14ea2d7005d10de Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 16:39:54 +1300 Subject: [PATCH 03/29] Added blueprint instance for /tasks --- app/routes/task_routes.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..cf45ad697 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,3 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint + +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") From 039c24d06667d7b286592ebe4df035aca2cd3621 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 16:44:15 +1300 Subject: [PATCH 04/29] Registered blueprint --- app/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..a356fed22 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -2,6 +2,7 @@ from .db import db, migrate from .models import task, goal import os +from .routes.task_routes import tasks_bp def create_app(config=None): app = Flask(__name__) @@ -18,5 +19,6 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here + app.register_blueprint(tasks_bp) return app From 1d93b7b7977bf0af16fe16c7cd37557cca366ac5 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 17:02:55 +1300 Subject: [PATCH 05/29] Added POST request for /tasks --- app/routes/task_routes.py | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index cf45ad697..dc417d01d 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,3 +1,24 @@ -from flask import Blueprint +from flask import Blueprint, abort, make_response, request +from app.models.task import Task +from ..db import db tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + +@tasks_bp.post("") +def create_task(): + request_body = request.get_json() + title = request_body["title"] + description = request_body["description"] + completed_at = request_body["completed_at"] + + new_task = Task(title=title, description=description, completed_at=completed_at) + db.session.add(new_task) + db.session.commit() + + response = { + "id": new_task.id, + "title": new_task.title, + "description": new_task.description, + "completed_at": completed_at + } + return response, 201 \ No newline at end of file From 858df5aceb5f270c949b80bb0455fb8efca7cdc0 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 17:08:18 +1300 Subject: [PATCH 06/29] Updated attribute is_complete --- app/routes/task_routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index dc417d01d..61d4b760d 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -9,7 +9,7 @@ def create_task(): request_body = request.get_json() title = request_body["title"] description = request_body["description"] - completed_at = request_body["completed_at"] + completed_at = request_body["is_complete"] new_task = Task(title=title, description=description, completed_at=completed_at) db.session.add(new_task) @@ -19,6 +19,6 @@ def create_task(): "id": new_task.id, "title": new_task.title, "description": new_task.description, - "completed_at": completed_at + "is_complete": completed_at } return response, 201 \ No newline at end of file From 2cc6f12a29cd923f5ab65e5e7e7b43e2306dff3f Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 17:15:28 +1300 Subject: [PATCH 07/29] Added get all tasks function to /tasks --- app/routes/task_routes.py | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 61d4b760d..10020c502 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -21,4 +21,21 @@ def create_task(): "description": new_task.description, "is_complete": completed_at } - return response, 201 \ No newline at end of file + return response, 201 + +@tasks_bp.get("") +def get_all_tasks(): + query = db.select(Task).order_by(Task.id) + tasks = db.session.scalars(query) + + tasks_response = [] + for task in tasks: + tasks_response.append( + { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at + } + ) + return tasks_response \ No newline at end of file From 6e1dab6035db1e0b79bf66590ac4fd035582937f Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 17:28:55 +1300 Subject: [PATCH 08/29] Added get one task to /task --- app/routes/task_routes.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 10020c502..a2f92cb6e 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -38,4 +38,17 @@ def get_all_tasks(): "is_complete": task.completed_at } ) - return tasks_response \ No newline at end of file + return tasks_response + + +@tasks_bp.get("/") +def get_one_task(task_id): + query = db.select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + return { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at + } \ No newline at end of file From 53a933af3d80fa420c33a8ce46855201994e33da Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 17:34:05 +1300 Subject: [PATCH 09/29] Added validate task to check if id is an int, created response body for 400 invalid response and 404 not found response. --- app/routes/task_routes.py | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index a2f92cb6e..bb1ef8195 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -43,12 +43,27 @@ def get_all_tasks(): @tasks_bp.get("/") def get_one_task(task_id): - query = db.select(Task).where(Task.id == task_id) - task = db.session.scalar(query) + task = validate_task(task_id) return { "id": task.id, "title": task.title, "description": task.description, "is_complete": task.completed_at - } \ No newline at end of file + } + +def validate_task(task_id): + try: + task_id = int(task_id) + except: + response = {"message": f"task {task_id} invalid"} + abort(make_response(response , 400)) + + query = db.select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + if not task: + response = {"message": f"task {task_id} not found"} + abort(make_response(response, 404)) + + return task \ No newline at end of file From 8c16efec2103e37eecb354b5e30c455657847bce Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 17:41:46 +1300 Subject: [PATCH 10/29] Added put request to update a task in /task --- app/routes/task_routes.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index bb1ef8195..66b05cbc2 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint, abort, make_response, request +from flask import Blueprint, abort, make_response, request, Response from app.models.task import Task from ..db import db @@ -66,4 +66,16 @@ def validate_task(task_id): response = {"message": f"task {task_id} not found"} abort(make_response(response, 404)) - return task \ No newline at end of file + return task + +@tasks_bp.put("/") +def update_task(task_id): + task = validate_task(task_id) + request_body = request.get_json() + + task.title = request_body["title"] + task.description = request_body["description"] + task.completed_at = request_body["is_complete"] + db.session.commit() + + return Response(status=204, mimetype="application/json") \ No newline at end of file From 2e862e96c3864e9983694bd5811e5c187ca82e3b Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 17:46:13 +1300 Subject: [PATCH 11/29] Added delete request in /tasks --- app/routes/task_routes.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 66b05cbc2..595e18b9b 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -78,4 +78,12 @@ def update_task(task_id): task.completed_at = request_body["is_complete"] db.session.commit() + return Response(status=204, mimetype="application/json") + +@tasks_bp.delete("/") +def delete_task(task_id): + task = validate_task(task_id) + db.session.delete(task) + db.session.commit() + return Response(status=204, mimetype="application/json") \ No newline at end of file From 50194e1e20f3f4383be48df59fccfe7d276b9bac Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 18:06:00 +1300 Subject: [PATCH 12/29] added to_dict to refactor the response body for create task, get all tasks, and get one task --- app/models/task.py | 8 ++++++ app/routes/task_routes.py | 59 +++++++++++++-------------------------- 2 files changed, 28 insertions(+), 39 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 85219d5ec..544c51826 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -9,3 +9,11 @@ class Task(db.Model): title: Mapped[str] description: Mapped[str] completed_at: Mapped[Optional[datetime]] + + def to_dict(self): + return dict( + id=self.id, + title=self.title, + description=self.description, + completed_at=self.completed_at + ) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 595e18b9b..f4c41e942 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -15,12 +15,7 @@ def create_task(): db.session.add(new_task) db.session.commit() - response = { - "id": new_task.id, - "title": new_task.title, - "description": new_task.description, - "is_complete": completed_at - } + response = new_task.to_dict() return response, 201 @tasks_bp.get("") @@ -28,16 +23,7 @@ def get_all_tasks(): query = db.select(Task).order_by(Task.id) tasks = db.session.scalars(query) - tasks_response = [] - for task in tasks: - tasks_response.append( - { - "id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.completed_at - } - ) + tasks_response = [task.to_dict() for task in tasks] return tasks_response @@ -45,28 +31,7 @@ def get_all_tasks(): def get_one_task(task_id): task = validate_task(task_id) - return { - "id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.completed_at - } - -def validate_task(task_id): - try: - task_id = int(task_id) - except: - response = {"message": f"task {task_id} invalid"} - abort(make_response(response , 400)) - - query = db.select(Task).where(Task.id == task_id) - task = db.session.scalar(query) - - if not task: - response = {"message": f"task {task_id} not found"} - abort(make_response(response, 404)) - - return task + return task.to_dict() @tasks_bp.put("/") def update_task(task_id): @@ -86,4 +51,20 @@ def delete_task(task_id): db.session.delete(task) db.session.commit() - return Response(status=204, mimetype="application/json") \ No newline at end of file + return Response(status=204, mimetype="application/json") + +def validate_task(task_id): + try: + task_id = int(task_id) + except: + response = {"message": f"task {task_id} invalid"} + abort(make_response(response , 400)) + + query = db.select(Task).where(Task.id == task_id) + task = db.session.scalar(query) + + if not task: + response = {"message": f"task {task_id} not found"} + abort(make_response(response, 404)) + + return task \ No newline at end of file From a114dd6a6103692ef1eaa15530e886de6bb39d44 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Tue, 5 Nov 2024 18:19:04 +1300 Subject: [PATCH 13/29] added query params to get all tasks --- app/routes/task_routes.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index f4c41e942..68b5354b6 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -20,8 +20,17 @@ def create_task(): @tasks_bp.get("") def get_all_tasks(): - query = db.select(Task).order_by(Task.id) - tasks = db.session.scalars(query) + query = db.select(Task) + + title_param = request.args.get("title") + if title_param: + query = query.where(Task.title.ilike(f"%{title_param}%")) + + description_param = request.args.get("description") + if description_param: + query = query.where(Task.description.ilike(f"%{description_param}%")) + + tasks = db.session.scalars(query.order_by(Task.id)) tasks_response = [task.to_dict() for task in tasks] return tasks_response From 41797aefc5b97cfa9668be8322f8456c43e9d9b1 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Wed, 6 Nov 2024 11:22:11 +1300 Subject: [PATCH 14/29] added a KeyError response to create_task and adjusted the response to pass test_create_task --- app/models/task.py | 23 ++++++++++++++++------- app/routes/task_routes.py | 35 +++++++++++++++++++++++------------ 2 files changed, 39 insertions(+), 19 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 544c51826..916ace072 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -8,12 +8,21 @@ 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]] + completed_at: Mapped[Optional[datetime]] = mapped_column(nullable=True) def to_dict(self): - return dict( - id=self.id, - title=self.title, - description=self.description, - completed_at=self.completed_at - ) + return { + "id":self.id, + "title":self.title, + "description":self.description, + "is_complete":self.completed_at is not None + } + + @classmethod + def from_dict(cls, task_data): + completed_at = datetime if task_data.get("is_complete", False) else None + return cls( + title=task_data["title"], + description=task_data["description"], + completed_at=completed_at + ) \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 68b5354b6..6c468b1d9 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,21 +2,24 @@ from app.models.task import Task from ..db import db + tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @tasks_bp.post("") def create_task(): request_body = request.get_json() - title = request_body["title"] - description = request_body["description"] - completed_at = request_body["is_complete"] + + try: + new_task = Task.from_dict(request_body) + + except KeyError as e: + response = {"details": "Invalid data"} + abort(make_response(response, 400)) - new_task = Task(title=title, description=description, completed_at=completed_at) db.session.add(new_task) db.session.commit() - response = new_task.to_dict() - return response, 201 + return {"task": new_task.to_dict()}, 201 @tasks_bp.get("") def get_all_tasks(): @@ -40,7 +43,7 @@ def get_all_tasks(): def get_one_task(task_id): task = validate_task(task_id) - return task.to_dict() + return {"task": task.to_dict()}, 200 @tasks_bp.put("/") def update_task(task_id): @@ -49,10 +52,18 @@ def update_task(task_id): task.title = request_body["title"] task.description = request_body["description"] - task.completed_at = request_body["is_complete"] + db.session.commit() - return Response(status=204, mimetype="application/json") + response_body = { + "task": { + "id": task.id, + "title": task.title, + "description": task.description, + "is_complete": task.completed_at is not None + } + } + return response_body @tasks_bp.delete("/") def delete_task(task_id): @@ -60,7 +71,8 @@ def delete_task(task_id): db.session.delete(task) db.session.commit() - return Response(status=204, mimetype="application/json") + response_body = {"details": f'Task {task_id} "{task.title}" successfully deleted'} + return response_body def validate_task(task_id): try: @@ -73,7 +85,6 @@ def validate_task(task_id): task = db.session.scalar(query) if not task: - response = {"message": f"task {task_id} not found"} + response = {"message": "task not found"} abort(make_response(response, 404)) - return task \ No newline at end of file From 51008a219593b1707b7d3cb78e207317e69fd3e0 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Wed, 6 Nov 2024 11:27:40 +1300 Subject: [PATCH 15/29] Added asserts to incomplete test for wave 1 --- tests/test_wave_01.py | 41 ++++++++++++++++++++++++----------------- 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..3e0932b05 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -2,7 +2,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_no_saved_tasks(client): # Act response = client.get("/tasks") @@ -13,7 +13,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") @@ -32,7 +32,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") @@ -51,7 +51,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") @@ -59,14 +59,16 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == { + "message": "task 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={ @@ -93,7 +95,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={ @@ -119,7 +121,7 @@ def test_update_task(client, one_task): 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={ @@ -130,14 +132,16 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == { + "message": "task 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_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -152,16 +156,19 @@ def test_delete_task(client, one_task): assert Task.query.get(1) == None -@pytest.mark.skip(reason="No way to test this feature yet") -def test_delete_task_not_found(client): +# @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 + assert response_body == { + "message": "task not found" + } - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** @@ -169,7 +176,7 @@ def test_delete_task_not_found(client): 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={ @@ -186,7 +193,7 @@ def test_create_task_must_contain_title(client): 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={ From 7894b20de5f1a6dbc105e9e245390eb6a65951fc Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Wed, 6 Nov 2024 12:32:47 +1300 Subject: [PATCH 16/29] added a sort param to order titles in asc and desc --- app/routes/task_routes.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 6c468b1d9..437c69f6c 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -33,7 +33,14 @@ def get_all_tasks(): if description_param: query = query.where(Task.description.ilike(f"%{description_param}%")) - tasks = db.session.scalars(query.order_by(Task.id)) + sort_param = request.args.get("sort") + if sort_param == "desc": + query = query.order_by(Task.title.desc()) + else: + query = query.order_by(Task.title.asc()) + + + tasks = db.session.scalars(query.order_by(Task.title)) tasks_response = [task.to_dict() for task in tasks] return tasks_response From 0b1c748920efdb46c3a4cd165263c1420da331d7 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Wed, 6 Nov 2024 12:34:06 +1300 Subject: [PATCH 17/29] wave 2 test file --- tests/test_wave_02.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..651e3aebd 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") From 37daef107d99206f7a4a04804605dc77beaf910f Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 12:29:00 +1300 Subject: [PATCH 18/29] Added code for incomplete and complete function --- app/models/task.py | 8 +++++++- app/routes/task_routes.py | 22 ++++++++++++++++++++++ tests/test_wave_03.py | 18 ++++++++++-------- 3 files changed, 39 insertions(+), 9 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 916ace072..a4f890b1f 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -25,4 +25,10 @@ def from_dict(cls, task_data): title=task_data["title"], description=task_data["description"], completed_at=completed_at - ) \ No newline at end of file + ) + + def mark_complete(self): + self.completed_at = datetime.now() + + def mark_incomplete(self): + self.completed_at = None \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 437c69f6c..8097cfd97 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,6 +1,7 @@ from flask import Blueprint, abort, make_response, request, Response from app.models.task import Task from ..db import db +from datetime import datetime tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -81,6 +82,27 @@ def delete_task(task_id): response_body = {"details": f'Task {task_id} "{task.title}" successfully deleted'} return response_body +@tasks_bp.patch("//mark_complete") +def mark_complete(task_id): + task = validate_task(task_id) + + task.mark_complete() + db.session.commit() + + return {"task": task.to_dict()}, 200 + + +@tasks_bp.patch("//mark_incomplete") +def mark_incomplete(task_id): + task = validate_task(task_id) + + task.mark_incomplete() + db.session.commit() + + return {"task" : task.to_dict()}, 200 + + + def validate_task(task_id): try: task_id = int(task_id) diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..b9b4a6476 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -5,7 +5,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_mark_complete_on_incomplete_task(client, one_task): # Arrange """ @@ -42,7 +42,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): assert Task.query.get(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") @@ -62,7 +62,7 @@ def test_mark_incomplete_on_complete_task(client, completed_task): assert Task.query.get(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 """ @@ -99,7 +99,7 @@ def test_mark_complete_on_completed_task(client, completed_task): assert Task.query.get(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") @@ -119,7 +119,7 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): assert Task.query.get(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") @@ -127,14 +127,15 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "task not found"} - raise Exception("Complete test with assertion about response body") + # 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") @@ -142,8 +143,9 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "task not found"} - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** From dc81387a8a07c9d082166d0fba617035e9e73eef Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 12:46:56 +1300 Subject: [PATCH 19/29] refactored response body for update function --- app/routes/task_routes.py | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 8097cfd97..3cc8842fa 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -63,15 +63,8 @@ def update_task(task_id): db.session.commit() - response_body = { - "task": { - "id": task.id, - "title": task.title, - "description": task.description, - "is_complete": task.completed_at is not None - } - } - return response_body + response_body = {"task":task.to_dict()} + return response_body, 200 @tasks_bp.delete("/") def delete_task(task_id): From d2efd56a87f6bc564b634750bc2a0ca3a11299f9 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 16:26:02 +1300 Subject: [PATCH 20/29] Added create task function in /goals --- app/__init__.py | 4 ++++ app/models/goal.py | 12 ++++++++++ app/routes/goal_routes.py | 21 +++++++++++++++- app/routes/task_routes.py | 36 +++++++++++++++++++++++++--- migrations/versions/0e59237c7b0c_.py | 32 +++++++++++++++++++++++++ tests/test_wave_05.py | 4 ++-- 6 files changed, 103 insertions(+), 6 deletions(-) create mode 100644 migrations/versions/0e59237c7b0c_.py diff --git a/app/__init__.py b/app/__init__.py index a356fed22..a10ecad15 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -3,6 +3,9 @@ from .models import task, goal import os from .routes.task_routes import tasks_bp +from .routes.goal_routes import goals_bp + + def create_app(config=None): app = Flask(__name__) @@ -20,5 +23,6 @@ def create_app(config=None): # 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..4c6182fec 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -3,3 +3,15 @@ class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + + def to_dict(self): + return { + "id":self.id, + "title":self.title, + } + + @classmethod + def from_dict(cls, goal_data): + new_goal = cls(title=goal_data["title"]) + return new_goal \ No newline at end of file diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..7483c8539 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,20 @@ -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 ..db import db + +goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + +@goals_bp.post("") +def create_goal(): + request_body = request.get_json() + + try: + new_goal = Goal.from_dict(request_body) + except KeyError as error: + response = {"details": "Invalid data"} + abort(make_response(response, 400)) + + db.session.add(new_goal) + db.session.commit() + + return {"goal":new_goal.to_dict()}, 201 diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3cc8842fa..6e87b1caf 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,10 +2,17 @@ from app.models.task import Task from ..db import db from datetime import datetime - +import requests +import os +from dotenv import load_dotenv +load_dotenv() tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") +# slack URL +SLACK_API_URL = os.environ.get('SLACK_API_URL') +SLACK_API_TOKEN = os.environ.get('SLACK_API_TOCKEN') + @tasks_bp.post("") def create_task(): request_body = request.get_json() @@ -81,7 +88,9 @@ def mark_complete(task_id): task.mark_complete() db.session.commit() - + + post_to_slack(task) + return {"task": task.to_dict()}, 200 @@ -109,4 +118,25 @@ def validate_task(task_id): if not task: response = {"message": "task not found"} abort(make_response(response, 404)) - return task \ No newline at end of file + return task + +def post_to_slack(task): + headers = { + "Authorization": f"Bearer {SLACK_API_TOKEN}", + "Content-Type": "application/json", + + } + if task.completed_at: + data = { + "text": f"Task '{task.title}' has been marked complete", + "channel": "C080MLHBX5W", + } + else: + data = { + "text": f"Task '{task.title}' has been marked incomplete", + "channel": "C080MLHBX5W", + } + + r = requests.post(SLACK_API_URL, headers=headers, json=data) + + return r \ No newline at end of file diff --git a/migrations/versions/0e59237c7b0c_.py b/migrations/versions/0e59237c7b0c_.py new file mode 100644 index 000000000..35adccda5 --- /dev/null +++ b/migrations/versions/0e59237c7b0c_.py @@ -0,0 +1,32 @@ +"""empty message + +Revision ID: 0e59237c7b0c +Revises: +Create Date: 2024-11-08 15:42:03.089793 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0e59237c7b0c' +down_revision = None +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_05.py b/tests/test_wave_05.py index aee7c52a1..0e96c850b 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -61,7 +61,7 @@ def test_get_goal_not_found(client): # ---- 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={ @@ -144,7 +144,7 @@ def test_delete_goal_not_found(client): # ---- 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={}) From 4abd4138170d9d08a89cd8ac2d035a1b48ef1b95 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 16:47:16 +1300 Subject: [PATCH 21/29] added get all method for /goals --- app/routes/goal_routes.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 7483c8539..7101d2200 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -18,3 +18,16 @@ def create_goal(): db.session.commit() return {"goal":new_goal.to_dict()}, 201 + +@goals_bp.get("") +def get_all_goals(): + query = db.select(Goal) + + title_param = request.args.get("title") + if title_param: + query = query.where(Goal.title.ilike(f"%({title_param}%")) + + goals = db.session.scalars(query.order_by(Goal.id)) + goals_response = [goal.to_dict() for goal in goals] + + return goals_response \ No newline at end of file From 5156434ef889f8816241d9f45f12ca850fd5ae3b Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 17:08:19 +1300 Subject: [PATCH 22/29] added get one goal to /goals and added validate id function --- app/routes/goal_routes.py | 23 ++++++++++++++++++++++- tests/test_wave_05.py | 13 ++++++++----- 2 files changed, 30 insertions(+), 6 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 7101d2200..3e91c5481 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -30,4 +30,25 @@ def get_all_goals(): goals = db.session.scalars(query.order_by(Goal.id)) goals_response = [goal.to_dict() for goal in goals] - return goals_response \ No newline at end of file + return goals_response + +@goals_bp.get("/") +def get_one_goal(goal_id): + goal = validate_goal(goal_id) + + return {"goal": goal.to_dict()}, 200 + +def validate_goal(goal_id): + try: + goal_id = int(goal_id) + except: + response = {"message": f"goal {goal_id} invalid"} + abort(make_response(response , 400)) + + query = db.select(Goal).where(Goal.id == goal_id) + goal = db.session.scalar(query) + + if not goal: + response = {"message": "goal not found"} + abort(make_response(response, 404)) + return goal \ No newline at end of file diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 0e96c850b..72b80323c 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.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_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +12,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 +29,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,14 +46,17 @@ 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 response_body == { + "message": "goal not found" + } + # raise Exception("Complete test") # Assert # ---- Complete Test ---- # assertion 1 goes here From 9b0f16800bc9ea6ef2170ea69ae266bf4a6f8ab0 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 17:32:50 +1300 Subject: [PATCH 23/29] added post update task on /goals and completed the update goal wave 5 tests --- app/routes/goal_routes.py | 14 +++++++++++++- tests/test_wave_05.py | 36 +++++++++++++++++++++++++----------- 2 files changed, 38 insertions(+), 12 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3e91c5481..90c73023f 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -51,4 +51,16 @@ def validate_goal(goal_id): if not goal: response = {"message": "goal not found"} abort(make_response(response, 404)) - return goal \ No newline at end of file + return goal + +@goals_bp.put("/") +def update_goal(goal_id): + goal = validate_goal(goal_id) + request_body = request.get_json() + + goal.title = request_body["title"] + + db.session.commit() + + response_body = {"goal": goal.to_dict()} + return response_body, 200 \ No newline at end of file diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 72b80323c..4443d6cd0 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -83,30 +83,44 @@ 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") + + # raise Exception("Complete test") # Act # ---- Complete Act Here ---- - + response = client.put("/goals/1", json={ + "title": "Build a habit of going outside daily" + }) # Assert + response_body = response.get_json() # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here + assert response.status_code == 200 + assert "goal" in response_body + assert response_body == { + "goal" : { + "id": 1, + "title": "Build a habit of going outside daily" + } + } # ---- Complete Assertions Here ---- -@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") + # raise Exception("Complete test") # Act # ---- Complete Act Here ---- - + response = client.put("/goals/1", json={ + "title" :"Update Task Title" + }) # Assert + response_body = response.get_json() # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert response_body == { + "message" : "goal not found" + } # ---- Complete Assertions Here ---- From 26e2e2af79dc672d7945b2a47793f1dc594f99f9 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 18:16:27 +1300 Subject: [PATCH 24/29] added delete function to /goals and updated incomplete tests for wave 5 --- app/routes/goal_routes.py | 11 ++++++++++- tests/test_wave_05.py | 25 ++++++++++++++++++------- 2 files changed, 28 insertions(+), 8 deletions(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 90c73023f..3708161a3 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -63,4 +63,13 @@ def update_goal(goal_id): db.session.commit() response_body = {"goal": goal.to_dict()} - return response_body, 200 \ No newline at end of file + return response_body, 200 + +@goals_bp.delete("/") +def delete_goal(goal_id): + goal = validate_goal(goal_id) + db.session.delete(goal) + db.session.commit() + + response_body = {"details": f'Goal {goal_id} "{goal.title}" successfully deleted'} + return response_body \ No newline at end of file diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 4443d6cd0..3223fdb2e 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -53,14 +53,15 @@ def test_get_goal_not_found(client): response = client.get("/goals/1") response_body = response.get_json() - assert response_body == { - "message": "goal not found" - } # raise Exception("Complete test") # Assert # ---- Complete Test ---- # assertion 1 goes here + assert response_body == { + "message": "goal not found" + } # assertion 2 goes here + assert response.status_code == 404 # ---- Complete Test ---- @@ -124,7 +125,7 @@ def test_update_goal_not_found(client): # ---- 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_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -139,23 +140,33 @@ def test_delete_goal(client, one_goal): # Check that the goal was deleted response = client.get("/goals/1") + response_body = response.get_json() assert response.status_code == 404 + assert response_body == { + "message": "goal not found" + } - raise Exception("Complete test with assertion about response body") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** -@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") + # raise Exception("Complete test") # Act # ---- Complete Act Here ---- + response = client.delete("/goals/1") + response_body = response.get_json() # Assert # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == { + "message": "goal not found" + } # assertion 1 goes here # assertion 2 goes here # ---- Complete Assertions Here ---- From 1bfc8f78d756e8da0cd6bc474f952c1e36a6fb28 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Fri, 8 Nov 2024 22:59:28 +1300 Subject: [PATCH 25/29] passed a few of wave 6 tests. --- app/models/goal.py | 6 ++- app/models/task.py | 17 ++++-- app/routes/goal_routes.py | 53 ++++++++++++++++++- ...87a6b5_added_foreign_key_column_to_task.py | 34 ++++++++++++ requirements.txt | 4 ++ tests/test_wave_06.py | 10 ++-- 6 files changed, 112 insertions(+), 12 deletions(-) create mode 100644 migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py diff --git a/app/models/goal.py b/app/models/goal.py index 4c6182fec..2f7f9e41f 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,9 +1,13 @@ -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): return { diff --git a/app/models/task.py b/app/models/task.py index a4f890b1f..b14bb792a 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,21 +1,27 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey from ..db import db from typing import Optional from datetime import datetime - +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[Optional[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): return { "id":self.id, "title":self.title, "description":self.description, - "is_complete":self.completed_at is not None + "is_complete":self.completed_at is not None, + "goal":self.goal.title if self.goal else None } @classmethod @@ -24,7 +30,8 @@ def from_dict(cls, task_data): return cls( title=task_data["title"], description=task_data["description"], - completed_at=completed_at + completed_at=completed_at, + goal_id=task_data.get("goal_id", None) ) def mark_complete(self): diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3708161a3..1ea5ce033 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,6 +1,7 @@ from flask import Blueprint, request, abort, make_response from app.models.goal import Goal from ..db import db +from app.models.task import Task goals_bp = Blueprint("goals_bp", __name__, url_prefix="/goals") @@ -72,4 +73,54 @@ def delete_goal(goal_id): db.session.commit() response_body = {"details": f'Goal {goal_id} "{goal.title}" successfully deleted'} - return response_body \ No newline at end of file + return response_body + +@goals_bp.post("//tasks") +def create_task_with_goal_id(goal_id): + goal = validate_goal(goal_id) + + request_body = request.get_json() + request_body["goal_id"] = goal.id + + try: + new_task = Task.from_dict(request_body) + + except KeyError as e: + response = {"details": "Invalid data"} + abort(make_response(response, 400)) + + db.session.add(new_task) + db.session.commit() + response_body = { + "id": goal.id, + "title": goal.title, + "tasks": [ + { + "id": new_task.id, + "goal_id": new_task.goal_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": new_task.is_complete + } + ] + } + + return response_body, 201 + +@goals_bp.get("//tasks") +def get_tasks_by_goal(goal_id): + goal = validate_goal(goal_id) + response_body = { + "id": goal.id, + "title": goal.title, + "tasks": [task.to_dict() for task in goal.tasks] + } + + return response_body + +# def get_tasks_by_goal(goal_id): +# goal = validate_goal(goal_id) +# response = [task.to_dict() for task in goal.tasks] +# print(goal.tasks) + # return response + diff --git a/migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py b/migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py new file mode 100644 index 000000000..c4345a9cc --- /dev/null +++ b/migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py @@ -0,0 +1,34 @@ +"""added foreign key column to task + +Revision ID: 807eea87a6b5 +Revises: 0e59237c7b0c +Create Date: 2024-11-08 18:31:27.273407 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '807eea87a6b5' +down_revision = '0e59237c7b0c' +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/requirements.txt b/requirements.txt index af8fc4cf4..c0d3e4f0f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,12 +3,14 @@ blinker==1.7.0 certifi==2024.8.30 charset-normalizer==3.3.2 click==8.1.7 +exceptiongroup==1.2.2 Flask==3.0.2 Flask-Migrate==4.0.5 Flask-SQLAlchemy==3.1.1 greenlet==3.0.3 gunicorn==21.2.0 idna==3.10 +importlib_metadata==8.5.0 iniconfig==2.0.0 itsdangerous==2.1.2 Jinja2==3.1.3 @@ -21,6 +23,8 @@ pytest==8.0.0 python-dotenv==1.0.1 requests==2.32.3 SQLAlchemy==2.0.25 +tomli==2.0.2 typing_extensions==4.9.0 urllib3==2.2.3 Werkzeug==3.0.1 +zipp==3.20.2 diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..a8304bab4 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -42,7 +42,7 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on assert len(Goal.query.get(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") @@ -50,14 +50,14 @@ 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") + assert response_body == {"message": "goal 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") @@ -74,7 +74,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") From 51b422b9fbdf1675dadef629822e6014f179914e Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Sat, 9 Nov 2024 00:02:50 +1300 Subject: [PATCH 26/29] reworked the get function /goals/goal id/tasks --- app/models/task.py | 1 + app/routes/goal_routes.py | 55 +++++++++++++-------------------------- tests/test_wave_06.py | 8 +++--- 3 files changed, 23 insertions(+), 41 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index b14bb792a..af7ab6551 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -21,6 +21,7 @@ def to_dict(self): "title":self.title, "description":self.description, "is_complete":self.completed_at is not None, + "goal_id": self.goal_id, "goal":self.goal.title if self.goal else None } diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 1ea5ce033..abe009837 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,5 +1,6 @@ from flask import Blueprint, request, abort, make_response from app.models.goal import Goal +from app.routes.task_routes import validate_task from ..db import db from app.models.task import Task @@ -76,51 +77,31 @@ def delete_goal(goal_id): return response_body @goals_bp.post("//tasks") -def create_task_with_goal_id(goal_id): +def add_tasks_tp_goal(goal_id): goal = validate_goal(goal_id) - request_body = request.get_json() - request_body["goal_id"] = goal.id - - try: - new_task = Task.from_dict(request_body) - - except KeyError as e: - response = {"details": "Invalid data"} - abort(make_response(response, 400)) + task_ids = request_body["task_ids"] + + for task_id in task_ids: + task = validate_task(task_id) + goal.tasks.append(task) - db.session.add(new_task) db.session.commit() - response_body = { + + response = { "id": goal.id, - "title": goal.title, - "tasks": [ - { - "id": new_task.id, - "goal_id": new_task.goal_id, - "title": new_task.title, - "description": new_task.description, - "is_complete": new_task.is_complete - } - ] + "task_ids": task_ids, } + + return response - return response_body, 201 @goals_bp.get("//tasks") def get_tasks_by_goal(goal_id): goal = validate_goal(goal_id) - response_body = { - "id": goal.id, - "title": goal.title, - "tasks": [task.to_dict() for task in goal.tasks] - } - - return response_body - -# def get_tasks_by_goal(goal_id): -# goal = validate_goal(goal_id) -# response = [task.to_dict() for task in goal.tasks] -# print(goal.tasks) - # return response - + tasks = [task.to_dict() for task in goal.tasks] + + response = goal.to_dict() + response["tasks"] = tasks + + return response diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index a8304bab4..59c4d7b5b 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -2,7 +2,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={ @@ -23,7 +23,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(Goal.query.get(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={ @@ -74,7 +74,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") @@ -99,7 +99,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() From fea87a2575edd7498287ba64aa5575075a2e7108 Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Sat, 9 Nov 2024 00:21:26 +1300 Subject: [PATCH 27/29] added code to pass wave 6 --- app/models/task.py | 3 +-- tests/test_wave_06.py | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index af7ab6551..544eb93d6 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -21,8 +21,7 @@ def to_dict(self): "title":self.title, "description":self.description, "is_complete":self.completed_at is not None, - "goal_id": self.goal_id, - "goal":self.goal.title if self.goal else None + "goal_id": self.goal_id } @classmethod diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 59c4d7b5b..88ec26999 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -74,7 +74,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") From 61b99cf0c6124499da361d77fd1c6eeffb6d882f Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Sat, 9 Nov 2024 06:56:39 +1300 Subject: [PATCH 28/29] restarted migration folder and updated to_dict --- app/models/task.py | 6 ++-- migrations/versions/0e59237c7b0c_.py | 32 ----------------- migrations/versions/807eea87a6b5_.py | 24 +++++++++++++ ...87a6b5_added_foreign_key_column_to_task.py | 34 ------------------- tests/test_wave_03.py | 2 +- 5 files changed, 29 insertions(+), 69 deletions(-) delete mode 100644 migrations/versions/0e59237c7b0c_.py create mode 100644 migrations/versions/807eea87a6b5_.py delete mode 100644 migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py diff --git a/app/models/task.py b/app/models/task.py index 544eb93d6..10148ff34 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -16,13 +16,15 @@ class Task(db.Model): goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") def to_dict(self): - return { + task_dict = { "id":self.id, "title":self.title, "description":self.description, "is_complete":self.completed_at is not None, - "goal_id": self.goal_id } + if self.goal_id: + task_dict["goal_id"] = self.goal_id + return task_dict @classmethod def from_dict(cls, task_data): diff --git a/migrations/versions/0e59237c7b0c_.py b/migrations/versions/0e59237c7b0c_.py deleted file mode 100644 index 35adccda5..000000000 --- a/migrations/versions/0e59237c7b0c_.py +++ /dev/null @@ -1,32 +0,0 @@ -"""empty message - -Revision ID: 0e59237c7b0c -Revises: -Create Date: 2024-11-08 15:42:03.089793 - -""" -from alembic import op -import sqlalchemy as sa - - -# revision identifiers, used by Alembic. -revision = '0e59237c7b0c' -down_revision = None -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/807eea87a6b5_.py b/migrations/versions/807eea87a6b5_.py new file mode 100644 index 000000000..822e2c436 --- /dev/null +++ b/migrations/versions/807eea87a6b5_.py @@ -0,0 +1,24 @@ +"""empty message + +Revision ID: 807eea87a6b5 +Revises: +Create Date: 2024-11-09 06:42:05.787657 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '807eea87a6b5' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + pass + + +def downgrade(): + pass diff --git a/migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py b/migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py deleted file mode 100644 index c4345a9cc..000000000 --- a/migrations/versions/807eea87a6b5_added_foreign_key_column_to_task.py +++ /dev/null @@ -1,34 +0,0 @@ -"""added foreign key column to task - -Revision ID: 807eea87a6b5 -Revises: 0e59237c7b0c -Create Date: 2024-11-08 18:31:27.273407 - -""" -from alembic import op -import sqlalchemy as sa - - -# revision identifiers, used by Alembic. -revision = '807eea87a6b5' -down_revision = '0e59237c7b0c' -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/test_wave_03.py b/tests/test_wave_03.py index b9b4a6476..95532544a 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -24,7 +24,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): mock_get.return_value.status_code = 200 # Act - response = client.patch("/tasks/1/mark_complete") + response = client.patch("/tasks/1/mark_complete") response_body = response.get_json() # Assert From 3a19fe09debb4a95cdf483909b5ae3465dfb679b Mon Sep 17 00:00:00 2001 From: Brianna Root Date: Sat, 9 Nov 2024 08:01:19 +1300 Subject: [PATCH 29/29] completed tests and deployed on render --- migrations/versions/773d2d7ecad7_.py | 42 ++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 migrations/versions/773d2d7ecad7_.py diff --git a/migrations/versions/773d2d7ecad7_.py b/migrations/versions/773d2d7ecad7_.py new file mode 100644 index 000000000..0687fafdb --- /dev/null +++ b/migrations/versions/773d2d7ecad7_.py @@ -0,0 +1,42 @@ +"""empty message + +Revision ID: 773d2d7ecad7 +Revises: 807eea87a6b5 +Create Date: 2024-11-09 07:25:03.052658 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '773d2d7ecad7' +down_revision = '807eea87a6b5' +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.Column('title', sa.String(), 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.Column('goal_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['goal_id'], ['goal.id'], ), + 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 ###