updated iteration time

Author: oneeb-nhs

src/eligibility_signposting_api/model/campaign_config.py

@@ -4,7 +4,7 @@
 import re
 import typing
 from collections import Counter
-from datetime import UTC, date, datetime
+from datetime import UTC, date, datetime, time
 from enum import StrEnum
 from functools import cached_property
 from operator import attrgetter
@@ -33,6 +33,7 @@
 IterationVersion = NewType("IterationVersion", int)
 IterationID = NewType("IterationID", str)
 IterationDate = NewType("IterationDate", date)
+IterationTime = NewType("IterationTime", time)
 RuleName = NewType("RuleName", str)
 RuleDescription = NewType("RuleDescription", str)
 RulePriority = NewType("RulePriority", int)
@@ -119,19 +120,19 @@ class IterationCohort(BaseModel):
 
     @cached_property
     def is_virtual_cohort(self) -> bool:
-        return self.virtual == Virtual.YES
+            return self.virtual == Virtual.YES
 
     @field_validator("virtual", mode="before")
     @classmethod
     def normalize_virtual(cls, value: str) -> Virtual:
         if value is None:
-            return Virtual.NO
+                return Virtual.NO
         if isinstance(value, str):
             value = value.strip().upper()
         if value == "Y":
-            return Virtual.YES
+                return Virtual.YES
         if value == "N":
-            return Virtual.NO
+                return Virtual.NO
         msg = f"Invalid value for Virtual: {value!r}"
         raise ValueError(msg)
 
@@ -160,8 +161,8 @@ class IterationRule(BaseModel):
     @field_validator("rule_stop", mode="before")
     def parse_yn_to_bool(cls, v: str | bool) -> bool:  # noqa: N805, FBT001
         if isinstance(v, str):
-            return v.upper() == "Y"
-        return v
+                return v.upper() == "Y"
+            return v
 
     _parent: Iteration | None = PrivateAttr(default=None)
 
@@ -183,7 +184,7 @@ def rule_code(self) -> str:
             for rule_entry in self._parent.rules_mapper.values():
                 if rule_entry and self.name in rule_entry.rule_names:
                     rule_code = rule_entry.rule_code
-        return rule_code or self.code or self.name
+            return rule_code or self.code or self.name
 
     @property
     def rule_text(self) -> str:
@@ -200,7 +201,7 @@ def rule_text(self) -> str:
             for rule_entry in self._parent.rules_mapper.values():
                 if rule_entry and self.name in rule_entry.rule_names:
                     rule_text = rule_entry.rule_text
-        return rule_text or self.description
+            return rule_text or self.description
 
     @cached_property
     def parsed_cohort_labels(self) -> list[str]:
@@ -211,11 +212,11 @@ def parsed_cohort_labels(self) -> list[str]:
             A list of cohort labels, split by comma. If no label is set, returns an empty list.
         """
         if not self.cohort_label:
-            return []
-        return [label.strip() for label in self.cohort_label.split(",") if label.strip()]
+                return []
+            return [label.strip() for label in self.cohort_label.split(",") if label.strip()]
 
     def __str__(self) -> str:
-        return json.dumps(self.model_dump(by_alias=True), indent=2)
+            return json.dumps(self.model_dump(by_alias=True), indent=2)
 
 
 class AvailableAction(BaseModel):
@@ -230,7 +231,7 @@ class AvailableAction(BaseModel):
 
 class ActionsMapper(RootModel[dict[str, AvailableAction]]):
     def get(self, key: str, default: AvailableAction | None = None) -> AvailableAction | None:
-        return self.root.get(key, default)
+            return self.root.get(key, default)
 
 
 class StatusText(BaseModel):
@@ -251,17 +252,18 @@ class RuleEntry(BaseModel):
 
 class RulesMapper(RootModel[dict[str, RuleEntry]]):
     def get(self, key: str, default: RuleEntry | None = None) -> RuleEntry | None:
-        return self.root.get(key, default)
+            return self.root.get(key, default)
 
     def values(self) -> list[RuleEntry]:
-        return list(self.root.values())
+            return list(self.root.values())
 
 
 class Iteration(BaseModel):
     id: IterationID = Field(..., alias="ID")
     version: IterationVersion = Field(..., alias="Version")
     name: IterationName = Field(..., alias="Name")
     iteration_date: IterationDate = Field(..., alias="IterationDate")
+    iteration_time: IterationTime = Field(..., alias="IterationTime")
     iteration_number: int | None = Field(None, alias="IterationNumber")
     approval_minimum: int | None = Field(None, alias="ApprovalMinimum")
     approval_maximum: int | None = Field(None, alias="ApprovalMaximum")
@@ -287,7 +289,7 @@ def __init__(self, **data: dict[str, typing.Any]) -> None:
     @classmethod
     def parse_dates(cls, v: str | date) -> date:
         if isinstance(v, date):
-            return v
+                return v
 
         v_str = str(v)
 
@@ -296,7 +298,7 @@ def parse_dates(cls, v: str | date) -> date:
             raise ValueError(msg)
 
         try:
-            return datetime.strptime(v_str, "%Y%m%d").date()  # noqa: DTZ007
+                return datetime.strptime(v_str, "%Y%m%d").date()  # noqa: DTZ007
         except ValueError as err:
             msg = f"Invalid date value: {v_str}. Must be a valid calendar date in YYYYMMDD format."
             raise ValueError(msg) from err
@@ -306,10 +308,22 @@ def parse_dates(cls, v: str | date) -> date:
     def serialize_dates(v: date, _info: SerializationInfo) -> str:
         return v.strftime("%Y%m%d")
 
+    @property
+    def get_iteration_datetime(self) -> datetime:
+        iteration_time = (
+            self.iteration_time
+            or getattr(getattr(self, "parent", None), "default_iteration_time", None)
+        )
+
+        if iteration_time is None:
+            raise ValueError("No iteration_time available on object or parent.default_iteration_time.")
+
+        return datetime.combine(self.iteration_date, iteration_time)
+
+
     def __str__(self) -> str:
         return json.dumps(self.model_dump(by_alias=True), indent=2)
 
-
 class CampaignConfig(BaseModel):
     id: CampaignID = Field(..., alias="ID")
     version: CampaignVersion = Field(..., alias="Version")
@@ -321,7 +335,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")
-    iteration_time: str | None = Field(None, alias="IterationTime")
+    default_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")
@@ -335,7 +349,7 @@ class CampaignConfig(BaseModel):
     @classmethod
     def parse_dates(cls, v: str | date) -> date:
         if isinstance(v, date):
-            return v
+                return v
 
         v_str = str(v)
 
@@ -344,22 +358,22 @@ def parse_dates(cls, v: str | date) -> date:
             raise ValueError(msg)
 
         try:
-            return datetime.strptime(v_str, "%Y%m%d").date()  # noqa: DTZ007
+                return datetime.strptime(v_str, "%Y%m%d").date()  # noqa: DTZ007
         except ValueError as err:
             msg = f"Invalid date value: {v_str}. Must be a valid calendar date in YYYYMMDD format."
             raise ValueError(msg) from err
 
     @field_serializer("start_date", "end_date", when_used="always")
     @staticmethod
     def serialize_dates(v: date, _info: SerializationInfo) -> str:
-        return v.strftime("%Y%m%d")
+            return v.strftime("%Y%m%d")
 
     @model_validator(mode="after")
     def check_start_and_end_dates_sensible(self) -> typing.Self:
         if self.start_date > self.end_date:
             message = f"start date {self.start_date} after end date {self.end_date}"
             raise ValueError(message)
-        return self
+            return self
 
     @model_validator(mode="after")
     def check_no_overlapping_iterations(self) -> typing.Self:
@@ -368,21 +382,21 @@ def check_no_overlapping_iterations(self) -> typing.Self:
             iteration_date, count = multiple_found
             message = f"{count} iterations with iteration date {iteration_date} in campaign {self.id}"
             raise ValueError(message)
-        return self
+            return self
 
     @cached_property
     def campaign_live(self) -> bool:
         today = datetime.now(tz=UTC).date()
-        return self.start_date <= today <= self.end_date
+            return self.start_date <= today <= self.end_date
 
     @cached_property
     def current_iteration(self) -> Iteration:
         today = datetime.now(tz=UTC).date()
         iterations_by_date_descending = sorted(self.iterations, key=attrgetter("iteration_date"), reverse=True)
-        return next(i for i in iterations_by_date_descending if i.iteration_date <= today)
+            return next(i for i in iterations_by_date_descending if i.iteration_date <= today)
 
     def __str__(self) -> str:
-        return json.dumps(self.model_dump(by_alias=True), indent=2)
+            return json.dumps(self.model_dump(by_alias=True), indent=2)
 
 
 class Rules(BaseModel):

tests/unit/validation/test_campaign_config_validator.py

@@ -318,3 +318,22 @@ def test_approval_minimum_greater_than_approval_maximum_is_invalid(
         data["ApprovalMinimum"] = approval_min
         data["ApprovalMaximum"] = approval_max
         CampaignConfigValidation(**data)
+
+    def test_iteration_time_overrides_default_iteration_time(
+        self,
+        valid_iteration_config_with_only_mandatory_fields,
+    ):
+        # Arrange
+        data = valid_iteration_config_with_only_mandatory_fields.copy()
+        data["default_iteration_time"] = "09:00:00"
+        data["iteration_time"] = "14:30:00"
+        config = CampaignConfigValidation(**data)
+
+        # Act
+        result = config.get_iteration_datetime
+
+        # Assert
+        assert result.time() == IterationTime(14, 30), (
+            "Expected iteration_time to take precedence over default_iteration_time"
+        )
+