Adding scenario 12 and relevant POMs / Classes / Utils (#144)

Fixing scenario 11

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

<!-- Describe your changes in detail. -->
Adding scenario 12 and fixing scenario 11, and broken subject creation.

## Context

<!-- Why is this change required? What problem does it solve? -->
Adding scenario 12 and fixing scenario 11, and broken subject creation.

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

classes/data/data_creation.py

@@ -5,7 +5,7 @@
 from classes.organisation.organisation_complex import Organisation
 from classes.subject.gender_type import GenderType
 from classes.address.address import Address
-from classes.person.person import Person
+from classes.person.person_data import Person
 from classes.screening.region_type import RegionType
 from classes.subject.pi_subject import PISubject
 from utils.nhs_number_tools import NHSNumberTools
@@ -113,17 +113,17 @@ def generate_random_subject(
         pi_subject = PISubject()
         pi_subject.nhs_number = NHSNumberTools.generate_random_nhs_number()
         person = self.generate_random_person(random_words_list, GenderType.NOT_KNOWN)
-        pi_subject.family_name = person.get_surname()
-        pi_subject.first_given_names = person.get_forename()
-        pi_subject.other_given_names = person.get_other_forenames()
-        pi_subject.previous_family_name = person.get_previous_surname()
-        pi_subject.name_prefix = person.get_title()
+        pi_subject.family_name = person.surname
+        pi_subject.first_given_names = person.forename
+        pi_subject.other_given_names = person.other_forenames
+        pi_subject.previous_family_name = person.previous_surname
+        pi_subject.name_prefix = person.title
         pi_subject.birth_date = datetime.date.today() - datetime.timedelta(
             days=60 * 365
         )
 
         pi_subject.death_date = None
-        gender = person.get_gender()
+        gender = person.gender
         if gender is not None:
             pi_subject.gender_code = gender.redefined_value
         else:
@@ -225,15 +225,15 @@ def generate_random_person(
             )
 
         person = Person()
-        person.set_title(self.generate_random_title(gender))
-        person.set_forename(random_words_list.get("forename", ""))
-        person.set_surname(random_words_list.get("surname", ""))
-        person.set_gender(gender)
+        person.title = self.generate_random_title(gender)
+        person.forename = random_words_list.get("forename", "")
+        person.surname = random_words_list.get("surname", "")
+        person.gender = gender
 
         if self.rand.randint(0, 100) < 5:
-            person.set_other_forenames(random_words_list.get("forename2", ""))
+            person.other_forenames = random_words_list.get("forename2", "")
         if self.rand.randint(0, 100) < 5:
-            person.set_previous_surname(random_words_list.get("surname2", ""))
+            person.previous_surname = random_words_list.get("surname2", "")
 
         logging.debug("generateRandomPerson: end")
         return person

classes/event/event_status_type.py

@@ -86,6 +86,11 @@ class EventStatusType(Enum):
         "A318",
         "Post-investigation Appointment NOT Required - Result Letter Created",
     )
+    A319 = (
+        305787,
+        "A319",
+        "Refer follow-up test after return from symptomatic referral letter (Patient & GP)",
+    )
     A320 = (160160, "A320", "Refer Another Test")
     A321 = (203141, "A321", "Manual Patient Result Letter Created")
     A322 = (203142, "A322", "GP Copy of Manual Patient Result Letter on Queue")
@@ -174,6 +179,7 @@ class EventStatusType(Enum):
     A370 = (160161, "A370", "Diagnostic Test Result Letter sent to GP")
     A371 = (20080, "A371", "Surgery Patient Result letter Printed")
     A372 = (20081, "A372", "Refer Symptomatic, GP Letter Printed")
+    A373 = (305780, "A373", "Symptomatic result recorded")
     A374 = (20082, "A374", "Return to Surveillance After Symptomatic Referral")
     A375 = (
         160176,
@@ -188,6 +194,11 @@ class EventStatusType(Enum):
     A383 = (20421, "A383", "Handover into Symptomatic Care - Patient Letter Printed")
     A384 = (20420, "A384", "Discharged from Screening - GP letter not required")
     A385 = (20419, "A385", "Handover into Symptomatic Care")
+    A389 = (
+        305783,
+        "A389",
+        "Refer Another Diagnostic Test after return from Symptomatic Referral",
+    )
     A391 = (20083, "A391", "Patient Discharge Letter Printed - No Patient Contact")
     A392 = (20084, "A392", "Patient Discharge Letter Printed - Patient Choice")
     A394 = (

classes/person/person_data.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+from typing import Optional
+from classes.subject.gender_type import GenderType
+
+
+@dataclass
+class Person:
+    """
+    Represents a person with name, title, previous surname, other forenames, and gender.
+    Provides methods to get full name and string representation.
+    """
+
+    surname: Optional[str] = None
+    forename: Optional[str] = None
+    title: Optional[str] = None
+    other_forenames: Optional[str] = None
+    previous_surname: Optional[str] = None
+    gender: Optional[GenderType] = None
+
+    def get_full_name(self) -> str:
+        """
+        Returns the full name of the person.
+        """
+        return f"{self.title or ''} {self.forename or ''} {self.surname or ''}".strip()
+
+    def __str__(self) -> str:
+        """
+        Returns a string representation of the person.
+        """
+        return f"{self.title or ''} {self.forename or ''} {self.surname or ''} (gender={self.gender})".strip()

pages/screening_subject_search/advance_fobt_screening_episode_page.py

@@ -96,6 +96,24 @@ def __init__(self, page: Page):
         self.redirect_to_reestablish_suitability_for_diagnostic_test_repatient_contact = self.page.get_by_role(
             "button", name="Redirect to re-establish"
         )
+        self.mdt_referral_required_button = self.page.get_by_role(
+            "button", name="MDT Referral Required"
+        )
+        self.mdt_referral_not_required_button = self.page.get_by_role(
+            "button", name="MDT Referral Not Required"
+        )
+        self.non_neoplastic_and_other_non_bowel_cancer_result_button = (
+            self.page.get_by_role(
+                "button", name="Non-neoplastic and Other Non-bowel Cancer Result"
+            )
+        )
+        self.return_to_fobt_after_symptomatic_referral_button = self.page.get_by_role(
+            "button", name="Return to FOBT after Symptomatic Referral"
+        )
+        self.refer_another_diagnostic_test_after_return_from_symptomatic_referral_button = self.page.get_by_role(
+            "button",
+            name="Refer Another Diagnostic Test after return from 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(
@@ -117,9 +135,6 @@ def __init__(self, page: Page):
         self.ct_colonography_test_type_dropdown = self.page.locator(
             "#UI_EXT_TEST_TYPE_38"
         )
-        self.invite_for_diagnostic_test_button = self.page.get_by_role(
-            "button", name="Invite for Diagnostic Test >>"
-        )
 
     def click_suitable_for_endoscopic_test_button(self) -> None:
         """Click the 'Suitable for Endoscopic Test' button."""
@@ -396,3 +411,29 @@ def select_any_practitioner(self) -> None:
                 return
 
         logging.warning("[CONTACT RECORD] No valid practitioner found to select")
+
+    def click_mdt_referral_required_button(self) -> None:
+        """Click the 'MDT Referral Required' button."""
+        self.safe_accept_dialog(self.mdt_referral_required_button)
+
+    def click_mdt_referral_not_required_button(self) -> None:
+        """Click the 'MDT Referral Not Required' button."""
+        self.safe_accept_dialog(self.mdt_referral_not_required_button)
+
+    def click_non_neoplastic_and_other_non_bowel_cancer_result_button(self) -> None:
+        """Click the 'Non-neoplastic and Other Non-bowel Cancer Result' button."""
+        self.safe_accept_dialog(
+            self.non_neoplastic_and_other_non_bowel_cancer_result_button
+        )
+
+    def click_return_to_fobt_after_symptomatic_referral_button(self) -> None:
+        """Click the 'Return to FOBT after Symptomatic Referral' button."""
+        self.safe_accept_dialog(self.return_to_fobt_after_symptomatic_referral_button)
+
+    def click_refer_another_diagnostic_test_after_return_from_symptomatic_referral_button(
+        self,
+    ) -> None:
+        """Click the 'Refer Another Diagnostic Test after return from Symptomatic Referral' button."""
+        self.click(
+            self.refer_another_diagnostic_test_after_return_from_symptomatic_referral_button
+        )

pages/screening_subject_search/diagnostic_test_outcome_page.py

@@ -14,6 +14,9 @@ class ReasonForOnwardReferral(StrEnum):
     CURRENTLY_UNSUITABLE_FOR_ENDOSCOPIC_REFERRAL = "20358"
     FURTHER_CLINICAL_ASSESSMENT = "20359"
     INCOMPLETE_COLONIC_VISUALISATION = "20481"
+    POLYP_EXCISION = "203011"
+    CORRECTIVE_SURGERY = "203012"
+    SUSPECTED_CANCER_SURGERY = "203013"
 
 
 class DiagnosticTestOutcomePage(BasePage):

pages/screening_subject_search/non_neoplastic_result_from_symptomatic_procedure_page.py

@@ -0,0 +1,54 @@
+from datetime import datetime
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from utils.calendar_picker import CalendarPicker
+
+
+class NonNeoplasticResultFromSymptomaticProcedurePage(BasePage):
+    """Non Neoplastic Result From Symptomatic Procedure Page locators, and methods for interacting with the 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)

pages/screening_subject_search/reopen_fobt_screening_episode_page.py

@@ -29,6 +29,11 @@ def __init__(self, page: Page):
         self.reopen_to_reschedule_diagnostic_test_button = self.page.get_by_role(
             "button", name="Reopen to Reschedule Diagnostic Test"
         )
+        self.reopen_to_rerecord_outcome_from_symptomatic_referral_button = (
+            self.page.get_by_role(
+                "button", name="Reopen to Re-record Outcome from Symptomatic Referral"
+            )
+        )
 
     def click_reopen_to_book_an_assessment_button(self) -> None:
         """Click the 'Reopen to book an assessment' button."""
@@ -55,3 +60,9 @@ def click_reopen_to_confirm_diagnostic_test_result_and_outcome_button(self) -> N
     def click_reopen_to_reschedule_diagnostic_test_button(self) -> None:
         """Click the 'Reopen to Reschedule Diagnostic Test' button."""
         self.safe_accept_dialog(self.reopen_to_reschedule_diagnostic_test_button)
+
+    def click_reopen_to_rerecord_outcome_from_symptomatic_referral_button(self) -> None:
+        """Click the 'Reopen to Re-record Outcome from Symptomatic Referral' button."""
+        self.safe_accept_dialog(
+            self.reopen_to_rerecord_outcome_from_symptomatic_referral_button
+        )

pages/screening_subject_search/return_from_symptomatic_referral_page.py

@@ -0,0 +1,45 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+
+
+class ReturnFromSymptomaticReferralPage(BasePage):
+    """Return From Symptomatic Referral Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        # Return From Symptomatic Referral - page locators
+        self.radiological_or_endoscopic_referral_dropdown = self.page.locator(
+            "#referralTypeId"
+        )
+        self.reason_for_onward_referral_dropdown = self.page.locator(
+            "#referralReasonId"
+        )
+        self.save_button = self.page.get_by_role("button", name="Save")
+
+    def select_radiological_or_endoscopic_referral_option(
+        self, referral_type: str
+    ) -> None:
+        """
+        Select a radiological or endoscopic referral from the dropdown.
+        Args:
+            referral_type (str): The referral type to be selected in the dropdown. Example: "Colonoscopy"
+        """
+        self.radiological_or_endoscopic_referral_dropdown.select_option(
+            label=referral_type
+        )
+
+    def select_reason_for_onward_referral_option(
+        self, reason_for_referral: str
+    ) -> None:
+        """
+        Select a reason for onward referral from the dropdown.
+        Args:
+            reason_for_referral (str): The reason for onward referral to be selected in the dropdown. Example: "Further Clinical Assessment"
+        """
+        self.reason_for_onward_referral_dropdown.select_option(
+            label=reason_for_referral
+        )
+
+    def click_save_button(self) -> None:
+        """Click the 'Save' button."""
+        self.click(self.save_button)

pages/screening_subject_search/subject_demographic_page.py

@@ -1,7 +1,8 @@
-from playwright.sync_api import Page, expect
+from playwright.sync_api import Page, Dialog
 from pages.base_page import BasePage
 from datetime import datetime
 from utils.calendar_picker import CalendarPicker
+import logging
 
 
 class SubjectDemographicPage(BasePage):
@@ -13,11 +14,9 @@ def __init__(self, page: Page):
         # Subject Demographic - page filters
         self.forename_field = self.page.get_by_role("textbox", name="Forename")
         self.surname_field = self.page.get_by_role("textbox", name="Surname")
-        self.postcode_field = self.page.get_by_role("textbox", name="Postcode")
+        self.postcode_field = self.page.locator("#UI_SUBJECT_POSTCODE")
         self.dob_field = self.page.get_by_role("textbox", name="Date of Birth")
-        self.update_subject_data_button = self.page.get_by_role(
-            "button", name="Update Subject Data"
-        )
+        self.update_subject_data_button = self.page.locator("#BTN_DEMOG_UPDATE_SUBJECT")
         self.temporary_address_show_link = (
             self.page.locator("font")
             .filter(has_text="Temporary Address show")
@@ -126,6 +125,39 @@ def click_update_subject_data_button(self) -> None:
         """Clicks on the 'Update Subject Data' button"""
         self.click(self.update_subject_data_button)
 
+    def click_update_subject_data_button_and_assert_dialog(
+        self, expected_text: str
+    ) -> None:
+        """
+        Clicks on the 'Update Subject Data' button and asserts that a dialog appears with the expected text.
+        Args:
+            expected_text (str): The text expected to be found in the dialog.
+        """
+        self._dialog_assertion_error = None
+
+        def handle_dialog(dialog: Dialog):
+            """
+            Handles the dialog and asserts that the dialog contains the expected text.
+            Args:
+                dialog (Dialog): the playwright dialog object
+            """
+            logging.info(f"Dialog appeared with message: {dialog.message}")
+            actual_text = dialog.message
+            try:
+                assert (
+                    expected_text in actual_text
+                ), f"Expected dialog to contain '{expected_text}', but got '{actual_text}'"
+            except AssertionError as e:
+                self._dialog_assertion_error = e
+            try:
+                dialog.accept()
+            except Exception:
+                logging.warning("Dialog already accepted or handled")
+
+        self.page.once("dialog", lambda dialog: handle_dialog(dialog))
+        self.click(self.update_subject_data_button)
+        self.page.wait_for_timeout(2000)
+
     def get_dob_field_value(self) -> str:
         """
         Returns the value in the date of birth input textbox