feat: TestSCIMClient raise a UnexpectedContentFormat exception when response is not JSON

Author: azmeuk

doc/changelog.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+[0.3.3] - Unreleased
+--------------------
+
+Added
+^^^^^
+- :class:`~scim2_client.engines.werkzeug.TestSCIMClient` raise a
+  :class:`~scim2_client.UnexpectedContentFormat` exception when response is not JSON.
+
 [0.3.2] - 2024-11-29
 --------------------
 
@@ -32,12 +40,12 @@ Fixed
 Added
 ^^^^^
 - The `Unknown resource type` request error keeps a reference to the faulty payload.
-- New `werkzeug` request engine for application development purpose.
-- New `AsyncSCIMClient` request engine. :issue:`1`
+- New :class:`~scim2_client.engines.werkzeug.TestSCIMClient` request engine for application development purpose.
+- New :class:`~scim2_client.engines.httpx.AsyncSCIMClient` request engine. :issue:`1`
 
 Changed
 ^^^^^^^
-- Separate httpx network code and SCIM code in separate file as a basis for async support (and maybe other request engines).
+- Separate httpx network code and SCIM code in separate file as a basis for async support (and other request engines).
 
 [0.2.2] - 2024-11-12
 --------------------

scim2_client/engines/werkzeug.py

@@ -1,3 +1,4 @@
+import json
 from contextlib import contextmanager
 from typing import Optional
 from typing import Union
@@ -13,13 +14,17 @@
 
 from scim2_client.client import BaseSyncSCIMClient
 from scim2_client.errors import SCIMClientError
+from scim2_client.errors import UnexpectedContentFormat
 
 
 @contextmanager
 def handle_response_error(response):
     try:
         yield
 
+    except json.decoder.JSONDecodeError as exc:
+        raise UnexpectedContentFormat(source=response) from exc
+
     except SCIMClientError as exc:
         exc.source = response
         raise exc

tests/engines/test_werkzeug.py

@@ -2,9 +2,12 @@
 from scim2_models import ResourceType
 from scim2_models import SearchRequest
 from scim2_models import User
+from werkzeug.wrappers import Request
+from werkzeug.wrappers import Response
 
 from scim2_client.engines.werkzeug import TestSCIMClient
 from scim2_client.errors import SCIMResponseErrorObject
+from scim2_client.errors import UnexpectedContentFormat
 
 scim2_server = pytest.importorskip("scim2_server")
 from scim2_server.backend import InMemoryBackend  # noqa: E402
@@ -61,3 +64,15 @@ def test_werkzeug_engine(scim_client):
     scim_client.delete(User, response_user.id)
     with pytest.raises(SCIMResponseErrorObject):
         scim_client.query(User, response_user.id)
+
+
+def test_no_json():
+    """Test that pages that do not return JSON raise an UnexpectedContentFormat error."""
+
+    @Request.application
+    def application(request):
+        return Response("Hello, World!", content_type="application/scim+json")
+
+    client = TestSCIMClient(app=application, resource_models=(User,))
+    with pytest.raises(UnexpectedContentFormat):
+        client.query(url="/")