Feature/bcss 21304 selenium0to playwright fobtregressiontests scenario 2 (#127)

Andyg79 · adrianoaru-nhs · web-flow · commit c8e4c61a87e5 · 2025-09-05T16:15:13.000+01:00
## Description  ## Context This covers the migration of the fobt regression tests scenario 2  ## Type of changes This is part of the selenium to playwright migration work  - [x] Refactoring (non-breaking change) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would change existing functionality) - [ ] Bug fix (non-breaking change which fixes an issue) ## Checklist  - [x] I am familiar with the [contributing guidelines](https://github.com/nhs-england-tools/playwright-python-blueprint/blob/main/CONTRIBUTING.md) - [x] I have followed the code style of the project - [x] I have added tests to cover my changes (where appropriate) - [x] I have updated the documentation accordingly - [x] This PR is a result of pair or mob programming --- ## Sensitive Information Declaration To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including [PII (Personal Identifiable Information) / PID (Personal Identifiable Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter. - [x] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes. --------- Co-authored-by: Adriano Aru <adriano.aru1@nhs.net> Co-authored-by: adrianoaru-nhs <194267545+adrianoaru-nhs@users.noreply.github.com>
diff --git a/pages/communication_production/batch_list_page.py b/pages/communication_production/batch_list_page.py
@@ -1,6 +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 utils.calendar_picker import CalendarPicker
 from utils.table_util import TableUtils
 import logging
@@ -204,6 +207,14 @@ 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).
+        """
+        self.click_main_menu_link()
+        self.go_to_communications_production_page()
+        CommunicationsProductionPage(self.page).go_to_active_batch_list_page()
+
 
 class ActiveBatchListPage(BatchListPage):
     """Active Batch List Page-specific methods."""
@@ -216,7 +227,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
         )
diff --git a/pages/screening_subject_search/subject_screening_summary_page.py b/pages/screening_subject_search/subject_screening_summary_page.py
@@ -81,8 +81,8 @@ def __init__(self, page: Page):
             "td.epihdr_label:text('Screening Status') + td.epihdr_data"
         )
         self.latest_event_status_cell = self.page.locator(
-            "table#subjectSummaryTable tr:has(td:text('Latest Event Status')) td.epihdr_data"
-        ).nth(0)
+            "td.epihdr_label:text('Latest Event Status') + td.epihdr_data"
+        )
 
     def wait_for_page_title(self) -> None:
         """Waits for the page to be the Subject Screening Summary"""
diff --git a/tests/regression/regression_tests/fobt_regression_tests/test_scenario_2.py b/tests/regression/regression_tests/fobt_regression_tests/test_scenario_2.py
@@ -0,0 +1,254 @@
+import pytest
+import logging
+from datetime import datetime
+from playwright.sync_api import Page
+from pages.communication_production.batch_list_page import ActiveBatchListPage
+from utils.oracle.subject_creation_util import CreateSubjectSteps
+from utils.user_tools import UserTools
+from utils.subject_assertion import subject_assertion
+from utils.call_and_recall_utils import CallAndRecallUtils
+from utils import screening_subject_page_searcher
+from utils.batch_processing import batch_processing
+from utils.fit_kit import FitKitLogged, FitKitGeneration
+from pages.screening_subject_search.subject_screening_summary_page import (
+    SubjectScreeningSummaryPage,
+)
+from pages.communication_production.batch_list_page import BatchListPage
+from pages.logout.log_out_page import LogoutPage
+
+
+@pytest.mark.vpn_required
+@pytest.mark.regression
+@pytest.mark.fobt_regression_tests
+def test_scenario_2(page: Page) -> None:
+    """
+    Scenario: 2: Normal kit reading
+
+    S1-S9-S10-S43-S2-S158-S159-C203 [SSCL4a]
+
+    This scenario tests the basic scenario where a subject returns their initial test kit which gives a normal result.
+
+    Scenario summary:
+    > Create a new subject in the FOBT age range > Inactive
+    > Run the FOBT failsafe trawl > Call
+    > Run the database transition to invite them for FOBT screening > S1(1.1)
+    > Process S1 letter batch > S9 (1.1)
+    > Run timed events > creates S9 letter (1.1)
+    > Process S9 letter batch > S10 (1.1)
+    > Log kit > S43 (1.2)
+    > Read kit with NORMAL result > S2 (1.3)
+    > Process S2 letter batch > S158 (1.3)
+    > Process S158 letter batch > S159 (1.3) > C203 (1.13)
+    > Check recall [SSCL4a]
+    """
+    summary_page = SubjectScreeningSummaryPage(page)
+    logging.info("[TEST START] Regression - fobt normal kit reading")
+
+    # Given I log in to BCSS "England" as user role "Hub Manager"
+    user_role = UserTools.user_login(
+        page, "Hub Manager State Registered at BCS01", return_role_type=True
+    )
+    if user_role is None:
+        raise ValueError("User cannot be assigned to a UserRoleType")
+
+    # And I create a subject that meets the following criteria:
+    requirements = {
+        "age (y/d)": "66/130",
+        "active gp practice in hub/sc": "BCS01/BCS001",
+    }
+    nhs_no = CreateSubjectSteps().create_custom_subject(requirements, user_role)
+    if nhs_no is None:
+        pytest.fail("Failed to create subject: NHS number not returned.")
+
+    # Then Comment: NHS number
+    logging.info(f"[SUBJECT CREATED] Created subject's NHS number: {nhs_no}")
+
+    # And my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "subject age": "66",
+            "subject has episodes": "No",
+            "screening status": "Inactive",
+        },
+    )
+
+    # Navigate to subject summary page in UI
+    screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
+
+    # Assert subject details in the UI
+    summary_page.assert_subject_age(66)
+    summary_page.assert_screening_status("Inactive")
+    logging.info("[UI ASSERTIONS COMPLETE] Updated subject details checked in the UI")
+
+    # When I run the FOBT failsafe trawl for my subject
+    CallAndRecallUtils().run_failsafe(nhs_no)
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "subject has episodes": "No",
+            "Screening Due Date": "Last Birthday",
+            "Screening due date date of change": "Today",
+            "Screening Due Date Reason": "Failsafe Trawl",
+            "screening status": "Call",
+            "Screening Status Date of Change": "Today",
+            "Screening Status Reason": "Failsafe Trawl",
+        },
+    )
+
+    # Navigate to subject summary page in UI
+    screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
+
+    # Assert subject details in the UI
+    summary_page.assert_screening_status("Call")
+    logging.info("[UI ASSERTIONS COMPLETE] Updated subject details checked in the UI")
+
+    # When I invite my subject for FOBT screening
+    CallAndRecallUtils().invite_subject_for_fobt_screening(nhs_no, user_role)
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "latest event status": "S1 Selected for Screening",
+            "latest episode kit class": "FIT",
+            "latest episode type": "FOBT",
+        },
+    )
+
+    # Then there is a "S1" letter batch for my subject with the exact title "Pre-invitation (FIT)"
+    # When I process the open "S1" letter batch for my subject
+    # Then there is a "S9" letter batch for my subject with the exact title "Invitation & Test Kit (FIT)"
+    batch_processing(
+        page, "S1", "Pre-invitation (FIT)", "S9 - Pre-invitation Sent", True
+    )
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "latest event status": "S9 - Pre-invitation Sent",
+        },
+    )
+
+    # When I process the open "S9" letter batch for my subject
+    batch_processing(
+        page,
+        "S9",
+        "Invitation & Test Kit (FIT)",
+        "S10 - Invitation & Test Kit Sent",
+        True,
+    )
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "latest event status": "S10 - Invitation & Test Kit Sent",
+        },
+    )
+
+    # When I log my subject's latest unlogged FIT kit
+    fit_kit = FitKitGeneration().get_fit_kit_for_subject_sql(nhs_no, False, False)
+    sample_date = datetime.now()
+    FitKitLogged().log_fit_kits(page, fit_kit, sample_date)
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "latest event status": "S43 Kit Returned and Logged (Initial Test)",
+        },
+    )
+
+    # Navigate to subject summary page in UI
+    screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
+
+    # Assert subject details in the UI
+    summary_page.assert_latest_event_status(
+        "S43 - Kit Returned and Logged (Initial Test)"
+    )
+    logging.info("[UI ASSERTIONS COMPLETE] Updated subject details checked in the UI")
+
+    # When I read my subject's latest logged FIT kit as "NORMAL"
+    FitKitLogged().read_latest_logged_kit(user_role, 2, fit_kit, "NORMAL")
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "latest event status": "S2 Normal",
+        },
+    )
+
+    # Navigate to subject summary page in UI
+    screening_subject_page_searcher.navigate_to_subject_summary_page(page, nhs_no)
+
+    # 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)"
+    # When I process the open "S2" letter batch for my subject
+    batch_processing(
+        page,
+        "S2",
+        "Subject Result (Normal)",
+        "S158 - Subject Discharge Sent (Normal)",
+        True,
+    )
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "latest event status": "S158 Subject Discharge Sent (Normal)",
+        },
+    )
+
+    # And there is a "S158" letter batch for my subject with the exact title "GP Result (Normal)"
+    # When I process the open "S158" letter batch for my subject
+    batch_processing(
+        page,
+        "S158",
+        "GP Result (Normal)",
+        "S159 - GP Discharge Sent (Normal)",
+        True,
+    )
+
+    # Then my subject has been updated as follows:
+    subject_assertion(
+        nhs_no,
+        {
+            "calculated screening due date": "2 years from latest S158 event",
+            "calculated lynch due date": "Null",
+            "calculated surveillance due date": "Null",
+            "ceased confirmation date": "Null",
+            "ceased confirmation details": "Null",
+            "ceased confirmation user ID": "Null",
+            "clinical reason for cease": "Null",
+            "latest episode accumulated result": "Definitive normal FOBt outcome",
+            "latest episode recall calculation method": "Date of last patient letter",
+            "latest episode recall episode type": "FOBT screening",
+            "latest episode recall surveillance type": "Null",
+            "latest episode status": "Closed",
+            "latest episode status reason": "Episode Complete",
+            "lynch due date": "Null",
+            "lynch due date date of change": "Null",
+            "lynch due date reason": "Null",
+            "screening status": "Recall",
+            # 'Screening status date of change' intentionally omitted as status may or may not have changed
+            "screening status reason": "Recall",
+            "screening due date": "Calculated screening due date",
+            "screening due date date of change": "Today",
+            "screening due date reason": "Recall",
+            "surveillance due date": "Null",
+            "surveillance due date date of change": "Unchanged",
+            "surveillance due date reason": "Unchanged",
+        },
+    )
+
+    logging.info("[TEST COMPLETE] Scenario 2 passed all assertions")
+    LogoutPage(page).log_out()
diff --git a/utils/batch_processing.py b/utils/batch_processing.py
@@ -31,7 +31,8 @@ def batch_processing(
     save_csv_as_df: bool = False,
 ) -> Optional[pd.DataFrame]:
     """
-    This is used to process batches.
+    Processes a batch in the BCSS UI by navigating to the batch, extracting subject NHS numbers (from the database or PDF),
+    verifying each subject's event status in the UI, and optionally running timed events or returning batch data as a DataFrame.
 
     Args:
         page (Page): This is the playwright page object
diff --git a/utils/call_and_recall_utils.py b/utils/call_and_recall_utils.py
@@ -55,7 +55,7 @@ def run_failsafe(self, nhs_no: str) -> None:
         result_cursor.close()
         cur.close()
         conn.close()
-        logging.info(f"END: failsafe stored proc executed for {nhs_no}")
+        logging.info(f"[FAILSAFE TRAWL RUN] FOBT failsafe trawl run for subject {nhs_no}")
 
     def invite_subject_for_fobt_screening(
         self, nhs_no: str, user_role: UserRoleType
diff --git a/utils/screening_subject_page_searcher.py b/utils/screening_subject_page_searcher.py
@@ -240,3 +240,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")
diff --git a/utils/subject_assertion.py b/utils/subject_assertion.py
@@ -7,7 +7,7 @@
 
 def subject_assertion(nhs_number: str, criteria: dict) -> None:
     """
-    Asserts that a subject with the given NHS number exists and matches the provided criteria.
+    Asserts that a subject with the given NHS number exists in the database and matches the provided criteria.
     Args:
         nhs_number (str): The NHS number of the subject to find.
         criteria (dict): A dictionary of criteria to match against the subject's attributes.
