Iterations BUC

Author: Karthikeyannhs

src/rules_validation_api/validators/campaign_config_validator.py

@@ -7,15 +7,15 @@
 class CampaignConfigValidation(CampaignConfig):
     iterations: list[IterationValidation] = Field(..., min_length=1, alias="Iterations")
 
-    @field_validator("id")
-    def validate_name(cls, value: str) -> str:
-        if not value.strip():
-            raise ValueError("campaign ID must not be empty")
-        return value
-
-    @field_validator("type")
-    def validate_type(cls, value: str) -> str:
-        allowed_values = {"V", "S"}
-        if value not in allowed_values:
-            raise ValueError(f"type must be one of {allowed_values}")
-        return value
+    # @field_validator("id")
+    # def validate_name(cls, value: str) -> str:
+    #     if not value.strip():
+    #         raise ValueError("campaign ID must not be empty")
+    #     return value
+    #
+    # @field_validator("type")
+    # def validate_type(cls, value: str) -> str:
+    #     allowed_values = {"V", "S"}
+    #     if value not in allowed_values:
+    #         raise ValueError(f"type must be one of {allowed_values}")
+    #     return value

src/rules_validation_api/validators/iteration_validator.py

@@ -1,4 +1,5 @@
-from pydantic import Field
+from pydantic import Field, ValidationError, model_validator
+from pydantic_core import InitErrorDetails
 
 from eligibility_signposting_api.model.campaign_config import Iteration
 from rules_validation_api.validators.actions_mapper_validator import ActionsMapperValidator
@@ -9,3 +10,22 @@ class IterationValidation(Iteration):
     iteration_rules: list[IterationRuleValidation] = Field(..., alias="IterationRules")
     actions_mapper: ActionsMapperValidator = Field(..., alias="ActionsMapper")
 
+    @model_validator(mode="after")
+    def validate_default_comms_routing_in_actions_mapper(self):
+        default_routing = self.default_comms_routing
+        actions_mapper = self.actions_mapper.root.keys()
+
+        if default_routing:
+            if not actions_mapper or default_routing not in actions_mapper:
+                error = InitErrorDetails(
+                    type='value_error',
+                    loc=('actions_mapper',),
+                    input=actions_mapper,
+                    ctx={'error': f"Missing entry for DefaultCommsRouting '{default_routing}' in ActionsMapper"}
+                )
+                raise ValidationError.from_exception_data(
+                    title='IterationValidation',
+                    line_errors=[error]
+                )
+
+        return self

tests/unit/validation/conftest.py

@@ -23,12 +23,22 @@ def valid_campaign_config_with_only_mandatory_fields():
                 "ApprovalMinimum": 10,
                 "ApprovalMaximum": 100,
                 "Type": "A",
-                "DefaultCommsRouting": "RouteA",
+                "DefaultCommsRouting": "BOOK_NBS",
                 "DefaultNotEligibleRouting": "RouteB",
                 "DefaultNotActionableRouting": "RouteC",
                 "IterationCohorts": [],
                 "IterationRules": [],
-                "ActionsMapper": {},
+                "ActionsMapper":
+                    {
+                        "BOOK_NBS":
+                            {
+                                "ExternalRoutingCode": "BookNBS",
+                                "ActionDescription": "",
+                                "ActionType": "ButtonWithAuthLink",
+                                "UrlLink": "http://www.nhs.uk/book-rsv",
+                                "UrlLabel": "Continue to booking"
+                            }
+                    }
             }
         ],
     }

tests/unit/validation/test_iteration_validator.py

@@ -81,7 +81,7 @@ def test_invalid_type(self, type_value, valid_campaign_config_with_only_mandator
             IterationValidation(**data)
 
     # DefaultCommsRouting
-    @pytest.mark.parametrize("routing_value", ["RouteA", "R1", "MainComm"])
+    @pytest.mark.parametrize("routing_value", ["BOOK_NBS"])
     def test_valid_default_comms_routing(self, routing_value, valid_campaign_config_with_only_mandatory_fields):
         data = {
             **valid_campaign_config_with_only_mandatory_fields["Iterations"][0],
@@ -140,3 +140,37 @@ def test_approval_maximum(self, approval_maximum, valid_campaign_config_with_onl
         }
         model = IterationValidation(**data)
         assert model.approval_maximum == approval_maximum
+
+
+class TestIterationCohortsSchemaValidations:
+    def test_valid_iteration_if_actions_mapper_has_entry_for_the_provided_default_routing_key(self, valid_campaign_config_with_only_mandatory_fields):
+        expected_action = {
+            "ExternalRoutingCode": "BookLocal",
+            "ActionDescription": "##Getting the vaccine\n"
+                                 "You can get an RSV vaccination at your GP surgery.\n"
+                                 "Your GP surgery may contact you about getting the RSV vaccine. "
+                                 "This may be by letter, text, phone call, email or through the NHS App. "
+                                 "You do not need to wait to be contacted before booking your vaccination.",
+            "ActionType": "InfoText"
+        }
+
+        data = {**valid_campaign_config_with_only_mandatory_fields["Iterations"][0],
+                "DefaultCommsRouting": "BOOK_LOCAL", "ActionsMapper": {
+                "BOOK_LOCAL": expected_action
+            }}
+        IterationValidation(**data)
+
+    def test_invalid_iteration_if_actions_mapper_has_no_entry_for_the_provided_default_routing_key(self, valid_campaign_config_with_only_mandatory_fields):
+        data = {**valid_campaign_config_with_only_mandatory_fields["Iterations"][0],
+                "DefaultCommsRouting": "BOOK_LOCAL", "ActionsMapper": {}} # Missing BOOK_LOCAL in ActionsMapper
+
+        with pytest.raises(ValidationError) as error:
+            IterationValidation(**data)
+
+        errors = error.value.errors()
+        assert any(
+            e["loc"][-1] == "actions_mapper" and "BOOK_LOCAL" in str(e["msg"])
+            for e in errors
+        ), "Expected validation error for missing BOOK_LOCAL entry in ActionsMapper"
+
+