Feature/bcss 21316 fobtregressiontests scenario 14 (#148)

mepr1 · adrianoaru-nhs · web-flow · commit cea68c521222 · 2025-11-17T12:03:11.000Z
## Description Adding scenario 14 from FOBTRegressionTests.  ## Context Adds a new scenario andPOM s for new pages  ## Type of changes  - [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 - [ ] 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>
diff --git a/classes/repositories/subject_repository.py b/classes/repositories/subject_repository.py
@@ -225,3 +225,58 @@ def get_matching_subject(
         except Exception:
             raise ValueError("No subject found matching the given criteria")
         return subject
+
+    def there_is_letter_batch_for_subject(
+        self,
+        nhs_no: str,
+        letter_batch_code: str,
+        letter_batch_title: str,
+        assertion: bool = True,
+    ) -> None:
+        """
+        Checks if the subject under test has a specific letter batch assosiated with them.
+        Args:
+            nhs_no (str): The subject's NHS number.
+            letter_batch_code (str): The letter batch code.
+            letter_batch_title (str): The letter batch title.
+            assertion (bool): If the subject should have this batch (True), or should not have this batch (False).
+        """
+        sql_query = """ SELECT lb.batch_id
+        FROM lett_batch_records lbr
+        INNER JOIN lett_batch lb
+        ON lb.batch_id = lbr.batch_id
+        INNER JOIN valid_values ld
+        ON ld.valid_value_id = lb.description_id
+        INNER JOIN valid_values lbs
+        ON lbs.valid_value_id = lb.status_id
+        WHERE lb.batch_state_id = 12018
+        AND lbr.screening_subject_id = :subject_id
+        AND lbs.allowed_value = :batch_code
+        AND LOWER(ld.description) = LOWER(:batch_title)
+        AND lbr.non_inclusion_id IS NULL
+        AND lbr.key_id != 11539
+        """
+
+        subject_id = self.oracle_db.get_subject_id_from_nhs_number(nhs_no)
+
+        params = {
+            "subject_id": subject_id,
+            "batch_code": letter_batch_code,
+            "batch_title": letter_batch_title,
+        }
+
+        batch_df = self.oracle_db.execute_query(sql_query, params)
+        if assertion:
+            assert (
+                not batch_df.empty
+            ), f"[DB ASSERTION FAILED] Subject {nhs_no} does not have a {letter_batch_code} - {letter_batch_title} batch when they are expected to"
+            logging.info(
+                f"[DB ASSERTION Passed] Subject {nhs_no} has a {letter_batch_code} - {letter_batch_title} batch"
+            )
+        else:
+            assert (
+                batch_df.empty
+            ), f"[DB ASSERTION FAILED] Subject {nhs_no} has a {letter_batch_code} - {letter_batch_title} batch when they are expected not to"
+            logging.info(
+                f"[DB ASSERTION Passed] Subject {nhs_no} does not have a {letter_batch_code} - {letter_batch_title} batch"
+            )
diff --git a/pages/screening_subject_search/advance_fobt_screening_episode_page.py b/pages/screening_subject_search/advance_fobt_screening_episode_page.py
@@ -114,6 +114,17 @@ def __init__(self, page: Page):
             "button",
             name="Refer Another Diagnostic Test after return from Symptomatic Referral",
         )
+        self.refer_to_survelliance_after_symptomatic_referral_button = (
+            self.page.get_by_role(
+                "button", name="Refer to Surveillance after Symptomatic Referral"
+            )
+        )
+        self.redirect_to_rerecord_the_outcome_of_symptomatic_referral_button = (
+            self.page.get_by_role(
+                "button",
+                name="Redirect to Re-record the Outcome of Symptomatic Referral",
+            )
+        )
         # Contact recording locators
         self.contact_direction_dropdown = self.page.get_by_label("Contact Direction")
         self.contact_made_between_dropdown = self.page.get_by_label(
@@ -135,6 +146,9 @@ def __init__(self, page: Page):
         self.ct_colonography_test_type_dropdown = self.page.locator(
             "#UI_EXT_TEST_TYPE_38"
         )
+        self.lnpcp_result_from_symptomatic_procedure_button = self.page.get_by_role(
+            "button", name="LNPCP Result from Symptomatic Procedure"
+        )
 
     def click_suitable_for_endoscopic_test_button(self) -> None:
         """Click the 'Suitable for Endoscopic Test' button."""
@@ -437,3 +451,19 @@ def click_refer_another_diagnostic_test_after_return_from_symptomatic_referral_b
         self.click(
             self.refer_another_diagnostic_test_after_return_from_symptomatic_referral_button
         )
+
+    def click_lnpcp_result_from_symptomatic_procedure_button(self) -> None:
+        """Click the 'LNPCP Result from Symptomatic Procedure' button."""
+        self.safe_accept_dialog(self.lnpcp_result_from_symptomatic_procedure_button)
+
+    def click_refer_to_survelliance_after_symptomatic_referral_button(
+        self,
+    ) -> None:
+        """Click the 'Refer to Surveillance after Symptomatic Referral' button."""
+        self.safe_accept_dialog(
+            self.refer_to_survelliance_after_symptomatic_referral_button
+        )
+
+    def click_redirect_to_rerecord_the_outcome_of_symptomatic_referral_button(self) -> None:
+        """Click the 'Redirect to Re-record the Outcome of Symptomatic Referral' button."""
+        self.safe_accept_dialog(self.redirect_to_rerecord_the_outcome_of_symptomatic_referral_button)
diff --git a/pages/screening_subject_search/diagnostic_test_outcome_page.py b/pages/screening_subject_search/diagnostic_test_outcome_page.py
@@ -29,6 +29,9 @@ def __init__(self, page: Page):
         self.test_outcome_dropdown = self.page.get_by_label(
             "Outcome of Diagnostic Test"
         )
+        self.reason_for_sympptomatic_referral_dropdown = self.page.get_by_label(
+            "Reason for Symptomatic Referral"
+        )
         self.save_button = self.page.get_by_role("button", name="Save")
         self.referral_procedure_dropdown = self.page.locator(
             "#UI_REFERRAL_PROCEDURE_TYPE"
@@ -56,6 +59,25 @@ def select_test_outcome_option(self, option: str) -> None:
         """
         self.test_outcome_dropdown.select_option(option)
 
+    def verify_reason_for_symptomatic_referral(self, symptomatic_reason: str) -> None:
+        """
+        Verify reason for symptomatic referral is visible.
+
+        Args:
+            symptomatic_reason(str): The accessible name or visible text of the symptomatic reason cell to verify.
+        """
+        expect(
+            self.page.get_by_role("cell", name=symptomatic_reason).nth(1)
+        ).to_be_visible()
+
+    def select_reason_for_symptomatic_referral_option(self, option: str) -> None:
+        """Select an option from the reason for symptomatic referral dropdown.
+
+        Args:
+            option (str): option (str): The option to select from the Reason For Symptomatic Referral options.
+        """
+        self.reason_for_sympptomatic_referral_dropdown.select_option(option)
+
     def click_save_button(self) -> None:
         """Click the 'Save' button."""
         self.click(self.save_button)
@@ -89,3 +111,11 @@ class OutcomeOfDiagnosticTest(StrEnum):
     REFER_SURVEILLANCE = "20365"
     INVESTIGATION_COMPLETE = "20360"
     REFER_ANOTHER_DIAGNOSTIC_TEST = "20364"
+
+
+class ReasonForSymptomaticReferral(StrEnum):
+    """Enum for Symptomatic Referral reason options."""
+
+    POLYP_EXCISION = "203011"
+    CORRECTIVE_SURGERY = "203012"
+    SUSPECTED_CANCER_SURGERY = "203013"
diff --git a/pages/screening_subject_search/lnpcp_result_from_symptomatic_procedure_page.py b/pages/screening_subject_search/lnpcp_result_from_symptomatic_procedure_page.py
@@ -0,0 +1,12 @@
+from playwright.sync_api import Page
+from pages.screening_subject_search.result_from_symptomatic_procedure_page import (
+    ResultFromSymptomaticProcedurePage,
+)
+
+
+class LnpcpResultFromSymptomaticProcedure(ResultFromSymptomaticProcedurePage):
+    """LNPCP specific implementation of Result from Symptomatic Procedure Page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
diff --git a/pages/screening_subject_search/non_neoplastic_result_from_symptomatic_procedure_page.py b/pages/screening_subject_search/non_neoplastic_result_from_symptomatic_procedure_page.py
@@ -1,54 +1,14 @@
-from datetime import datetime
 from playwright.sync_api import Page
-from pages.base_page import BasePage
-from utils.calendar_picker import CalendarPicker
+from pages.screening_subject_search.result_from_symptomatic_procedure_page import (
+    ResultFromSymptomaticProcedurePage,
+)
 
 
-class NonNeoplasticResultFromSymptomaticProcedurePage(BasePage):
-    """Non Neoplastic Result From Symptomatic Procedure Page locators, and methods for interacting with the page."""
+class NonNeoplasticResultFromSymptomaticProcedurePage(
+    ResultFromSymptomaticProcedurePage
+):
+    """Non-Neoplastic specific implementation of Result from Symptomatic Procedure Page."""
 
     def __init__(self, page: Page):
         super().__init__(page)
-        # Non Neoplastic Result From Symptomatic Procedure - page locators
-        self.date_of_symptomatic_procedure_calendar_button = self.page.locator(
-            "#UI_SURGERY_DATE__LinkOrButton"
-        )
-        self.alert_textbox = self.page.locator("#UI_SPAN_RECALL_TEXT")
-        self.all_tests = self.page.locator("#UI_ID_RECALL_ANCHOR_DATE_EXT_TEST_ID")
-        self.save_button = self.page.get_by_role("button", name="Save")
-
-    def click_date_of_symptomatic_procedure_calendar_button(self) -> None:
-        """Click the date of symptomatic procedure calendar button."""
-        self.click(self.date_of_symptomatic_procedure_calendar_button)
-
-    def enter_date_of_symptomatic_procedure(self, date: datetime) -> None:
-        """
-        Enter the date of the symptomatic procedure.
-        Args:
-            date (datetime): The date to be entered in the date of symptomatic procedure field. Example: datetime(2023, 10, 25)
-        """
-        self.click_date_of_symptomatic_procedure_calendar_button()
-        CalendarPicker(self.page).v1_calender_picker(date)
-
-    def assert_text_in_alert_textbox(self, expected_text: str) -> None:
-        """
-        Assert that the expected text is present in the alert textbox.
-        Args:
-            expected_text (str): The text expected to be found in the alert textbox. Example: "This is a test alert"
-        """
-        actual_text = self.alert_textbox.inner_text()
-        assert (
-            expected_text in actual_text
-        ), f"Expected text '{expected_text}' not found in alert textbox. Actual text: '{actual_text}'"
-
-    def select_test_number(self, test_number: int) -> None:
-        """
-        Select a test from the all tests dropdown by its index.
-        Args:
-            test_number (int): The index of the test to select (1-based index). Example: if you want to select the 1st test pass in 1
-        """
-        self.click(self.all_tests.nth(test_number - 1))
-
-    def click_save_button(self) -> None:
-        """Click the 'Save' button."""
-        self.click(self.save_button)
+        self.page = page
diff --git a/pages/screening_subject_search/refer_to_mdt_page.py b/pages/screening_subject_search/refer_to_mdt_page.py
@@ -0,0 +1,48 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from datetime import datetime
+from utils.calendar_picker import CalendarPicker
+
+
+class ReferToMDTPage(BasePage):
+    """Refer to MDT Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+
+        # Refer MDT page - page locators
+        self.mdt_discussion_date_field = self.page.locator("#UI_MDT_DATE_LinkOrButton")
+        self.mdt_location = self.page.locator("#UI_NS_SITE_SELECT_LINK")
+        self.visible_ui_results_string = 'select[id^="UI_RESULTS_"]:visible'
+        self.record_MDT_appointment_button = self.page.locator(
+            '[name="UI_BUTTON_SAVE"]'
+        )
+
+    def enter_date_in_Mdt_discussion_date_field(self, date: datetime) -> None:
+        """
+        Enters a date in the MDT discussion date field.
+        Args:
+            date (datetime): The date to enter in the field.
+        """
+        self.click(self.mdt_discussion_date_field)
+        CalendarPicker(self.page).v2_calendar_picker(date)
+        self.mdt_discussion_date_field.press("Tab")
+
+    def select_mdt_location_lookup(self, option: int) -> None:
+        """
+        This method is designed to select an option from the MDT location lookup dropdown.
+        Args:
+            option (int): The index of the option to select (0-based).
+        """
+        self.click(self.mdt_location)
+        select_locator = self.page.locator(self.visible_ui_results_string)
+        select_locator.first.wait_for(state="visible")
+        # Find all option elements inside the select and click the one at the given index
+        option_elements = select_locator.first.locator("option")
+        option_elements.nth(option).wait_for(state="visible")
+        self.click(option_elements.nth(option))
+
+    def click_record_MDT_appointment_button(self) -> None:
+        """Clicks the record MDT appointment button."""
+        self.click(self.record_MDT_appointment_button)
diff --git a/pages/screening_subject_search/result_from_symptomatic_procedure_page.py b/pages/screening_subject_search/result_from_symptomatic_procedure_page.py
@@ -0,0 +1,57 @@
+from datetime import datetime
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from utils.calendar_picker import CalendarPicker
+
+
+class ResultFromSymptomaticProcedurePage(BasePage):
+    """Base class for Result from Symptomatic Procedure pages with common locators and methods."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        # Result from Symptomatic Procedure Page - page locators
+        self.date_of_symptomatic_procedure_calendar_button = self.page.locator(
+            "#UI_SURGERY_DATE__LinkOrButton"
+        )
+        self.alert_textbox = self.page.locator("#UI_SPAN_RECALL_TEXT")
+        self.all_tests = self.page.locator(
+            "[id^='UI_ID_RECALL_ANCHOR_DATE_EXT_TEST_ID']"
+        )
+        self.save_button = self.page.get_by_role("button", name="Save")
+
+    def click_date_of_symptomatic_procedure_calendar_button(self) -> None:
+        """Click the date of symptomatic procedure calendar button."""
+        self.click(self.date_of_symptomatic_procedure_calendar_button)
+
+    def enter_date_of_symptomatic_procedure(self, date: datetime) -> None:
+        """
+        Enter the date of the symptomatic procedure.
+        Args:
+            date (datetime): The date to be entered in the date of symptomatic procedure field. Example: datetime(2023, 10, 25)
+        """
+        self.click_date_of_symptomatic_procedure_calendar_button()
+        CalendarPicker(self.page).v1_calender_picker(date)
+
+    def assert_text_in_alert_textbox(self, expected_text: str) -> None:
+        """
+        Assert that the expected text is present in the alert textbox.
+        Args:
+            expected_text (str): The text expected to be found in the alert textbox. Example: "This is a test alert"
+        """
+        actual_text = self.alert_textbox.inner_text()
+        assert (
+            expected_text in actual_text
+        ), f"Expected text '{expected_text}' not found in alert textbox. Actual text: '{actual_text}'"
+
+    def select_test_number(self, test_number: int) -> None:
+        """
+        Select a test from the all tests dropdown by its index.
+        Args:
+            test_number (int): The index of the test to select (1-based index). Example: if you want to select the 1st test pass in 1
+        """
+        self.click(self.all_tests.nth(test_number - 1))
+
+    def click_save_button(self) -> None:
+        """Click the 'Save' button."""
+        self.click(self.save_button)
diff --git a/pages/screening_subject_search/subject_screening_summary_page.py b/pages/screening_subject_search/subject_screening_summary_page.py
@@ -446,6 +446,10 @@ def change_screening_status(self, status_option: str, reason_option: str) -> Non
         self.click_update_subject_data()
         self.page.wait_for_timeout(1000)
 
+    def assert_reopen_episode_button_not_visible(self) -> None:
+        """Assert that the 'Reopen FOBT Screening Episode' button is not visible"""
+        expect(self.reopen_fobt_screening_episode_button).not_to_be_visible()
+
 
 class ChangeScreeningStatusOptions(StrEnum):
     """Enum for Change Screening Status options."""
diff --git a/tests/regression/regression_tests/fobt_regression_tests/test_scenario_12.py b/tests/regression/regression_tests/fobt_regression_tests/test_scenario_12.py
@@ -57,9 +57,7 @@
     YesNoOptions,
     EndoscopyLocationOptions,
 )
-from pages.screening_subject_search.non_neoplastic_result_from_symptomatic_procedure_page import (
-    NonNeoplasticResultFromSymptomaticProcedurePage,
-)
+from pages.screening_subject_search.non_neoplastic_result_from_symptomatic_procedure_page import (NonNeoplasticResultFromSymptomaticProcedurePage)
 from utils.subject_demographics import SubjectDemographicUtil
 from pages.screening_subject_search.reopen_fobt_screening_episode_page import (
     ReopenFOBTScreeningEpisodePage,
diff --git a/tests/regression/regression_tests/fobt_regression_tests/test_scenario_14.py b/tests/regression/regression_tests/fobt_regression_tests/test_scenario_14.py
diff --git a/utils/appointments.py b/utils/appointments.py
diff --git a/utils/investigation_dataset.py b/utils/investigation_dataset.py
diff --git a/utils/oracle/subject_selection_query_builder.py b/utils/oracle/subject_selection_query_builder.py
