Some refactoring

Updated some docstrings
Updated assert_latest_event_status to be more robust
Centralised SUBJECT VIEW logging by moving it into navigate_to_subject_summary_page

Author: Andyg79

pages/communication_production/batch_list_page.py

@@ -1,7 +1,9 @@
 from playwright.sync_api import Page, expect, Locator
 from pages.base_page import BasePage
 from datetime import datetime
-from pages.communication_production.communications_production_page import CommunicationsProductionPage
+from pages.communication_production.communications_production_page import (
+    CommunicationsProductionPage,
+)
 from utils.calendar_picker import CalendarPicker
 from utils.table_util import TableUtils
 import logging
@@ -228,7 +230,10 @@ def select_first_active_batch(self) -> None:
         self.select_first_batch_row(self.table_selector, timeout_ms=10000)
 
     def is_batch_present(self, batch_type: str) -> bool:
-        """Checks if a batch of the given type exists in the active batch list."""
+        """Checks if a batch of the given type exists in the active batch list.
+        Args:
+            batch_type (str): The type of the batch to check for e.g. "S1 - Pre-invitation (FIT)"
+        """
         locator = self.page.locator(
             f"{self.table_selector} tbody tr td", has_text=batch_type
         )

pages/screening_subject_search/subject_screening_summary_page.py

@@ -331,7 +331,7 @@ def navigate_to_spine_search(self) -> None:
         Navigates to the Spine Search screen by clicking the appropriate link
         and loading the target URL.
         """
-        #self.retrieve_data_link.click()
+        # self.retrieve_data_link.click()
         self.click(self.retrieve_data_link)
         self.page.goto(self.spine_url)
 
@@ -377,15 +377,17 @@ def assert_latest_event_status(self, expected_status: str) -> None:
         Asserts that the latest event status displayed in the summary table matches the expected value.
 
         Args:
-            expected_status (str): The expected event status (e.g., 'S9 Pre-invitation Sent').
+            expected_status (str): The expected event status (e.g., 'S9 - Pre-invitation Sent').
 
         Raises:
             AssertionError: If the status in the UI does not match the expected value.
         """
-        actual_status = self.latest_event_status_cell.inner_text().strip()
-        assert actual_status == expected_status, (
-            f"[LATEST EVENT STATUS MISMATCH] Expected '{expected_status}', but found '{actual_status}' in UI."
-        )
+        cell = self.get_latest_event_status_cell(expected_status)
+        actual_status = cell.inner_text().strip()
+        assert (
+            actual_status == expected_status
+        ), f"[LATEST EVENT STATUS MISMATCH] Expected '{expected_status}', but found '{actual_status}' in UI."
+
 
 class ChangeScreeningStatusOptions(Enum):
     """Enum for Change Screening Status options."""

tests/regression/regression_tests/fobt_regression_tests/test_scenario_2.py

@@ -70,11 +70,10 @@ def test_scenario_2(page: Page) -> None:
             "screening status": "Inactive",
         },
     )
-    logging.info("[DB ASSERTIONS COMPLETE] Created subject's details checked in the DB")
+    logging.info("[DB ASSERTIONS COMPLETE] Created subject details checked in the DB")
 
     # Navigate to subject summary page in UI
     screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
-    logging.info(f"[SUBJECT VIEW] Subject {nhs_no} loaded in UI")
 
     # Assert subject details in the UI
     summary_page.assert_subject_age(66)
@@ -100,11 +99,10 @@ def test_scenario_2(page: Page) -> None:
             "Screening Status Reason": "Failsafe Trawl",
         },
     )
-    logging.info("[DB ASSERTIONS COMPLETE]Updated subject details checked in the DB")
+    logging.info("[DB ASSERTIONS COMPLETE] Updated subject details checked in the DB")
 
     # Navigate to subject summary page in UI
     screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
-    logging.info(f"[SUBJECT VIEW] Subject {nhs_no} loaded in UI")
 
     # Assert subject details in the UI
     summary_page.assert_screening_status("Inactive")
@@ -180,7 +178,6 @@ def test_scenario_2(page: Page) -> None:
 
     # Navigate to subject summary page in UI
     screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
-    logging.info(f"[SUBJECT VIEW] Subject {nhs_no} loaded in UI")
 
     # Assert subject details in the UI
     summary_page.assert_latest_event_status(
@@ -202,7 +199,6 @@ def test_scenario_2(page: Page) -> None:
 
     # Navigate to subject summary page in UI
     screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
-    logging.info(f"[SUBJECT VIEW] Subject {nhs_no} loaded in UI")
 
     # Assert subject details in the UI
     summary_page.assert_latest_event_status("S2 - Normal")

utils/fit_kit.py

@@ -240,6 +240,11 @@ def read_latest_logged_kit(
     ) -> None:
         """
         Reads the subject's latest logged FIT kit and updates its status/result.
+        Args:
+            user (UserRoleType): The user performing the action.
+            kit_type (int): The type of the kit.
+            kit (str): The FIT kit ID to be read.
+            kit_result (str): The result of the kit reading. Valid values are "NORMAL", "ABNORMAL", "SPOILT", "TECHNICAL_FAILURE".
         """
         logging.info("start: read_latest_logged_kit")
 
@@ -300,7 +305,13 @@ def read_latest_logged_kit(
         logging.info("exit: read_latest_logged_kit")
 
     def log_fit_kit(self, page: Page, nhs_no: str) -> str:
-        """Logs the FIT kit for a given subject."""
+        """Logs the FIT kit for a given subject.
+        Args:
+            page (Page): The Playwright page object.
+            nhs_no (str): The NHS number of the subject.
+        Returns:
+            str: The FIT kit ID that was successfully logged.
+        """
         BasePage(page).click_main_menu_link()
         fit_kit = FitKitGeneration().get_fit_kit_for_subject_sql(nhs_no, False, False)
         BasePage(page).go_to_fit_test_kits_page()