feat: support loading configuration object in ListResponses

Author: azmeuk

doc/changelog.rst

@@ -7,6 +7,7 @@ Changelog
 Added
 ^^^^^
 - Display server discovery step network connections.
+- Support loading server configuration objects in :class:`~scim2_models.ListResponses`.
 
 [0.2.0] - 2024-12-03
 --------------------

scim2_cli/__init__.py

@@ -9,6 +9,7 @@
 from scim2_client import SCIMClientError
 from scim2_client.engines.httpx import SyncSCIMClient
 from scim2_models import Group
+from scim2_models import ListResponse
 from scim2_models import Resource
 from scim2_models import ResourceType
 from scim2_models import Schema
@@ -53,17 +54,27 @@ def load_config_files(
 ]:
     if schemas_fd:
         schemas_payload = json.load(schemas_fd)
-        schemas_obj = [Schema.model_validate(schema) for schema in schemas_payload]
+        if isinstance(schemas_payload, dict):
+            schemas_obj = ListResponse[Schema].model_validate(schemas_payload).resources
+        else:
+            schemas_obj = [Schema.model_validate(schema) for schema in schemas_payload]
         resource_models = [Resource.from_schema(schema) for schema in schemas_obj]
 
     else:
         resource_models = [User, Group]
 
     if resource_types_fd:
         resource_types_payload = json.load(resource_types_fd)
-        resource_types = [
-            ResourceType.model_validate(item) for item in resource_types_payload
-        ]
+        if isinstance(schemas_payload, dict):
+            resource_types = (
+                ListResponse[ResourceType]
+                .model_validate(resource_types_payload)
+                .resources
+            )
+        else:
+            resource_types = [
+                ResourceType.model_validate(item) for item in resource_types_payload
+            ]
     else:
         resource_types = None
 

tests/test_cli.py

@@ -1,13 +1,16 @@
 import json
 import os
 
+import pytest
 from scim2_models import AuthenticationScheme
 from scim2_models import Bulk
 from scim2_models import ChangePassword
 from scim2_models import ETag
 from scim2_models import Filter
+from scim2_models import ListResponse
 from scim2_models import Patch
 from scim2_models import ResourceType
+from scim2_models import Schema
 from scim2_models import ServiceProviderConfig
 from scim2_models import Sort
 from scim2_models import User
@@ -112,11 +115,9 @@ def test_env_vars(runner, httpserver, simple_user_payload):
         del os.environ["SCIM_CLI_HEADERS"]
 
 
-def test_custom_configuration_by_parameter(
-    runner, httpserver, simple_user_payload, tmp_path
-):
-    """Test passing custom .JSON configuration files to the command."""
-    spc = ServiceProviderConfig(
+@pytest.fixture
+def service_provider_configuration():
+    return ServiceProviderConfig(
         documentation_uri="https://scim.test",
         patch=Patch(supported=False),
         bulk=Bulk(supported=False, max_operations=0, max_payload_size=0),
@@ -134,29 +135,48 @@ def test_custom_configuration_by_parameter(
                 primary=True,
             ),
         ],
-    ).model_dump()
+    )
 
-    spc_path = tmp_path / "service_provider_configuration.json"
-    with open(spc_path, "w") as fd:
-        json.dump(spc, fd)
 
-    schemas = [User.to_schema().model_dump()]
-    schemas_path = tmp_path / "schemas.json"
-    with open(schemas_path, "w") as fd:
-        json.dump(schemas, fd)
+@pytest.fixture
+def schemas():
+    return [User.to_schema()]
+
 
-    resource_types = [
+@pytest.fixture
+def resource_types():
+    return [
         ResourceType(
             id="User",
             name="User",
             endpoint="/somewhere-different",
             description="User accounts",
             schema_="urn:ietf:params:scim:schemas:core:2.0:User",
-        ).model_dump()
+        )
     ]
+
+
+def test_custom_configuration_by_parameter(
+    runner,
+    httpserver,
+    simple_user_payload,
+    tmp_path,
+    service_provider_configuration,
+    schemas,
+    resource_types,
+):
+    """Test passing custom .JSON configuration files to the command."""
+    spc_path = tmp_path / "service_provider_configuration.json"
+    with open(spc_path, "w") as fd:
+        json.dump(service_provider_configuration.model_dump(), fd)
+
+    schemas_path = tmp_path / "schemas.json"
+    with open(schemas_path, "w") as fd:
+        json.dump([schema.model_dump() for schema in schemas], fd)
+
     resource_types_path = tmp_path / "resource_types.json"
     with open(resource_types_path, "w") as fd:
-        json.dump(resource_types, fd)
+        json.dump([resource_type.model_dump() for resource_type in resource_types], fd)
 
     httpserver.expect_request(
         "/somewhere-different/foobar",
@@ -187,49 +207,94 @@ def test_custom_configuration_by_parameter(
     assert result.exit_code == 0
 
 
-def test_custom_configuration_by_env(runner, httpserver, simple_user_payload, tmp_path):
-    """Test passing custom .JSON configuration files to the command."""
-    spc = ServiceProviderConfig(
-        documentation_uri="https://scim.test",
-        patch=Patch(supported=False),
-        bulk=Bulk(supported=False, max_operations=0, max_payload_size=0),
-        change_password=ChangePassword(supported=True),
-        filter=Filter(supported=False, max_results=0),
-        sort=Sort(supported=False),
-        etag=ETag(supported=False),
-        authentication_schemes=[
-            AuthenticationScheme(
-                name="OAuth Bearer Token",
-                description="Authentication scheme using the OAuth Bearer Token Standard",
-                spec_uri="http://www.rfc-editor.org/info/rfc6750",
-                documentation_uri="https://scim.test",
-                type="oauthbearertoken",
-                primary=True,
-            ),
+def test_custom_configuration_in_list_response(
+    runner,
+    httpserver,
+    simple_user_payload,
+    tmp_path,
+    service_provider_configuration,
+    schemas,
+    resource_types,
+):
+    """Test that ListResponse format is supported."""
+    spc_path = tmp_path / "service_provider_configuration.json"
+    with open(spc_path, "w") as fd:
+        json.dump(service_provider_configuration.model_dump(), fd)
+
+    schemas_path = tmp_path / "schemas.json"
+    with open(schemas_path, "w") as fd:
+        json.dump(
+            ListResponse[Schema](
+                total_results=len(schemas),
+                start_index=1,
+                items_per_page=len(schemas),
+                resources=schemas,
+            ).model_dump(),
+            fd,
+        )
+
+    resource_types_path = tmp_path / "resource_types.json"
+    with open(resource_types_path, "w") as fd:
+        json.dump(
+            ListResponse[ResourceType](
+                total_results=len(resource_types),
+                start_index=1,
+                items_per_page=len(resource_types),
+                resources=resource_types,
+            ).model_dump(),
+            fd,
+        )
+
+    httpserver.expect_request(
+        "/somewhere-different/foobar",
+        method="GET",
+    ).respond_with_json(
+        simple_user_payload("foobar"),
+        status=200,
+        content_type="application/scim+json",
+    )
+
+    result = runner.invoke(
+        cli,
+        [
+            "--url",
+            httpserver.url_for("/"),
+            "--service-provider-config",
+            spc_path,
+            "--schemas",
+            schemas_path,
+            "--resource-types",
+            resource_types_path,
+            "query",
+            "user",
+            "foobar",
         ],
-    ).model_dump()
+        catch_exceptions=False,
+    )
+    assert result.exit_code == 0
 
+
+def test_custom_configuration_by_env(
+    runner,
+    httpserver,
+    simple_user_payload,
+    tmp_path,
+    service_provider_configuration,
+    schemas,
+    resource_types,
+):
+    """Test passing custom .JSON configuration files to the command."""
     spc_path = tmp_path / "service_provider_configuration.json"
     with open(spc_path, "w") as fd:
-        json.dump(spc, fd)
+        json.dump(service_provider_configuration.model_dump(), fd)
 
-    schemas = [User.to_schema().model_dump()]
     schemas_path = tmp_path / "schemas.json"
     with open(schemas_path, "w") as fd:
-        json.dump(schemas, fd)
+        json.dump([schema.model_dump() for schema in schemas], fd)
 
-    resource_types = [
-        ResourceType(
-            id="User",
-            name="User",
-            endpoint="/somewhere-different",
-            description="User accounts",
-            schema_="urn:ietf:params:scim:schemas:core:2.0:User",
-        ).model_dump()
-    ]
     resource_types_path = tmp_path / "resource_types.json"
     with open(resource_types_path, "w") as fd:
-        json.dump(resource_types, fd)
+        json.dump([resource_type.model_dump() for resource_type in resource_types], fd)
 
     httpserver.expect_request(
         "/somewhere-different/foobar",