diff --git a/.gitignore b/.gitignore index 4e9b18359..be3d242ec 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,9 @@ .vscode .DS_Store +# log files +app.log + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/ada-project-docs/wave_06.md b/ada-project-docs/wave_06.md index c05834ef1..75b80777d 100644 --- a/ada-project-docs/wave_06.md +++ b/ada-project-docs/wave_06.md @@ -1,4 +1,4 @@ -# Wave 6: Establishing a One-to-Many Relationship + # Wave 6: Establishing a One-to-Many Relationship ## Goal diff --git a/app/__init__.py b/app/__init__.py index 3c581ceeb..2d0bcfc34 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,10 +1,25 @@ from flask import Flask from .db import db, migrate from .models import task, goal +from .routes.task_routes import bp as tasks_bp +from .routes.goal_routes import bp as goals_bp import os +from dotenv import load_dotenv +import logging +from logging.config import dictConfig +from flask_cors import CORS + + +load_dotenv() + def create_app(config=None): app = Flask(__name__) + # CORS(app) # Enable CORS for all routes + + # configure_logging(app) + configure_logging(app) + logger = logging.getLogger(__name__) app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') @@ -14,9 +29,42 @@ def create_app(config=None): # to override the app's default settings for testing app.config.update(config) - db.init_app(app) - migrate.init_app(app, db) + try: + db.init_app(app) + migrate.init_app(app, db) + logger.info("Database initialized successfully.") + + with app.app_context(): + # db.session.execute("SELECT 1") + logger.info("DB connection test passed") + except Exception as e: + logger.exception("Error during DB initialization or connection") - # Register Blueprints here + # Register Blueprints + app.register_blueprint(tasks_bp) + app.register_blueprint(goals_bp) + + # configure_logging(app) + + configure_logging(app) + logger = logging.getLogger(__name__) return app + + +def configure_logging(app): + # Clear any default Flask handlers (useful for avoiding duplicate logs) + for handler in app.logger.handlers: + app.logger.removeHandler(handler) + + logging.basicConfig( + level=logging.INFO, + format='%(asctime)s %(levelname)s: %(message)s [in %(pathname)s:%(lineno)d]', + handlers=[ + logging.StreamHandler(), # logs to console + logging.FileHandler("app.log") # log to file + ] + ) + + # log Flask startup + logging.getLogger().info("Logging is set up.") diff --git a/app/models/goal.py b/app/models/goal.py index 44282656b..73e419eda 100644 --- a/app/models/goal.py +++ b/app/models/goal.py @@ -1,5 +1,39 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, relationship from ..db import db +from sqlalchemy import ForeignKey +from typing import Optional 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") + + @classmethod + def from_dict(cls, goal_data): + goal = cls(title=goal_data["title"]) + + return goal + + def goal_with_tasks(self): + task_list = [] + + for task in self.tasks: + task = task.to_dict() + task["goal_id"] = self.id + task_list.append(task) + + goal_with_tasks = self.to_dict() + goal_with_tasks["tasks"] = task_list + + return goal_with_tasks + + def to_dict(self): + goal_as_dict = { + "id": self.id, + "title": self.title, + } + + # if self.tasks: + # goal_as_dict["task_ids"] = [task.id for task in self.tasks] + + return goal_as_dict diff --git a/app/models/task.py b/app/models/task.py index 5d99666a4..0e8979a38 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -1,5 +1,44 @@ -from sqlalchemy.orm import Mapped, mapped_column +from sqlalchemy.orm import Mapped, mapped_column, column_property, relationship +from sqlalchemy import ForeignKey +from typing import Optional +from sqlalchemy import DateTime +from datetime import datetime from ..db import db class Task(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + title: Mapped[str] + description: Mapped[str] + completed_at: Mapped[Optional[datetime]] = mapped_column(DateTime, nullable=True) + is_complete = column_property(completed_at != None) + goal_id: Mapped[Optional[int]] = mapped_column(ForeignKey("goal.id")) + goal: Mapped[Optional["Goal"]] = relationship(back_populates="tasks") + + @classmethod + def from_dict(cls, task_data): + goal_id=task_data.get("goal_id") + completed_at = task_data.get("completed_at", None) + + return cls( + title=task_data["title"], + description=task_data["description"], + completed_at = completed_at, + goal_id=goal_id + ) + + + def to_dict(self, include_completed_at=False): + task_as_dict = { + "id": self.id, + "title": self.title, + "description": self.description, + "is_complete": bool(self.is_complete) + } + + if include_completed_at: + task_as_dict["completed_at"] = self.completed_at + + if self.goal: + task_as_dict["goal_id"] = self.goal.id + + return task_as_dict \ No newline at end of file diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/goal_routes.py b/app/routes/goal_routes.py index 3aae38d49..f8ed94383 100644 --- a/app/routes/goal_routes.py +++ b/app/routes/goal_routes.py @@ -1 +1,93 @@ -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 .route_utilities import validate_model, create_model, delete_model +from datetime import datetime +from datetime import timezone +import requests +import os + +bp = Blueprint("goals_bp", __name__, url_prefix="/goals") + + +@bp.post("") +def create_goal(): + request_body = request.get_json() + new_goal, status_code = create_model(Goal, request_body) + + return {"goal": new_goal}, status_code + + +@bp.get("") +def get_all_goals(): + query = db.select(Goal) + + title_param = request.args.get("title") + if title_param: + query = query.where(Goal.title.ilike(f"%{title_param}%")) + + query = query.order_by(Goal.id) + result = db.session.execute(query) + goals = result.scalars().all() + + goals_response = [] + for goal in goals: + goals_response.append(goal.to_dict()) + + return goals_response + + +@bp.get("/") +def get_one_goal(goal_id): + goal = validate_model(Goal, goal_id) + return {"goal": goal.to_dict()} + + +@bp.put("/") +def update_one_goal(goal_id): + task = validate_model(Goal, goal_id) + request_body = request.get_json() + + task.title = request_body["title"] + + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +@bp.delete("/") +def delete_one_goal(goal_id): + + return delete_model(Goal, goal_id) + + +@bp.post("//tasks") +def tasks_to_goal(goal_id): + goal = validate_model(Goal, goal_id) + + request_body = request.get_json() + + if "task_ids" in request_body: + for task in goal.tasks: + task.goal_id = None + + task_list = request_body.get("task_ids") + + for task_id in task_list: + task = validate_model(Task, task_id) + task.goal_id = goal.id + + db.session.commit() + + return { + "id": goal.id, + "task_ids": task_list + } + + +@bp.get("//tasks") +def tasks_for_specific_goal(goal_id): + goal = validate_model(Goal, goal_id) + + return goal.goal_with_tasks(), 200 diff --git a/app/routes/route_utilities.py b/app/routes/route_utilities.py new file mode 100644 index 000000000..8bfcaa348 --- /dev/null +++ b/app/routes/route_utilities.py @@ -0,0 +1,78 @@ +from flask import abort, make_response, Response +from ..db import db +import os +import requests +import logging + + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + response = {"message": f":{cls.__name__} with {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__} with {model_id} does not exist"} + 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 = {"details": "Invalid data"} + # 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 delete_model(cls, model_id): + model = validate_model(cls, model_id) + + db.session.delete(model) + db.session.commit() + + return Response(status=204, mimetype="application/json") + + +# Work in progress +def task_to_dict(Task, data): + { + "id": data.id, + "title": data.title, + "description": data.description, + "is_complete": bool(data.completed_at), + "goal": data.goal_id + } + + return task_to_dict + +def send_message_task_complete_slack(task_title): + slack_url = os.environ.get("SLACK_BOT_PATH") + slack_token = os.environ.get("SLACK_BOT_TOKEN") + slack_channel = os.environ.get("SLACK_CHANNEL_ID") # Can also be channel ID like "C01ABCXYZ" + + message = { + "channel": slack_channel, + "text": f"Someone just completed the task {task_title}" + } + + headers = { + "Authorization": f"Bearer {slack_token}", + "Content-Type": "application/json" + } + + response = requests.post(slack_url, json=message, headers=headers) + + if not response.ok: + logger = logging.getLogger(__name__) + logger.error(f"Slack message failed: {response.json()}") diff --git a/app/routes/task_routes.py b/app/routes/task_routes.py index 3aae38d49..d1d47009f 100644 --- a/app/routes/task_routes.py +++ b/app/routes/task_routes.py @@ -1 +1,131 @@ -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 app.models.goal import Goal +from ..db import db +from .route_utilities import validate_model, create_model, delete_model, send_message_task_complete_slack +from datetime import datetime +from datetime import timezone +import requests +import os + + +bp = Blueprint("tasks_bp", __name__, url_prefix="/tasks") + + +@bp.post("") +def create_task(): + request_body = request.get_json() + new_task, status_code = create_model(Task, request_body) + + return {"task": new_task}, status_code + + +@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}%")) + + completed_at_param = request.args.get("completed_at") + if completed_at_param: + query = query.where(Task.completed_at.like=={completed_at_param}) + + sort_param = request.args.get("sort") + if sort_param == "asc": + query = query.order_by(Task.title.asc()) + elif sort_param == "desc": + query = query.order_by(Task.title.desc()) + + query = query.order_by(Task.id) + tasks = db.session.scalars(query) + + tasks_response = [task.to_dict() for task in tasks] + + return tasks_response + + +@bp.get("/") +def get_one_task(task_id): + task = validate_model(Task, task_id) + return {"task": task.to_dict()} + + +@bp.put("/") +def update_one_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 = request_body.get("completed_at") + db.session.commit() + # needs fixing + return Response(status=204, mimetype="application/json") + + +@bp.delete("/") +def delete_one_task(task_id): + + return delete_model(Task, task_id) + +# Wave 3 +# @bp.patch("//mark_complete") +# def completed_task(task_id): +# task = validate_model(Task, task_id) +# task.completed_at = datetime.now(timezone.utc) +# print(f'********* mark_complete {task_id} {task.completed_at}') +# task_title = task.title +# send_request_to_slackbot(task_title) + +# db.session.commit() + +# return Response(status=204, mimetype="application/json") + +# def send_request_to_slackbot(data): +# print(f'********* request_to_slackbot') +# bot_path = os.environ.get("SLACK_BOT_PATH") +# bot_token = os.environ.get("SLACK_BOT_TOKEN") +# channel_id = os.environ.get("SLACK_CHANNEL_ID") +# message = "Restoration attempt #3 {data}" + +# token = f"Bearer {bot_token}" +# headers = { +# "Content-type": "application/json", +# "Authorization": token} +# request_body = { +# "channel": channel_id, +# "text": message +# } + +# CORRECTED YELLOW ISSUE #2 (There are two route handlers registered for /tasks/id/mark_incomplete) +@bp.patch("//mark_incomplete") +def incomplete_task(task_id): + task = validate_model(Task, task_id) + task.completed_at = None + + db.session.commit() + return Response(status=204, mimetype="application/json") + + +# @bp.patch("//mark_complete") +# def completed_on_complete_task(task_id): +# task = validate_model(Task, task_id) +# task.completed_at = datetime.now(timezone.utc) + +# db.session.commit() +# return Response(status=204, mimetype="application/json") + + + +@bp.patch("//mark_complete") +def completed_task_notification_by_API(task_id): + task = validate_model(Task, task_id) + task.completed_at = datetime.now(timezone.utc) + db.session.commit() + + send_message_task_complete_slack(task.title) + + # ADDED mimetype to fix json + return Response(status=204, mimetype="application/json") diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic,flask_migrate + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..7cfdccb86 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,111 @@ +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/76435b7e6989_.py b/migrations/versions/76435b7e6989_.py new file mode 100644 index 000000000..4bd90e635 --- /dev/null +++ b/migrations/versions/76435b7e6989_.py @@ -0,0 +1,39 @@ +"""empty message + +Revision ID: 76435b7e6989 +Revises: +Create Date: 2025-05-01 14:05:25.215222 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '76435b7e6989' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('task', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('completed_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('task') + op.drop_table('goal') + # ### end Alembic commands ### diff --git a/migrations/versions/adfe2b4cdb8a_.py b/migrations/versions/adfe2b4cdb8a_.py new file mode 100644 index 000000000..412bb79f0 --- /dev/null +++ b/migrations/versions/adfe2b4cdb8a_.py @@ -0,0 +1,32 @@ +"""empty message + +Revision ID: adfe2b4cdb8a +Revises: 76435b7e6989 +Create Date: 2025-05-07 23:42:20.014139 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'adfe2b4cdb8a' +down_revision = '76435b7e6989' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('goal', schema=None) as batch_op: + batch_op.add_column(sa.Column('title', sa.String(), nullable=False)) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('goal', schema=None) as batch_op: + batch_op.drop_column('title') + + # ### end Alembic commands ### diff --git a/migrations/versions/d84fb4711374_.py b/migrations/versions/d84fb4711374_.py new file mode 100644 index 000000000..750af7242 --- /dev/null +++ b/migrations/versions/d84fb4711374_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: d84fb4711374 +Revises: adfe2b4cdb8a +Create Date: 2025-05-08 16:29:03.502760 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'd84fb4711374' +down_revision = 'adfe2b4cdb8a' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.add_column(sa.Column('goal_id', sa.Integer(), nullable=True)) + batch_op.create_foreign_key(None, 'goal', ['goal_id'], ['id']) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('task', schema=None) as batch_op: + batch_op.drop_constraint(None, type_='foreignkey') + batch_op.drop_column('goal_id') + + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index b989cae17..ef800efe0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,6 +5,7 @@ charset-normalizer==3.4.1 click==8.1.8 coverage==7.6.12 Flask==3.1.0 +flask_cors==6.0.1 Flask-Migrate==4.1.0 Flask-SQLAlchemy==3.1.1 gunicorn==23.0.0 diff --git a/test_db_connection.py b/test_db_connection.py new file mode 100644 index 000000000..89ecd0273 --- /dev/null +++ b/test_db_connection.py @@ -0,0 +1,19 @@ +from sqlalchemy import create_engine +import os +from dotenv import load_dotenv + +# Load environment variables from .env file +load_dotenv() + +# Read the DATABASE_URL from the environment +db_url = os.getenv("SQLALCHEMY_DATABASE_URI") +print(f"Connecting to: {db_url}") + +try: + engine = create_engine(db_url) + connection = engine.connect() + print("✅ Connected successfully!") + connection.close() +except Exception as e: + print("❌ Connection failed:") + print(e) \ No newline at end of file diff --git a/tests/test_wave_01.py b/tests/test_wave_01.py index 55475db79..023477b5d 100644 --- a/tests/test_wave_01.py +++ b/tests/test_wave_01.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_get_tasks_no_saved_tasks(client): # Act response = client.get("/tasks") @@ -14,7 +14,7 @@ def test_get_tasks_no_saved_tasks(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_one_saved_tasks(client, one_task): # Act response = client.get("/tasks") @@ -33,7 +33,7 @@ def test_get_tasks_one_saved_tasks(client, one_task): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_task(client, one_task): # Act response = client.get("/tasks/1") @@ -52,7 +52,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,14 +60,15 @@ def test_get_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": f"Task with 1 does not exist"} - 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_create_task(client): # Act response = client.post("/tasks", json={ @@ -97,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={ @@ -117,7 +118,7 @@ def test_update_task(client, one_task): -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_update_task_not_found(client): # Act response = client.put("/tasks/1", json={ @@ -128,14 +129,15 @@ def test_update_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": "Task with 1 does not exist"} - 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_delete_task(client, one_task): # Act response = client.delete("/tasks/1") @@ -146,7 +148,7 @@ def test_delete_task(client, one_task): query = db.select(Task).where(Task.id == 1) assert db.session.scalar(query) == None -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_task_not_found(client): # Act response = client.delete("/tasks/1") @@ -154,8 +156,9 @@ def test_delete_task_not_found(client): # Assert assert response.status_code == 404 + assert response_body == {"message": f"Task with 1 does not exist"} - 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*************** # ***************************************************************** @@ -163,7 +166,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={ @@ -180,7 +183,7 @@ def test_create_task_must_contain_title(client): assert db.session.scalars(db.select(Task)).all() == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_task_must_contain_description(client): # Act response = client.post("/tasks", json={ diff --git a/tests/test_wave_02.py b/tests/test_wave_02.py index a087e0909..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 d7d441695..63fd40f59 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,20 @@ 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_incomplete_on_incomplete_task(client, one_task): + # Act + response = client.patch("/tasks/1/mark_incomplete") + + # Assert + assert response.status_code == 204 + + query = db.select(Task).where(Task.id == 1) + assert db.session.scalar(query).completed_at == None + + + +# @pytest.mark.skip(reason="No way to test this feature yet") def test_mark_complete_on_completed_task(client, completed_task): # Arrange """ @@ -74,7 +87,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 +99,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 +107,15 @@ def test_mark_complete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == {'message': 'Task with 1 does not exist'} - 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 +123,9 @@ def test_mark_incomplete_missing_task(client): # Assert assert response.status_code == 404 + assert response_body == {'message': 'Task with 1 does not exist'} - 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*************** # ***************************************************************** diff --git a/tests/test_wave_05.py b/tests/test_wave_05.py index 222d10cf0..fa7893842 100644 --- a/tests/test_wave_05.py +++ b/tests/test_wave_05.py @@ -1,7 +1,9 @@ import pytest +from app.models.goal import Goal +from app.db import db -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_no_saved_goals(client): # Act response = client.get("/goals") @@ -12,7 +14,7 @@ def test_get_goals_no_saved_goals(client): assert response_body == [] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goals_one_saved_goal(client, one_goal): # Act response = client.get("/goals") @@ -29,7 +31,7 @@ def test_get_goals_one_saved_goal(client, one_goal): ] -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_goal(client, one_goal): # Act response = client.get("/goals/1") @@ -46,22 +48,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 + assert response.status_code == 404 + assert response_body == {"message": f"Goal with 1 does not exist"} # ---- Complete Test ---- # assertion 1 goes here # assertion 2 goes here # ---- Complete Test ---- -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal(client): # Act response = client.post("/goals", json={ @@ -80,12 +84,19 @@ 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" + }) + query = db.select(Goal).where(Goal.id == 1) + goal = db.session.scalar(query) + # Assert + assert response.status_code == 204 + assert response.headers.get("Content-Length") == None + assert goal.title == "Updated Goal Title" # Assert # ---- Complete Assertions Here ---- # assertion 1 goes here @@ -94,20 +105,21 @@ def test_update_goal(client, one_goal): # ---- Complete Assertions Here ---- -@pytest.mark.skip(reason="test to be completed by student") +# @pytest.mark.skip(reason="test to be completed by student") def test_update_goal_not_found(client): - raise Exception("Complete test") - # Act - # ---- Complete Act Here ---- + response = client.get("/goals/1") + response_body = response.get_json() # Assert + assert response.status_code == 404 + assert response_body == {"message": f"Goal with 1 does not exist"} # ---- Complete Assertions Here ---- # assertion 1 goes here # assertion 2 goes here # ---- Complete Assertions Here ---- -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_delete_goal(client, one_goal): # Act response = client.delete("/goals/1") @@ -121,28 +133,29 @@ def test_delete_goal(client, one_goal): response_body = response.get_json() assert "message" in response_body + assert response_body["message"] == "Goal with 1 does not exist" - 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") - - # Act - # ---- Complete Act Here ---- + response = client.delete("/goals/1") + response_body = response.get_json() # Assert + assert response.status_code == 404 + assert response_body == {"message": f"Goal with 1 does not exist"} # ---- Complete Assertions Here ---- # assertion 1 goes here # assertion 2 goes here # ---- Complete Assertions Here ---- -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_create_goal_missing_title(client): # Act response = client.post("/goals", json={}) diff --git a/tests/test_wave_06.py b/tests/test_wave_06.py index 0317f835a..752a3cd0c 100644 --- a/tests/test_wave_06.py +++ b/tests/test_wave_06.py @@ -3,7 +3,7 @@ import pytest -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal(client, one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -25,7 +25,7 @@ def test_post_task_ids_to_goal(client, one_goal, three_tasks): assert len(db.session.scalar(query).tasks) == 3 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_one_goal, three_tasks): # Act response = client.post("/goals/1/tasks", json={ @@ -45,22 +45,23 @@ def test_post_task_ids_to_goal_already_with_goals(client, one_task_belongs_to_on assert len(db.session.scalar(query).tasks) == 2 -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal_no_goal(client): # Act response = client.get("/goals/1/tasks") response_body = response.get_json() + print(response_body) # Assert assert response.status_code == 404 - - raise Exception("Complete test with assertion about response body") + assert response_body == {"message": 'Goal with 1 does not exist'} + # 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,11 +78,12 @@ def test_get_tasks_for_specific_goal_no_tasks(client, one_goal): } -@pytest.mark.skip(reason="No way to test this feature yet") +# @pytest.mark.skip(reason="No way to test this feature yet") def test_get_tasks_for_specific_goal(client, one_task_belongs_to_one_goal): # Act response = client.get("/goals/1/tasks") response_body = response.get_json() + print(response_body) # Assert assert response.status_code == 200 @@ -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/views.py b/tests/views.py new file mode 100644 index 000000000..8a81043c7 --- /dev/null +++ b/tests/views.py @@ -0,0 +1,25 @@ +{ + 'id': 1, + 'task_ids': [1], + 'tasks': [ + {'description': 'Notice something new every day', + 'goal_id': 1, + 'id': 1, + 'is_complete': False, + 'title': 'Go on my daily walk 🏞'}], + 'title': 'Build a habit of going outside daily'} + + +{ + "id": 1, + "title": "Build a habit of going outside daily", + "tasks": [ + { + "id": 1, + "goal_id": 1, + "title": "Go on my daily walk 🏞", + "description": "Notice something new every day", + "is_complete": False + } + ] + } \ No newline at end of file