Simplify mocking with default values mocker

Author: bennylope

tests/conftest.py

@@ -1,4 +1,5 @@
 """Test fixtures."""
+
 import datetime
 
 import pytest
@@ -78,3 +79,50 @@ def frozen_time(mocker):
     now.return_value = datetime.datetime(
         2023, 8, 13, 12, 30, 15, tzinfo=datetime.timezone.utc
     )
+
+
+@pytest.fixture
+def discourse_request(discourse_host, discourse_client, requests_mock):
+    """Fixture for mocking Discourse API requests.
+
+    The only request arguments are the method and the path.
+
+    Example:
+
+    >>> def test_something(discourse_request):
+    >>>     request = discourse_request(
+    >>>         "put",  # the method, case-insensitive
+    >>>         "/the-path.json?q=4",  # the absolute path with query, NO host
+    >>>         headers={'content-type': 'text/plain'},  # override default headers
+    >>>         content=b"ERROR",  # override bytestring response
+    >>>     )
+
+    If `content` is provided, that will be used as the response body.
+    If `json` is provided, then the body will return the given JSON-
+        compatable Python structure (e.g. dictionary).
+    If neither is given then the return `json` will be an empty
+        dictionary (`{}`).
+
+    Returns a function for inserting sensible default values.
+    """
+
+    def inner(method, path, headers=None, json=None, content=None):
+        full_path = f"{discourse_host}{path}"
+        if not headers:
+            headers = {
+                "Content-Type": "application/json; charset=utf-8",
+                "Api-Key": discourse_client.api_key,
+                "Api-Username": discourse_client.api_username,
+            }
+
+        kwargs = {}
+        if content:
+            kwargs["content"] = content
+        elif json:
+            kwargs["json"] = json
+        else:
+            kwargs["json"] = {}
+
+        return requests_mock.request(method, full_path, headers=headers, **kwargs)
+
+    return inner

tests/test_client.py

@@ -20,13 +20,12 @@ def test_empty_content_http_ok(discourse_host, discourse_client, requests_mock):
 
 
 class TestUserManagement:
-    def test_get_user(self, discourse_host, discourse_client, requests_mock):
-        request = requests_mock.get(
-            f"{discourse_host}/users/someuser.json",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={"user": "someuser"},
+    def test_get_user(self, discourse_host, discourse_client, discourse_request):
+        request = discourse_request(
+            "get", "/users/someuser.json", json={"user": "someuser"}
         )
         discourse_client.user("someuser")
+
         assert request.called_once
 
     def test_create_user(self, discourse_host, discourse_client, requests_mock):
@@ -47,52 +46,34 @@ def test_create_user(self, discourse_host, discourse_client, requests_mock):
         assert session_request.called_once
         assert user_request.called_once
 
-    def test_update_email(self, discourse_host, discourse_client, requests_mock):
-        request = requests_mock.put(
-            f"{discourse_host}/users/someuser/preferences/email",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={},
-        )
+    def test_update_email(self, discourse_host, discourse_client, discourse_request):
+        request = discourse_request("put", "/users/someuser/preferences/email")
         discourse_client.update_email("someuser", "[email protected]")
 
         assert request.called_once
 
-    def test_update_user(self, discourse_client, requests_mock):
-        request = requests_mock.put(
-            f"{discourse_client.host}/users/someuser",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={},
-        )
+    def test_update_user(self, discourse_client, discourse_request):
+        request = discourse_request("put", "/users/someuser")
         discourse_client.update_user("someuser", a="a", b="b")
 
         assert request.called_once
 
-    def test_update_username(self, discourse_client, requests_mock):
-        request = requests_mock.put(
-            f"{discourse_client.host}/users/someuser/preferences/username",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={},
-        )
+    def test_update_username(self, discourse_client, discourse_request):
+        request = discourse_request("put", "/users/someuser/preferences/username")
         discourse_client.update_username("someuser", "newname")
 
         assert request.called_once
 
-    def test_by_external_id(self, discourse_client, requests_mock):
-        request = requests_mock.get(
-            f"{discourse_client.host}/users/by-external/123",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={"user": "123"},
+    def test_by_external_id(self, discourse_client, discourse_request):
+        request = discourse_request(
+            "get", "/users/by-external/123", json={"user": "123"}
         )
         discourse_client.by_external_id(123)
 
         assert request.called_once
 
-    def test_suspend_user(self, discourse_client, requests_mock, frozen_time):
-        request = requests_mock.put(
-            f"{discourse_client.host}/admin/users/123/suspend",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={},
-        )
+    def test_suspend_user(self, discourse_client, discourse_request, frozen_time):
+        request = discourse_request("put", "/admin/users/123/suspend")
         discourse_client.suspend(123, 1, "Testing")
 
         assert request.called_once
@@ -103,22 +84,14 @@ def test_suspend_user(self, discourse_client, requests_mock, frozen_time):
         assert request_payload["reason"] == ["Testing"]
         assert request_payload["suspend_until"] == ["2023-08-14T12:30:15+00:00"]
 
-    def test_unsuspend_user(self, discourse_client, requests_mock):
-        request = requests_mock.put(
-            f"{discourse_client.host}/admin/users/123/unsuspend",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={},
-        )
+    def test_unsuspend_user(self, discourse_client, discourse_request):
+        request = discourse_request("put", "/admin/users/123/unsuspend")
         discourse_client.unsuspend(123)
 
         assert request.called_once
 
-    def test_user_bagdes(self, discourse_client, requests_mock):
-        request = requests_mock.get(
-            f"{discourse_client.host}/user-badges/myusername.json",
-            headers={"Content-Type": "application/json; charset=utf-8"},
-            json={},
-        )
+    def test_user_bagdes(self, discourse_client, discourse_request):
+        request = discourse_request("get", "/user-badges/myusername.json")
         discourse_client.user_badges("myusername")
 
         assert request.called_once