feat: make schema_tester optional init argument

Make `OpenAPIClient` `schema_tester` init argument optional by providing
default factory method for `schema_tester` instances.

Author: skarzi

README.md

@@ -246,7 +246,10 @@ schema_tester = SchemaTester()
 
 
 class MySimpleTestCase(SimpleTestCase):
-    client_class = functools.partial(OpenAPIClient, schema_tester=schema_tester)
+    client_class = OpenAPIClient
+    # or use `functools.partial` when you want to provide custom
+    # ``SchemaTester`` instance:
+    # client_class = functools.partial(OpenAPIClient, schema_tester=schema_tester)
 ```
 
 This will ensure you all newly implemented views will be validated against

openapi_tester/clients.py

@@ -5,22 +5,32 @@
 
 from rest_framework.test import APIClient
 
+from .schema_tester import SchemaTester
+
 if TYPE_CHECKING:
     from rest_framework.response import Response
 
-    from .schema_tester import SchemaTester
-
 
 class OpenAPIClient(APIClient):
     """``APIClient`` validating responses against OpenAPI schema."""
 
-    def __init__(self, *args, schema_tester: SchemaTester, **kwargs) -> None:
+    def __init__(
+        self,
+        *args,
+        schema_tester: SchemaTester | None = None,
+        **kwargs,
+    ) -> None:
         """Initialize ``OpenAPIClient`` instance."""
         super().__init__(*args, **kwargs)
-        self.schema_tester = schema_tester
+        self.schema_tester = schema_tester or self._schema_tester_factory()
 
     def request(self, **kwargs) -> Response:  # type: ignore[override]
         """Validate fetched response against given OpenAPI schema."""
         response = super().request(**kwargs)
         self.schema_tester.validate_response(response)
         return response
+
+    @staticmethod
+    def _schema_tester_factory() -> SchemaTester:
+        """Factory of default ``SchemaTester`` instances."""
+        return SchemaTester()

tests/test_clients.py

@@ -15,7 +15,16 @@ def openapi_client(settings) -> OpenAPIClient:
     """Sample ``OpenAPIClient`` instance to use in tests."""
     # use `drf-yasg` schema loader in tests
     settings.INSTALLED_APPS = [app for app in settings.INSTALLED_APPS if app != "drf_spectacular"]
-    return OpenAPIClient(schema_tester=SchemaTester())
+    return OpenAPIClient()
+
+
+def test_init_schema_tester_passed():
+    """Ensure passed ``SchemaTester`` instance is used."""
+    schema_tester = SchemaTester()
+
+    client = OpenAPIClient(schema_tester=schema_tester)
+
+    assert client.schema_tester is schema_tester
 
 
 @pytest.mark.parametrize(
@@ -77,16 +86,20 @@ def test_request_invalid_response(
         openapi_client.generic(**generic_kwargs)
 
 
-def test_django_testcase_client_class():
+@pytest.mark.parametrize(
+    "openapi_client_class",
+    [
+        OpenAPIClient,
+        functools.partial(OpenAPIClient, schema_tester=SchemaTester()),
+    ],
+)
+def test_django_testcase_client_class(openapi_client_class):
     """Ensure example from README.md about Django test case works fine."""
 
     class DummyTestCase(SimpleTestCase):
         """Django ``TestCase`` with ``OpenAPIClient`` client."""
 
-        client_class = functools.partial(
-            OpenAPIClient,
-            schema_tester=SchemaTester(),
-        )
+        client_class = openapi_client_class
 
     test_case = DummyTestCase()
     test_case._pre_setup()