fix: improve patch operation error messages

Author: azmeuk

scim2_tester/checkers/patch_add.py

@@ -132,7 +132,11 @@ def check_add_attribute(
                         check_result(
                             context,
                             status=Status.ERROR,
-                            reason=f"PATCH modify() returned incorrect value for '{urn}'",
+                            reason=(
+                                f"PATCH modify() returned unexpected value for '{urn}'.\n"
+                                f"Patched value: {patch_value}\n"
+                                f"Returned value: {modify_actual_value}"
+                            ),
                             resource_type=model.__name__,
                             data={
                                 "urn": urn,
@@ -186,7 +190,11 @@ def check_add_attribute(
                 check_result(
                     context,
                     status=Status.ERROR,
-                    reason=f"Attribute '{urn}' was not added or has incorrect value",
+                    reason=(
+                        f"Attribute '{urn}' was not added or has unexpected value"
+                        f"Patched value: {patch_value}\n"
+                        f"Returned value: {actual_value}"
+                    ),
                     resource_type=model.__name__,
                     data={
                         "urn": urn,

scim2_tester/checkers/patch_replace.py

@@ -126,7 +126,11 @@ def check_replace_attribute(
                         check_result(
                             context,
                             status=Status.ERROR,
-                            reason=f"PATCH modify() returned incorrect value for '{urn}'",
+                            reason=(
+                                f"PATCH modify() returned unexpected value for '{urn}'.\n"
+                                f"Patched value: {patch_value}\n"
+                                f"Returned value: {modify_actual_value}"
+                            ),
                             resource_type=model.__name__,
                             data={
                                 "urn": urn,
@@ -179,7 +183,11 @@ def check_replace_attribute(
                 check_result(
                     context,
                     status=Status.ERROR,
-                    reason=f"Attribute '{urn}' was not replaced or has incorrect value",
+                    reason=(
+                        f"Attribute '{urn}' was not replaced or has unexpected value"
+                        f"Patched value: {patch_value}\n"
+                        f"Returned value: {actual_value}"
+                    ),
                     resource_type=model.__name__,
                     data={
                         "urn": urn,

tests/test_patch_add.py

@@ -363,7 +363,9 @@ def test_patch_add_modify_result_incorrect_value(testing_context):
     results = check_add_attribute(testing_context, User)
 
     error_results = [
-        r for r in results if r.status == Status.ERROR and "incorrect value" in r.reason
+        r
+        for r in results
+        if r.status == Status.ERROR and "unexpected value" in r.reason
     ]
     assert len(error_results) > 0
 
@@ -405,7 +407,7 @@ def test_patch_add_query_failure_after_patch(httpserver, testing_context):
         r
         for r in results
         if r.status == Status.ERROR
-        and "was not added or has incorrect value" in r.reason
+        and "was not added or has unexpected value" in r.reason
     ]
     assert len(error_results) > 0