feat: check for Schema and ResourceType with invalid ids

Author: azmeuk

doc/changelog.rst

@@ -8,6 +8,7 @@ Added
 ^^^^^
 - Restrict expected status codes in checks.
 - Check individual :class:`~scim2_models.Schema` and :class:`~scim2_models.ResourceType` endpoints.
+- Check for :class:`~scim2_models.Schema` and :class:`~scim2_models.ResourceType` with invalid ids.
 
 Fixed
 ^^^^^

scim2_tester/resource_types.py

@@ -1,3 +1,5 @@
+import uuid
+
 from scim2_models import Error
 from scim2_models import ResourceType
 
@@ -25,6 +27,8 @@ def check_resource_types_endpoint(conf: CheckConfig) -> list[CheckResult]:
         for resource_type in resource_types_result.data:
             results.append(check_query_resource_type_by_id(conf, resource_type))
 
+    results.append(check_access_invalid_resource_type(conf))
+
     return results
 
 
@@ -56,3 +60,37 @@ def check_query_resource_type_by_id(
 
     reason = f"Successfully accessed the /ResourceTypes/{resource_type.id} endpoint."
     return CheckResult(conf, status=Status.SUCCESS, reason=reason, data=response)
+
+
+@checker
+def check_access_invalid_resource_type(conf: CheckConfig) -> CheckResult:
+    probably_invalid_id = str(uuid.uuid4())
+    response = conf.client.query(
+        ResourceType,
+        probably_invalid_id,
+        expected_status_codes=conf.expected_status_codes or [404],
+        raise_scim_errors=False,
+    )
+
+    if not isinstance(response, Error):
+        return CheckResult(
+            conf,
+            status=Status.ERROR,
+            reason=f"/resource_types/{probably_invalid_id} invalid URL did not return an Error object",
+            data=response,
+        )
+
+    if response.status != 404:
+        return CheckResult(
+            conf,
+            status=Status.ERROR,
+            reason=f"/resource_types/{probably_invalid_id} invalid URL did return an object, but the status code is {response.status}",
+            data=response,
+        )
+
+    return CheckResult(
+        conf,
+        status=Status.SUCCESS,
+        reason=f"/resource_types/{probably_invalid_id} invalid URL correctly returned a 404 error",
+        data=response,
+    )

scim2_tester/schemas.py

@@ -1,3 +1,5 @@
+import uuid
+
 from scim2_models import Error
 from scim2_models import Schema
 
@@ -25,6 +27,8 @@ def check_schemas_endpoint(conf: CheckConfig) -> list[CheckResult]:
         for resource_type in schemas_result.data:
             results.append(check_query_schema_by_id(conf, resource_type))
 
+    results.append(check_access_invalid_schema(conf))
+
     return results
 
 
@@ -56,3 +60,37 @@ def check_query_schema_by_id(conf: CheckConfig, schema: Schema) -> CheckResult:
 
     reason = f"Successfully accessed the /Schemas/{schema.id} endpoint."
     return CheckResult(conf, status=Status.SUCCESS, reason=reason, data=response)
+
+
+@checker
+def check_access_invalid_schema(conf: CheckConfig) -> CheckResult:
+    probably_invalid_id = str(uuid.uuid4())
+    response = conf.client.query(
+        Schema,
+        probably_invalid_id,
+        expected_status_codes=conf.expected_status_codes or [404],
+        raise_scim_errors=False,
+    )
+
+    if not isinstance(response, Error):
+        return CheckResult(
+            conf,
+            status=Status.ERROR,
+            reason=f"/Schemas/{probably_invalid_id} invalid URL did not return an Error object",
+            data=response,
+        )
+
+    if response.status != 404:
+        return CheckResult(
+            conf,
+            status=Status.ERROR,
+            reason=f"/Schemas/{probably_invalid_id} invalid URL did return an object, but the status code is {response.status}",
+            data=response,
+        )
+
+    return CheckResult(
+        conf,
+        status=Status.SUCCESS,
+        reason=f"/Schemas/{probably_invalid_id} invalid URL correctly returned a 404 error",
+        data=response,
+    )

tests/test_resource_types.py

@@ -1,6 +1,7 @@
 import re
 
 from scim2_models import Context
+from scim2_models import Error
 from scim2_models import ListResponse
 from scim2_models import ResourceType
 
@@ -26,6 +27,11 @@ def test_resource_types_endpoint(httpserver, check_config):
             status=200,
             content_type="application/scim+json",
         )
+    httpserver.expect_request(re.compile(r"^/ResourceTypes/.*$")).respond_with_json(
+        Error(status=404, detail="ResourceType Not Found").model_dump(),
+        status=404,
+        content_type="application/scim+json",
+    )
 
     results = check_resource_types_endpoint(check_config)
 

tests/test_schemas.py

@@ -1,15 +1,16 @@
 import re
 
 from scim2_models import Context
+from scim2_models import Error
 from scim2_models import ListResponse
 from scim2_models import Schema
 
 from scim2_tester.schemas import check_schemas_endpoint
 from scim2_tester.utils import Status
 
 
-def test_schemas_endpoint(httpserver, check_config):
-    """Test a fully functional resource types endpoint."""
+def test_shemas_endpoint(httpserver, check_config):
+    """Test a fully functional schemas endpoint."""
     schemas = [model.to_schema() for model in check_config.client.resource_models]
     httpserver.expect_request(re.compile(r"^/Schemas$")).respond_with_json(
         ListResponse[Schema](
@@ -27,13 +28,18 @@ def test_schemas_endpoint(httpserver, check_config):
             status=200,
             content_type="application/scim+json",
         )
+    httpserver.expect_request(re.compile(r"^/Schemas/.*$")).respond_with_json(
+        Error(status=404, detail="Schema Not Found").model_dump(),
+        status=404,
+        content_type="application/scim+json",
+    )
 
     results = check_schemas_endpoint(check_config)
 
     assert all(result.status == Status.SUCCESS for result in results)
 
 
-def test_resource_missing_query_endpoint(httpserver, check_config):
+def test_missing_query_endpoint(httpserver, check_config):
     """Test that individual Schema endpoints are missing."""
     schemas = [model.to_schema() for model in check_config.client.resource_models]
     httpserver.expect_request(re.compile(r"^/Schemas$")).respond_with_json(