NRL-1285 update parent model with validator for empty fields

Author: eesa456

api/producer/createDocumentReference/tests/test_create_document_reference.py

@@ -384,6 +384,50 @@ def test_create_document_reference_invalid_body():
     }
 
 
+def test_create_document_reference_empty_fields_in_body():
+    doc_ref = load_document_reference("Y05868-736253002-Valid")
+    doc_ref.author = []
+    doc_ref.context = {"practiceSetting": {}, "sourcePatientInfo": None}
+    doc_ref.category = [{"coding": [{"system": "", "code": None}]}]
+    doc_ref.text = ""
+
+    event = create_test_api_gateway_event(
+        headers=create_headers(),
+        body=doc_ref.model_dump_json(exclude_none=True),
+    )
+    result = handler(event, create_mock_context())
+    body = result.pop("body")
+
+    assert result == {
+        "statusCode": "400",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
+
+    parsed_body = json.loads(body)
+
+    assert parsed_body == {
+        "resourceType": "OperationOutcome",
+        "issue": [
+            {
+                "severity": "error",
+                "code": "invalid",
+                "details": {
+                    "coding": [
+                        {
+                            "code": "MESSAGE_NOT_WELL_FORMED",
+                            "display": "Message not well formed",
+                            "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                        }
+                    ],
+                },
+                "diagnostics": "Request body could not be parsed (root: Value error, The following fields are empty: text, author, context.sourcePatientInfo, category[0].coding[0].system, category[0].coding[0].code)",
+                "expression": ["root"],
+            }
+        ],
+    }
+
+
 def test_create_document_reference_invalid_resource():
     doc_ref = load_document_reference("Y05868-736253002-Valid")
     doc_ref.custodian = None

layer/nrlf/core/parent_model.py

@@ -1,6 +1,6 @@
 from typing import Annotated, List, Optional
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, model_validator
 
 
 class ParentCoding(BaseModel):
@@ -81,6 +81,60 @@ class ParentExtension(BaseModel):
 
 
 class Parent(BaseModel):
+    @model_validator(mode="before")
+    @classmethod
+    def validate_empty_fields(cls, values):
+        """
+        Iteratively check every field in the model for emptiness.
+        If a field is empty, add it to the error list with its full location.
+        """
+        stack = [(None, values)]
+        empty_fields = []
+
+        while stack:
+            path, current_value = stack.pop()
+
+            if isinstance(current_value, dict):
+                for key, value in current_value.items():
+                    full_path = f"{path}.{key}" if path else key
+                    if (
+                        value is None
+                        or value == ""
+                        or (isinstance(value, list) and not value)
+                    ):
+                        empty_fields.append(full_path)
+                    else:
+                        stack.append((full_path, value))
+
+            elif isinstance(current_value, list):
+                for index, item in enumerate(current_value):
+                    full_path = f"{path}[{index}]" if path else f"[{index}]"
+                    if (
+                        item is None
+                        or item == ""
+                        or (isinstance(item, dict) and not item)
+                    ):
+                        empty_fields.append(full_path)
+                    else:
+                        stack.append((full_path, item))
+
+            elif isinstance(current_value, BaseModel):
+                nested_values = current_value.model_dump(exclude_none=True)
+                for nested_field, nested_value in nested_values.items():
+                    full_path = f"{path}.{nested_field}" if path else nested_field
+                    stack.append((full_path, nested_value))
+
+            else:
+                if current_value is None or current_value == "":
+                    empty_fields.append(path)
+
+        if empty_fields:
+            raise ValueError(
+                f"The following fields are empty: {', '.join(empty_fields)}"
+            )
+
+        return values
+
     model_config = ConfigDict(regex_engine="python-re", extra="forbid")
     extension: Annotated[
         Optional[List[ParentExtension]],

tests/features/producer/createDocumentReference-failure.feature

@@ -1014,3 +1014,35 @@ Feature: Producer - createDocumentReference - Failure Scenarios
         ]
       }
       """
+
+  Scenario: Reject DocumentReference with empty non-mandatory field (author)
+    Given the application 'DataShare' (ID 'z00z-y11y-x22x') is registered to access the API
+    And the organisation 'TSTCUS' is authorised to access pointer types:
+      | system                 | value     |
+      | http://snomed.info/sct | 736253002 |
+    When producer 'TSTCUS' requests creation of a DocumentReference with default test values except 'author' is:
+      """
+      "author": []
+      """
+    Then the response status code is 400
+    And the response is an OperationOutcome with 1 issue
+    And the OperationOutcome contains the issue:
+      """
+      {
+        "severity": "error",
+        "code": "invalid",
+        "details": {
+            "coding": [
+            {
+                "system": "https://fhir.nhs.uk/ValueSet/Spine-ErrorOrWarningCode-1",
+                "code": "MESSAGE_NOT_WELL_FORMED",
+                "display": "Message not well formed"
+            }
+            ]
+        },
+        "diagnostics": "Request body could not be parsed (author: Field is an empty list)",
+        "expression": [
+            "author"
+        ]
+      }
+      """