ELI-615 | renamed best_iteration_result to iteration_result_summary

Author: Karthikeyannhs

src/eligibility_signposting_api/audit/audit_context.py

@@ -19,10 +19,10 @@
 )
 from eligibility_signposting_api.audit.audit_service import AuditService
 from eligibility_signposting_api.model.eligibility_status import (
-    BestIterationResult,
     CohortGroupResult,
     ConditionName,
     IterationResult,
+    IterationResultSummary,
     MatchedActionDetail,
     Reason,
     RuleType,
@@ -63,13 +63,13 @@ def add_request_details(request: Request) -> None:
     @staticmethod
     def append_audit_condition(
         condition_name: ConditionName,
-        best_iteration_result: BestIterationResult,
+        iteration_result_summary: IterationResultSummary,
         action_detail: MatchedActionDetail,
     ) -> None:
         audit_eligibility_cohorts, audit_eligibility_cohort_groups, audit_actions = [], [], []
-        best_active_iteration = best_iteration_result.active_iteration
-        best_candidate = best_iteration_result.iteration_result
-        best_cohort_results = best_iteration_result.cohort_results
+        best_active_iteration = iteration_result_summary.active_iteration
+        best_candidate = iteration_result_summary.iteration_result
+        best_cohort_results = iteration_result_summary.cohort_results
         filter_audit_rules, suitability_audit_rules = [], []
 
         if best_cohort_results:
@@ -94,8 +94,8 @@ def append_audit_condition(
         audit_actions = AuditContext.create_audit_actions(action_detail.actions)
 
         audit_condition = AuditCondition(
-            campaign_id=best_iteration_result.campaign_id,
-            campaign_version=best_iteration_result.campaign_version,
+            campaign_id=iteration_result_summary.campaign_id,
+            campaign_version=iteration_result_summary.campaign_version,
             iteration_id=best_active_iteration.id if best_active_iteration else None,
             iteration_version=best_active_iteration.version if best_active_iteration else None,
             condition_name=condition_name,

src/eligibility_signposting_api/model/eligibility_status.py

@@ -138,7 +138,7 @@ class IterationResult:
 
 
 @dataclass
-class BestIterationResult:
+class IterationResultSummary:
     iteration_result: IterationResult
     active_iteration: Iteration | None = None
     campaign_id: CampaignID | None = None

src/eligibility_signposting_api/services/calculators/eligibility_calculator.py

@@ -11,12 +11,12 @@
 from eligibility_signposting_api.audit.audit_context import AuditContext
 from eligibility_signposting_api.model import campaign_config, eligibility_status
 from eligibility_signposting_api.model.eligibility_status import (
-    BestIterationResult,
     CohortGroupResult,
     Condition,
     ConditionName,
     EligibilityStatus,
     IterationResult,
+    IterationResultSummary,
     Reason,
     Status,
     StatusText,
@@ -94,21 +94,21 @@ def get_eligibility_status(
         )
         for condition_name, campaign in requested_cc_with_active_iteration:
             if campaign is None:
-                continue
+                continue  # skipping as no active iteration was found.
 
-            best_iteration_result = self.get_iteration_result(campaign)
+            iteration_result_summary = self.evaluate_iteration_result_summary(campaign)
 
             matched_action_detail = self.action_rule_handler.get_actions(
                 self.person,
-                best_iteration_result.active_iteration,
-                best_iteration_result.iteration_result,
+                iteration_result_summary.active_iteration,
+                iteration_result_summary.iteration_result,
                 include_actions_flag=include_actions_flag,
             )
 
-            best_iteration_result = TokenProcessor.find_and_replace_tokens(self.person, best_iteration_result)
+            iteration_result_summary = TokenProcessor.find_and_replace_tokens(self.person, iteration_result_summary)
             matched_action_detail = TokenProcessor.find_and_replace_tokens(self.person, matched_action_detail)
 
-            condition_results[condition_name] = best_iteration_result.iteration_result
+            condition_results[condition_name] = iteration_result_summary.iteration_result
             condition_results[condition_name].actions = matched_action_detail.actions
 
             condition: Condition = self.build_condition(
@@ -119,14 +119,16 @@ def get_eligibility_status(
 
             AuditContext.append_audit_condition(
                 condition_name,
-                best_iteration_result,
+                iteration_result_summary,
                 matched_action_detail,
             )
 
         # Consolidate all the results and return
         return eligibility_status.EligibilityStatus(conditions=final_result)
 
-    def get_iteration_result(self, campaign_with_active_iteration: CampaignConfig) -> BestIterationResult:
+    def evaluate_iteration_result_summary(
+        self, campaign_with_active_iteration: CampaignConfig
+    ) -> IterationResultSummary:
         active_iteration = campaign_with_active_iteration.current_iteration
         cohort_results: dict[CohortLabel, CohortGroupResult] = self.rule_processor.get_cohort_group_results(
             self.person, active_iteration
@@ -138,7 +140,7 @@ def get_iteration_result(self, campaign_with_active_iteration: CampaignConfig) -
             active_iteration.status_text, ConditionName(campaign_with_active_iteration.target), status
         )
 
-        return BestIterationResult(
+        return IterationResultSummary(
             IterationResult(status, status_text, best_cohorts, []),
             active_iteration,
             campaign_with_active_iteration.id,

src/eligibility_signposting_api/services/processors/action_rule_handler.py

@@ -27,14 +27,14 @@ def get_actions(
         self,
         person: Person,
         active_iteration: Iteration | None,
-        best_iteration_result: IterationResult,
+        iteration_result: IterationResult,
         *,
         include_actions_flag: bool,
     ) -> MatchedActionDetail:
         action_detail = MatchedActionDetail()
 
         if active_iteration is not None and include_actions_flag:
-            rule_type = best_iteration_result.status.get_action_rule_type()
+            rule_type = iteration_result.status.get_action_rule_type()
             action_detail = self._handle(person, active_iteration, rule_type)
 
         return action_detail

tests/unit/audit/test_audit_context.py

@@ -15,11 +15,11 @@
     ActionCode,
     ActionDescription,
     ActionType,
-    BestIterationResult,
     CohortGroupResult,
     ConditionName,
     InternalActionCode,
     IterationResult,
+    IterationResultSummary,
     MatchedActionDetail,
     Reason,
     RuleCode,
@@ -147,7 +147,7 @@ def test_append_audit_condition_adds_condition_to_audit_log_on_g_for_actionable_
         campaign_config.RuleName("RedirectRuleName1"), campaign_config.RulePriority(1), suggested_actions
     )
 
-    best_iteration_results = BestIterationResult(
+    iteration_result_summary = IterationResultSummary(
         iteration_result,
         iteration,
         campaign_details[0],
@@ -158,7 +158,7 @@ def test_append_audit_condition_adds_condition_to_audit_log_on_g_for_actionable_
     with app.app_context():
         g.audit_log = AuditEvent()
 
-        AuditContext.append_audit_condition(condition_name, best_iteration_results, matched_action_detail)
+        AuditContext.append_audit_condition(condition_name, iteration_result_summary, matched_action_detail)
 
         expected_audit_action = [
             AuditAction(
@@ -227,7 +227,7 @@ def test_should_append_audit_suppression_rules_for_actionable_status(app):
     )
     campaign_details = (CampaignID("CampaignID1"), CampaignVersion(123))
 
-    best_iteration_results = BestIterationResult(
+    iteration_result_summary = IterationResultSummary(
         iteration_result,
         iteration,
         campaign_details[0],
@@ -238,7 +238,7 @@ def test_should_append_audit_suppression_rules_for_actionable_status(app):
     with app.app_context():
         g.audit_log = AuditEvent()
 
-        AuditContext.append_audit_condition(condition_name, best_iteration_results, MatchedActionDetail())
+        AuditContext.append_audit_condition(condition_name, iteration_result_summary, MatchedActionDetail())
 
         assert g.audit_log.response.condition, condition_name
         cond = g.audit_log.response.condition[0]
@@ -288,7 +288,7 @@ def test_should_append_audit_filter_rules_for_not_actionable_status(app):
     )
     campaign_details = (CampaignID("CampaignID1"), CampaignVersion(123))
 
-    best_iteration_results = BestIterationResult(
+    iteration_result_summary = IterationResultSummary(
         iteration_result,
         iteration,
         campaign_details[0],
@@ -299,7 +299,7 @@ def test_should_append_audit_filter_rules_for_not_actionable_status(app):
     with app.app_context():
         g.audit_log = AuditEvent()
 
-        AuditContext.append_audit_condition(condition_name, best_iteration_results, MatchedActionDetail())
+        AuditContext.append_audit_condition(condition_name, iteration_result_summary, MatchedActionDetail())
 
         assert g.audit_log.response.condition, condition_name
         cond = g.audit_log.response.condition[0]