Completing scenario 18 (#154)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description

<!-- Describe your changes in detail. -->
Migrating scenario 18 of FOBTRegressionTests into playwright

## Context

<!-- Why is this change required? What problem does it solve? -->
Migrating scenario 18 of FOBTRegressionTests into playwright

## Type of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->

- [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

<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->

- [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.

Author: adrianoaru-nhs

pages/screening_subject_search/advance_fobt_screening_episode_page.py

@@ -37,6 +37,9 @@ def __init__(self, page: Page):
         self.invite_for_diagnostic_test_button = self.page.get_by_role(
             "button", name="Invite for Diagnostic Test >>"
         )
+        self.cancer_result_refer_mdt_button = self.page.get_by_role(
+            "button", name="Cancer Result, Refer MDT >>"
+        )
         self.attend_diagnostic_test_button = self.page.get_by_role(
             "button", name="Attend Diagnostic Test"
         )
@@ -136,6 +139,10 @@ def __init__(self, page: Page):
                 "button", name="Redirect to Establish Attendance at Appointment"
             )
         )
+        self.date_of_symptomatic_procedure_input = self.page.get_by_role(
+            "textbox", name="Date of Symptomatic Procedure"
+        )
+
         # Contact recording locators
         self.contact_direction_dropdown = self.page.get_by_label("Contact Direction")
         self.contact_made_between_dropdown = self.page.get_by_label(
@@ -150,6 +157,7 @@ def __init__(self, page: Page):
         self.patient_contacted_dropdown = self.page.get_by_label("Patient Contacted")
         self.outcome_dropdown = self.page.get_by_label("Outcome")
         self.save_button = self.page.locator("input[name='UI_BUTTON_SAVE']")
+
         # CT Colonography invitation locators
         self.ct_colonography_appointment_date_input = self.page.locator(
             "#UI_APPT_DATE_38"
@@ -177,6 +185,10 @@ def click_invite_for_diagnostic_test_button(self) -> None:
         """Click the 'Invite for Diagnostic Test' button."""
         self.safe_accept_dialog(self.invite_for_diagnostic_test_button)
 
+    def click_cancer_result_refer_mdt_button(self) -> None:
+        """Click the 'Cancer Result, Refer MDT >>' button."""
+        self.safe_accept_dialog(self.cancer_result_refer_mdt_button)
+
     def click_attend_diagnostic_test_button(self) -> None:
         """Click the 'Attend Diagnostic Test' button."""
         self.click(self.attend_diagnostic_test_button)
@@ -498,3 +510,13 @@ def click_redirect_to_establish_attendance_at_appointment_button(
         self.safe_accept_dialog(
             self.redirect_to_establish_attendance_at_appointment_button
         )
+
+    def enter_date_of_symptomatic_procedure(self, date: datetime) -> None:
+        """
+        Enter a date of symptomatic procedure.
+        Args:
+            date (datetime): The date to enter
+        """
+        CalendarPicker(self.page).calendar_picker_ddmmyyyy(
+            date, self.date_of_symptomatic_procedure_input
+        )

pages/screening_subject_search/close_fobt_screening_episode_page.py

@@ -32,3 +32,5 @@ def close_fobt_screening_episode(self, reason_text: str) -> None:
 
         # Step 4: Click final 'Close Episode' button
         self.safe_accept_dialog(self.final_close_button)
+
+        self.page.wait_for_timeout(500)  # Timeout to allow subject to be updated on DB.

pages/screening_subject_search/confirm_the_manual_sending_of_a_disclaimer_letter_page.py

@@ -0,0 +1,17 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+
+
+class ConfirmTheManualSendingOfADisclaimerLetterPage(BasePage):
+    """Confirm The Manual Sending Of A Disclaimer Letter Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+
+        # Confirm The Manual Sending Of A Disclaimer Letter - page locators
+        self.confirm_button = self.page.get_by_role("button", name="Confirm")
+
+    def click_confirm_button(self) -> None:
+        """Click the 'Confirm' button."""
+        self.click(self.confirm_button)

pages/screening_subject_search/handover_into_symptomatic_care_page.py

@@ -1,5 +1,7 @@
 from playwright.sync_api import Page
 from pages.base_page import BasePage
+from datetime import datetime
+from utils.calendar_picker import CalendarPicker
 
 
 class HandoverIntoSymptomaticCarePage(BasePage):
@@ -18,6 +20,8 @@ def __init__(self, page: Page):
         self.cease_from_program_dropdown = self.page.locator(
             "#UI_CEASE_FROM_PROGRAM_ID"
         )
+        self.mdt_date_field = self.page.locator("#UI_MDT_DATE")
+        self.site_dropdown = self.page.locator("#UI_NS_SITE_SELECT_LINK")
 
     def select_referral_dropdown_option(self, value: str) -> None:
         """
@@ -75,3 +79,42 @@ def select_cease_from_program(self, cease: bool) -> None:
         """
         value = "Yes" if cease else "No"
         self.cease_from_program_dropdown.select_option(value)
+
+    def enter_mdt_date(self, date: datetime) -> None:
+        """
+        Enters a date into the 'MDT Date' field
+        Args:
+            date (datetime): The date to enter.
+        """
+        CalendarPicker(self.page).calendar_picker_ddmmyyyy(date, self.mdt_date_field)
+
+    def select_site_dropdown_option_index(self, index: int) -> None:
+        """
+        Select a given option from the site dropdown.
+
+        Args:
+            value (str): The value of the option you want to select
+        """
+        self.click(self.site_dropdown)
+        select_locator = self.page.locator('select[id^="UI_RESULTS_"]:visible')
+        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(index).wait_for(state="visible")
+        self.click(option_elements.nth(index))
+
+    def fill_with_cancer_details(self) -> None:
+        """
+        Complete the Handover into Symptomatic Care form with the cancer details scenario:
+            MDT Date: Today
+            Site: Last option
+            Screening Practitioner: 1st option
+            Note: Handover notes for Cancer scenario
+        """
+        self.enter_mdt_date(datetime.today())
+        self.select_site_dropdown_option_index(-1)
+        self.select_practitioner_from_index(1)
+        self.fill_notes("Handover notes for Cancer scenario")
+        self.click_save_button()
+        self.page.wait_for_timeout(500)  # Timeout to allow subject to update in the DB.

pages/screening_subject_search/record_informed_dissent_page.py

@@ -0,0 +1,41 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from datetime import datetime
+from utils.calendar_picker import CalendarPicker
+
+
+class RecordInformedDissentPage(BasePage):
+    """Record Informed Dissent Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+
+        # Record informed Dissent - page locators
+        self.notes_field = self.page.locator("#UI_NOTES_TEXT")
+        self.date_confimed_input = self.page.locator("#UI_CEASING_CONFIRM_DATE")
+        self.confirm_cease_button = self.page.get_by_role(
+            "button", name="Confirm Cease"
+        )
+
+    def fill_notes_field(self, note: str) -> None:
+        """
+        Fill the notes field.
+        Args:
+            note (str): The note to add.
+        """
+        self.notes_field.fill(note)
+
+    def enter_date_confirmed(self, date: datetime) -> None:
+        """
+        Enter date confirmed
+        Args:
+            date (datetime): The date to enter
+        """
+        CalendarPicker(self.page).calendar_picker_ddmmyyyy(
+            date, self.date_confimed_input
+        )
+
+    def click_confirm_cease_button(self) -> None:
+        """Click the 'Confirm Cease' button."""
+        self.safe_accept_dialog(self.confirm_cease_button)

pages/screening_subject_search/record_request_to_cease_page.py

@@ -0,0 +1,152 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from enum import Enum
+from utils.calendar_picker import CalendarPicker
+from datetime import datetime
+from pages.screening_subject_search.subject_screening_summary_page import (
+    SubjectScreeningSummaryPage,
+)
+from pages.screening_subject_search.confirm_the_manual_sending_of_a_disclaimer_letter_page import (
+    ConfirmTheManualSendingOfADisclaimerLetterPage,
+)
+from pages.screening_subject_search.record_informed_dissent_page import (
+    RecordInformedDissentPage,
+)
+from typing import Optional
+
+
+class RecordRequestToCeasePage(BasePage):
+    """Record Request To Cease Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+
+        # Record Request To Cease - page locators
+        self.reason_dropdown = self.page.locator("#A_C_RequestCeaseReason")
+        self.save_request_cease_button = self.page.get_by_role(
+            "button", name="Save Request Cease"
+        )
+        self.confirm_cease_button = self.page.get_by_role(
+            "button", name="Confirm Cease"
+        )
+        self.cease_notes = self.page.locator("#UI_NOTES_TEXT")
+        self.cease_date_confirmed_textbox = self.page.locator(
+            "#UI_CEASING_CONFIRM_DATE"
+        )
+
+    def select_request_cease_reason(self, cease_reason: "ReasonForCeasing") -> None:
+        """
+        Selects a request cease option.
+        Args:
+            cease_reason (ReasonForCeasing): The reason to request cease
+        """
+        self.reason_dropdown.select_option(label=cease_reason.reason)
+
+    def click_save_request_cease_button(self) -> None:
+        """Click the 'Save Request Cease' button."""
+        self.click(self.save_request_cease_button)
+        self.page.wait_for_timeout(
+            500
+        )  # Timeout to allow time for the subject to be updated on the DB.
+
+    def fill_cease_notes(self, note: str) -> None:
+        """
+        Enter a Note in the cease notes
+        Args:
+            note (str): The note to add.
+        """
+        self.cease_notes.fill(note)
+
+    def enter_cease_date_confirmed(self, date: datetime) -> None:
+        """
+        Enter cease date confirmed
+        Args:
+            date (datetime): The date to enter
+        """
+        CalendarPicker(self.page).calendar_picker_ddmmyyyy(
+            date, self.cease_date_confirmed_textbox
+        )
+
+    def click_confirm_cease_button(self) -> None:
+        """Click the 'Confirm Cease' button."""
+        self.click(self.confirm_cease_button)
+
+    def cease_subject_with_reason(self, reason: str) -> None:
+        """
+        Ceases a subject with a reason
+        Args:
+            reason (str): The reason to request cease:
+                Can be any of the following:
+                - Informed Dissent
+                - Informed Dissent (verbal only)
+                - No Colon (subject request)
+                - No Colon (programme assessed)
+                - Informal Death
+        """
+        reason_for_ceasing = ReasonForCeasing.by_description_case_insensitive(reason)
+        if reason_for_ceasing is None:
+            raise ValueError("Incorrect reason for cease selected.")
+        self.select_request_cease_reason(reason_for_ceasing)
+
+        if reason_for_ceasing.is_immediate_cease:
+            self.fill_cease_notes("AUTO TESTING: confirm immediate manual cease")
+            self.enter_cease_date_confirmed(datetime.now())
+            self.click_confirm_cease_button()
+
+        else:
+            self.click_save_request_cease_button()
+            SubjectScreeningSummaryPage(self.page).click_record_disclaimer_letter_sent()
+            ConfirmTheManualSendingOfADisclaimerLetterPage(
+                self.page
+            ).click_confirm_button()
+            SubjectScreeningSummaryPage(
+                self.page
+            ).click_record_return_of_disclaimer_letter()
+            RecordInformedDissentPage(self.page).fill_notes_field(
+                "AUTO TESTING: confirm not-immediate manual cease"
+            )
+            RecordInformedDissentPage(self.page).enter_date_confirmed(datetime.now())
+            RecordInformedDissentPage(self.page).click_confirm_cease_button()
+
+
+class ReasonForCeasing(Enum):
+    INFORMED_DISSENT = ("Informed Dissent", 43, False)
+    INFORMED_DISSENT_VERBAL_ONLY = ("Informed Dissent (verbal only)", 44, True)
+    NO_COLON_SUBJECT_REQUEST = ("No Colon (subject request)", 45, False)
+    NO_COLON_PROGRAMME_ASSESSED = ("No Colon (programme assessed)", 46, True)
+    INFORMAL_DEATH = ("Informal Death", 47, True)
+
+    def __init__(self, reason: str, value: int, is_immediate_cease_reason: bool):
+        self._reason = reason
+        self._value = value
+        self._is_immediate_cease_reason = is_immediate_cease_reason
+
+    @property
+    def reason(self) -> str:
+        return self._reason
+
+    @property
+    def value(self) -> int:
+        return self._value
+
+    @property
+    def is_immediate_cease(self) -> bool:
+        return self._is_immediate_cease_reason
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, reason: str
+    ) -> Optional["ReasonForCeasing"]:
+        """
+        Get ReasonForCeasing member by description, case insensitive.
+        Args:
+            reason (str): The reason description to look for.
+        Returns:
+            Optional[ReasonForCeasing]: The matching ReasonForCeasing member, or None if not found.
+        """
+        reason_lower = reason.lower()
+        for member in cls:
+            if member.reason.lower() == reason_lower:
+                return member
+        return None

pages/screening_subject_search/refer_to_mdt_page.py

@@ -15,11 +15,11 @@ def __init__(self, page: Page):
         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(
+        self.record_mdt_appointment_button = self.page.locator(
             '[name="UI_BUTTON_SAVE"]'
         )
 
-    def enter_date_in_Mdt_discussion_date_field(self, date: datetime) -> None:
+    def enter_date_in_mdt_discussion_date_field(self, date: datetime) -> None:
         """
         Enters a date in the MDT discussion date field.
         Args:
@@ -43,6 +43,6 @@ def select_mdt_location_lookup(self, option: int) -> None:
         option_elements.nth(option).wait_for(state="visible")
         self.click(option_elements.nth(option))
 
-    def click_record_MDT_appointment_button(self) -> None:
+    def click_record_mdt_appointment_button(self) -> None:
         """Clicks the record MDT appointment button."""
-        self.click(self.record_MDT_appointment_button)
+        self.click(self.record_mdt_appointment_button)

pages/screening_subject_search/reopen_screening_episode_after_manual_cease_page.py

@@ -0,0 +1,28 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+
+
+class ReopenScreeningEpisodeAfterManualCeasePage(BasePage):
+    """Reopen Screening Episode After Manual Cease Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+
+        # Reopen Screening Episode After Manual Cease - page locators
+        self.notes_field = self.page.locator("#UI_NOTES_TEXT")
+        self.uncease_and_reopen_episode_button = self.page.get_by_role(
+            "button", name="uncease and reopen Episode"
+        )
+
+    def fill_notes_field(self, note: str) -> None:
+        """
+        Enter a note into the notes field.
+        Args:
+            note (str): The note to enter.
+        """
+        self.notes_field.fill(note)
+
+    def click_uncease_and_reopen_episode_button(self) -> None:
+        """Click the 'uncease and reopen Episode' button."""
+        self.click(self.uncease_and_reopen_episode_button)