Merge branch 'main' of github.com:NHSDigital/bcss-playwright into feature/BCSS-21494-subject-criteria-ui-application

Author: adrianoaru-nhs

pages/base_page.py

@@ -256,7 +256,7 @@ def assert_dialog_text(self, expected_text: str, accept: bool = False) -> None:
         If no dialog appears, logs an error.
         Args:
             expected_text (str): The text that should be present in the dialog.
-            accept (bool): Set to True if you want to accept the dialog, by deafult is is set to False.
+            accept (bool): Set to True if you want to accept the dialog, by default is is set to False.
         """
         self._dialog_assertion_error = None
 
@@ -265,7 +265,7 @@ def handle_dialog(dialog: Dialog, accept: bool = False):
             Handles the dialog and asserts that the dialog contains the expected text.
             Args:
                 dialog (Dialog): the playwright dialog object
-                accept (bool): Set to True if you want to accept the dialog, by deafult is is set to False.
+                accept (bool): Set to True if you want to accept the dialog, by default is is set to False.
             """
             logging.info(f"Dialog appeared with message: {dialog.message}")
             actual_text = dialog.message

pages/screening_practitioner_appointments/appointment_detail_page.py

@@ -15,7 +15,7 @@ def __init__(self, page: Page):
         self.calendar_button = self.page.get_by_role("button", name="Calendar")
         self.save_button = self.page.get_by_role("button", name="Save")
         self.cancel_radio = self.page.get_by_role("radio", name="Cancel")
-        self.reason_for_cancellation_dropwdown = self.page.get_by_label(
+        self.reason_for_cancellation_dropdown = self.page.get_by_label(
             "Reason for Cancellation"
         )
 
@@ -84,7 +84,7 @@ def select_reason_for_cancellation_option(self, option: str) -> None:
             option: The reason for cancellation to select.
             The options are in the ReasonForCancellationOptions class
         """
-        self.reason_for_cancellation_dropwdown.select_option(value=option)
+        self.reason_for_cancellation_dropdown.select_option(value=option)
 
 
 class ReasonForCancellationOptions(StrEnum):

pages/screening_subject_search/close_fobt_screening_episode_page.py

@@ -0,0 +1,34 @@
+from pages.base_page import BasePage
+from playwright.sync_api import Page
+
+
+class CloseFobtScreeningEpisodePage(BasePage):
+    """Close FOBT Screening Episode Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        self.close_fobt_screening_episode_button = self.page.get_by_role(
+            "button", name="Close FOBT Screening Episode"
+        )
+        self.reason_dropdown = self.page.locator("#CLOSE_REASON")
+        self.notes_textarea = self.page.locator("#UI_NOTES_TEXT")
+        self.final_close_button = self.page.locator("#UI_BUTTON_CLOSE")
+
+    def close_fobt_screening_episode(self, reason_text: str) -> None:
+        """
+        Complete the process of closing a FOBT screening episode.
+        Args:
+            reason_text (str): The visible text of the reason to select from the dropdown.
+        """
+        # Step 1: Trigger the dialog and accept it
+        self.safe_accept_dialog(self.close_fobt_screening_episode_button)
+
+        # Step 2: Select reason from dropdown
+        self.reason_dropdown.select_option(label=reason_text)
+
+        # Step 3: Enter note
+        self.notes_textarea.fill("automation test note")
+
+        # Step 4: Click final 'Close Episode' button
+        self.safe_accept_dialog(self.final_close_button)

pages/screening_subject_search/record_diagnosis_date_page.py

@@ -10,8 +10,10 @@ class RecordDiagnosisDatePage(BasePage):
     def __init__(self, page: Page):
         super().__init__(page)
         self.page = page
+
         # Record Diagnosis Date - page locators
         self.diagnosis_date_field = self.page.locator("#diagnosisDate")
+        self.reason_dropdown = self.page.locator("#reason")
         self.save_button = self.page.get_by_role("button", name="Save")
 
     def enter_date_in_diagnosis_date_field(self, date: datetime) -> None:
@@ -41,3 +43,22 @@ def get_alert_message(self) -> str:
             return self.alert_message.inner_text()
         else:
             return ""
+
+    def record_diagnosis_reason(self, reason_text: str) -> None:
+        """
+        Selects a diagnosis reason from the dropdown and saves the form.
+
+        Args:
+            reason_text (str): The visible text of the reason to select.
+                Valid options include:
+                - "Patient declined all appointments"
+                - "2 DNAs of colonoscopy assessment appt"
+                - "Patient emigrated"
+                - "Patient deceased"
+                - "Patient choice"
+                - "Patient could not be contacted"
+                - "Reopened old episode, date unknown"
+                - "Other"
+        """
+        self.reason_dropdown.select_option(label=reason_text)
+        self.safe_accept_dialog(self.save_button)

pages/screening_subject_search/subject_screening_summary_page.py

@@ -44,7 +44,7 @@ def __init__(self, page: Page):
         self.update_subject_data = self.page.get_by_role(
             "button", name="Update Subject Data"
         )
-        self.close_fobt_screening_episode = self.page.get_by_role(
+        self.close_fobt_screening_episode_button = self.page.get_by_role(
             "button", name="Close FOBT Screening Episode"
         )
         self.a_page_to_advance_the_episode = self.page.get_by_text(
@@ -86,6 +86,9 @@ def __init__(self, page: Page):
         self.reopen_fobt_screening_episode_button = self.page.get_by_role(
             "button", name="Reopen FOBT Screening Episode"
         )
+        self.reopen_for_correction_button = self.page.get_by_role(
+            "button", name="Reopen episode for correction"
+        )
 
     def wait_for_page_title(self) -> None:
         """Waits for the page to be the Subject Screening Summary"""
@@ -189,7 +192,7 @@ def click_update_subject_data(self) -> None:
 
     def click_close_fobt_screening_episode(self) -> None:
         """Click on the 'Close FOBT Screening Episode' button."""
-        self.click(self.close_fobt_screening_episode)
+        self.click(self.close_fobt_screening_episode_button)
 
     def go_to_a_page_to_advance_the_episode(self) -> None:
         """Click on the link to go to a page to advance the episode."""
@@ -365,6 +368,7 @@ def assert_subject_age(self, expected_age: int) -> None:
         assert (
             actual_age == expected_age
         ), f"[AGE MISMATCH] Expected age {expected_age}, but found {actual_age} in UI."
+        logging.info("[UI ASSERTIONS COMPLETE] Subject age checked in the UI")
 
     def assert_screening_status(self, expected_status: str) -> None:
         """
@@ -380,6 +384,9 @@ def assert_screening_status(self, expected_status: str) -> None:
         assert (
             actual_status.lower() == expected_status.lower()
         ), f"[SCREENING STATUS MISMATCH] Expected '{expected_status}', but found '{actual_status}' in UI."
+        logging.info(
+            "[UI ASSERTIONS COMPLETE] Subject screening status checked in the UI"
+        )
 
     def assert_latest_event_status(self, expected_status: str) -> None:
         """
@@ -395,11 +402,26 @@ def assert_latest_event_status(self, expected_status: str) -> None:
         assert (
             actual_status == expected_status
         ), f"[LATEST EVENT STATUS MISMATCH] Expected '{expected_status}', but found '{actual_status}' in UI."
+        logging.info(
+            "[UI ASSERTIONS COMPLETE] Subject latest event status checked in the UI"
+        )
 
     def click_reopen_fobt_screening_episode_button(self) -> None:
         """Click on the 'Reopen FOBT Screening Episode' button"""
         self.click(self.reopen_fobt_screening_episode_button)
 
+    def reopen_fobt_screening_episode(self) -> None:
+        """
+        Reopen a previously closed FOBT screening episode, including confirmation modal.
+        - Clicks the 'Reopen FOBT Screening Episode' button
+        - Then safely accepts the dialog triggered by 'Reopen episode for correction'
+        """
+        # Step 1: Click the initial 'Reopen FOBT Screening Episode' button
+        self.click_reopen_fobt_screening_episode_button()
+
+        # Step 2: Safely accept the confirmation dialog triggered by the correction button
+        self.safe_accept_dialog(self.reopen_for_correction_button)
+
 
 class ChangeScreeningStatusOptions(Enum):
     """Enum for Change Screening Status options."""

tests/regression/regression_tests/fobt_regression_tests/test_scenario_2.py

@@ -2,7 +2,6 @@
 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
@@ -13,7 +12,6 @@
 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
 
 
@@ -79,7 +77,6 @@ def test_scenario_2(page: Page) -> None:
     # 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)
@@ -103,7 +100,6 @@ def test_scenario_2(page: Page) -> None:
 
     # 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)
@@ -170,7 +166,6 @@ def test_scenario_2(page: Page) -> None:
     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")
@@ -188,7 +183,6 @@ def test_scenario_2(page: Page) -> None:
 
     # 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