diff --git a/ada-project-docs/optional-enhancements.md b/ada-project-docs/optional-enhancements.md index 526ea5e42..7b3c8dcc6 100644 --- a/ada-project-docs/optional-enhancements.md +++ b/ada-project-docs/optional-enhancements.md @@ -1,4 +1,4 @@ -# Optional Enhancements +dour# Optional Enhancements ## Goal @@ -42,7 +42,7 @@ Here are some ideas to start: - Create a class method in `Task` named `from_json()` - Converts JSON into a new instance of `Task` - Takes in a dictionary in the shape of the JSON our API receives in the create and update routes - - Returns an instance of `Task` + - Returns an instance of `Task` ### Use List Comprehensions diff --git a/ada-project-docs/wave_01.md b/ada-project-docs/wave_01.md index 30be86ad8..29d3d4275 100644 --- a/ada-project-docs/wave_01.md +++ b/ada-project-docs/wave_01.md @@ -27,7 +27,7 @@ Tasks should contain these attributes. **The tests require the following columns ### Tips -- To work with date information, we can import the `datetime` data type with the import line `from datetime import datetime`. +- To work with date information, we can import the `datetime` data type with the import line `from datetime import datetime`. - SQLAlchemy supports optional, or _nullable_, columns with specific syntax. - Don't forget to run: - `flask db init` once during setup @@ -50,7 +50,7 @@ Tasks should contain these attributes. **The tests require the following columns ### CLI -In addition to testing your code with pytest and postman, you can play test your code with the CLI (Command Line Interface) by running `python3 cli/main.py`. +In addition to testing your code with pytest and postman, you can play test your code with the CLI (Command Line Interface) by running `python3 cli/main.py`. The flask server needs to be running first before running the CLI. @@ -122,8 +122,7 @@ As a client, I want to be able to make a `GET` request to `/tasks` when there ar #### Get One Task: One Saved Task -As a client, I want to be able to make a `GET` request to `/tasks/1` when there is at least one saved task and get this response: - +As a client, I want to be able to make a `GET` request to `/tasks/1` when there is at least one saved task and get this respons `200 OK` ```json @@ -192,7 +191,7 @@ The response code should be `404`. You may choose the response body. Make sure to complete the tests for non-existing tasks to check that the correct response body is returned. - + #### Create a Task: Invalid Task With Missing Data diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..cda3d76d7 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,13 +1,16 @@ from flask import Flask from .db import db, migrate from .models import task, goal +from .routes.task_routes import tasks_bp +from .routes.goal_routes import goals_bp import os + def create_app(config=None): app = Flask(__name__) - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("SQLALCHEMY_DATABASE_URI") if config: # Merge `config` into the app's configuration @@ -18,5 +21,7 @@ def create_app(config=None): migrate.init_app(app, db) # Register Blueprints here + app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) return app diff --git a/app/models/goal.py b/app/models/goal.py index 44282656b..a02345ee2 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,5 +1,15 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from ..db import db + class Goal(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + tasks: Mapped[list["Task"]] = relationship("Task", back_populates="goal") + + def to_dict(self): + return dict(id=self.id, title=self.title) + + @classmethod + def from_dict(cls, goal_data): + return cls(title=goal_data["title"]) diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..84ec70ed7 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,34 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship +from sqlalchemy import ForeignKey from ..db import db +from datetime import datetime +from typing import Optional + class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] = mapped_column(String, nullable=False) + description: Mapped[str] + completed_at: Mapped[Optional[datetime]] + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship("Goal", back_populates="tasks") + + def to_dict(self): + task_dict = { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": task.is_complete()}) + } + if self.goal_id is not None: + task_dict["goal_id"] = self.goal_id + return task_dict + + @classmethod + def from_dict(cls, task_data): + return cls( + goal_id=task_data.get("goal_id"), + title=task_data["title"], + description=task_data["description"], + completed_at=task_data.get("completed_at", None), + ) diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..f9b1bb567 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,142 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, abort, make_response, request, Response +from app.models.goal import Goal +from app.models.task import Task +from ..db import db +from datetime import datetime + +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": f"Invalid data - missing {error.args[0]}"} + abort(make_response(response, 400)) + + db.session.add(new_goal) + db.session.commit() + + response = {"goal": new_goal.to_dict()} + return response, 201 + + +@goals_bp.get("") +def get_all_goals(): + query = db.select(Goal) + + title_param = request.args.get("title") + sort = request.args.get("sort", "asc") # Default to ascending order + + query = db.select(Goal) + + if title_param: + query = query.where(Goal.title.ilike(f"%{title_param}%")) + + if sort == "desc": + query = query.order_by(Goal.title.asc()) + + goals = db.session.scalars(query) + goals_response = [goal.to_dict() for goal in goals] + + return goals_response, 200 + + +@goals_bp.get("/") +def get_single_goal(goal_id): + goal = validate_goal(goal_id) + + return {"goal": goal.to_dict()} + + +@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 = {"goal": goal.to_dict()} + return response, 200 + + +@goals_bp.patch("//mark_complete") +def mark_goal_complete(goal_id): + goal = validate_goal(goal_id) + goal.completed_at = datetime.now() + db.session.commit() + + return {"goal": goal.to_dict()}, 200 + + +@goals_bp.patch("//mark_incomplete") +def mark_goal_incomplete(goal_id): + goal = validate_goal(goal_id) + goal.completed_at = None + + db.session.commit() + + return {"goal": goal.to_dict()}, 200 + + +@goals_bp.delete("/") +def delete_goal(goal_id): + goal = validate_goal(goal_id) + + db.session.delete(goal) + db.session.commit() + response = {"details": f'Goal {goal_id} "{goal.title}" successfully deleted'} + return response, 200 + + +@goals_bp.post("//tasks") +def assign_tasks_to_goal(goal_id): + goal = validate_goal(goal_id) + request_body = request.get_json() + task_ids = request_body.get("task_ids", []) + + tasks = [validate_model(Task, task_id) for task_id in task_ids] + + goal.tasks.extend(tasks) + db.session.commit() + + return {"id": goal.id, "task_ids": task_ids}, 200 + + +@goals_bp.get("//tasks") +def get_tasks_by_goal(goal_id): + goal = validate_goal(goal_id) + goal_dict = goal.to_dict() + goal_dict["tasks"] = [task.to_dict() for task in goal.tasks] + return goal_dict + + +@goals_bp.get("/tasks/") +def get_one_task_by_goal(goal_id, task_id): + + goal = validate_goal(Goal, goal_id) + task = validate_goal(Task, task_id) + + if task in goal.tasks: + goal_dict = goal.to_dict() + goal_dict["task"] = task.to_dict() + return goal_dict + return {"details": f"Task {task.id} not found for Goal {goal.id}"}, 404 + + +def validate_goal(goal_id): + try: + goal_id = int(goal_id) + except ValueError: + abort(400, description="Invalid goal_id") + + goal = Goal.query.get(goal_id) + if goal is None: + abort(make_response({"message": f"goal {goal_id} not found"}, 404)) + + return goal diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..454b6573d 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,119 @@ -from flask import Blueprint \ No newline at end of file +from flask import Blueprint, abort, make_response, request, Response +from app.models.task import Task +from ..db import db +from datetime import datetime +from app.models.task import Task + +tasks_bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + + + +@tasks_bp.post("") +def create_task(): + request_body = request.get_json() + + try: + new_task = Task.from_dict(request_body) + + except KeyError: + response = {"details": "Invalid data"} + abort(make_response(response, 400)) + + + db.session.add(new_task) + db.session.commit() + + response = {"task": new_task.to_dict()} + return response, 201 + + +@tasks_bp.get("") +def get_all_tasks(): + query = db.select(Task) + description_param = request.args.get("description") + if description_param: + query = query.where(Task.description.ilike(f"%{description_param}%")).order_by(Task.id) + + title_param = request.args.get("title") + sort = request.args.get("sort", "asc") # Default to ascending order + + query = db.select(Task) + + if title_param: + query = query.where(Task.title.ilike(f"%{title_param}%")) + + if sort == "desc": + query = query.order_by(Task.title.desc()) + else: + query = query.order_by(Task.title.asc()) + + tasks = db.session.scalars(query) + tasks_response = [task.to_dict() for task in tasks] + + return tasks_response, 200 + + +@tasks_bp.get("/") +def get_single_task(task_id): + task = validate_task(task_id) + + + return {"task": task.to_dict()} + + +@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.get("description") + task.completed_at = request_body.get("completed_at") + + db.session.commit() + response = {"task": task.to_dict()} + return response, 200 + +@tasks_bp.patch("//mark_complete") +def mark_task_complete(task_id): + task = validate_task(task_id) + task.completed_at = datetime.now() + db.session.commit() + + return {"task": task.to_dict()}, 200 + +@tasks_bp.patch("//mark_incomplete") +def mark_task_incomplete(task_id): + task = validate_task(task_id) + task.completed_at = None + + db.session.commit() + + return {"task": task.to_dict()}, 200 + + +@tasks_bp.delete("/") +def delete_task(task_id): + task = validate_task(task_id) + + db.session.delete(task) + db.session.commit() + response = { + "details": f'Task {task_id} "{task.title}" successfully deleted' + } + return response, 200 + +def validate_task(task_id): + try: + task_id = int(task_id) + except ValueError: + response = {"details": f"Task {task_id} invalid"} + abort(make_response(response, 404)) + + task = db.session.get(Task,task_id) + + if not task: + response = {"message": f"task {task_id} not found"} + abort(make_response(response, 404)) + + return task \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic,flask_migrate + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..4c9709271 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,113 @@ +import logging +from logging.config import fileConfig + +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except (TypeError, AttributeError): + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option('sqlalchemy.url', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=get_metadata(), literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + conf_args = current_app.extensions['migrate'].configure_args + if conf_args.get("process_revision_directives") is None: + conf_args["process_revision_directives"] = process_revision_directives + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + **conf_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/0150dc2aa100_.py b/migrations/versions/0150dc2aa100_.py new file mode 100644 index 000000000..90228969c --- /dev/null +++ b/migrations/versions/0150dc2aa100_.py @@ -0,0 +1,42 @@ +"""empty message + +Revision ID: 0150dc2aa100 +Revises: +Create Date: 2024-11-08 16:02:12.714867 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0150dc2aa100' +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.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 ### diff --git a/requirements.txt b/requirements.txt index af8fc4cf4..5e98f339c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,6 +3,7 @@ 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 @@ -21,6 +22,7 @@ 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 diff --git a/seed.py b/seed.py new file mode 100644 index 000000000..ef624ac35 --- /dev/null +++ b/seed.py @@ -0,0 +1,33 @@ +from app import create_app, db +from app.models.task import Task +from app.models.goal import Goal +from datetime import datetime + + +my_app = create_app() + +with my_app.app_context(): + + goal1 = Goal(title="Health and Well-being") + goal2 = Goal(title="Team Collaboration") + goal3 = Goal(title="Skill Development") + goal4 = Goal(title="Project Planning") + + db.session.add_all([goal1, goal2, goal3, goal4]) + db.session.commit() + + tasks = [ + Task(title="Go on my daily walk 🏞", description="Notice something new every day", completed_at=None, goal_id=goal1.id), + Task(title="Yoga Practice", description="30 minutes of morning yoga", completed_at=None, goal_id=goal1.id), + Task(title="Team Meeting", description="Attend the weekly team sync-up meeting", completed_at=datetime(2024, 10, 2, 9, 0), goal_id=goal2.id), + Task(title="Code Review", description="Review code for recent pull requests", completed_at=datetime(2024, 10, 3, 11, 15), goal_id=goal2.id), + Task(title="Client Call", description="Discuss requirements with the client", completed_at=datetime(2024, 10, 4, 15, 0), goal_id=goal2.id), + Task(title="Update Documentation", description="Add details to the API documentation", completed_at=datetime(2024, 10, 5, 10, 30), goal_id=goal3.id), + Task(title="Research on Tech Trends", description="Research new technology trends for the next project", completed_at=datetime(2024, 10, 6, 13, 0), goal_id=goal3.id), + Task(title="Design New Feature", description="Design wireframes for new app feature", completed_at=datetime(2024, 10, 7, 16, 45), goal_id=goal3.id), + Task(title="Project Roadmap", description="Create roadmap for the new project", completed_at=None, goal_id=goal4.id), + Task(title="Sprint Planning", description="Plan tasks for upcoming sprint", completed_at=None, goal_id=goal4.id) + ] + + db.session.add_all(tasks) + db.session.commit() diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index dca626d78..2c5f56a66 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") @@ -60,13 +60,17 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + id = 1 + assert response_body == {"message": f"task {id} not found"} -@pytest.mark.skip(reason="No way to test this feature yet") + + +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task(client): # Act response = client.post("/tasks", json={ @@ -78,6 +82,7 @@ def test_create_task(client): # Assert assert response.status_code == 201 assert "task" in response_body + assert response_body == { "task": { "id": 1, @@ -93,7 +98,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 +124,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={ @@ -131,13 +136,15 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + id = 1 + assert response_body == {"message": f"task {id} not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -152,7 +159,7 @@ def test_delete_task(client, one_task): assert Task.query.get(1) == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task_not_found(client): # Act response = client.delete("/tasks/1") @@ -161,15 +168,18 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + assert response.status_code == 404 + assert response_body == {"message": "task 1 not found"} + assert Task.query.all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_title(client): # Act response = client.post("/tasks", json={ @@ -186,7 +196,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={ 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") diff --git a/tests/test_wave_03.py b/tests/test_wave_03.py index 32d379822..f234f260b 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") @@ -128,13 +128,15 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + id =1 + assert response_body == {"message": f"task {id} not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_incomplete_missing_task(client): # Act response = client.patch("/tasks/1/mark_incomplete") @@ -143,7 +145,9 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 - 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*************** # ***************************************************************** + id =1 + assert response_body == {"message": f"task {id} not found"} diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index aee7c52a1..74a502b58 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,8 @@ import pytest +from app.models.goal import 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_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +13,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 +30,7 @@ def test_get_goals_one_saved_goal(client, one_goal): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goal(client, one_goal): # Act response = client.get("/goals/1") @@ -46,22 +47,24 @@ 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 + assert response.status_code == 404 # assertion 2 goes here # ---- Complete Test ---- + id = 1 + assert response_body == {"message": f"goal {id} not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal(client): # Act response = client.post("/goals", json={ @@ -80,34 +83,55 @@ 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 + response = client.put("/goals/1", json={ + "title": "Updated Goal Title" + }) + response_body = response.get_json() # ---- Complete Act Here ---- # Assert # ---- Complete Assertions Here ---- # assertion 1 goes here + assert response.status_code == 200 # assertion 2 goes here + assert "goal" in response_body # assertion 3 goes here # ---- Complete Assertions Here ---- + assert response_body == { + "goal": { + "id": 1, + "title": "Updated Goal Title", + } + } + goal = Goal.query.get(1) + 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") + # raise Exception("Complete test") # Act + response = client.put("/goals/1", json={ + "title": "Updated Goal Title" + }) # ---- Complete Act Here ---- + response_body = response.get_json() # Assert # ---- Complete Assertions Here ---- # assertion 1 goes here + assert response.status_code == 404 # assertion 2 goes here # ---- Complete Assertions Here ---- + id = 1 + assert response_body == {"message": f"goal {id} not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -124,27 +148,33 @@ def test_delete_goal(client, one_goal): response = client.get("/goals/1") assert response.status_code == 404 - 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*************** # ***************************************************************** + assert Goal.query.get(1) == None -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_delete_goal_not_found(client): - raise Exception("Complete test") + # 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 + assert response.status_code == 404 + # ---- Complete Assertions Here ---- + assert response_body == {"message": "goal 1 not found"} + + assert Goal.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_goal_missing_title(client): # Act response = client.post("/goals", json={}) diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 8afa4325e..fbaeaf5c6 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -2,47 +2,39 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal(client, one_goal, three_tasks): # Act - response = client.post("/goals/1/tasks", json={ - "task_ids": [1, 2, 3] - }) + response = client.post("/goals/1/tasks", json={"task_ids": [1, 2, 3]}) response_body = response.get_json() # Assert assert response.status_code == 200 assert "id" in response_body assert "task_ids" in response_body - assert response_body == { - "id": 1, - "task_ids": [1, 2, 3] - } + assert response_body == {"id": 1, "task_ids": [1, 2, 3]} # Check that Goal was updated in the db assert len(Goal.query.get(1).tasks) == 3 -@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): +# @pytest.mark.skip(reason="No way to test this feature yet") +def test_post_task_ids_to_goal_already_with_goals( + client, one_task_belongs_to_one_goal, three_tasks +): # Act - response = client.post("/goals/1/tasks", json={ - "task_ids": [1, 4] - }) + response = client.post("/goals/1/tasks", json={"task_ids": [1, 4]}) response_body = response.get_json() # Assert assert response.status_code == 200 assert "id" in response_body assert "task_ids" in response_body - assert response_body == { - "id": 1, - "task_ids": [1, 4] - } + assert response_body == {"id": 1, "task_ids": [1, 4]} 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") @@ -51,13 +43,15 @@ 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") + # raise Exception("Complete test with assertion about response body") # ***************************************************************** # **Complete test with assertion about response body*************** # ***************************************************************** + id = 1 + assert response_body == {"message": f"goal {id} not found"} -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): # Act response = client.get("/goals/1/tasks") @@ -70,11 +64,11 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): assert response_body == { "id": 1, "title": "Build a habit of going outside daily", - "tasks": [] + "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_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") @@ -93,13 +87,13 @@ def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): "goal_id": 1, "title": "Go on my daily walk 🏞", "description": "Notice something new every day", - "is_complete": False + "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_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): response = client.get("/tasks/1") response_body = response.get_json() @@ -113,6 +107,6 @@ def test_get_task_includes_goal_id(client, one_task_belongs_to_one_goal): "goal_id": 1, "title": "Go on my daily walk 🏞", "description": "Notice something new every day", - "is_complete": False + "is_complete": False, } }