added validate_message_status (#49)

Author: dnimmo

src/functions/message_status/validate_message_status.py

@@ -0,0 +1,44 @@
+import uuid
+
+success_message = "Validation successful"
+
+def invalid_type_message(field, expected_type):
+    return f"Invalid type for field {field}. Expected {expected_type.__name__}"
+
+def missing_field_message(field):
+    return f"Missing required field: {field}"
+
+def validate_message_status(request):
+    required_fields = {
+        "batch_id": uuid.UUID,
+        "message_reference": uuid.UUID,
+        "nhs_number": str,
+        "recipient_id": str,
+    }
+
+    for field, expected_type in required_fields.items():
+        if field not in request:
+            return False, missing_field_message(field)
+        try:
+            if expected_type == uuid.UUID:
+                uuid.UUID(request[field])
+            elif not isinstance(request[field], expected_type):
+                raise ValueError()
+        except ValueError:
+            return False, invalid_type_message(field, expected_type)
+
+    optional_fields = {
+        "current_state": str,
+        "message_id": str,
+        "full_payload_details": (dict, type(None)),
+    }
+
+    for field, expected_type in optional_fields.items():
+        if field in request:
+            if isinstance(expected_type, tuple):
+                if not isinstance(request[field], expected_type):
+                    return False, invalid_type_message(field, expected_type)
+            elif not isinstance(request[field], expected_type):
+                return False, invalid_type_message(field, expected_type)
+
+    return True, success_message

tests/message_status/test_validate_message_status.py

@@ -0,0 +1,85 @@
+import pytest
+import uuid
+import validate_message_status
+
+def generate_uuid():
+    return str(uuid.uuid4())
+
+@pytest.mark.parametrize(
+    "req, expected_result, expected_message",
+    [
+        # All required fields present/valid
+        (
+            {
+                "batch_id": generate_uuid(),
+                "message_reference": generate_uuid(),
+                "nhs_number": "1234567890",
+                "recipient_id": "recipient123",
+            },
+            True,
+            validate_message_status.success_message,
+        ),
+        # Missing required field (batch_id)
+        (
+            {
+                "message_reference": generate_uuid(),
+                "nhs_number": "1234567890",
+                "recipient_id": "recipient123",
+            },
+            False,
+            validate_message_status.missing_field_message("batch_id"),
+        ),
+        # Invalid type for `batch_id`
+        (
+            {
+                "batch_id": "invalid-uuid",
+                "message_reference": generate_uuid(),
+                "nhs_number": "1234567890",
+                "recipient_id": "recipient123",
+            },
+            False,
+            validate_message_status.invalid_type_message("batch_id", uuid.UUID),
+        ),
+        # Invalid type for `nhs_number`
+        (
+            {
+                "batch_id": generate_uuid(),
+                "message_reference": generate_uuid(),
+                "nhs_number": 1234567890,
+                "recipient_id": "recipient123",
+            },
+            False,
+            validate_message_status.invalid_type_message("nhs_number", str),
+        ),
+        #  All optional fields are valid
+        (
+            {
+                "batch_id": generate_uuid(),
+                "message_reference": generate_uuid(),
+                "nhs_number": "1234567890",
+                "recipient_id": "recipient123",
+                "current_state": "SENT",
+                "message_id": "msg123",
+                "full_payload_details": {"key": "value"},
+            },
+            True,
+            validate_message_status.success_message,
+        ),
+        # Invalid optional field type (current_state)
+        (
+            {
+                "batch_id": generate_uuid(),
+                "message_reference": generate_uuid(),
+                "nhs_number": "1234567890",
+                "recipient_id": "recipient123",
+                "current_state": 123,
+            },
+            False,
+            validate_message_status.invalid_type_message("current_state", str),
+        ),
+    ],
+)
+def test_validate_message_status(req, expected_result, expected_message):
+    result, message = validate_message_status.validate_message_status(req)
+    assert result == expected_result
+    assert message == expected_message