moved helper methods from test file into relevant utils

Author: Andyg79

pages/communication_production/batch_list_page.py

@@ -1,6 +1,7 @@
 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 utils.calendar_picker import CalendarPicker
 from utils.table_util import TableUtils
 import logging
@@ -204,6 +205,17 @@ def select_first_batch_row(self, table_selector: str, timeout_ms: int = 0) -> No
         ), f"No batch links found in table '{table_selector}'"
         first_link.click()
 
+    def navigate_to_active_batch_list_page(self) -> None:
+        """
+        Navigates to the active batch list page from anywhere in bcss (providing the main menu link is displayed).
+
+        Args:
+            page (Page): The Playwright page object.
+        """
+        BasePage(self.page).click_main_menu_link()
+        BasePage(self.page).go_to_communications_production_page()
+        CommunicationsProductionPage(self.page).go_to_active_batch_list_page()
+
 
 class ActiveBatchListPage(BatchListPage):
     """Active Batch List Page-specific methods."""

tests/regression/regression_tests/fobt_regression_tests/test_scenario_2.py

@@ -21,34 +21,7 @@
 )
 from pages.fit_test_kits.log_devices_page import LogDevicesPage
 from pages.fit_test_kits.fit_test_kits_page import FITTestKitsPage
-
-
-# Helper function to navigate to subject profile
-def navigate_to_subject_summary_page(page, nhs_no: str) -> None:
-    """
-    Navigates to the subject profile in the UI using the NHS number.
-
-    Args:
-        page (Page): The Playwright page object.
-        nhs_no (str): The NHS number of the subject to search.
-    """
-    BasePage(page).click_main_menu_link()
-    BasePage(page).go_to_screening_subject_search_page()
-    screening_subject_page_searcher.search_subject_by_nhs_number(page, nhs_no)
-    logging.info(f"[SUBJECT VIEW] Subject {nhs_no} loaded in UI")
-
-
-# Helper function to navigate to active batch list
-def navigate_to_active_batch_list(page: Page) -> None:
-    """
-    Navigates to the active batch list page in the UI.
-
-    Args:
-        page (Page): The Playwright page object.
-    """
-    BasePage(page).click_main_menu_link()
-    BasePage(page).go_to_communications_production_page()
-    CommunicationsProductionPage(page).go_to_active_batch_list_page()
+from pages.communication_production.batch_list_page import BatchListPage
 
 
 # Helper function to log FIT kit
@@ -128,7 +101,7 @@ def test_scenario_2(page: Page) -> None:
     logging.info("[DB ASSERTIONS COMPLETE] Created subject's details checked in the DB")
 
     # Navigate to subject summary page in UI
-    navigate_to_subject_summary_page(page, nhs_no)
+    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
@@ -158,7 +131,7 @@ def test_scenario_2(page: Page) -> None:
     logging.info("[DB ASSERTIONS COMPLETE]Updated subject details checked in the DB")
 
     # Navigate to subject summary page in UI
-    navigate_to_subject_summary_page(page, nhs_no)
+    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
@@ -181,7 +154,7 @@ def test_scenario_2(page: Page) -> None:
     logging.info("[DB ASSERTIONS COMPLETE] Updated subject details checked in the DB")
 
     # Then there is a "S1" letter batch for my subject with the exact title "Pre-invitation (FIT)"
-    navigate_to_active_batch_list(page)
+    BatchListPage(page).navigate_to_active_batch_list_page()
     ActiveBatchListPage(page).is_batch_present("S1 - Pre-invitation (FIT)")
     logging.info("[UI ASSERTIONS COMPLETE] S1 Letter batch exists")
 
@@ -191,15 +164,14 @@ def test_scenario_2(page: Page) -> None:
         page, "S1", "Pre-invitation (FIT)", "S9 - Pre-invitation Sent", True
     )
     logging.info("[DB ASSERTIONS COMPLETE] Updated subject status checked in the DB")
+    logging.info("[UI ASSERTIONS COMPLETE] Updated subject details checked in the UI")
 
     # Navigate to subject summary page in UI
     # 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("S9 - Pre-invitation Sent")
-    # logging.info("[UI ASSERTIONS COMPLETE] Updated subject details checked in the UI")
-    # logging.info("[DEBUG TEST PASSED]")
 
     # When I run Timed Events for my subject
     # nhs_df = pd.DataFrame(
@@ -248,7 +220,7 @@ def test_scenario_2(page: Page) -> None:
     logging.info("[DB ASSERTIONS COMPLETE] Updated subject status checked in the DB")
 
     # Navigate to subject summary page in UI
-    navigate_to_subject_summary_page(page, nhs_no)
+    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
@@ -270,15 +242,15 @@ def test_scenario_2(page: Page) -> None:
     logging.info("[DB ASSERTIONS COMPLETE] Updated subject status checked in the DB")
 
     # Navigate to subject summary page in UI
-    navigate_to_subject_summary_page(page, nhs_no)
+    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")
     logging.info("[UI ASSERTIONS COMPLETE] Updated subject details checked in the UI")
 
     # And there is a "S2" letter batch for my subject with the exact title "Subject Result (Normal)"
-    navigate_to_active_batch_list(page)
+    BatchListPage(page).navigate_to_active_batch_list_page()
     ActiveBatchListPage(page).is_batch_present("S2 - Subject Result (Normal)")
     logging.info("[UI ASSERTIONS COMPLETE] S2 Letter batch exists")
 
@@ -302,15 +274,15 @@ def test_scenario_2(page: Page) -> None:
     # logging.info("[DB ASSERTIONS COMPLETE] Updated subject status checked in the DB")
 
     # Navigate to subject summary page in UI
-    navigate_to_subject_summary_page(page, nhs_no)
+    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("S158 - Subject Discharge Sent (Normal)")
     logging.info("[UI ASSERTIONS COMPLETE] Updated subject details checked in the UI")
 
     # And there is a "S158" letter batch for my subject with the exact title "GP Result (Normal)"
-    navigate_to_active_batch_list(page)
+    BatchListPage(page).navigate_to_active_batch_list_page()
     ActiveBatchListPage(page).is_batch_present("S158 - GP Result (Normal)")
     logging.info("[UI ASSERTIONS COMPLETE] S158 Letter batch exists")
 
@@ -357,7 +329,7 @@ def test_scenario_2(page: Page) -> None:
     logging.info("[DB ASSERTIONS COMPLETE] Updated subject details checked in the DB")
 
     # Navigate to subject summary page in UI
-    navigate_to_subject_summary_page(page, nhs_no)
+    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

utils/screening_subject_page_searcher.py

@@ -7,6 +7,7 @@
     SubjectScreeningSummaryPage,
 )
 from playwright.sync_api import Page, expect
+import logging
 
 
 def verify_subject_event_status_by_nhs_no(
@@ -233,3 +234,18 @@ def search_subject_episode_by_nhs_number(page: Page, nhs_number: str) -> None:
         SearchAreaSearchOptions.SEARCH_AREA_WHOLE_DATABASE.value
     )
     SubjectScreeningPage(page).click_search_button()
+
+
+def navigate_to_subject_summary_page(page, nhs_no: str) -> None:
+    """
+    Navigates to the subject summary page in the UI using the given NHS number.
+    This method can be used from anywhere in bcss providing the main menu link is displayed.
+
+    Args:
+        page (Page): The Playwright page object.
+        nhs_no (str): The NHS number of the subject to view.
+    """
+    BasePage(page).click_main_menu_link()
+    BasePage(page).go_to_screening_subject_search_page()
+    search_subject_by_nhs_number(page, nhs_no)
+    logging.info(f"[SUBJECT VIEW] Subject {nhs_no} loaded in UI")