Switch tests to declarative respx request lookups

Use declarative respx lookups (params__eq, headers__contains, json__eq) via mock_route request_* arguments and response_* payload arguments.

Set API fixtures to deterministic request IDs so request-header assertions remain fully declarative and consistent across sync and async tests.

Author: goncalossilva

tests/conftest.py

@@ -15,6 +15,7 @@
     DEFAULT_LABELS_RESPONSE,
     DEFAULT_PROJECT_RESPONSE,
     DEFAULT_PROJECTS_RESPONSE,
+    DEFAULT_REQUEST_ID,
     DEFAULT_SECTION_RESPONSE,
     DEFAULT_SECTIONS_RESPONSE,
     DEFAULT_TASK_META_RESPONSE,
@@ -42,13 +43,19 @@
 
 @pytest.fixture
 def todoist_api() -> Iterator[TodoistAPI]:
-    with TodoistAPI(DEFAULT_TOKEN) as api:
+    with TodoistAPI(
+        DEFAULT_TOKEN,
+        request_id_fn=lambda: DEFAULT_REQUEST_ID,
+    ) as api:
         yield api
 
 
 @pytest_asyncio.fixture
 async def todoist_api_async() -> AsyncIterator[TodoistAPIAsync]:
-    async with TodoistAPIAsync(DEFAULT_TOKEN) as api:
+    async with TodoistAPIAsync(
+        DEFAULT_TOKEN,
+        request_id_fn=lambda: DEFAULT_REQUEST_ID,
+    ) as api:
         yield api
 
 

tests/test_api_comments.py

@@ -8,13 +8,7 @@
     DEFAULT_API_URL,
     PaginatedResults,
 )
-from tests.utils.test_utils import (
-    auth_matcher,
-    data_matcher,
-    enumerate_async,
-    mock_route,
-    request_id_matcher,
-)
+from tests.utils.test_utils import api_headers, enumerate_async, mock_route
 from todoist_api_python.models import Attachment
 
 if TYPE_CHECKING:
@@ -41,9 +35,9 @@ async def test_get_comment(
         respx_mock,
         method="GET",
         url=endpoint,
-        json=default_comment_response,
-        status=200,
-        matchers=[auth_matcher(), request_id_matcher()],
+        request_headers=api_headers(),
+        response_json=default_comment_response,
+        response_status=200,
     )
 
     comment = todoist_api.get_comment(comment_id)
@@ -74,13 +68,11 @@ async def test_get_comments(
             respx_mock,
             method="GET",
             url=endpoint,
-            json=page,
-            status=200,
-            params={"task_id": task_id} | ({"cursor": cursor} if cursor else {}),
-            matchers=[
-                auth_matcher(),
-                request_id_matcher(),
-            ],
+            request_params={"task_id": task_id}
+            | ({"cursor": cursor} if cursor else {}),
+            request_headers=api_headers(),
+            response_json=page,
+            response_status=200,
         )
         cursor = page["next_cursor"]
 
@@ -122,19 +114,14 @@ async def test_add_comment(
         respx_mock,
         method="POST",
         url=f"{DEFAULT_API_URL}/comments",
-        json=default_comment_response,
-        status=200,
-        matchers=[
-            auth_matcher(),
-            request_id_matcher(),
-            data_matcher(
-                {
-                    "content": content,
-                    "project_id": project_id,
-                    "attachment": attachment.to_dict(),
-                }
-            ),
-        ],
+        request_headers=api_headers(),
+        request_json={
+            "content": content,
+            "project_id": project_id,
+            "attachment": attachment.to_dict(),
+        },
+        response_json=default_comment_response,
+        response_status=200,
     )
 
     new_comment = todoist_api.add_comment(
@@ -172,9 +159,10 @@ async def test_update_comment(
         respx_mock,
         method="POST",
         url=f"{DEFAULT_API_URL}/comments/{default_comment.id}",
-        json=updated_comment_dict,
-        status=200,
-        matchers=[auth_matcher(), request_id_matcher(), data_matcher(args)],
+        request_headers=api_headers(),
+        request_json=args,
+        response_json=updated_comment_dict,
+        response_status=200,
     )
 
     response = todoist_api.update_comment(comment_id=default_comment.id, **args)
@@ -203,8 +191,8 @@ async def test_delete_comment(
         respx_mock,
         method="DELETE",
         url=endpoint,
-        status=204,
-        matchers=[auth_matcher(), request_id_matcher()],
+        request_headers=api_headers(),
+        response_status=204,
     )
 
     response = todoist_api.delete_comment(comment_id)

tests/test_api_completed_tasks.py

@@ -12,12 +12,7 @@
 import pytest
 
 from tests.data.test_defaults import DEFAULT_API_URL, PaginatedItems
-from tests.utils.test_utils import (
-    auth_matcher,
-    enumerate_async,
-    mock_route,
-    request_id_matcher,
-)
+from tests.utils.test_utils import api_headers, enumerate_async, mock_route
 from todoist_api_python._core.utils import format_datetime
 
 if TYPE_CHECKING:
@@ -56,13 +51,10 @@ async def test_get_completed_tasks_by_due_date(
             respx_mock,
             method="GET",
             url=endpoint,
-            json=page,
-            status=200,
-            params=params | ({"cursor": cursor} if cursor else {}),
-            matchers=[
-                auth_matcher(),
-                request_id_matcher(),
-            ],
+            request_params=params | ({"cursor": cursor} if cursor else {}),
+            request_headers=api_headers(),
+            response_json=page,
+            response_status=200,
         )
         cursor = page["next_cursor"]
 
@@ -121,13 +113,10 @@ async def test_get_completed_tasks_by_completion_date(
             respx_mock,
             method="GET",
             url=endpoint,
-            json=page,
-            status=200,
-            params=params | ({"cursor": cursor} if cursor else {}),
-            matchers=[
-                auth_matcher(),
-                request_id_matcher(),
-            ],
+            request_params=params | ({"cursor": cursor} if cursor else {}),
+            request_headers=api_headers(),
+            response_json=page,
+            response_status=200,
         )
         cursor = page["next_cursor"]
 

tests/test_api_labels.py

@@ -5,13 +5,7 @@
 import pytest
 
 from tests.data.test_defaults import DEFAULT_API_URL, PaginatedResults
-from tests.utils.test_utils import (
-    auth_matcher,
-    data_matcher,
-    enumerate_async,
-    mock_route,
-    request_id_matcher,
-)
+from tests.utils.test_utils import api_headers, enumerate_async, mock_route
 
 if TYPE_CHECKING:
     import respx
@@ -36,9 +30,9 @@ async def test_get_label(
         respx_mock,
         method="GET",
         url=endpoint,
-        json=default_label_response,
-        status=200,
-        matchers=[auth_matcher()],
+        request_headers=api_headers(),
+        response_json=default_label_response,
+        response_status=200,
     )
 
     label = todoist_api.get_label(label_id)
@@ -68,10 +62,10 @@ async def test_get_labels(
             respx_mock,
             method="GET",
             url=endpoint,
-            json=page,
-            status=200,
-            params={"cursor": cursor} if cursor else {},
-            matchers=[auth_matcher(), request_id_matcher()],
+            request_params={"cursor": cursor} if cursor else {},
+            request_headers=api_headers(),
+            response_json=page,
+            response_status=200,
         )
         cursor = page["next_cursor"]
 
@@ -109,13 +103,10 @@ async def test_search_labels(
             respx_mock,
             method="GET",
             url=endpoint,
-            json=page,
-            status=200,
-            params={"query": query} | ({"cursor": cursor} if cursor else {}),
-            matchers=[
-                auth_matcher(),
-                request_id_matcher(),
-            ],
+            request_params={"query": query} | ({"cursor": cursor} if cursor else {}),
+            request_headers=api_headers(),
+            response_json=page,
+            response_status=200,
         )
         cursor = page["next_cursor"]
 
@@ -150,13 +141,10 @@ async def test_add_label_minimal(
         respx_mock,
         method="POST",
         url=f"{DEFAULT_API_URL}/labels",
-        json=default_label_response,
-        status=200,
-        matchers=[
-            auth_matcher(),
-            request_id_matcher(),
-            data_matcher({"name": label_name}),
-        ],
+        request_headers=api_headers(),
+        request_json={"name": label_name},
+        response_json=default_label_response,
+        response_status=200,
     )
 
     new_label = todoist_api.add_label(name=label_name)
@@ -189,13 +177,10 @@ async def test_add_label_full(
         respx_mock,
         method="POST",
         url=f"{DEFAULT_API_URL}/labels",
-        json=default_label_response,
-        status=200,
-        matchers=[
-            auth_matcher(),
-            request_id_matcher(),
-            data_matcher({"name": label_name} | args),
-        ],
+        request_headers=api_headers(),
+        request_json={"name": label_name} | args,
+        response_json=default_label_response,
+        response_status=200,
     )
 
     new_label = todoist_api.add_label(name=label_name, **args)
@@ -225,9 +210,10 @@ async def test_update_label(
         respx_mock,
         method="POST",
         url=f"{DEFAULT_API_URL}/labels/{default_label.id}",
-        json=updated_label_dict,
-        status=200,
-        matchers=[auth_matcher(), request_id_matcher(), data_matcher(args)],
+        request_headers=api_headers(),
+        request_json=args,
+        response_json=updated_label_dict,
+        response_status=200,
     )
 
     response = todoist_api.update_label(label_id=default_label.id, **args)
@@ -254,8 +240,8 @@ async def test_delete_label(
         respx_mock,
         method="DELETE",
         url=endpoint,
-        status=204,
-        matchers=[auth_matcher(), request_id_matcher()],
+        request_headers=api_headers(),
+        response_status=204,
     )
 
     response = todoist_api.delete_label(label_id)
@@ -267,5 +253,3 @@ async def test_delete_label(
 
     assert len(respx_mock.calls) == 2
     assert response is True
-
-