NRL-518 Improve pydantic diagnostic message

Author: axelkrastek1-nhs

layer/nrlf/core/errors.py

@@ -9,16 +9,23 @@
 from nrlf.producer.fhir.r4.model import OperationOutcome, OperationOutcomeIssue
 
 
+def format_error_location(loc: List) -> str:
+    formatted_loc = ""
+    for each in loc:
+        if isinstance(each, int):
+            formatted_loc = f"{formatted_loc}[{each}]"
+        else:
+            formatted_loc = f"{formatted_loc}.{each}" if formatted_loc else str(each)
+    return formatted_loc
+
+
 def diag_for_error(error: ErrorDetails) -> str:
-    if error["loc"]:
-        loc_string = ".".join(str(each) for each in error["loc"])
-        return f"{loc_string}: {error['msg']}"
-    else:
-        return f"root: {error['msg']}"
+    loc_string = format_error_location(error["loc"])
+    return f"{loc_string}: {error['msg']}" if loc_string else f"root: {error['msg']}"
 
 
 def expression_for_error(error: ErrorDetails) -> Optional[str]:
-    return str(".".join(str(each) for each in error["loc"]) if error["loc"] else "root")
+    return format_error_location(error["loc"]) or "root"
 
 
 class OperationOutcomeError(Exception):

layer/nrlf/core/tests/test_pydantic_errors.py

@@ -28,8 +28,8 @@ def test_validate_content_missing_attachment():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content.0.attachment: Field required)",
-        "expression": ["content.0.attachment"],
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].attachment: Field required)",
+        "expression": ["content[0].attachment"],
     }
 
 
@@ -56,6 +56,34 @@ def test_validate_content_missing_content_type():
                 }
             ]
         },
-        "diagnostics": "Failed to parse DocumentReference resource (content.0.attachment.contentType: Field required)",
-        "expression": ["content.0.attachment.contentType"],
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].attachment.contentType: Field required)",
+        "expression": ["content[0].attachment.contentType"],
+    }
+
+
+def test_validate_content_missing_format():
+    validator = DocumentReferenceValidator()
+    document_ref_data = load_document_reference_json("Y05868-736253002-Valid")
+
+    document_ref_data["content"][0].pop("format")
+
+    with pytest.raises(ParseError) as error:
+        validator.validate(document_ref_data)
+
+    exc = error.value
+    assert len(exc.issues) == 1
+    assert exc.issues[0].model_dump(exclude_none=True) == {
+        "severity": "error",
+        "code": "invalid",
+        "details": {
+            "coding": [
+                {
+                    "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                    "code": "INVALID_RESOURCE",
+                    "display": "Invalid validation of resource",
+                }
+            ]
+        },
+        "diagnostics": "Failed to parse DocumentReference resource (content[0].format: Field required)",
+        "expression": ["content[0].format"],
     }

tests/features/producer/createDocumentReference-failure.feature

@@ -725,9 +725,9 @@ Feature: Producer - createDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (content.0.attachment.contentType: String should match pattern '[^\\s]+(\\s[^\\s]+)*')",
+        "diagnostics": "Request body could not be parsed (content[0].attachment.contentType: String should match pattern '[^\\s]+(\\s[^\\s]+)*')",
         "expression": [
-            "content.0.attachment.contentType"
+            "content[0].attachment.contentType"
         ]
       }
       """

tests/features/producer/updateDocumentReference-failure.feature

@@ -144,9 +144,9 @@ Feature: Producer - updateDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (content.0.attachment.contentType: String should match pattern '[^\\s]+(\\s[^\\s]+)*')",
+        "diagnostics": "Request body could not be parsed (content[0].attachment.contentType: String should match pattern '[^\\s]+(\\s[^\\s]+)*')",
         "expression": [
-            "content.0.attachment.contentType"
+            "content[0].attachment.contentType"
         ]
       }
       """

tests/features/producer/upsertDocumentReference-failure.feature

@@ -306,9 +306,9 @@ Feature: Producer - upsertDocumentReference - Failure Scenarios
             }
             ]
         },
-        "diagnostics": "Request body could not be parsed (content.0.attachment.contentType: String should match pattern '[^\\s]+(\\s[^\\s]+)*')",
+        "diagnostics": "Request body could not be parsed (content[0].attachment.contentType: String should match pattern '[^\\s]+(\\s[^\\s]+)*')",
         "expression": [
-            "content.0.attachment.contentType"
+            "content[0].attachment.contentType"
         ]
       }
       """