Merge branch 'main' of https://github.com/AdaGold/task-list-api into ay_update_wave6_test

Author: yangashley

ada-project-docs/wave_01.md

@@ -150,32 +150,19 @@ As a client, I want to be able to make a `PUT` request to `/tasks/1` when there
 
 and get this response:
 
-`200 OK`
+`204 No Content`
 
-```json
-{
-  "task": {
-    "id": 1,
-    "title": "Updated Task Title",
-    "description": "Updated Test Description",
-    "is_complete": false
-  }
-}
-```
+The response should have a mimetype of "application/json" to keep our API response type consistent.
 
 Note that the update endpoint does update the `completed_at` attribute. This will be updated with custom endpoints implemented in Wave 3.
 
 #### Delete Task: Deleting a Task
 
 As a client, I want to be able to make a `DELETE` request to `/tasks/1` when there is at least one saved task and get this response:
 
-`200 OK`
+`204 No Content`
 
-```json
-{
-  "details": "Task 1 \"Go on my daily walk 🏞\" successfully deleted"
-}
-```
+The response should have a mimetype of "application/json" to keep our API response type consistent.
 
 #### No Matching Task: Get, Update, and Delete
 

ada-project-docs/wave_03.md

@@ -34,6 +34,12 @@ when I send a `PATCH` request to `/tasks/1/mark_complete`,
 
 then the task is updated, so that its `completed_at` value is the current date, and I get this response:
 
+`204 No Content`
+
+The response should have a mimetype of "application/json" to keep our API response type consistent.
+
+After I have made the `PATCH` request, I can submit a `GET` request to `/tasks/1`, which will return the response:
+
 `200 OK`
 
 ```json
@@ -58,6 +64,12 @@ when I send a `PATCH` request to `/tasks/1/mark_incomplete`,
 
 then the task is updated, so that its `completed_at` value is `null`/`None`, and I get this response:
 
+`204 No Content`
+
+The response should have a mimetype of "application/json" to keep our API response type consistent.
+
+After I have made the `PATCH` request, I can submit a `GET` request to `/tasks/1`, which will return the response:
+
 `200 OK`
 
 ```json
@@ -82,6 +94,12 @@ when I send a `PATCH` request to `/tasks/1/mark_complete`,
 
 then I want this to behave exactly like `/tasks/1/mark_complete` for an incomplete task. The task is updated, so that its `completed_at` value is the current date, and I get this response:
 
+`204 No Content`
+
+The response should have a mimetype of "application/json" to keep our API response type consistent.
+
+After I have made the `PATCH` request, I can submit a `GET` request to `/tasks/1`, which will return the response:
+
 `200 OK`
 
 ```json
@@ -106,6 +124,12 @@ when I send a `PATCH` request to `/tasks/1/mark_incomplete`,
 
 then I want this to behave exactly like `/tasks/1/mark_incomplete` for a complete task. Its `completed_at` value remains as `null`/`None`, and I get this response:
 
+`204 No Content`
+
+The response should have a mimetype of "application/json" to keep our API response type consistent.
+
+After I have made the `PATCH` request, I can submit a `GET` request to `/tasks/1`, which will return the response:
+
 `200 OK`
 
 ```json

ada-project-docs/wave_05.md

@@ -125,28 +125,17 @@ As a client, I want to be able to make a `PUT` request to `/goals/1` when there
 
 and get this response:
 
-`200 OK`
+`204 No Content`
 
-```json
-{
-  "goal": {
-    "id": 1,
-    "title": "Updated Goal Title"
-  }
-}
-```
+The response should have a mimetype of "application/json" to keep our API response type consistent.
 
 ### Delete Goal: Deleting a Goal
 
 As a client, I want to be able to make a `DELETE` request to `/goals/1` when there is at least one saved goal and get this response:
 
-`200 OK`
+`204 No Content`
 
-```json
-{
-  "details": "Goal 1 \"Build a habit of going outside daily\" successfully deleted"
-}
-```
+The response should have a mimetype of "application/json" to keep our API response type consistent.
 
 ### No matching Goal: Get, Update, and Delete
 

tests/conftest.py

@@ -57,14 +57,14 @@ def one_task(app):
 def three_tasks(app):
     db.session.add_all([
         Task(title="Water the garden 🌷", 
-             description="", 
-             completed_at=None),
+            description="", 
+            completed_at=None),
         Task(title="Answer forgotten email 📧", 
-             description="", 
-             completed_at=None),
+            description="", 
+            completed_at=None),
         Task(title="Pay my outstanding tickets 😭", 
-             description="", 
-             completed_at=None)
+            description="", 
+            completed_at=None)
     ])
     db.session.commit()
 
@@ -77,7 +77,7 @@ def three_tasks(app):
 def completed_task(app):
     new_task = Task(title="Go on my daily walk 🏞", 
                     description="Notice something new every day", 
-                    completed_at=datetime.utcnow())
+                    completed_at=datetime.now())
     db.session.add(new_task)
     db.session.commit()
 
@@ -99,7 +99,9 @@ def one_goal(app):
 # goal has this task, and the task belongs to one goal
 @pytest.fixture
 def one_task_belongs_to_one_goal(app, one_goal, one_task):
-    task = Task.query.first()
-    goal = Goal.query.first()
+    task_query = db.select(Task).where(Task.id == 1)
+    goal_query = db.select(Goal).where(Goal.id == 1)
+    task = db.session.scalar(task_query)
+    goal = db.session.scalar(goal_query)
     goal.tasks.append(task)
-    db.session.commit()
+    db.session.commit()

tests/test_wave_01.py

@@ -1,4 +1,5 @@
 from app.models.task import Task
+from app.db import db
 import pytest
 
 
@@ -86,7 +87,10 @@ def test_create_task(client):
             "is_complete": False
         }
     }
-    new_task = Task.query.get(1)
+    
+    query = db.select(Task).where(Task.id == 1)
+    new_task = db.session.scalar(query)
+
     assert new_task
     assert new_task.title == "A Brand New Task"
     assert new_task.description == "Test Description"
@@ -100,25 +104,19 @@ def test_update_task(client, one_task):
         "title": "Updated Task Title",
         "description": "Updated Test Description",
     })
-    response_body = response.get_json()
 
     # Assert
-    assert response.status_code == 200
-    assert "task" in response_body
-    assert response_body == {
-        "task": {
-            "id": 1,
-            "title": "Updated Task Title",
-            "description": "Updated Test Description",
-            "is_complete": False
-        }
-    }
-    task = Task.query.get(1)
+    assert response.status_code == 204
+
+    query = db.select(Task).where(Task.id == 1)
+    task = db.session.scalar(query)
+
     assert task.title == "Updated Task Title"
     assert task.description == "Updated Test Description"
     assert task.completed_at == None
 
 
+
 @pytest.mark.skip(reason="No way to test this feature yet")
 def test_update_task_not_found(client):
     # Act
@@ -141,16 +139,12 @@ def test_update_task_not_found(client):
 def test_delete_task(client, one_task):
     # Act
     response = client.delete("/tasks/1")
-    response_body = response.get_json()
 
     # Assert
-    assert response.status_code == 200
-    assert "details" in response_body
-    assert response_body == {
-        "details": 'Task 1 "Go on my daily walk 🏞" successfully deleted'
-    }
-    assert Task.query.get(1) == None
+    assert response.status_code == 204
 
+    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")
 def test_delete_task_not_found(client):
@@ -166,7 +160,7 @@ def test_delete_task_not_found(client):
     # **Complete test with assertion about response body***************
     # *****************************************************************
 
-    assert Task.query.all() == []
+    assert db.session.scalars(db.select(Task)).all() == []
 
 
 @pytest.mark.skip(reason="No way to test this feature yet")
@@ -183,7 +177,7 @@ def test_create_task_must_contain_title(client):
     assert response_body == {
         "details": "Invalid data"
     }
-    assert Task.query.all() == []
+    assert db.session.scalars(db.select(Task)).all() == []
 
 
 @pytest.mark.skip(reason="No way to test this feature yet")
@@ -200,4 +194,4 @@ def test_create_task_must_contain_description(client):
     assert response_body == {
         "details": "Invalid data"
     }
-    assert Task.query.all() == []
+    assert db.session.scalars(db.select(Task)).all() == []

tests/test_wave_03.py

@@ -2,6 +2,7 @@
 from unittest.mock import Mock, patch
 from datetime import datetime
 from app.models.task import Task
+from app.db import db
 import pytest
 
 
@@ -25,41 +26,24 @@ def test_mark_complete_on_incomplete_task(client, one_task):
 
         # Act
         response = client.patch("/tasks/1/mark_complete")
-    response_body = response.get_json()
 
     # Assert
-    assert response.status_code == 200
-    assert "task" in response_body
-    assert response_body["task"]["is_complete"] == True
-    assert response_body == {
-        "task": {
-            "id": 1,
-            "title": "Go on my daily walk 🏞",
-            "description": "Notice something new every day",
-            "is_complete": True
-        }
-    }
-    assert Task.query.get(1).completed_at
+    assert response.status_code == 204
+    
+    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")
 def test_mark_incomplete_on_complete_task(client, completed_task):
     # Act
     response = client.patch("/tasks/1/mark_incomplete")
-    response_body = response.get_json()
+    
 
     # Assert
-    assert response.status_code == 200
-    assert response_body["task"]["is_complete"] == False
-    assert response_body == {
-        "task": {
-            "id": 1,
-            "title": "Go on my daily walk 🏞",
-            "description": "Notice something new every day",
-            "is_complete": False
-        }
-    }
-    assert Task.query.get(1).completed_at == None
+    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")
@@ -82,41 +66,24 @@ def test_mark_complete_on_completed_task(client, completed_task):
 
         # Act
         response = client.patch("/tasks/1/mark_complete")
-    response_body = response.get_json()
+    
 
     # Assert
-    assert response.status_code == 200
-    assert "task" in response_body
-    assert response_body["task"]["is_complete"] == True
-    assert response_body == {
-        "task": {
-            "id": 1,
-            "title": "Go on my daily walk 🏞",
-            "description": "Notice something new every day",
-            "is_complete": True
-        }
-    }
-    assert Task.query.get(1).completed_at
+    assert response.status_code == 204
 
+    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")
 def test_mark_incomplete_on_incomplete_task(client, one_task):
     # Act
     response = client.patch("/tasks/1/mark_incomplete")
-    response_body = response.get_json()
 
     # Assert
-    assert response.status_code == 200
-    assert response_body["task"]["is_complete"] == False
-    assert response_body == {
-        "task": {
-            "id": 1,
-            "title": "Go on my daily walk 🏞",
-            "description": "Notice something new every day",
-            "is_complete": False
-        }
-    }
-    assert Task.query.get(1).completed_at == None
+    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")

tests/test_wave_05.py

@@ -111,19 +111,17 @@ def test_update_goal_not_found(client):
 def test_delete_goal(client, one_goal):
     # Act
     response = client.delete("/goals/1")
-    response_body = response.get_json()
 
     # Assert
-    assert response.status_code == 200
-    assert "details" in response_body
-    assert response_body == {
-        "details": 'Goal 1 "Build a habit of going outside daily" successfully deleted'
-    }
+    assert response.status_code == 204
 
     # Check that the goal was deleted
     response = client.get("/goals/1")
     assert response.status_code == 404
 
+    response_body = response.get_json()
+    assert "message" in response_body
+
     raise Exception("Complete test with assertion about response body")
     # *****************************************************************
     # **Complete test with assertion about response body***************