Feature/bcss 20615 new regression tests subject episodes diagnosis date (#110)

<!-- markdownlint-disable-next-line first-line-heading -->
BCSS - 20615 - Selenium to Playwright - Regression Tests - Subject
Episodes - Diagnosis Date
New PR is created.

## Context
Code change is implemeted. Locator is created & Hard coded values are
removed & moved to POM.
Below are the lists of files checked in.

1. Test File -->
tests/regression/subject_diagnosis_date/test_subject_episodes_diagnosis_date.py
2. Pages --> Screening_Subject_Search -->
subject_episode_events_and_notes_page.py
3. Pages --> Screening_Subject_Search -->
advance_fobt_screening_episode_page.py
4. 	Pages --> Screening_Subject_Search --> record_diagnosis_date_page.py
5. 	pytest.ini
6. 	users.json
7.	Classes --> diagnosis_date_reason_type	

## 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)
- [ ] 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: vidhya-chandra1

classes/diagnosis_date_reason_type.py

@@ -98,6 +98,6 @@ def get_valid_value_id(self) -> Optional[int]:
 
     def get_description(self) -> str:
         """
-        Returns the description for the diagnosis date reason.
+        Returns the description for the diagnosis date reason
         """
         return self._description

pages/screening_subject_search/advance_fobt_screening_episode_page.py

@@ -17,6 +17,7 @@ def __init__(self, page: Page):
         self.calendar_button = self.page.get_by_role("button", name="Calendar")
         self.test_type_dropdown = self.page.locator("#UI_EXT_TEST_TYPE_2233")
         self.test_type_dropdown_2 = self.page.locator("#UI_EXT_TEST_TYPE_4325")
+        self.advance_checkbox = self.page.get_by_label("There are some events available which should only be used in exceptional circumstances. If you wish to see them, check this box")
         self.invite_for_diagnostic_test_button = self.page.get_by_role(
             "button", name="Invite for Diagnostic Test >>"
         )
@@ -111,3 +112,7 @@ def click_record_diagnosis_date_button(self) -> None:
     def click_record_contact_with_patient_button(self) -> None:
         """Click the 'Record Contact with Patient' button."""
         self.click(self.record_contact_with_patient_button)
+
+    def check_advance_checkbox(self) -> None:
+        """Selects the 'Advance FOBT' checkbox"""
+        self.advance_checkbox.check()

pages/screening_subject_search/record_diagnosis_date_page.py

@@ -22,8 +22,22 @@ def enter_date_in_diagnosis_date_field(self, date: datetime) -> None:
         """
         self.click(self.diagnosis_date_field)
         CalendarPicker(self.page).v2_calendar_picker(date)
-        self.diagnosis_date_field.press("Enter")
+        self.diagnosis_date_field.press("Tab")
 
     def click_save_button(self) -> None:
         """Clicks the save button."""
         self.click(self.save_button)
+
+    def get_alert_message(self) -> str:
+        """
+        Retrieve the visible alert message from the page, if any.
+
+        Returns:
+            str: The inner text of the alert element if it's visible;
+            otherwise, an empty string.
+        """
+        self.alert_message = self.page.get_by_role("alert")
+        if self.alert_message.is_visible():
+            return self.alert_message.inner_text()
+        else:
+            return ""

pages/screening_subject_search/subject_episode_events_and_notes_page.py

@@ -0,0 +1,143 @@
+import logging
+import pytest
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+from typing import Dict
+
+class SubjectEpisodeEventsAndNotesPage(BasePage):
+    """Episode Events and Notes Page locators, and methods for interacting with the page."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        # List of episode events and notes - page locators
+        self.latest_event_status_cell = self.page.locator(
+            "table >> td.epihdr_data"
+        ).nth(
+            0
+        )  # if it's the first one
+        self.latest_event_cell = self.page.get_by_role(
+            "cell", name="Record Diagnosis Date", exact=True
+        )
+        self.latest_diagnosis_cell = self.page.locator(
+            "td[align='center']:has-text('Diag Date :')"
+        )
+
+        # Episode details (Replace with actual selectors only for scenario 17)
+        self.latest_episode_status = self.page.locator("#latestEpisodeStatus")
+        self.latest_episode_has_diagnosis_date = self.page.locator(
+            "#latestEpisodeHasDiagnosisDate"
+        )
+        self.latest_episode_diagnosis_reason = self.page.locator(
+            "#latestEpisodeDiagnosisDateReason"
+        )
+        self.process_sspi_update_button = self.page.get_by_text("Process SSPI Update")
+        self.deduction_reason_dropdown = self.page.locator("#deductionReason")
+        self.confirm_sspi_update_button = self.page.get_by_text("Confirm")
+
+    def expected_episode_event_is_displayed(self, event_description: str) -> None:
+        """Check if the expected episode event is displayed on the page."""
+        expect(
+            self.page.get_by_role("cell", name=event_description, exact=True)
+        ).to_be_visible()
+
+    def get_latest_event_details(self) -> dict:
+        """
+        Retrieves key details for the latest episode entry from the UI.
+
+        Returns:
+        dict: A dictionary containing the following keys:
+            - "latest_event_status" (str): The current status text of the latest event.
+            - "event" (str): A description or name of the latest event.
+            - "item" (str): Details related to the latest diagnosis item.
+
+        Raises:
+        pytest.fail: If any of the UI elements cannot be read, the test fails immediately.
+        """
+        try:
+            status_text = self.latest_event_status_cell.inner_text()
+            event_text = self.latest_event_cell.inner_text()
+            diagnosis_text = self.latest_diagnosis_cell.first.inner_text()
+            logging.debug(f"DEBUG: {event_text}, {status_text}, {diagnosis_text}")
+        except Exception as e:
+            pytest.fail(f"Failed to read latest episode event details from UI: {e}")
+        return {
+            "latest_event_status": status_text,
+            "event": event_text,
+            "item": diagnosis_text,
+        }
+
+    def validate_event_status_is_not_A50(self, event_details: dict) -> None:
+        """Validates that latest_event_status does not contain 'A50'."""
+        latest_status = event_details.get("latest_event_status")
+        logging.info(f"Validating Latest Event Status: {latest_status}")
+
+        if latest_status is None:
+            pytest.fail("Missing 'latest_event_status' in event_details.")
+        elif "A50" in str(latest_status):
+            pytest.fail(
+                f"Invalid status detected: 'A50' is not allowed. Received: '{latest_status}'"
+            )
+        logging.info(f"Status '{latest_status}' is allowed.")
+
+    def is_record_diagnosis_date_option_available(self) -> bool:
+        """
+        Check if the 'Record Diagnosis Date' option is available on the page
+
+        Returns:
+            bool: True if the option is available, False otherwise.
+        """
+        try:
+            return self.page.get_by_role(
+                "button", name="Record Diagnosis Date"
+            ).is_visible()
+        except Exception as e:
+            logging.error(f"Record Diagnosis Date option not found: {e}")
+            return False
+
+    def is_amend_diagnosis_date_option_available(self) -> bool:
+        """
+        Check if the 'Amend Diagnosis Date' option is available on the page.
+
+        Returns:
+            bool: True if the option is available, False otherwise.
+        """
+        try:
+            return self.page.get_by_role(
+                "button", name="Amend Diagnosis Date"
+            ).is_visible()
+        except Exception as e:
+            logging.error(f"Error checking for 'Amend Diagnosis Date' option: {e}")
+            return False
+
+    def process_sspi_update_for_death(self, deduction_reason: str) -> None:
+        """
+        Submits an SSPI update for a death-related deduction reason through the UI workflow.
+
+        Args:
+        deduction_reason (str): The label of the deduction reason to select from the dropdown.
+
+        Steps:
+        - Clicks the SSPI update button.
+        - Selects the specified deduction reason from the dropdown.
+        - Confirms the SSPI update by clicking the confirmation button.
+        """
+        self.process_sspi_update_button.click()
+        self.deduction_reason_dropdown.select_option(label=deduction_reason)
+        self.confirm_sspi_update_button.click()
+
+    def get_latest_episode_details(self) -> Dict[str, str]:
+        """
+        Retrieve details of the latest episode from the UI elements.
+
+        Returns:
+            Dict[str, str]: A dictionary containing:
+                - 'latest_episode_status': The status text of the latest episode.
+                - 'latest_episode_has_diagnosis_date': Indicator of whether a diagnosis date is present.
+                - 'latest_episode_diagnosis_date_reason': Reason explaining the diagnosis date status.
+        """
+        return {
+            "latest_episode_status": self.latest_episode_status.inner_text(),
+            "latest_episode_has_diagnosis_date": self.latest_episode_has_diagnosis_date.inner_text(),
+            "latest_episode_diagnosis_date_reason": self.latest_episode_diagnosis_reason.inner_text(),
+        }

pytest.ini

@@ -45,3 +45,4 @@ markers =
     subject_search: tests that are part of the subject search test suite
     investigation_dataset_tests: tests that are part of the investigation dataset test suite
     skip_before_test: tests that will not use the before_test fixture
+    fobt_diagnosis_date_entry_tests: tests that are part of fobt subject episodes record diagnosis date