refactor: all checkers return list of CheckResult

Author: azmeuk

scim2_tester/checker.py

@@ -72,8 +72,9 @@ def check_server(
     context = CheckContext(client, conf)
     results = []
 
-    result_spc = service_provider_config_endpoint(context)
-    results.append(result_spc)
+    result_spc_list = service_provider_config_endpoint(context)
+    results.extend(result_spc_list)
+    result_spc = result_spc_list[0]  # Get the first (and only) result
     if result_spc.status != Status.SKIPPED and not client.service_provider_config:
         client.service_provider_config = result_spc.data
 
@@ -103,7 +104,7 @@ def check_server(
         return results
 
     result_random = random_url(context)
-    results.append(result_random)
+    results.extend(result_random)
 
     for resource_type in client.resource_types or []:
         if conf.resource_types and resource_type.name not in conf.resource_types:

scim2_tester/checkers/misc.py

@@ -10,7 +10,7 @@
 
 
 @checker("misc")
-def random_url(context: CheckContext) -> CheckResult:
+def random_url(context: CheckContext) -> list[CheckResult]:
     """Validate server error handling for non-existent endpoints.
 
     Tests that the server properly returns a :class:`~scim2_models.Error` object with HTTP 404 status
@@ -37,21 +37,27 @@ def random_url(context: CheckContext) -> CheckResult:
     )
 
     if not isinstance(response, Error):
-        return CheckResult(
-            status=Status.ERROR,
-            reason=f"{probably_invalid_url} did not return an Error object",
-            data=response,
-        )
+        return [
+            CheckResult(
+                status=Status.ERROR,
+                reason=f"{probably_invalid_url} did not return an Error object",
+                data=response,
+            )
+        ]
 
     if response.status != 404:
-        return CheckResult(
-            status=Status.ERROR,
-            reason=f"{probably_invalid_url} did return an object, but the status code is {response.status}",
+        return [
+            CheckResult(
+                status=Status.ERROR,
+                reason=f"{probably_invalid_url} did return an object, but the status code is {response.status}",
+                data=response,
+            )
+        ]
+
+    return [
+        CheckResult(
+            status=Status.SUCCESS,
+            reason=f"{probably_invalid_url} correctly returned a 404 error",
             data=response,
         )
-
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"{probably_invalid_url} correctly returned a 404 error",
-        data=response,
-    )
+    ]

scim2_tester/checkers/resource.py

@@ -43,10 +43,10 @@ def resource_type_tests(
 
     results = []
 
-    results.append(object_creation(context, model))
-    results.append(object_query(context, model))
-    results.append(object_query_without_id(context, model))
-    results.append(object_replacement(context, model))
-    results.append(object_deletion(context, model))
+    results.extend(object_creation(context, model))
+    results.extend(object_query(context, model))
+    results.extend(object_query_without_id(context, model))
+    results.extend(object_replacement(context, model))
+    results.extend(object_deletion(context, model))
 
     return results

scim2_tester/checkers/resource_delete.py

@@ -9,7 +9,9 @@
 
 
 @checker("crud:delete")
-def object_deletion(context: CheckContext, model: type[Resource[Any]]) -> CheckResult:
+def object_deletion(
+    context: CheckContext, model: type[Resource[Any]]
+) -> list[CheckResult]:
     """Validate SCIM resource deletion via DELETE requests.
 
     Tests that resources can be successfully deleted using DELETE method and
@@ -39,14 +41,18 @@ def object_deletion(context: CheckContext, model: type[Resource[Any]]) -> CheckR
 
     try:
         context.client.query(model, test_obj.id)
-        return CheckResult(
-            status=Status.ERROR,
-            reason=f"{model.__name__} object with id {test_obj.id} still exists after deletion",
-        )
+        return [
+            CheckResult(
+                status=Status.ERROR,
+                reason=f"{model.__name__} object with id {test_obj.id} still exists after deletion",
+            )
+        ]
     except Exception:
         pass
 
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"Successfully deleted {model.__name__} object with id {test_obj.id}",
-    )
+    return [
+        CheckResult(
+            status=Status.SUCCESS,
+            reason=f"Successfully deleted {model.__name__} object with id {test_obj.id}",
+        )
+    ]

scim2_tester/checkers/resource_get.py

@@ -25,7 +25,9 @@ def _model_from_resource_type(
 
 
 @checker("crud:read")
-def object_query(context: CheckContext, model: type[Resource[Any]]) -> CheckResult:
+def object_query(
+    context: CheckContext, model: type[Resource[Any]]
+) -> list[CheckResult]:
     """Validate SCIM resource retrieval by ID via GET requests.
 
     Tests that individual resources can be successfully retrieved using GET method
@@ -52,17 +54,19 @@ def object_query(context: CheckContext, model: type[Resource[Any]]) -> CheckResu
         expected_status_codes=context.conf.expected_status_codes or [200],
     )
 
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"Successfully queried {model.__name__} object with id {test_obj.id}",
-        data=response,
-    )
+    return [
+        CheckResult(
+            status=Status.SUCCESS,
+            reason=f"Successfully queried {model.__name__} object with id {test_obj.id}",
+            data=response,
+        )
+    ]
 
 
 @checker("crud:read")
 def object_query_without_id(
     context: CheckContext, model: type[Resource[Any]]
-) -> CheckResult:
+) -> list[CheckResult]:
     """Validate SCIM resource listing via GET requests without ID.
 
     Tests that resources can be successfully listed using GET method on the
@@ -87,14 +91,18 @@ def object_query_without_id(
 
     found = any(test_obj.id == resource.id for resource in response.resources)
     if not found:
-        return CheckResult(
-            status=Status.ERROR,
-            reason=f"Could not find {model.__name__} object with id {test_obj.id} in list response",
+        return [
+            CheckResult(
+                status=Status.ERROR,
+                reason=f"Could not find {model.__name__} object with id {test_obj.id} in list response",
+                data=response,
+            )
+        ]
+
+    return [
+        CheckResult(
+            status=Status.SUCCESS,
+            reason=f"Successfully found {model.__name__} object with id {test_obj.id} in list response",
             data=response,
         )
-
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"Successfully found {model.__name__} object with id {test_obj.id} in list response",
-        data=response,
-    )
+    ]

scim2_tester/checkers/resource_post.py

@@ -9,7 +9,9 @@
 
 
 @checker("crud:create")
-def object_creation(context: CheckContext, model: type[Resource[Any]]) -> CheckResult:
+def object_creation(
+    context: CheckContext, model: type[Resource[Any]]
+) -> list[CheckResult]:
     """Validate SCIM resource creation via POST requests.
 
     Tests that resources can be successfully created using POST method on the
@@ -31,8 +33,10 @@ def object_creation(context: CheckContext, model: type[Resource[Any]]) -> CheckR
     """
     created_obj = context.resource_manager.create_and_register(model)
 
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"Successfully created {model.__name__} object with id {created_obj.id}",
-        data=created_obj,
-    )
+    return [
+        CheckResult(
+            status=Status.SUCCESS,
+            reason=f"Successfully created {model.__name__} object with id {created_obj.id}",
+            data=created_obj,
+        )
+    ]

scim2_tester/checkers/resource_put.py

@@ -13,7 +13,7 @@
 @checker("crud:update")
 def object_replacement(
     context: CheckContext, model: type[Resource[Any]]
-) -> CheckResult:
+) -> list[CheckResult]:
     """Validate SCIM resource replacement via PUT requests.
 
     Tests that resources can be successfully replaced using PUT method, modifying
@@ -54,8 +54,10 @@ def object_replacement(
         modified_obj, expected_status_codes=context.conf.expected_status_codes or [200]
     )
 
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"Successfully replaced {model.__name__} object with id {test_obj.id}",
-        data=response,
-    )
+    return [
+        CheckResult(
+            status=Status.SUCCESS,
+            reason=f"Successfully replaced {model.__name__} object with id {test_obj.id}",
+            data=response,
+        )
+    ]

scim2_tester/checkers/resource_types.py

@@ -32,16 +32,20 @@ def _resource_types_endpoint(context: CheckContext) -> list[CheckResult]:
        "Service providers MUST provide this endpoint."
 
     """
-    resource_types_result = query_all_resource_types(context)
-    results = [resource_types_result]
+    results = []
+    resource_types_result_list = query_all_resource_types(context)
+    results.extend(resource_types_result_list)
+    resource_types_result = resource_types_result_list[
+        0
+    ]  # Get the first (and only) result
 
     if resource_types_result.status == Status.SUCCESS:
         for resource_type in resource_types_result.data:
-            results.append(query_resource_type_by_id(context, resource_type))
+            results.extend(query_resource_type_by_id(context, resource_type))
 
         results.extend(resource_types_schema_validation(context))
 
-    results.append(access_invalid_resource_type(context))
+    results.extend(access_invalid_resource_type(context))
 
     return results
 
@@ -122,7 +126,7 @@ def resource_types_schema_validation(
 
 
 @checker("discovery", "resource-types")
-def query_all_resource_types(context: CheckContext) -> CheckResult:
+def query_all_resource_types(context: CheckContext) -> list[CheckResult]:
     """Validate retrieval of all available resource types.
 
     Tests that the ``/ResourceTypes`` endpoint returns a list of all supported
@@ -143,13 +147,13 @@ def query_all_resource_types(context: CheckContext) -> CheckResult:
     )
     available = ", ".join([f"'{resource.name}'" for resource in response.resources])
     reason = f"Resource types available are: {available}"
-    return CheckResult(status=Status.SUCCESS, reason=reason, data=response.resources)
+    return [CheckResult(status=Status.SUCCESS, reason=reason, data=response.resources)]
 
 
 @checker("discovery", "resource-types")
 def query_resource_type_by_id(
     context: CheckContext, resource_type: ResourceType
-) -> CheckResult:
+) -> list[CheckResult]:
     """Validate individual ResourceType retrieval by ID.
 
     Tests that specific resource types can be retrieved using GET requests
@@ -171,11 +175,11 @@ def query_resource_type_by_id(
         expected_status_codes=context.conf.expected_status_codes or [200],
     )
     reason = f"Successfully accessed the /ResourceTypes/{resource_type.id} endpoint."
-    return CheckResult(status=Status.SUCCESS, reason=reason, data=response)
+    return [CheckResult(status=Status.SUCCESS, reason=reason, data=response)]
 
 
 @checker("discovery", "resource-types")
-def access_invalid_resource_type(context: CheckContext) -> CheckResult:
+def access_invalid_resource_type(context: CheckContext) -> list[CheckResult]:
     """Validate error handling for non-existent resource type IDs.
 
     Tests that accessing ``/ResourceTypes/{invalid_id}`` with a non-existent resource
@@ -199,21 +203,27 @@ def access_invalid_resource_type(context: CheckContext) -> CheckResult:
     )
 
     if not isinstance(response, Error):
-        return CheckResult(
-            status=Status.ERROR,
-            reason=f"/resource_types/{probably_invalid_id} invalid URL did not return an Error object",
-            data=response,
-        )
+        return [
+            CheckResult(
+                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(
-            status=Status.ERROR,
-            reason=f"/resource_types/{probably_invalid_id} invalid URL did return an object, but the status code is {response.status}",
+        return [
+            CheckResult(
+                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(
+            status=Status.SUCCESS,
+            reason=f"/resource_types/{probably_invalid_id} invalid URL correctly returned a 404 error",
             data=response,
         )
-
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"/resource_types/{probably_invalid_id} invalid URL correctly returned a 404 error",
-        data=response,
-    )
+    ]