Implement PATCH checks

scim2_tester/checkers/patch_add.py

@@ -0,0 +1,134 @@
+"""PATCH add operation checkers for SCIM compliance testing."""
+
+from typing import Any
+
+from scim2_client import SCIMClientError
+from scim2_models import Mutability
+from scim2_models import PatchOp
+from scim2_models import PatchOperation
+from scim2_models import Required
+from scim2_models import Resource
+
+from ..filling import generate_random_value
+from ..urns import get_annotation_by_urn
+from ..urns import get_value_by_urn
+from ..urns import iter_all_urns
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from ..utils import checker
+from ..utils import compare_field
+
+
+@checker("patch:add")
+def check_add_attribute(
+    context: CheckContext, model: type[Resource[Any]]
+) -> list[CheckResult]:
+    """Test PATCH add operation on all attributes (simple, complex, and extensions).
+
+    Creates a minimal resource, then iterates over ALL possible URNs (base model,
+    extensions, and sub-attributes) to test PATCH add operations systematically.
+    Uses a unified approach that handles all attribute types consistently.
+
+    **Tested Behavior:**
+    - Adding new attribute values (simple, complex, and extension attributes)
+    - Server accepts the PATCH request with correct URN paths for extensions
+    - Response contains the added attribute with correct values
+
+    **Status:**
+    - :attr:`~scim2_tester.Status.SUCCESS`: Attribute successfully added
+    - :attr:`~scim2_tester.Status.ERROR`: Failed to add attribute
+    - :attr:`~scim2_tester.Status.SKIPPED`: No addable attributes found
+
+    .. pull-quote:: :rfc:`RFC 7644 Section 3.5.2.1 - Add Operation <7644#section-3.5.2.1>`
+
+       "The 'add' operation is used to add a new attribute and/or values to
+       an existing resource."
+    """
+    results = []
+    all_urns = list(
+        iter_all_urns(
+            model,
+            required=[Required.false],
+            mutability=[Mutability.read_write, Mutability.write_only],
+            # Not supported until filters are implemented in scim2_models
+            include_subattributes=False,
+        )
+    )
+
+    if not all_urns:
+        return [
+            CheckResult(
+                status=Status.SKIPPED,
+                reason=f"No addable attributes found for {model.__name__}",
+                resource_type=model.__name__,
+            )
+        ]
+
+    base_resource = context.resource_manager.create_and_register(model)
+
+    for urn, source_model in all_urns:
+        patch_value = generate_random_value(context, urn=urn, model=source_model)
+
+        patch_op = PatchOp[type(base_resource)](
+            operations=[
+                PatchOperation(
+                    op=PatchOperation.Op.add,
+                    path=urn,
+                    value=patch_value,
+                )
+            ]
+        )
+
+        try:
+            updated_resource = context.client.modify(
+                resource_model=type(base_resource),
+                id=base_resource.id,
+                patch_op=patch_op,
+            )
+        except SCIMClientError as exc:
+            results.append(
+                CheckResult(
+                    status=Status.ERROR,
+                    reason=f"Failed to add attribute '{urn}': {exc}",
+                    resource_type=model.__name__,
+                    data={
+                        "urn": urn,
+                        "error": exc,
+                        "patch_value": patch_value,
+                    },
+                )
+            )
+            continue
+
+        actual_value = get_value_by_urn(updated_resource, urn)
+
+        if get_annotation_by_urn(
+            Mutability, urn, source_model
+        ) == Mutability.write_only or compare_field(patch_value, actual_value):
+            results.append(
+                CheckResult(
+                    status=Status.SUCCESS,
+                    reason=f"Successfully added attribute '{urn}'",
+                    resource_type=model.__name__,
+                    data={
+                        "urn": urn,
+                        "value": patch_value,
+                    },
+                )
+            )
+        else:
+            results.append(
+                CheckResult(
+                    status=Status.ERROR,
+                    reason=f"Attribute '{urn}' was not added or has incorrect value",
+                    resource_type=model.__name__,
+                    data={
+                        "urn": urn,
+                        "expected": patch_value,
+                        "actual": actual_value,
+                    },
+                )
+            )
+
+    return results

scim2_tester/checkers/patch_remove.py

@@ -0,0 +1,136 @@
+"""PATCH remove operation checkers for SCIM compliance testing."""
+
+from typing import Any
+
+from scim2_client import SCIMClientError
+from scim2_models import Mutability
+from scim2_models import PatchOp
+from scim2_models import PatchOperation
+from scim2_models import Required
+from scim2_models import Resource
+
+from ..urns import get_annotation_by_urn
+from ..urns import get_value_by_urn
+from ..urns import iter_all_urns
+from ..utils import CheckContext
+from ..utils import CheckResult
+from ..utils import Status
+from ..utils import checker
+
+
+@checker("patch:remove")
+def check_remove_attribute(
+    context: CheckContext, model: type[Resource[Any]]
+) -> list[CheckResult]:
+    """Test PATCH remove operation on all attributes (simple, complex, and extensions).
+
+    Creates a resource with initial values, then iterates over ALL possible URNs
+    (base model, extensions, and sub-attributes) to test PATCH remove operations
+    systematically. Uses a unified approach that handles all attribute types consistently.
+
+    **Tested Behavior:**
+    - Removing attribute values (simple, complex, and extension attributes)
+    - Server accepts the PATCH request with correct URN paths for extensions
+    - Response contains the resource with removed attributes (null/missing)
+
+    **Status:**
+    - :attr:`~scim2_tester.Status.SUCCESS`: Attribute successfully removed
+    - :attr:`~scim2_tester.Status.ERROR`: Failed to remove attribute or attribute still exists
+    - :attr:`~scim2_tester.Status.SKIPPED`: No removable attributes found
+
+    .. pull-quote:: :rfc:`RFC 7644 Section 3.5.2.2 - Remove Operation <7644#section-3.5.2.2>`
+
+       "The 'remove' operation removes the value at the target location specified
+       by the required attribute 'path'. The operation performs the following
+       functions, depending on the target location specified by 'path'."
+    """
+    results = []
+    all_urns = list(
+        iter_all_urns(
+            model,
+            required=[Required.false],
+            mutability=[Mutability.read_write, Mutability.write_only],
+            # Not supported until filters are implemented in scim2_models
+            include_subattributes=False,
+        )
+    )
+
+    if not all_urns:
+        return [
+            CheckResult(
+                status=Status.SKIPPED,
+                reason=f"No removable attributes found for {model.__name__}",
+                resource_type=model.__name__,
+            )
+        ]
+
+    full_resource = context.resource_manager.create_and_register(model, fill_all=True)
+
+    for urn, source_model in all_urns:
+        initial_value = get_value_by_urn(full_resource, urn)
+        if initial_value is None:
+            continue
+
+        remove_op = PatchOp[type(full_resource)](
+            operations=[
+                PatchOperation(
+                    op=PatchOperation.Op.remove,
+                    path=urn,
+                )
+            ]
+        )
+
+        try:
+            updated_resource = context.client.modify(
+                resource_model=type(full_resource),
+                id=full_resource.id,
+                patch_op=remove_op,
+            )
+        except SCIMClientError as exc:
+            results.append(
+                CheckResult(
+                    status=Status.ERROR,
+                    reason=f"Failed to remove attribute '{urn}': {exc}",
+                    resource_type=model.__name__,
+                    data={
+                        "urn": urn,
+                        "error": exc,
+                        "initial_value": initial_value,
+                    },
+                )
+            )
+            continue
+
+        actual_value = get_value_by_urn(updated_resource, urn)
+
+        if (
+            get_annotation_by_urn(Mutability, urn, source_model)
+            == Mutability.write_only
+            or actual_value is None
+        ):
+            results.append(
+                CheckResult(
+                    status=Status.SUCCESS,
+                    reason=f"Successfully removed attribute '{urn}'",
+                    resource_type=model.__name__,
+                    data={
+                        "urn": urn,
+                        "initial_value": initial_value,
+                    },
+                )
+            )
+        else:
+            results.append(
+                CheckResult(
+                    status=Status.ERROR,
+                    reason=f"Attribute '{urn}' was not removed",
+                    resource_type=model.__name__,
+                    data={
+                        "urn": urn,
+                        "initial_value": initial_value,
+                        "actual_value": actual_value,
+                    },
+                )
+            )
+
+    return results