refactor: introduce a CheckContext class

Author: azmeuk

scim2_tester/checker.py

@@ -107,7 +107,7 @@ def check_server(
     results = []
 
     # Get the initial basic objects
-    result_spc = check_service_provider_config_endpoint(client, conf)
+    result_spc = check_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
@@ -140,7 +140,7 @@ def check_server(
         return results
 
     # Miscelleaneous checks
-    result_random = check_random_url(client, conf)
+    result_random = check_random_url(context)
     results.append(result_random)
 
     # Resource checks

scim2_tester/resource.py

@@ -37,10 +37,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.client, context.conf, model))
-    results.append(check_object_query(context.client, context.conf, model))
-    results.append(check_object_query_without_id(context.client, context.conf, model))
-    results.append(check_object_replacement(context.client, context.conf, model))
-    results.append(check_object_deletion(context.client, context.conf, model))
+    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))
 
     return results

scim2_tester/resource_types.py

@@ -20,18 +20,14 @@ def check_resource_types_endpoint(context: CheckContext) -> list[CheckResult]:
         - Check that a 403 response is returned if a filter is passed
         - Check that the `schema` attribute exists and is available.
     """
-    resource_types_result = check_query_all_resource_types(context.client, context.conf)
+    resource_types_result = check_query_all_resource_types(context)
     results = [resource_types_result]
 
     if resource_types_result.status == Status.SUCCESS:
         for resource_type in resource_types_result.data:
-            results.append(
-                check_query_resource_type_by_id(
-                    context.client, context.conf, resource_type
-                )
-            )
+            results.append(check_query_resource_type_by_id(context, resource_type))
 
-    results.append(check_access_invalid_resource_type(context.client, context.conf))
+    results.append(check_access_invalid_resource_type(context))
 
     return results
 

scim2_tester/schemas.py

@@ -20,16 +20,14 @@ def check_schemas_endpoint(context: CheckContext) -> list[CheckResult]:
         - Check that a 403 response is returned if a filter is passed
         - Check that the 'ResourceType', 'ServiceProviderConfig' and 'Schema' schemas are provided.
     """
-    schemas_result = check_query_all_schemas(context.client, context.conf)
+    schemas_result = check_query_all_schemas(context)
     results = [schemas_result]
 
     if schemas_result.status == Status.SUCCESS:
         for resource_type in schemas_result.data:
-            results.append(
-                check_query_schema_by_id(context.client, context.conf, resource_type)
-            )
+            results.append(check_query_schema_by_id(context, resource_type))
 
-    results.append(check_access_invalid_schema(context.client, context.conf))
+    results.append(check_access_invalid_schema(context))
 
     return results
 

scim2_tester/utils.py

@@ -200,54 +200,52 @@ def check_schemas_endpoint(...):
 
     def decorator(func):
         @functools.wraps(func)
-        def wrapped(client: SCIMClient, conf: CheckConfig, *args, **kwargs):
+        def wrapped(context: CheckContext, *args, **kwargs):
             func_tags = set(tags) if tags else set()
 
             # Check if function should be skipped based on tag filtering
-            if conf.include_tags and not _matches_hierarchical_tags(
-                func_tags, conf.include_tags
+            if context.conf.include_tags and not _matches_hierarchical_tags(
+                func_tags, context.conf.include_tags
             ):
                 return CheckResult(
-                    conf,
+                    context.conf,
                     status=Status.SKIPPED,
                     title=func.__name__,
                     description=func.__doc__,
                     tags=func_tags,
                     reason="Skipped due to tag filtering",
                 )
 
-            if conf.exclude_tags and _matches_hierarchical_tags(
-                func_tags, conf.exclude_tags
+            if context.conf.exclude_tags and _matches_hierarchical_tags(
+                func_tags, context.conf.exclude_tags
             ):
                 return CheckResult(
-                    conf,
+                    context.conf,
                     status=Status.SKIPPED,
                     title=func.__name__,
                     description=func.__doc__,
                     tags=func_tags,
                     reason="Skipped due to tag exclusion",
                 )
 
-            context = CheckContext(client, conf)
-
             try:
                 result = func(context, *args, **kwargs)
 
             except SCIMClientError as exc:
-                if conf.raise_exceptions:
+                if context.conf.raise_exceptions:
                     raise
 
                 reason = f"{exc} {exc.__cause__}" if exc.__cause__ else str(exc)
                 result = CheckResult(
-                    conf, status=Status.ERROR, reason=reason, data=exc.source
+                    context.conf, status=Status.ERROR, reason=reason, data=exc.source
                 )
 
             except Exception as exc:
-                if conf.raise_exceptions:
+                if context.conf.raise_exceptions:
                     raise
 
                 result = CheckResult(
-                    conf, status=Status.ERROR, reason=str(exc), data=exc
+                    context.conf, status=Status.ERROR, reason=str(exc), data=exc
                 )
 
             finally:

tests/test_random_url.py

@@ -15,7 +15,7 @@ def test_random_url(httpserver, check_config):
         content_type="application/scim+json",
     )
 
-    result = check_random_url(check_config.client, check_config.conf)
+    result = check_random_url(check_config)
 
     assert result.status == Status.SUCCESS
     assert "correctly returned a 404 error" in result.reason
@@ -31,7 +31,7 @@ def test_random_url_valid_object(httpserver, check_config):
         content_type="application/scim+json",
     )
 
-    result = check_random_url(check_config.client, check_config.conf)
+    result = check_random_url(check_config)
 
     assert result.status == Status.ERROR
     assert "did not return an Error object" in result.reason
@@ -45,7 +45,7 @@ def test_random_url_not_404(httpserver, check_config):
         content_type="application/scim+json",
     )
 
-    result = check_random_url(check_config.client, check_config.conf)
+    result = check_random_url(check_config)
 
     assert result.status == Status.ERROR
     assert "did return an object, but the status code is 200" in result.reason

tests/test_utils.py

@@ -22,7 +22,8 @@ def check_function(context: CheckContext) -> CheckResult:
 
     # Test that result gets tags
     conf = CheckConfig(raise_exceptions=False)
-    result = check_function(None, conf)
+    context = CheckContext(client=None, conf=conf)
+    result = check_function(context)
     assert result.tags == {"tag1", "tag2"}
     assert result.title == "check_function"
     assert result.description == "Test check function."
@@ -42,7 +43,8 @@ def check_function(context: CheckContext) -> CheckResult:
 
     # Test that result gets empty tags
     conf = CheckConfig(raise_exceptions=False)
-    result = check_function(None, conf)
+    context = CheckContext(client=None, conf=conf)
+    result = check_function(context)
     assert result.tags == set()
 
 
@@ -58,7 +60,8 @@ def check_function(context: CheckContext) -> list[CheckResult]:
         ]
 
     conf = CheckConfig(raise_exceptions=False)
-    results = check_function(None, conf)
+    context = CheckContext(client=None, conf=conf)
+    results = check_function(context)
 
     # All results should have tags
     assert all(r.tags == {"tag1"} for r in results)
@@ -141,10 +144,12 @@ def test_func(context):
 
     # Test include tags matching
     conf_include = CheckConfig(include_tags={"crud"})
-    result = test_func(None, conf_include)  # Call with decorator signature
+    context_include = CheckContext(client=None, conf=conf_include)
+    result = test_func(context_include)  # Call with decorator signature
     assert result.status.name == "SUCCESS"
 
     # Test exclude tags matching
     conf_exclude = CheckConfig(exclude_tags={"crud"})
-    result = test_func(None, conf_exclude)  # Call with decorator signature
+    context_exclude = CheckContext(client=None, conf=conf_exclude)
+    result = test_func(context_exclude)  # Call with decorator signature
     assert result.status.name == "SKIPPED"