refactor: move checkers in a dedicated directory and document them

Author: azmeuk

doc/reference.rst

@@ -1,5 +1,14 @@
 Reference
 =========
 
+Checkers
+--------
+
+.. automodule:: scim2_tester.checkers
+   :members:
+
+Public API
+----------
+
 .. automodule:: scim2_tester
    :members:

scim2_tester/checker.py

@@ -1,48 +1,16 @@
 import argparse
-import uuid
-from typing import Any
 
 from scim2_client.engines.httpx import SyncSCIMClient
-from scim2_models import Error
 
-from scim2_tester.resource import check_resource_type
-from scim2_tester.resource_types import check_resource_types_endpoint
-from scim2_tester.schemas import check_schemas_endpoint
-from scim2_tester.service_provider_config import check_service_provider_config_endpoint
+from scim2_tester.checkers import random_url
+from scim2_tester.checkers import resource_type_tests
+from scim2_tester.checkers import resource_types_endpoint
+from scim2_tester.checkers import schemas_endpoint
+from scim2_tester.checkers import service_provider_config_endpoint
 from scim2_tester.utils import CheckConfig
 from scim2_tester.utils import CheckContext
 from scim2_tester.utils import CheckResult
 from scim2_tester.utils import Status
-from scim2_tester.utils import checker
-
-
-@checker("misc")
-def check_random_url(context: CheckContext) -> CheckResult:
-    """Check that a request to a random URL returns a 404 Error object."""
-    probably_invalid_url = f"/{str(uuid.uuid4())}"
-    response: Any = context.client.query(
-        url=probably_invalid_url, raise_scim_errors=False
-    )
-
-    if not isinstance(response, Error):
-        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}",
-            data=response,
-        )
-
-    return CheckResult(
-        status=Status.SUCCESS,
-        reason=f"{probably_invalid_url} correctly returned a 404 error",
-        data=response,
-    )
 
 
 def check_server(
@@ -107,12 +75,12 @@ def check_server(
     results = []
 
     # Get the initial basic objects
-    result_spc = check_service_provider_config_endpoint(context)
+    result_spc = service_provider_config_endpoint(context)
     results.append(result_spc)
     if result_spc.status != Status.SKIPPED and not client.service_provider_config:
         client.service_provider_config = result_spc.data
 
-    results_resource_types = check_resource_types_endpoint(context)
+    results_resource_types = resource_types_endpoint(context)
     results.extend(results_resource_types)
     if not client.resource_types:
         # Find first non-skipped result with data
@@ -121,7 +89,7 @@ def check_server(
                 client.resource_types = rt_result.data
                 break
 
-    results_schemas = check_schemas_endpoint(context)
+    results_schemas = schemas_endpoint(context)
     results.extend(results_schemas)
     if not client.resource_models:
         # Find first non-skipped result with data
@@ -140,7 +108,7 @@ def check_server(
         return results
 
     # Miscelleaneous checks
-    result_random = check_random_url(context)
+    result_random = random_url(context)
     results.append(result_random)
 
     # Resource checks
@@ -149,7 +117,7 @@ def check_server(
         if conf.resource_types and resource_type.name not in conf.resource_types:
             continue
 
-        resource_results = check_resource_type(context, resource_type)
+        resource_results = resource_type_tests(context, resource_type)
         # Add resource type to each result for better tracking
         for result in resource_results:
             result.resource_type = resource_type.name

scim2_tester/checkers/__init__.py

@@ -0,0 +1,53 @@
+"""SCIM server compliance checkers.
+
+This module contains all the individual checkers for validating SCIM server implementations.
+Each checker is decorated with tags that allow selective test execution.
+
+Available checker categories:
+
+- discovery: ServiceProviderConfig, ResourceTypes, Schemas endpoints
+- crud: Create, Read, Update, Delete operations
+- misc: Random URL access tests
+"""
+
+from .misc import random_url
+from .resource import resource_type_tests
+from .resource_delete import object_deletion
+from .resource_get import model_from_resource_type
+from .resource_get import object_query
+from .resource_get import object_query_without_id
+from .resource_post import object_creation
+from .resource_put import object_replacement
+from .resource_types import access_invalid_resource_type
+from .resource_types import query_all_resource_types
+from .resource_types import query_resource_type_by_id
+from .resource_types import resource_types_endpoint
+from .schemas import access_invalid_schema
+from .schemas import query_all_schemas
+from .schemas import query_schema_by_id
+from .schemas import schemas_endpoint
+from .service_provider_config import service_provider_config_endpoint
+
+__all__ = [
+    # Discovery checkers
+    "service_provider_config_endpoint",
+    "resource_types_endpoint",
+    "query_all_resource_types",
+    "query_resource_type_by_id",
+    "access_invalid_resource_type",
+    "schemas_endpoint",
+    "query_all_schemas",
+    "query_schema_by_id",
+    "access_invalid_schema",
+    # CRUD checkers
+    "object_creation",
+    "object_query",
+    "object_query_without_id",
+    "object_replacement",
+    "object_deletion",
+    "resource_type_tests",
+    # Miscellaneous checkers
+    "random_url",
+    # Utilities
+    "model_from_resource_type",
+]

scim2_tester/checkers/misc.py

@@ -0,0 +1,38 @@
+import uuid
+from typing import Any
+
+from scim2_models import Error
+
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from ..utils import checker
+
+
+@checker("misc")
+def random_url(context: CheckContext) -> CheckResult:
+    """Check that a request to a random URL returns a 404 Error object."""
+    probably_invalid_url = f"/{str(uuid.uuid4())}"
+    response: Any = context.client.query(
+        url=probably_invalid_url, raise_scim_errors=False
+    )
+
+    if not isinstance(response, Error):
+        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}",
+            data=response,
+        )
+
+    return CheckResult(
+        status=Status.SUCCESS,
+        reason=f"{probably_invalid_url} correctly returned a 404 error",
+        data=response,
+    )

scim2_tester/resource.py scim2_tester/checkers/resource.pyscim2_tester/resource.py renamed to scim2_tester/checkers/resource.py

@@ -1,17 +1,17 @@
 from scim2_models import ResourceType
 
-from scim2_tester.resource_delete import check_object_deletion
-from scim2_tester.resource_get import check_object_query
-from scim2_tester.resource_get import check_object_query_without_id
-from scim2_tester.resource_get import model_from_resource_type
-from scim2_tester.resource_post import check_object_creation
-from scim2_tester.resource_put import check_object_replacement
-from scim2_tester.utils import CheckContext
-from scim2_tester.utils import CheckResult
-from scim2_tester.utils import Status
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from .resource_delete import object_deletion
+from .resource_get import model_from_resource_type
+from .resource_get import object_query
+from .resource_get import object_query_without_id
+from .resource_post import object_creation
+from .resource_put import object_replacement
 
 
-def check_resource_type(
+def resource_type_tests(
     context: CheckContext,
     resource_type: ResourceType,
 ) -> list[CheckResult]:
@@ -36,10 +36,10 @@ def check_resource_type(
     # These functions have @checker decorators so we call them with client, conf
     # The decorator will create a context and call the function appropriately
     # For now, call them directly - may need adjustment based on actual function signatures
-    results.append(check_object_creation(context, model))
-    results.append(check_object_query(context, model))
-    results.append(check_object_query_without_id(context, model))
-    results.append(check_object_replacement(context, model))
-    results.append(check_object_deletion(context, model))
+    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))
 
     return results

scim2_tester/resource_delete.py scim2_tester/checkers/resource_delete.pyscim2_tester/resource_delete.py renamed to scim2_tester/checkers/resource_delete.py

@@ -2,16 +2,14 @@
 
 from scim2_models import Resource
 
-from scim2_tester.utils import CheckContext
-from scim2_tester.utils import CheckResult
-from scim2_tester.utils import Status
-from scim2_tester.utils import checker
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from ..utils import checker
 
 
 @checker("crud:delete")
-def check_object_deletion(
-    context: CheckContext, model: type[Resource[Any]]
-) -> CheckResult:
+def object_deletion(context: CheckContext, model: type[Resource[Any]]) -> CheckResult:
     """Test object deletion with automatic cleanup.
 
     Creates a test object specifically for deletion testing, performs the

scim2_tester/resource_get.py scim2_tester/checkers/resource_get.pyscim2_tester/resource_get.py renamed to scim2_tester/checkers/resource_get.py

@@ -3,10 +3,10 @@
 from scim2_models import Resource
 from scim2_models import ResourceType
 
-from scim2_tester.utils import CheckContext
-from scim2_tester.utils import CheckResult
-from scim2_tester.utils import Status
-from scim2_tester.utils import checker
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from ..utils import checker
 
 
 def model_from_resource_type(
@@ -29,9 +29,7 @@ def model_from_resource_type(
 
 
 @checker("crud:read")
-def check_object_query(
-    context: CheckContext, model: type[Resource[Any]]
-) -> CheckResult:
+def object_query(context: CheckContext, model: type[Resource[Any]]) -> CheckResult:
     """Test object query by ID with automatic cleanup.
 
     Creates a temporary test object, queries it by ID to validate the
@@ -57,7 +55,7 @@ def check_object_query(
 
 
 @checker("crud:read")
-def check_object_query_without_id(
+def object_query_without_id(
     context: CheckContext, model: type[Resource[Any]]
 ) -> CheckResult:
     """Test object listing without ID with automatic cleanup.

scim2_tester/resource_post.py scim2_tester/checkers/resource_post.pyscim2_tester/resource_post.py renamed to scim2_tester/checkers/resource_post.py

@@ -2,16 +2,14 @@
 
 from scim2_models import Resource
 
-from scim2_tester.utils import CheckContext
-from scim2_tester.utils import CheckResult
-from scim2_tester.utils import Status
-from scim2_tester.utils import checker
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from ..utils import checker
 
 
 @checker("crud:create")
-def check_object_creation(
-    context: CheckContext, model: type[Resource[Any]]
-) -> CheckResult:
+def object_creation(context: CheckContext, model: type[Resource[Any]]) -> CheckResult:
     """Test object creation with automatic cleanup.
 
     Creates a test object of the specified model type, validates the creation

scim2_tester/resource_put.py scim2_tester/checkers/resource_put.pyscim2_tester/resource_put.py renamed to scim2_tester/checkers/resource_put.py

@@ -3,15 +3,15 @@
 from scim2_models import Mutability
 from scim2_models import Resource
 
-from scim2_tester.filling import fill_with_random_values
-from scim2_tester.utils import CheckContext
-from scim2_tester.utils import CheckResult
-from scim2_tester.utils import Status
-from scim2_tester.utils import checker
+from ..filling import fill_with_random_values
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from ..utils import checker
 
 
 @checker("crud:update")
-def check_object_replacement(
+def object_replacement(
     context: CheckContext, model: type[Resource[Any]]
 ) -> CheckResult:
     """Test object replacement (PUT) with automatic cleanup.