reverted default_iteration_time to iteration_time

Author: oneeb-nhs

src/eligibility_signposting_api/model/campaign_config.py

@@ -344,7 +344,7 @@ def iteration_datetime(self) -> datetime:
         if self.iteration_time:
             iteration_time = self.iteration_time
         elif self._parent:
-            iteration_time = self._parent.default_iteration_time
+            iteration_time = self._parent.iteration_time
         else:
             msg = f"No iteration_time and no parent linked for iteration {self.id}"
             raise ValueError(msg)
@@ -366,7 +366,7 @@ class CampaignConfig(BaseModel):
     reviewer: list[str] | None = Field(None, alias="Reviewer")
     iteration_frequency: Literal["X", "D", "W", "M", "Q", "A"] = Field(..., alias="IterationFrequency")
     iteration_type: Literal["A", "M", "S", "O"] = Field(..., alias="IterationType")
-    default_iteration_time: IterationTime = Field(default=IterationTime(time(0, 0, 0)), alias="DefaultIterationTime")
+    iteration_time: IterationTime = Field(default=IterationTime(time(0, 0, 0)), alias="IterationTime")
     default_comms_routing: str | None = Field(None, alias="DefaultCommsRouting")
     start_date: StartDate = Field(..., alias="StartDate")
     end_date: EndDate = Field(..., alias="EndDate")
@@ -400,7 +400,7 @@ def parse_dates(cls, v: str | date) -> date:
             msg = f"Invalid date value: {v_str}. Must be a valid calendar date in YYYYMMDD format."
             raise ValueError(msg) from err
 
-    @field_validator("default_iteration_time", mode="before")
+    @field_validator("iteration_time", mode="before")
     @classmethod
     def parse_times(cls, v: str | time) -> time | None:
         if not v:
@@ -426,7 +426,7 @@ def parse_times(cls, v: str | time) -> time | None:
     def serialize_dates(v: date, _info: SerializationInfo) -> str:
         return v.strftime("%Y%m%d")
 
-    @field_serializer("default_iteration_time", when_used="always")
+    @field_serializer("iteration_time", when_used="always")
     @staticmethod
     def serialize_time(v: time, _info: SerializationInfo) -> str | None:
         return v.strftime("%H:%M:%S") if v else None

src/rules_validation_api/app.py

@@ -88,14 +88,17 @@ def display_current_iteration(result: RulesValidation) -> None:
     if is_campaign_live:
         sys.stdout.write(f"{YELLOW}Campaign is {RESET}{GREEN}LIVE{RESET}\n")
         current = config.current_iteration
-        if current:
-            sys.stdout.write(
-                f"{YELLOW}Current active Iteration Number: {RESET}{GREEN}{current.iteration_number}{RESET}\n"
-            )
-            sys.stdout.write(
-                f"{YELLOW}Current active Iteration's date&time: {RESET}{GREEN}{current.iteration_datetime}{RESET}\n"
-            )
-        else:
+
+        try:
+            current = config.current_iteration
+            if current:
+                sys.stdout.write(
+                    f"{YELLOW}Current active Iteration Number: {RESET}{GREEN}{current.iteration_number}{RESET}\n"
+                )
+                sys.stdout.write(
+                    f"{YELLOW}Current active Iteration's date&time: {RESET}{GREEN}{current.iteration_datetime}{RESET}\n"
+                )
+        except StopIteration:
             sys.stdout.write(f"{YELLOW}No active iteration could be determined{RESET}\n")
 
     else:
@@ -109,18 +112,20 @@ def display_current_iteration(result: RulesValidation) -> None:
     # ---- Next Iteration ----
     if not is_campaign_expired:
         sorted_iterations = sorted(iterations, key=attrgetter("iteration_date"))
-        next_iteration = next(
-            (i for i in sorted_iterations if i.iteration_date > today), None
-        )
 
-        if next_iteration:
-            sys.stdout.write(
-                f"{YELLOW}Next active Iteration Number: {RESET}{GREEN}{next_iteration.iteration_number}{RESET}\n"
+        try:
+            next_iteration = next(
+                (i for i in sorted_iterations if i.iteration_date > today), None
             )
-            sys.stdout.write(
-                f"{YELLOW}Next active Iteration's date&time: {RESET}{GREEN}{next_iteration.iteration_datetime}{RESET}\n"
-            )
-        else:
+
+            if next_iteration:
+                sys.stdout.write(
+                    f"{YELLOW}Next active Iteration Number: {RESET}{GREEN}{next_iteration.iteration_number}{RESET}\n"
+                )
+                sys.stdout.write(
+                    f"{YELLOW}Next active Iteration's date&time: {RESET}{GREEN}{next_iteration.iteration_datetime}{RESET}\n"
+                )
+        except StopIteration:
             sys.stdout.write(f"{YELLOW}No next active iteration could be determined{RESET}\n")
 
     # ---- Total Iterations ----

tests/fixtures/builders/model/rule.py

@@ -98,7 +98,7 @@ class RawCampaignConfigFactory(ModelFactory[CampaignConfig]):
     id = "42-hi5tch-hi5kers-gu5ide-t2o-t3he-gal6axy"
     start_date = Use(past_date)
     end_date = Use(future_date)
-    default_iteration_time = IterationTime(time(0, 0, 0))
+    iteration_time = IterationTime(time(0, 0, 0))
 
 
 class CampaignConfigFactory(RawCampaignConfigFactory):

tests/test_data/test_config/test_config_v1.3.0.json

@@ -20,7 +20,7 @@
     "ApprovalMaximum": 5000000,
     "IterationFrequency": "X",
     "IterationType": "M",
-    "DefaultIterationTime": "07:00:00",
+    "IterationTime": "07:00:00",
     "Iterations": [
       {
         "ID": "id_100",

tests/unit/validation/test_app.py

@@ -1,6 +1,7 @@
 import sys
 from io import StringIO
 from unittest.mock import Mock, PropertyMock
+from datetime import UTC, datetime, timedelta
 
 from pydantic import BaseModel, ValidationError
 
@@ -84,6 +85,8 @@ def test_no_current_iteration():
     # iterations must be a list, not a Mock
     result.campaign_config.iterations = []
 
+    result.campaign_config.end_date = datetime.now(UTC).date() + timedelta(days=1)
+
     # current_iteration should raise StopIteration
     type(result.campaign_config).current_iteration = PropertyMock(side_effect=StopIteration)
 

tests/unit/validation/test_campaign_config_validator.py

@@ -167,13 +167,13 @@ def test_reviewer_field(self, reviewer, valid_campaign_config_with_only_mandator
         model = CampaignConfigValidation(**data)
         assert model.reviewer == reviewer
 
-    @pytest.mark.parametrize("default_iteration_time", ["14:00:00", "09:30:00", "18:45:00"])
-    def test_default_iteration_time_field(
-        self, default_iteration_time, valid_campaign_config_with_only_mandatory_fields
+    @pytest.mark.parametrize("iteration_time", ["14:00:00", "09:30:00", "18:45:00"])
+    def test_iteration_time_field(
+        self, iteration_time, valid_campaign_config_with_only_mandatory_fields
     ):
-        data = {**valid_campaign_config_with_only_mandatory_fields, "DefaultIterationTime": default_iteration_time}
+        data = {**valid_campaign_config_with_only_mandatory_fields, "IterationTime": iteration_time}
         model = CampaignConfigValidation(**data)
-        assert model.default_iteration_time == datetime.strptime(default_iteration_time, "%H:%M:%S").time()  # noqa: DTZ007
+        assert model.iteration_time == datetime.strptime(iteration_time, "%H:%M:%S").time()  # noqa: DTZ007
 
     @pytest.mark.parametrize("routing", ["email", "sms", "push"])
     def test_default_comms_routing_field(self, routing, valid_campaign_config_with_only_mandatory_fields):

tests/unit/validation/test_iteration_validator.py

@@ -520,11 +520,11 @@ def test_invalid_iteration_collects_errors_if_iteration_rules_have_invalid_data(
         [
             # Case 1: Iteration time overrides default
             ("14:30:00", "09:00:00", datetime(2025, 1, 2, 14, 30, 0)),  # noqa: DTZ001
-            # Case 2: Iteration time is missing, so it uses default_iteration_time
+            # Case 2: Iteration time is missing, so it uses campaign config iteration_time
             (None, "09:00:00", datetime(2025, 1, 2, 9, 0, 0)),  # noqa: DTZ001
             # Case 3: Both are the same
             ("10:00:00", "10:00:00", datetime(2025, 1, 2, 10, 0, 0)),  # noqa: DTZ001
-            # Case 4: Both are None, falls back to default value (12 AM) in default_iteration_time
+            # Case 4: Both are None, falls back to default value (12 AM) in campaign config iteration_time
             (None, None, datetime(2025, 1, 2, 0, 0, 0)),  # noqa: DTZ001
         ],
     )
@@ -544,7 +544,7 @@ def test_iteration_full_datetime_validation(
         data = valid_campaign_config_with_only_mandatory_fields.copy()
 
         if default_time_iteration_input:
-            data["default_iteration_time"] = default_time_iteration_input
+            data["iteration_time"] = default_time_iteration_input
 
         data["Iterations"] = [iteration_data]