feat: TestSCIMClient environ parameter.

Author: azmeuk

doc/changelog.rst

@@ -1,12 +1,15 @@
 Changelog
 =========
 
-[0.4.4] - Unreleased
+[0.5.0] - Unreleased
 --------------------
 
-Added
-^^^^^
-- :class:`~scim2_client.engines.werkzeug.TestSCIMClient` can take a `client` parameter.
+.. warning::
+
+    This version comes with breaking changes:
+
+    - :class:`~scim2_client.engines.werkzeug.TestSCIMClient` ``app`` is dropped in favor
+      of ``client`` and ``environ``. Have a look at the reference for examples.
 
 [0.4.3] - 2024-12-06
 --------------------

scim2_client/engines/werkzeug.py

@@ -37,10 +37,10 @@ class TestSCIMClient(BaseSyncSCIMClient):
     This client avoids to perform real HTTP requests and directly execute the server code instead.
     This allows to dynamically catch the exceptions if something gets wrong.
 
-    :param app: A WSGI application instance that will be used to send requests.
     :param client: An optional custom :class:`Werkzeug test Client <werkzeug.test.Client>`.
         If :data:`None` a default client is initialized.
     :param scim_prefix: The scim root endpoint in the application.
+    :param environ: Additional parameters that will be passed to every request.
     :param resource_models: A tuple of :class:`~scim2_models.Resource` types expected to be handled by the SCIM client.
         If a request payload describe a resource that is not in this list, an exception will be raised.
     :param check_request_payload: If :data:`False`,
@@ -56,9 +56,14 @@ class TestSCIMClient(BaseSyncSCIMClient):
 
         from scim2_client.engines.werkzeug import TestSCIMClient
         from scim2_models import User, Group
+        from werkzeug.test import Client
 
         scim_provider = myapp.create_app()
-        testclient = TestSCIMClient(app=scim_provider, resource_models=(User, Group))
+        testclient = TestSCIMClient(
+            app=Client(scim_provider),
+            environ={"base_url": "/scim/v2"},
+            resource_models=(User, Group),
+        )
 
         request_user = User(user_name="foo", display_name="bar")
         response_user = scim_client.create(request_user)
@@ -70,15 +75,16 @@ class TestSCIMClient(BaseSyncSCIMClient):
 
     def __init__(
         self,
-        app,
-        client: Optional[Client] = None,
-        *args,
+        client: Client,
+        environ: Optional[dict] = None,
         scim_prefix: str = "",
+        *args,
         **kwargs,
     ):
         super().__init__(*args, **kwargs)
-        self.client = client or Client(app)
+        self.client = client
         self.scim_prefix = scim_prefix
+        self.environ = environ or {}
 
     def make_url(self, url: Optional[str]) -> str:
         url = url or ""
@@ -112,9 +118,8 @@ def create(
             **kwargs,
         )
 
-        response = self.client.post(
-            self.make_url(req.url), json=req.payload, **req.request_kwargs
-        )
+        environ = {**self.environ, **req.request_kwargs}
+        response = self.client.post(self.make_url(req.url), json=req.payload, **environ)
 
         with handle_response_error(req.payload):
             return self.check_response(
@@ -152,8 +157,9 @@ def query(
         )
 
         query_string = urlencode(req.payload, doseq=False) if req.payload else None
+        environ = {**self.environ, **req.request_kwargs}
         response = self.client.get(
-            self.make_url(req.url), query_string=query_string, **req.request_kwargs
+            self.make_url(req.url), query_string=query_string, **environ
         )
 
         with handle_response_error(req.payload):
@@ -187,9 +193,8 @@ def search(
             **kwargs,
         )
 
-        response = self.client.post(
-            self.make_url(req.url), json=req.payload, **req.request_kwargs
-        )
+        environ = {**self.environ, **req.request_kwargs}
+        response = self.client.post(self.make_url(req.url), json=req.payload, **environ)
 
         with handle_response_error(response):
             return self.check_response(
@@ -222,7 +227,8 @@ def delete(
             **kwargs,
         )
 
-        response = self.client.delete(self.make_url(req.url), **req.request_kwargs)
+        environ = {**self.environ, **req.request_kwargs}
+        response = self.client.delete(self.make_url(req.url), **environ)
 
         with handle_response_error(response):
             return self.check_response(
@@ -253,9 +259,8 @@ def replace(
             **kwargs,
         )
 
-        response = self.client.put(
-            self.make_url(req.url), json=req.payload, **req.request_kwargs
-        )
+        environ = {**self.environ, **req.request_kwargs}
+        response = self.client.put(self.make_url(req.url), json=req.payload, **environ)
 
         with handle_response_error(response):
             return self.check_response(

tests/engines/test_werkzeug.py

@@ -1,6 +1,7 @@
 import pytest
 from scim2_models import SearchRequest
 from scim2_models import User
+from werkzeug.test import Client
 from werkzeug.wrappers import Request
 from werkzeug.wrappers import Response
 
@@ -27,9 +28,10 @@ def scim_provider():
 
 @pytest.fixture
 def scim_client(scim_provider):
-    client = TestSCIMClient(app=scim_provider)
-    client.discover()
-    return client
+    werkzeug_client = Client(scim_provider)
+    scim_client = TestSCIMClient(werkzeug_client)
+    scim_client.discover()
+    return scim_client
 
 
 def test_werkzeug_engine(scim_client):
@@ -69,6 +71,25 @@ def test_no_json():
     def application(request):
         return Response("Hello, World!", content_type="application/scim+json")
 
-    client = TestSCIMClient(app=application, resource_models=(User,))
+    werkzeug_client = Client(application)
+    scim_client = TestSCIMClient(client=werkzeug_client, resource_models=(User,))
+    scim_client.register_naive_resource_types()
     with pytest.raises(UnexpectedContentFormat):
-        client.query(url="/")
+        scim_client.query(url="/")
+
+
+def test_environ(scim_client):
+    @Request.application
+    def application(request):
+        assert request.headers["content-type"] == "foobar"
+        user = User(user_name="foobar", id="foobar")
+        return Response(user.model_dump_json(), content_type="application/scim+json")
+
+    werkzeug_client = Client(application)
+    scim_client = TestSCIMClient(
+        client=werkzeug_client,
+        environ={"headers": {"content-type": "foobar"}},
+        resource_models=(User,),
+    )
+    scim_client.register_naive_resource_types()
+    scim_client.query(url="/Users")