From d68433c18ef8e80b82c0b735aeebe2bc140a11fd Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Thu, 30 Oct 2025 14:22:54 -0700 Subject: [PATCH 01/10] set up, create database and .env --- 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 ba5324f28f01405a6fb42c43c20fff6ab2cfc70e Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Tue, 4 Nov 2025 01:22:46 -0800 Subject: [PATCH 02/10] create route_utilities as helpfer function files --- app/__init__.py | 2 ++ app/models/task.py | 34 ++++++++++++++++++++++ app/routes/route_utilities.py | 43 ++++++++++++++++++++++++++++ app/routes/task_routes.py | 34 +++++++++++++++++++++- migrations/versions/dcfc602af8d0_.py | 39 +++++++++++++++++++++++++ tests/test_wave_01.py | 28 +++++++++--------- tests/test_wave_07.py | 2 +- 7 files changed, 166 insertions(+), 16 deletions(-) create mode 100644 app/routes/route_utilities.py create mode 100644 migrations/versions/dcfc602af8d0_.py diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..80dc0d60a 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,6 +1,7 @@ from flask import Flask from .db import db, migrate from .models import task, goal +from .routes.task_routes import tasks_bp import os def create_app(config=None): @@ -18,5 +19,6 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here + app.register_blueprint(tasks_bp) return app diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..4e694b52a 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,39 @@ from sqlalchemy.orm import Mapped, mapped_column +from typing import Optional from ..db import db +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]] = mapped_column(nullable=True, default=None) + + + def to_dict(self): + + task_as_dict = {} + task_as_dict["id"] = self.id + task_as_dict["title"] = self.title + task_as_dict["description"] = self.description + # task_as_dict["completed_at"] = self.completed_at + task_as_dict["is_complete"] = False + + # if self.goal: + # task_as_dict["goal"] = self.goal.name + + return task_as_dict + + + @classmethod + def from_dict(cls, task_data): + + goal_id = task_data.get("goal_id") + + new_task = cls( + title=task_data["title"], + description=task_data["description"] + # goal_id=goal_id + ) + + return new_task diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py new file mode 100644 index 000000000..cfab444fc --- /dev/null +++ b/app/routes/route_utilities.py @@ -0,0 +1,43 @@ +from flask import abort, make_response +from ..db import db + +# def validate_model(cls, model_id): +# try: +# model_id = int(model_id) +# except: +# response = {"message": f"{cls.__name__} {model_id} invalid"} +# abort(make_response(response , 400)) + +# query = db.select(cls).where(cls.id == model_id) +# model = db.session.scalar(query) + +# if not model: +# response = {"message": f"{cls.__name__} {model_id} not found"} +# abort(make_response(response, 404)) + +# return model + +def create_model(cls, model_data): + try: + new_model = cls.from_dict(model_data) + + except KeyError as error: + response = {"message": f"Invalid request: missing {error.args[0]}"} + abort(make_response(response, 400)) + + db.session.add(new_model) + db.session.commit() + + return new_model.to_dict(), 201 + +# def get_models_with_filters(cls, filters=None): +# query = db.select(cls) + +# if filters: +# for attribute, value in filters.items(): +# if hasattr(cls, attribute): +# query = query.where(getattr(cls, attribute).ilike(f"%{value}%")) + +# models = db.session.scalars(query.order_by(cls.id)) +# models_response = [model.to_dict() for model in models] +# return models_response \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..3bb9287db 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,33 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, abort, request, Response +from app.models.task import Task +from .route_utilities import create_model +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"] +# is_complete = False + +# new_task= Task(title=title, description=description) +# db.session.add(new_task) +# db.session.commit() + +# response = { +# "id": new_task.id, +# "title": new_task.title, +# "description": new_task.description, +# "is_complete": False +# } +# return response, 201 + +@tasks_bp.post("") +def create_task(): + request_body = request.get_json() + return create_model(Task, request_body) + + diff --git a/migrations/versions/dcfc602af8d0_.py b/migrations/versions/dcfc602af8d0_.py new file mode 100644 index 000000000..1ab6bcb1d --- /dev/null +++ b/migrations/versions/dcfc602af8d0_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: dcfc602af8d0 +Revises: +Create Date: 2025-11-03 22:54:05.265988 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'dcfc602af8d0' +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/tests/test_wave_01.py b/tests/test_wave_01.py index fac95a0a3..9308a15a6 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -2,7 +2,7 @@ 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_task_to_dict(): #Arrange new_task = Task(id = 1, title="Make My Bed", @@ -19,7 +19,7 @@ def test_task_to_dict(): assert task_dict["description"] == "Start the day off right!" assert task_dict["is_complete"] == False -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_to_dict_missing_id(): #Arrange new_task = Task(title="Make My Bed", @@ -36,7 +36,7 @@ def test_task_to_dict_missing_id(): assert task_dict["description"] == "Start the day off right!" assert task_dict["is_complete"] == False -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_to_dict_missing_title(): #Arrange new_task = Task(id = 1, @@ -53,7 +53,7 @@ def test_task_to_dict_missing_title(): assert task_dict["description"] == "Start the day off right!" assert task_dict["is_complete"] == False -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_from_dict(): #Arrange task_dict = { @@ -70,7 +70,7 @@ def test_task_from_dict(): assert task_obj.description == "Start the day off right!" assert task_obj.completed_at is 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_task_from_dict_no_title(): #Arrange task_dict = { @@ -82,7 +82,7 @@ def test_task_from_dict_no_title(): with pytest.raises(KeyError, match = 'title'): Task.from_dict(task_dict) -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_task_from_dict_no_description(): #Arrange task_dict = { @@ -94,7 +94,7 @@ def test_task_from_dict_no_description(): with pytest.raises(KeyError, match = 'description'): Task.from_dict(task_dict) -@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") @@ -105,7 +105,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") @@ -124,7 +124,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") @@ -155,7 +155,7 @@ def test_get_task_not_found(client): # ***************************************************************** -@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={ @@ -181,7 +181,7 @@ def test_create_task(client): 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={ @@ -219,7 +219,7 @@ def test_update_task_not_found(client): # ***************************************************************** -@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") @@ -247,7 +247,7 @@ def test_delete_task_not_found(client): assert db.session.scalars(db.select(Task)).all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_title(client): # Act response = client.post("/tasks", json={ @@ -264,7 +264,7 @@ def test_create_task_must_contain_title(client): assert db.session.scalars(db.select(Task)).all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_description(client): # Act response = client.post("/tasks", json={ diff --git a/tests/test_wave_07.py b/tests/test_wave_07.py index 7e7cef55a..ac15d03e1 100644 --- a/tests/test_wave_07.py +++ b/tests/test_wave_07.py @@ -2,7 +2,7 @@ from werkzeug.exceptions import HTTPException from app.models.goal import Goal from app.models.task import Task -from app.routes.route_utilities import create_model, validate_model +# from app.routes.route_utilities import create_model, validate_model @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_task(client, three_tasks): From ae4988aaea413536746fd25bad6cc38f1d9a2544 Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Tue, 4 Nov 2025 02:43:20 -0800 Subject: [PATCH 03/10] task file is set up with class, to_dict and from_dict to access data column, and this is the model; also create task routes file to do the crud routes, and all the wave 1 tests passed and wrote some test with asert on response_body --- app/routes/route_utilities.py | 44 +++++++++++++++---------------- app/routes/task_routes.py | 49 +++++++++++++++++++++-------------- tests/test_wave_01.py | 15 ++++++----- 3 files changed, 60 insertions(+), 48 deletions(-) diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index cfab444fc..9926b56ef 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -1,28 +1,28 @@ from flask import abort, make_response from ..db import db -# def validate_model(cls, model_id): -# try: -# model_id = int(model_id) -# except: -# response = {"message": f"{cls.__name__} {model_id} invalid"} -# abort(make_response(response , 400)) +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + response = {"message": f"{cls.__name__} {model_id} invalid"} + abort(make_response(response , 400)) -# query = db.select(cls).where(cls.id == model_id) -# model = db.session.scalar(query) + query = db.select(cls).where(cls.id == model_id) + model = db.session.scalar(query) -# if not model: -# response = {"message": f"{cls.__name__} {model_id} not found"} -# abort(make_response(response, 404)) + if not model: + response = {"message": f"{cls.__name__} {model_id} not found"} + abort(make_response(response, 404)) -# return model + return model def create_model(cls, model_data): try: new_model = cls.from_dict(model_data) except KeyError as error: - response = {"message": f"Invalid request: missing {error.args[0]}"} + response = {"details": "Invalid data"} abort(make_response(response, 400)) db.session.add(new_model) @@ -30,14 +30,14 @@ def create_model(cls, model_data): return new_model.to_dict(), 201 -# def get_models_with_filters(cls, filters=None): -# query = db.select(cls) +def get_models_with_filters(cls, filters=None): + query = db.select(cls) -# if filters: -# for attribute, value in filters.items(): -# if hasattr(cls, attribute): -# query = query.where(getattr(cls, attribute).ilike(f"%{value}%")) + if filters: + for attribute, value in filters.items(): + if hasattr(cls, attribute): + query = query.where(getattr(cls, attribute).ilike(f"%{value}%")) -# models = db.session.scalars(query.order_by(cls.id)) -# models_response = [model.to_dict() for model in models] -# return models_response \ No newline at end of file + models = db.session.scalars(query.order_by(cls.id)) + models_response = [model.to_dict() for model in models] + return models_response \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3bb9287db..31305498a 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1,33 +1,42 @@ from flask import Blueprint, abort, request, Response from app.models.task import Task -from .route_utilities import create_model +from .route_utilities import create_model, validate_model, get_models_with_filters 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"] -# is_complete = False - -# new_task= Task(title=title, description=description) -# db.session.add(new_task) -# db.session.commit() - -# response = { -# "id": new_task.id, -# "title": new_task.title, -# "description": new_task.description, -# "is_complete": False -# } -# return response, 201 - @tasks_bp.post("") def create_task(): request_body = request.get_json() return create_model(Task, request_body) +@tasks_bp.get("") +def get_task(): + return get_models_with_filters(Task, request.args) + +@tasks_bp.get("/") +def get_one_task(task_id): + task = validate_model(Task, task_id) + return task.to_dict() + +@tasks_bp.put("/") +def update_task(task_id): + task = validate_model(Task, task_id) + request_body = request.get_json() + + task.title = request_body["title"] + task.description = request_body["description"] + task.completed_at = None + db.session.commit() + + return Response(status=204, mimetype="application/json") # 204 means No Content + +@tasks_bp.delete("/") +def delete_task(task_id): + task = validate_model(Task, task_id) + db.session.delete(task) + db.session.commit() + + return Response(status=204, mimetype="application/json") diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 9308a15a6..c7af956b5 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.py @@ -140,7 +140,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") @@ -148,8 +148,9 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 not found"} - raise Exception("Complete test with assertion about response body") + # raise Exception(f"Test failed: not ask is found, got {response}") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** @@ -201,7 +202,7 @@ def test_update_task(client, one_task): -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_update_task_not_found(client): # Act response = client.put("/tasks/1", json={ @@ -212,8 +213,9 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 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*************** # ***************************************************************** @@ -230,7 +232,7 @@ def test_delete_task(client, one_task): query = db.select(Task).where(Task.id == 1) assert db.session.scalar(query) == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task_not_found(client): # Act response = client.delete("/tasks/1") @@ -238,8 +240,9 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 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 7bbd07b7bbcf1c84fa06ae78921177ad6ccbea66 Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Tue, 4 Nov 2025 14:04:16 -0800 Subject: [PATCH 04/10] wave 2 completed with soring by title asc or desc or else by id, all wave 2 tests passed --- app/__init__.py | 4 ++-- app/routes/route_utilities.py | 14 ++++++++++++-- app/routes/task_routes.py | 18 +++++++++++------- tests/test_wave_02.py | 4 ++-- 4 files changed, 27 insertions(+), 13 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 80dc0d60a..a18c0b590 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,7 @@ from flask import Flask from .db import db, migrate from .models import task, goal -from .routes.task_routes import tasks_bp +from .routes.task_routes import bp import os def create_app(config=None): @@ -19,6 +19,6 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here - app.register_blueprint(tasks_bp) + app.register_blueprint(bp) return app diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index 9926b56ef..d2561ec2b 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -1,6 +1,7 @@ from flask import abort, make_response from ..db import db +# just get one model with id def validate_model(cls, model_id): try: model_id = int(model_id) @@ -30,7 +31,8 @@ def create_model(cls, model_data): return new_model.to_dict(), 201 -def get_models_with_filters(cls, filters=None): +# get models with some same attribute/s +def get_models_with_filters(cls, filters=None, sort_parameter=None): query = db.select(cls) if filters: @@ -38,6 +40,14 @@ def get_models_with_filters(cls, filters=None): if hasattr(cls, attribute): query = query.where(getattr(cls, attribute).ilike(f"%{value}%")) - models = db.session.scalars(query.order_by(cls.id)) + + if sort_parameter == "asc": + query = query.order_by(cls.title.asc()) + elif sort_parameter == "desc": + query = query.order_by(cls.title.desc()) + else: + query = query.order_by(cls.id) + + models = db.session.scalars(query) models_response = [model.to_dict() for model in models] return models_response \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 31305498a..432db90e6 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -4,24 +4,27 @@ from ..db import db -tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") +# so we do not need to rewrite tasks_bp all the time +bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") -@tasks_bp.post("") +@bp.post("") def create_task(): request_body = request.get_json() return create_model(Task, request_body) -@tasks_bp.get("") +@bp.get("") def get_task(): - return get_models_with_filters(Task, request.args) + sort_parameter = request.args.get("sort") + return get_models_with_filters(Task, request.args, sort_parameter) -@tasks_bp.get("/") + +@bp.get("/") def get_one_task(task_id): task = validate_model(Task, task_id) return task.to_dict() -@tasks_bp.put("/") +@bp.put("/") def update_task(task_id): task = validate_model(Task, task_id) request_body = request.get_json() @@ -33,10 +36,11 @@ def update_task(task_id): return Response(status=204, mimetype="application/json") # 204 means No Content -@tasks_bp.delete("/") +@bp.delete("/") def delete_task(task_id): task = validate_model(Task, task_id) db.session.delete(task) db.session.commit() return Response(status=204, mimetype="application/json") + 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 2faf3c6eeee10ff86cac41be398d213bd0587728 Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Tue, 4 Nov 2025 14:58:36 -0800 Subject: [PATCH 05/10] finish wave 3 with patch to partically update the complete or incomplete, pass all wave 3 tests --- app/models/task.py | 2 +- app/routes/route_utilities.py | 3 ++- app/routes/task_routes.py | 21 ++++++++++++++++++++- tests/test_wave_03.py | 18 ++++++++++-------- 4 files changed, 33 insertions(+), 11 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index 4e694b52a..f79b9bdb6 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -17,7 +17,7 @@ def to_dict(self): task_as_dict["title"] = self.title task_as_dict["description"] = self.description # task_as_dict["completed_at"] = self.completed_at - task_as_dict["is_complete"] = False + task_as_dict["is_complete"] = self.completed_at is not None # if self.goal: # task_as_dict["goal"] = self.goal.name diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py index d2561ec2b..d2d069c75 100644 --- a/app/routes/route_utilities.py +++ b/app/routes/route_utilities.py @@ -40,7 +40,7 @@ def get_models_with_filters(cls, filters=None, sort_parameter=None): if hasattr(cls, attribute): query = query.where(getattr(cls, attribute).ilike(f"%{value}%")) - + # wave 2 sorting if sort_parameter == "asc": query = query.order_by(cls.title.asc()) elif sort_parameter == "desc": @@ -50,4 +50,5 @@ def get_models_with_filters(cls, filters=None, sort_parameter=None): models = db.session.scalars(query) models_response = [model.to_dict() for model in models] + return models_response \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 432db90e6..68838f98f 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -2,7 +2,7 @@ from app.models.task import Task from .route_utilities import create_model, validate_model, get_models_with_filters from ..db import db - +from datetime import datetime # so we do not need to rewrite tasks_bp all the time bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -44,3 +44,22 @@ def delete_task(task_id): return Response(status=204, mimetype="application/json") + +@bp.patch("//mark_complete") +def patch_task_mark_complete_with_timestamp(task_id): + task = validate_model(Task, task_id) + + task.completed_at = datetime.now() + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +@bp.patch("//mark_incomplete") +def patch_task_mark_incomplete(task_id): + task = validate_model(Task, task_id) + + task.completed_at = None + db.session.commit() + + return Response(status=204, mimetype="application/json") \ No newline at end of file diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index d7d441695..46958c6d4 100644 --- a/tests/test_wave_03.py +++ b/tests/test_wave_03.py @@ -6,7 +6,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 """ @@ -34,7 +34,7 @@ def test_mark_complete_on_incomplete_task(client, one_task): assert db.session.scalar(query).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_complete_task(client, completed_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -46,7 +46,7 @@ def test_mark_incomplete_on_complete_task(client, completed_task): assert db.session.scalar(query).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_completed_task(client, completed_task): # Arrange """ @@ -74,7 +74,7 @@ def test_mark_complete_on_completed_task(client, completed_task): query = db.select(Task).where(Task.id == 1) assert db.session.scalar(query).completed_at -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_on_incomplete_task(client, one_task): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -86,7 +86,7 @@ def test_mark_incomplete_on_incomplete_task(client, one_task): assert db.session.scalar(query).completed_at == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_missing_task(client): # Act response = client.patch("/tasks/1/mark_complete") @@ -94,14 +94,15 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 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") @@ -109,8 +110,9 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task 1 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 f5b3000a74a75bb2c36a7ed7450e81107dd16f15 Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Tue, 4 Nov 2025 18:14:02 -0800 Subject: [PATCH 06/10] finishe wave 4, set up slack api bot to post in in channel, slack-api-testing after the task is marked complete, tested in postman with patch --- app/__init__.py | 2 ++ app/routes/task_routes.py | 17 +++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index a18c0b590..d1584ca5e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -7,6 +7,8 @@ def create_app(config=None): app = Flask(__name__) + + # use os because it is from .env app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 68838f98f..d6ca1b0b3 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -3,6 +3,8 @@ from .route_utilities import create_model, validate_model, get_models_with_filters from ..db import db from datetime import datetime +import os +import requests # so we do not need to rewrite tasks_bp all the time bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") @@ -52,6 +54,21 @@ def patch_task_mark_complete_with_timestamp(task_id): task.completed_at = datetime.now() db.session.commit() + SLACK_BOT_TOKEN = os.environ.get("SLACK_BOT_TOKEN") + + if SLACK_BOT_TOKEN: + url = "https://slack.com/api/chat.postMessage" + headers = { + "Authorization": f"Bearer {SLACK_BOT_TOKEN}", + "Content-Type": "application/json" + } + + data = { + "channel": "slack-api-testing", + "text": f"Someone just completed the task {task.title}" + } + requests.post(url, headers=headers, json=data) + return Response(status=204, mimetype="application/json") From d2ae805ec3bc66d73f5e0fb7efa74f38e71ffd02 Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Tue, 4 Nov 2025 23:49:22 -0800 Subject: [PATCH 07/10] create goal model, complete wave 5, pass all the tests, add blueprint for both task and goal inside init --- app/__init__.py | 6 +- app/models/goal.py | 16 ++++ app/routes/goal_routes.py | 43 +++++++++- app/routes/task_routes.py | 3 +- .../versions/bbf9a818b8cf_add_goal_model.py | 32 ++++++++ tests/test_wave_05.py | 79 ++++++++++--------- 6 files changed, 136 insertions(+), 43 deletions(-) create mode 100644 migrations/versions/bbf9a818b8cf_add_goal_model.py diff --git a/app/__init__.py b/app/__init__.py index d1584ca5e..2acb8bab4 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,8 @@ from flask import Flask from .db import db, migrate from .models import task, goal -from .routes.task_routes import bp +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): @@ -21,6 +22,7 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here - app.register_blueprint(bp) + 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..4ed6f2f94 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,5 +1,21 @@ from sqlalchemy.orm import Mapped, mapped_column +from typing import Optional from ..db import db + class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + + def to_dict(self): + goal_as_dict = { + "id" : self.id, + "title": self.title + } + + return goal_as_dict + + @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..1c716d9b7 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,42 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, abort, request, Response +from app.models.goal import Goal +from .route_utilities import create_model, validate_model, get_models_with_filters +from ..db import db +from datetime import datetime +import os +import requests + +bp = Blueprint("goal_bp", __name__, url_prefix="/goals") + +@bp.post("") +def create_goal(): + request_body = request.get_json() + # called the function inside route_utilities + return create_model(Goal, request_body) + +@bp.get("") +def get_goal(): + return get_models_with_filters(Goal, request.args) + +@bp.get("/") +def get_one_goal(goal_id): + goal = validate_model(Goal, goal_id) + return goal.to_dict() + +@bp.put("/") +def update_goal(goal_id): + goal = validate_model(Goal, goal_id) + request_body = request.get_json() + + goal.title = request_body["title"] + db.session.commit() + + return Response(status=204, mimetype="application/json") # 204 means No Content + +@bp.delete("/") +def delete_goal(goal_id): + goal = validate_model(Goal, goal_id) + db.session.delete(goal) + db.session.commit() + + return Response(status=204, mimetype="application/json") \ No newline at end of file diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index d6ca1b0b3..05f82df87 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -79,4 +79,5 @@ def patch_task_mark_incomplete(task_id): task.completed_at = None db.session.commit() - return Response(status=204, mimetype="application/json") \ No newline at end of file + return Response(status=204, mimetype="application/json") + diff --git a/migrations/versions/bbf9a818b8cf_add_goal_model.py b/migrations/versions/bbf9a818b8cf_add_goal_model.py new file mode 100644 index 000000000..f6f96a92f --- /dev/null +++ b/migrations/versions/bbf9a818b8cf_add_goal_model.py @@ -0,0 +1,32 @@ +"""add goal model + +Revision ID: bbf9a818b8cf +Revises: dcfc602af8d0 +Create Date: 2025-11-04 22:14:18.481183 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'bbf9a818b8cf' +down_revision = 'dcfc602af8d0' +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 b7cc330ae..291b4f9a6 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,8 @@ 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_goal_to_dict(): #Arrange new_goal = Goal(id=1, title="Seize the Day!") @@ -13,7 +14,7 @@ def test_goal_to_dict(): assert goal_dict["id"] == 1 assert goal_dict["title"] == "Seize the Day!" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_to_dict_no_id(): #Arrange new_goal = Goal(title="Seize the Day!") @@ -25,7 +26,7 @@ def test_goal_to_dict_no_id(): assert goal_dict["id"] is None assert goal_dict["title"] == "Seize the Day!" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_to_dict_no_title(): #Arrange new_goal = Goal(id=1) @@ -39,7 +40,7 @@ def test_goal_to_dict_no_title(): -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_from_dict(): #Arrange goal_dict = { @@ -52,7 +53,7 @@ def test_goal_from_dict(): #Assert assert goal_obj.title == "Seize the Day!" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_goal_from_dict_no_title(): #Arrange goal_dict = { @@ -63,7 +64,7 @@ def test_goal_from_dict_no_title(): Goal.from_dict(goal_dict) -@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") @@ -74,7 +75,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") @@ -91,7 +92,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") @@ -105,22 +106,22 @@ 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") + # raise Exception("Complete test") # Assert # ---- Complete Test ---- - # assertion 1 goes here - # assertion 2 goes here + assert response.status_code == 404 + assert response_body == {"message": "Goal 1 not found"} # ---- Complete Test ---- -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal(client): # Act response = client.post("/goals", json={ @@ -136,34 +137,34 @@ def test_create_goal(client): } -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal(client, one_goal): - raise Exception("Complete test") # Act - # ---- Complete Act Here ---- + response = client.put("/goals/1", json={ + "title": "Updated Goal Title" + }) # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # assertion 3 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 204 + + query = db.select(Goal).where(Goal.id == 1) + goal = db.session.scalar(query) + assert goal.title == "Updated Goal Title" -@pytest.mark.skip(reason="test to be completed by student") + +# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): - raise Exception("Complete test") - # Act - # ---- Complete Act Here ---- + # Act + response = client.get("/goals") + response_body = response.get_json() # Assert - # ---- Complete Assertions Here ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + 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_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -177,28 +178,28 @@ def test_delete_goal(client, one_goal): response_body = response.get_json() assert "message" in response_body + assert response_body == {"message": "Goal 1 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 ---- - # assertion 1 goes here - # assertion 2 goes here - # ---- Complete Assertions Here ---- + assert response.status_code == 404 + assert response_body == {"message": "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_missing_title(client): # Act response = client.post("/goals", json={}) From 665fa5855031774127fb71920323694eed94936f Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Wed, 5 Nov 2025 21:43:55 -0800 Subject: [PATCH 08/10] added foreignkey in tasks to link to goal, work on wave 6, one to many, wave 7 refactor, with the route utilities, test passed for wave 6 and 7 --- app/models/goal.py | 3 +- app/models/task.py | 40 +++++++++----- app/routes/goal_routes.py | 55 ++++++++++++++++++- ..._add_goal_id_as_foreign_key_inside_task.py | 34 ++++++++++++ tests/test_wave_06.py | 16 +++--- tests/test_wave_07.py | 47 ++++++++++------ 6 files changed, 155 insertions(+), 40 deletions(-) create mode 100644 migrations/versions/e8772a9dba88_add_goal_id_as_foreign_key_inside_task.py diff --git a/app/models/goal.py b/app/models/goal.py index 4ed6f2f94..fbd444407 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,4 +1,4 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from typing import Optional from ..db import db @@ -6,6 +6,7 @@ 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): goal_as_dict = { diff --git a/app/models/task.py b/app/models/task.py index f79b9bdb6..b27e5b819 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,4 +1,5 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey from typing import Optional from ..db import db from datetime import datetime @@ -8,22 +9,31 @@ class Task(db.Model): title: Mapped[str] description: Mapped[str] completed_at: Mapped[Optional[datetime]] = mapped_column(nullable=True, default=None) + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") - + + + def to_dict(self): + result = { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": self.completed_at is not None + } + + if self.goal_id: + result.update({ + "goal_id": self.goal.id + }) + + return result + + + - task_as_dict = {} - task_as_dict["id"] = self.id - task_as_dict["title"] = self.title - task_as_dict["description"] = self.description - # task_as_dict["completed_at"] = self.completed_at - task_as_dict["is_complete"] = self.completed_at is not None - # if self.goal: - # task_as_dict["goal"] = self.goal.name - - return task_as_dict - @classmethod def from_dict(cls, task_data): @@ -32,8 +42,8 @@ def from_dict(cls, task_data): new_task = cls( title=task_data["title"], - description=task_data["description"] - # goal_id=goal_id + description=task_data["description"], + goal_id=goal_id ) return new_task diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 1c716d9b7..94cbdefa6 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1,5 +1,6 @@ from flask import Blueprint, abort, request, Response from app.models.goal import Goal +from app.models.task import Task from .route_utilities import create_model, validate_model, get_models_with_filters from ..db import db from datetime import datetime @@ -39,4 +40,56 @@ def delete_goal(goal_id): db.session.delete(goal) db.session.commit() - return Response(status=204, mimetype="application/json") \ No newline at end of file + return Response(status=204, mimetype="application/json") + +# called the function inside route_utilities +# the create_author function called route_utilities + +#wave 6 +@bp.post("//tasks") +def post_task_ids_to_goal(goal_id): + goal = validate_model(Goal, goal_id) + + request_body = request.get_json() + task_ids = request_body.get("task_ids", []) + + # use query to get all the tasks that is related to this one goal + # this is also use later, can make it into a helpfer function later + tasks_assign_to_goal = Task.query.filter_by(goal_id=goal.id).all() + + # setting the goal_id to none + # so now the goal does not have the task(s) + for task in tasks_assign_to_goal: + task.goal_id = None + + # use of foreign key to connecting the two + for task_id in task_ids: + task = validate_model(Task, task_id) + task.goal_id = goal.id + + db.session.commit() + + return { + "id": goal.id, + "task_ids": task_ids, + }, 200 + + + +@bp.get("//tasks") +def get_tasks_for_specific_goal(goal_id): + goal = validate_model(Goal, goal_id) + + tasks_assign_to_goal = Task.query.filter_by(goal_id=goal.id).all() + + # return as a dict + # all tha tasks inside goal + tasks_list = [task.to_dict() for task in tasks_assign_to_goal] + + return { + "id": goal.id, + "title": goal.title, + "tasks": tasks_list + }, 200 + + diff --git a/migrations/versions/e8772a9dba88_add_goal_id_as_foreign_key_inside_task.py b/migrations/versions/e8772a9dba88_add_goal_id_as_foreign_key_inside_task.py new file mode 100644 index 000000000..8f868bb4a --- /dev/null +++ b/migrations/versions/e8772a9dba88_add_goal_id_as_foreign_key_inside_task.py @@ -0,0 +1,34 @@ +"""add goal id as foreign key inside task + +Revision ID: e8772a9dba88 +Revises: bbf9a818b8cf +Create Date: 2025-11-05 00:45:50.186633 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e8772a9dba88' +down_revision = 'bbf9a818b8cf' +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_06.py b/tests/test_wave_06.py index 727fce93a..a4deab9cb 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -3,7 +3,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal(client, one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -25,7 +25,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(db.session.scalar(query).tasks) == 3 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal_overwrites_existing_tasks(client, one_task_belongs_to_one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -45,7 +45,7 @@ def test_post_task_ids_to_goal_overwrites_existing_tasks(client, one_task_belong assert len(db.session.scalar(query).tasks) == 2 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_goal(client): # Act response = client.get("/goals/1/tasks") @@ -53,14 +53,16 @@ def test_get_tasks_for_specific_goal_no_goal(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Goal 1 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_get_tasks_for_specific_goal_no_tasks(client, one_goal): # Act response = client.get("/goals/1/tasks") @@ -77,7 +79,7 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -102,7 +104,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() diff --git a/tests/test_wave_07.py b/tests/test_wave_07.py index ac15d03e1..396e4eb23 100644 --- a/tests/test_wave_07.py +++ b/tests/test_wave_07.py @@ -2,9 +2,10 @@ from werkzeug.exceptions import HTTPException from app.models.goal import Goal from app.models.task import Task -# from app.routes.route_utilities import create_model, validate_model +from app.routes.route_utilities import validate_model, create_model, get_models_with_filters -@pytest.mark.skip(reason="No way to test this feature yet") + +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_task(client, three_tasks): #Act task_1 = validate_model(Task, 1) @@ -24,7 +25,7 @@ def test_route_utilities_validate_model_with_task(client, three_tasks): assert task_3.title == "Pay my outstanding tickets 😭" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_task_invalid_id(client, three_tasks): #Act & Assert # Calling `validate_model` without being invoked by a route will @@ -35,25 +36,30 @@ def test_route_utilities_validate_model_with_task_invalid_id(client, three_tasks # Test that the correct status code and response message are returned response = e.value.get_response() assert response.status_code == 400 + assert response.get_json() == {"message": "Task One invalid"} - raise Exception("Complete test with an assertion about the response body") + # raise Exception("Complete test with an assertion about the response body") # ***************************************************************************** # ** Complete test with an assertion about the 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_route_utilities_validate_model_with_task_missing_id(client, three_tasks): #Act & Assert with pytest.raises(HTTPException) as e: result_task = validate_model(Task, 4) + + response = e.value.get_response() + assert response.status_code == 404 + assert response.get_json() == {"message": "Task 4 not found"} - raise Exception("Complete test with assertion status code and response body") + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code 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_route_utilities_validate_model_with_goal(client, one_goal): #Act goal_1 = validate_model(Goal, 1) @@ -62,29 +68,33 @@ def test_route_utilities_validate_model_with_goal(client, one_goal): assert goal_1.id == 1 assert goal_1.title == "Build a habit of going outside daily" -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_validate_model_with_goal_invalid_id(client, one_goal): #Act & Assert with pytest.raises(HTTPException) as e: result_task = validate_model(Goal, "One") + + response = e.value.get_response() + assert response.status_code == 400 + assert response.get_json() == {"message": "Goal One invalid"} - raise Exception("Complete test with assertion status code and response body") + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code 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_route_utilities_validate_model_with_goal_missing_id(client, one_goal): #Act & Assert with pytest.raises(HTTPException) as e: result_task = validate_model(Goal, 4) - raise Exception("Complete test with assertion status code and response body") + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code 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_route_utilities_create_model_with_task(client): #Arrange request_body = { @@ -103,7 +113,7 @@ def test_route_utilities_create_model_with_task(client): assert response[0]["is_complete"] == False assert response[1] == 201 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_create_model_with_task_missing_title(client): #Arrange request_body = { @@ -120,7 +130,7 @@ def test_route_utilities_create_model_with_task_missing_title(client): assert response.get_json() == {"details": "Invalid data"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_create_model_with_goal(client): #Arrange request_body = { @@ -135,7 +145,7 @@ def test_route_utilities_create_model_with_goal(client): assert response[0]["title"] == "Seize the Day!" assert response[1] == 201 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_route_utilities_create_model_with_goal_missing_title(client): #Arrange request_body = { @@ -144,8 +154,13 @@ def test_route_utilities_create_model_with_goal_missing_title(client): #Act with pytest.raises(HTTPException) as e: create_model(Goal, request_body) + + + response = e.value.get_response() + assert response.status_code == 400 + assert response.get_json() == {"details": "Invalid data"} - raise Exception("Complete test with assertion status code and response body") + # raise Exception("Complete test with assertion status code and response body") # ***************************************************************************** # **Complete test with assertion about status code response body*************** # ***************************************************************************** From 1a853145b80ae2f9e3ca8487f1fde603fe21d703 Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Thu, 6 Nov 2025 15:00:06 -0800 Subject: [PATCH 09/10] refactor the get function in goal routes.py --- app/models/task.py | 3 --- app/routes/goal_routes.py | 12 +++--------- 2 files changed, 3 insertions(+), 12 deletions(-) diff --git a/app/models/task.py b/app/models/task.py index b27e5b819..c5839c57c 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -32,9 +32,6 @@ def to_dict(self): - - - @classmethod def from_dict(cls, task_data): diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 94cbdefa6..3412ab93d 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -54,7 +54,7 @@ def post_task_ids_to_goal(goal_id): task_ids = request_body.get("task_ids", []) # use query to get all the tasks that is related to this one goal - # this is also use later, can make it into a helpfer function later + # goal.id is inside class Task Model tasks_assign_to_goal = Task.query.filter_by(goal_id=goal.id).all() # setting the goal_id to none @@ -80,16 +80,10 @@ def post_task_ids_to_goal(goal_id): def get_tasks_for_specific_goal(goal_id): goal = validate_model(Goal, goal_id) - tasks_assign_to_goal = Task.query.filter_by(goal_id=goal.id).all() - - # return as a dict - # all tha tasks inside goal - tasks_list = [task.to_dict() for task in tasks_assign_to_goal] + tasks_list = [task.to_dict() for task in goal.tasks] return { "id": goal.id, "title": goal.title, "tasks": tasks_list - }, 200 - - + }, 200 \ No newline at end of file From 4379c3e8211c0056bc5957c490cbead8863fdd33 Mon Sep 17 00:00:00 2001 From: YanYi Chen Date: Thu, 6 Nov 2025 15:10:37 -0800 Subject: [PATCH 10/10] wave 6 edit with comments --- app/routes/goal_routes.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3412ab93d..bc7d289f8 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -75,12 +75,27 @@ def post_task_ids_to_goal(goal_id): }, 200 +# another approach +# @bp.get("//tasks") +# def get_tasks_for_specific_goal(goal_id): +# goal = validate_model(Goal, goal_id) + +# tasks_list = [task.to_dict() for task in goal.tasks] + +# return { +# "id": goal.id, +# "title": goal.title, +# "tasks": tasks_list +# }, 200 + @bp.get("//tasks") def get_tasks_for_specific_goal(goal_id): goal = validate_model(Goal, goal_id) - tasks_list = [task.to_dict() for task in goal.tasks] + tasks_assign_to_goal = Task.query.filter_by(goal_id=goal.id).all() + + tasks_list = [task.to_dict() for task in tasks_assign_to_goal] return { "id": goal.id,