Feature/bcss 21310 selenium to playwright fobtregressiontests scenario 7 (#138)

adrianoaru-nhs · Andyg79 · web-flow · commit eb476494fcd2 · 2025-09-19T09:15:08.000+01:00
## Description  Adding scenario 7 from fobtregressiontests.feature ## Context  Adding scenario 7 from fobtregressiontests.feature ## 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: AndyG <179915678+Andyg79@users.noreply.github.com>
diff --git a/classes/deduction/deduction_reason_types.py b/classes/deduction/deduction_reason_types.py
@@ -0,0 +1,126 @@
+from enum import Enum
+from typing import Optional
+
+
+class DeductionReasonType(Enum):
+    """
+    Enum representing deduction reason types, mapped to valid value IDs, allowed values, and descriptions.
+    Provides utility methods for lookup by description, allowed value, and valid value ID.
+    """
+
+    AFL = (307006, "AFL", "AF Enlistment (local)")
+    AFN = (307007, "AFN", "AF Enlistment (AF)")
+    CGA = (307008, "CGA", "Gone away")
+    DEA = (307009, "DEA", "Death")
+    Death = (307009, "DEA", "Death")  # Alias for DEA
+    DDR = (1, "DDR", "Deducted at Doctor's request")
+    DIS = (307010, "DIS", "Practice dissolution")
+    DPR = (2, "DPR", "Deducted at Patient's request")
+    EMB = (307011, "EMB", "Embarkation")
+    Embarkation = (307011, "EMB", "Embarkation")  # Alias for EMB
+    FP69 = (17, "FP69", "Deducted as a result of a non-respond to an FP69/")
+    LDN = (307012, "LDN", "Logical Deletion")
+    MH = (7, "M/H", "Mental Hospital")
+    NIT = (307013, "NIT", "Transfer to Northern Ireland")
+    OR = (10, "O/R", "Other")
+    OPA = (307014, "OPA", "Address out of practice area")
+    ORR = (307015, "ORR", "Other Reason")
+    PAR = (13, "PAR", "Practice advise subject no longer resident")
+    PSR = (14, "PSR", "Practice advise removal via screening system")
+    PVR = (15, "PVR", "Practice advise removal via vaccination data")
+    R = (26, "R", "Deducted as a result of removal to other HA")
+    RA = (8, "R/A", "Registration/A")
+    RC = (9, "R/C", "Registration Cancelled")
+    RU = (27, "R/U", "Deducted as a result of return undelivered")
+    RDI = (307016, "RDI", "Practice Request - immediate")
+    RDR = (307017, "RDR", "Practice request")
+    RFI = (307018, "RFI", "Residential Institute")
+    RPR = (307019, "RPR", "Patient request")
+    SD = (6, "S/D", "Service Dependant")
+    SCT = (307020, "SCT", "Transferred to Scotland")
+    SDL = (307021, "SDL", "Services Dependant (local)")
+    SDN = (307022, "SDN", "Services Dependant (SMU)")
+    SER = (5, "SER", "Services")
+    TRA = (307023, "TRA", "Temporary resident not returned")
+
+    def __init__(
+        self, valid_value_id: int, allowed_value: str, description: str
+    ) -> None:
+        self._valid_value_id = valid_value_id
+        self._allowed_value = allowed_value
+        self._description = description
+
+    @property
+    def valid_value_id(self) -> int:
+        """Returns the valid value ID for the deduction reason type."""
+        return self._valid_value_id
+
+    @property
+    def allowed_value(self) -> str:
+        """Returns the allowed value for the deduction reason type."""
+        return self._allowed_value
+
+    @property
+    def description(self) -> str:
+        """Returns the description for the deduction reason type."""
+        return self._description
+
+    @classmethod
+    def by_description(cls, description: str) -> Optional["DeductionReasonType"]:
+        """
+        Returns the enum member matching the given description (case-sensitive).
+        Args:
+            description (str): The description to match.
+        Returns:
+            Optional[DeductionReasonType]: The matching enum member, or None if not found.
+        """
+        for member in cls:
+            if member.description == description:
+                return member
+        return None
+
+    @classmethod
+    def by_description_case_insensitive(
+        cls, description: str
+    ) -> Optional["DeductionReasonType"]:
+        """
+        Returns the enum member matching the given description (case-insensitive).
+        Args:
+            description (str): The description to match.
+        Returns:
+            Optional[DeductionReasonType]: The matching enum member, or None if not found.
+        """
+        desc_lower = description.lower()
+        for member in cls:
+            if member.description.lower() == desc_lower:
+                return member
+        return None
+
+    @classmethod
+    def by_deduction_code(cls, code: str) -> Optional["DeductionReasonType"]:
+        """
+        Returns the enum member matching the given allowed value (deduction code).
+        Args:
+            code (str): The code to match.
+        Returns:
+            Optional[DeductionReasonType]: The matching enum member, or None if not found.
+        """
+        code_upper = code.upper()
+        for member in cls:
+            if member.allowed_value.upper() == code_upper:
+                return member
+        return None
+
+    @classmethod
+    def by_valid_value_id(cls, valid_value_id: int) -> Optional["DeductionReasonType"]:
+        """
+        Returns the enum member matching the given valid value ID.
+        Args:
+            valid_value_id (str): The valid_value_id to match.
+        Returns:
+            Optional[DeductionReasonType]: The matching enum member, or None if not found.
+        """
+        for member in cls:
+            if member.valid_value_id == valid_value_id:
+                return member
+        return None
diff --git a/classes/episode/subject_has_episode.py b/classes/episode/subject_has_episode.py
@@ -32,7 +32,7 @@ def by_description(cls, description: str) -> Optional["SubjectHasEpisode"]:
             Optional[SubjectHasEpisode]: The matching enum member, or None if not found.
         """
         for item in cls:
-            if item.value == description:
+            if item.value.lower() == description.lower():
                 return item
         return None
 
diff --git a/classes/repositories/subject_repository.py b/classes/repositories/subject_repository.py
@@ -1,7 +1,10 @@
 import logging
 from typing import Optional
 from classes.subject.pi_subject import PISubject
+from classes.subject.subject import Subject
+from classes.user.user import User
 from utils.oracle.oracle import OracleDB
+from utils.oracle.subject_selection_query_builder import SubjectSelectionQueryBuilder
 
 
 class SubjectRepository:
@@ -193,3 +196,32 @@ def get_latest_gp_practice_for_subject(self, nhs_number: str) -> Optional[str]:
         if df.empty:
             return None
         return df.iloc[0]["gp_code"]
+
+    def get_matching_subject(
+        self, criteria: dict, subject: Subject, user: User
+    ) -> Subject:
+        """
+        Finds a subject in the DB matching the given criteria.
+        Args:
+            criteria (dict): The criteria you want the subject to match
+            subject (Subject): The subject class object. Can be populated or not, depends on the criteria
+            user (User): The user class object. Can be populated or not, depends on the criteria
+        Returns:
+            Subject: A populated Subject object with a subject that matches the provided criteria
+        Raises:
+            ValueError: If no subject matching the criteria was found.
+        """
+        builder = SubjectSelectionQueryBuilder()
+        query, bind_vars = builder.build_subject_selection_query(
+            criteria=criteria,
+            user=user,
+            subject=subject,
+            subjects_to_retrieve=1,
+        )
+        df = OracleDB().execute_query(query, bind_vars)
+        try:
+            df_row = df.iloc[0]
+            subject = Subject().from_dataframe_row(df_row)
+        except Exception:
+            raise ValueError("No subject found matching the given criteria")
+        return subject
diff --git a/pages/screening_practitioner_appointments/appointment_detail_page.py b/pages/screening_practitioner_appointments/appointment_detail_page.py
@@ -1,6 +1,8 @@
 from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
 from enum import StrEnum
+from datetime import datetime
+from utils.calendar_picker import CalendarPicker
 
 
 class AppointmentDetailPage(BasePage):
@@ -87,6 +89,23 @@ def select_reason_for_cancellation_option(self, option: str) -> None:
         self.reason_for_cancellation_dropdown.select_option(value=option)
 
 
+    def mark_appointment_as_attended(self, date: datetime) -> None:
+        """
+        Marks an appointment as attended.
+        Args:
+            date (datetime): The date the appointment was attended
+        """
+        self.wait_for_attendance_radio(
+            600000
+        )  # Max of 10 minute wait as appointments need to be set for future times and they are in 10 minute intervals
+        self.check_attendance_radio()
+        self.check_attended_check_box()
+        self.click_calendar_button()
+        CalendarPicker(self.page).v1_calender_picker(date)
+        self.click_save_button()
+        self.verify_text_visible("Record updated")
+
+
 class ReasonForCancellationOptions(StrEnum):
     """Enum for cancellation reason options"""
 
diff --git a/pages/screening_subject_search/advance_fobt_screening_episode_page.py b/pages/screening_subject_search/advance_fobt_screening_episode_page.py
@@ -44,6 +44,16 @@ def __init__(self, page: Page):
         self.record_contact_with_patient_button = self.page.get_by_role(
             "button", name="Record Contact with Patient"
         )
+        self.amend_diagnosis_date_button = self.page.get_by_role(
+            "button", name="Amend Diagnosis Date"
+        )
+        self.advance_checkbox_v2 = self.page.get_by_role("checkbox")
+        self.subsequent_assessment_appointment_required_dropdown = (
+            self.page.get_by_role("combobox")
+        )
+        self.subsequent_assessment_appointment_required_button = self.page.get_by_role(
+            "button", name="Subsequent Assessment Appointment Required"
+        )
         self.suitable_for_radiological_test_button = self.page.get_by_role(
             "button", name="Suitable for Radiological Test"
         )
@@ -57,6 +67,9 @@ def __init__(self, page: Page):
                 "button", name="Waiting Decision to Proceed with Diagnostic Test"
             )
         )
+        self.not_suitable_for_diagnostic_tests_button = self.page.get_by_role(
+            "button", name="Not Suitable for Diagnostic Tests"
+        )
 
     def click_suitable_for_endoscopic_test_button(self) -> None:
         """Click the 'Suitable for Endoscopic Test' button."""
@@ -126,6 +139,28 @@ def check_advance_checkbox(self) -> None:
         """Selects the 'Advance FOBT' checkbox"""
         self.advance_checkbox.check()
 
+    def click_amend_diagnosis_date_button(self) -> None:
+        """Checks the 'Advance FOBT' checkbox and clicks the 'Amend Diagnosis Date' button."""
+        self.advance_checkbox_v2.check()
+        self.click(self.amend_diagnosis_date_button)
+
+    def click_and_select_subsequent_assessment_appointment_required(
+        self, option: str
+    ) -> None:
+        """
+        Click the 'Subsequent Assessment Appointment Required' button and select an option from the dropdown.
+        Args:
+            option (str): The option to select from the dropdown.
+            Must be one of:
+                - 'Previous attendance, further assessment required'
+                - 'Interpreter requirement not identified'
+                - 'SC interpreter DNA'
+        """
+        self.subsequent_assessment_appointment_required_dropdown.select_option(
+            label=option
+        )
+        self.safe_accept_dialog(self.subsequent_assessment_appointment_required_button)
+
     def click_suitable_for_radiological_test_button(self) -> None:
         """Click the 'Suitable for Radiological Test' button."""
         self.safe_accept_dialog(self.suitable_for_radiological_test_button)
@@ -141,3 +176,7 @@ def click_waiting_decision_to_proceed_with_diagnostic_test(self) -> None:
         self.safe_accept_dialog(
             self.waiting_decision_to_proceed_with_diagnostic_test_button
         )
+
+    def click_not_suitable_for_diagnostic_tests_button(self) -> None:
+        """Click the 'Not Suitable for Diagnostic Tests' button."""
+        self.safe_accept_dialog(self.not_suitable_for_diagnostic_tests_button)
diff --git a/pages/screening_subject_search/patient_advised_of_diagnosis_page.py b/pages/screening_subject_search/patient_advised_of_diagnosis_page.py
@@ -0,0 +1,28 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from datetime import datetime
+from utils.calendar_picker import CalendarPicker
+
+
+class PatientAdvisedOfDiagnosisPage(BasePage):
+    """Advance FOBT Screening Episode Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        # Patient Advised Of Diagnosis - page locators
+        self.diagnosis_date_calendar_icon = self.page.locator("#diagnosisAdvice span")
+        self.reason_dropdown = self.page.locator("#reason")
+        self.save_button = self.page.get_by_role("button", name="Save")
+
+    def select_diagnosis_date_and_reason(self, date: datetime, reason: str) -> None:
+        """
+        Selects the diagnosis date and reason, then saves the form.
+        Args:
+            date (datetime): The diagnosis date to select.
+            reason (str): The reason for the diagnosis.
+        """
+        self.click(self.diagnosis_date_calendar_icon)
+        CalendarPicker(self.page).v2_calendar_picker(date)
+        self.reason_dropdown.select_option(label=reason)
+        self.click(self.save_button)
diff --git a/pages/screening_subject_search/reopen_fobt_screening_episode_page.py b/pages/screening_subject_search/reopen_fobt_screening_episode_page.py
@@ -12,6 +12,12 @@ def __init__(self, page: Page):
         self.reopen_to_book_an_assessment_button = self.page.get_by_role(
             "button", name="Reopen to book an assessment"
         )
+        self.reopen_episode_for_correction_button = self.page.get_by_role(
+            "button", name="Reopen episode for correction"
+        )
+        self.reopen_due_to_subject_or_patient_decision = self.page.get_by_role(
+            "button", name="Reopen due to subject or patient decision"
+        )
         self.reopen_following_non_response_button = self.page.get_by_role(
             "button", name="Reopen following Non-Response"
         )
@@ -20,6 +26,14 @@ def click_reopen_to_book_an_assessment_button(self) -> None:
         """Click the 'Reopen to book an assessment' button."""
         self.safe_accept_dialog(self.reopen_to_book_an_assessment_button)
 
+    def click_reopen_episode_for_correction_button(self) -> None:
+        """Click the 'Reopen episode for correction' button."""
+        self.safe_accept_dialog(self.reopen_episode_for_correction_button)
+
+    def click_reopen_due_to_subject_or_patient_decision(self) -> None:
+        """Click the 'Reopen due to subject or patient decision' button."""
+        self.safe_accept_dialog(self.reopen_due_to_subject_or_patient_decision)
+
     def click_reopen_following_non_response_button(self) -> None:
         """Click the 'Reopen following Non-Response' button."""
         self.safe_accept_dialog(self.reopen_following_non_response_button)
diff --git a/tests/regression/regression_tests/fobt_regression_tests/test_scenario_7.py b/tests/regression/regression_tests/fobt_regression_tests/test_scenario_7.py
diff --git a/utils/sspi_change_steps.py b/utils/sspi_change_steps.py
