Feature/bcss 20608 new regression tests subject spine retrieval (#112)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description
Selenium to Playwright - Regression Tests - Subject - Spine Retrieval
<!-- Describe your changes in detail. -->

## Context
New Code is implemented in below files
1) Tests File --> subject_diagnosis_date -->
test_subject_episodes_diagnosis_spine_retrieval.py
2) POM       --> subject_diagnosis_date --> subject_diagnosis_date.py
3) pytest.ini
<!-- Why is this change required? What problem does it solve? -->

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

pages/screening_subject_search/subject_screening_summary_page.py

@@ -11,6 +11,8 @@ class SubjectScreeningSummaryPage(BasePage):
     def __init__(self, page: Page):
         super().__init__(page)
         self.page = page
+        self.spine_url = "https://bcss-bcss-18680-ddc-bcss.k8s-nonprod.texasplatform.uk/servlet/SpineSearchScreen"
+
         # Subject Screening Summary - page filters
         self.subject_screening_summary = self.page.get_by_role(
             "cell", name="Subject Screening Summary", exact=True
@@ -30,6 +32,7 @@ def __init__(self, page: Page):
         self.individual_letters = self.page.get_by_role(
             "link", name="Individual Letters"
         )
+        self.retrieve_data_link = self.page.get_by_role("link", name="Retrieve Data from Spine")
         self.patient_contacts = self.page.get_by_role("link", name="Patient Contacts")
         self.more = self.page.get_by_role("link", name="more")
         self.change_screening_status = self.page.get_by_label("Change Screening Status")
@@ -310,6 +313,14 @@ def click_book_practitioner_clinic_button(self) -> None:
         """Click on the 'Book Practitioner Clinic' button"""
         self.click(self.book_practitioner_clinic_button)
 
+    def navigate_to_spine_search(self) -> None:
+        """
+        Navigates to the Spine Search screen by clicking the appropriate link
+        and loading the target URL.
+        """
+        #self.retrieve_data_link.click()
+        self.click(self.retrieve_data_link)
+        self.page.goto(self.spine_url)
 
 class ChangeScreeningStatusOptions(Enum):
     """Enum for Change Screening Status options."""

pages/screening_subject_search/subject_spine_retrieval_search_page.py

@@ -0,0 +1,86 @@
+from datetime import datetime
+from playwright.sync_api import Page, Locator
+from pages.base_page import BasePage
+from typing import Dict
+from utils.calendar_picker import CalendarPicker
+
+class SpineSearchPage(BasePage):
+    """
+    Page object for the Spine Search screen, enabling demographic searches
+    and data retrieval from the Spine system.
+    """
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+
+        # Define locators
+        self.demographics_radio = self.page.get_by_role("radio", name="Demographics")
+        self.date_of_birth_field = self.page.locator("#dateOfBirth")
+        self.surname_field = self.page.locator("#surname")
+        self.forename_field = self.page.locator("#forename")
+        self.gender_dropdown = self.page.locator("#gender")
+        self.postcode_field = self.page.locator("#postcode")
+        self.search_button = self.page.get_by_role("button", name="Search")
+        self.alert_locator= self.page.locator(".spine-alert")
+
+        # CalendarPicker utility instance
+        self.calendar_picker = CalendarPicker(self.page)
+
+    def select_demographic_search(self) -> None:
+        """
+        Selects the 'Demographics' radio button to enable demographic search mode.
+        """
+        self.demographics_radio.check()
+
+    def enter_search_criteria(
+        self, dob: str, surname: str, forename: str, gender: str, postcode: str
+    ) -> None:
+        """
+        Fills in the demographic search fields with the provided values.
+
+        Args:
+            dob (str): Date of birth in string format (e.g., "06 May 1940").
+            surname (str): Subject's surname.
+            forename (str): Subject's forename.
+            gender (str): Gender value ("Male" or "Female").
+            postcode (str): Subject's postcode.
+        """
+
+        # Convert dob string to datetime object
+        dob_dt = datetime.strptime(dob, "%d %b %Y")  # Adjust format if needed
+        self.click(self.date_of_birth_field)
+        self.calendar_picker.v2_calendar_picker(dob_dt)  # dob should be in a supported format, e.g. "YYYY-MM-DD"
+        self.surname_field.fill(surname)
+        self.forename_field.fill(forename)
+        gender_option = {"Male": "1", "Female": "2"}.get(gender, "1")
+        self.gender_dropdown.select_option(gender_option)
+        self.postcode_field.fill(postcode)
+
+    def perform_search(self) -> None:
+        """
+        Clicks the 'Search' button to initiate the Spine demographic search.
+        """
+        self.click(self.search_button)
+
+    def get_spine_alert_message(self) -> str:
+        """
+        Retrieves the text content of a visible spine alert message from the page.
+
+        This method waits for the alert element with the CSS class `.spine-alert` to become visible
+        within a 5-second timeout. If the alert appears, its inner text is returned after stripping
+        leading and trailing whitespace. If the alert does not appear within the timeout or an unexpected
+        error occurs, an empty string is returned and the error is logged to the console.
+
+        Returns:
+            str: The stripped text of the alert message if visible, otherwise an empty string.
+        """
+        alert_locator = self.page.locator(".spine-alert")
+        try:
+            alert_locator.wait_for(state="visible", timeout=5000)
+            return alert_locator.inner_text().strip()
+        except TimeoutError:
+            print("Alert message not visible within timeout.")
+            return ""
+        except Exception as e:
+            print(f"Unexpected error while fetching alert: {e}")
+            return ""

pytest.ini

@@ -49,3 +49,4 @@ markers =
     bcss_additional_tests: tests that are part of the BCSS additional tests test suite
     colonoscopy_dataset_tests: tests that are part of the colonoscopy datasets test suite
     fobt_diagnosis_date_entry_tests: tests that are part of fobt subject episodes record diagnosis date
+    spine_retrieval_search_tests: tests that are part of subject spine retrieval demographics

tests/regression/subject_diagnosis_date/test_subject_episodes_diagnosis_spine_retrieval.py

@@ -0,0 +1,35 @@
+import pytest
+from playwright.sync_api import Page, expect
+from utils.user_tools import UserTools
+from pages.base_page import BasePage
+from pages.screening_subject_search.subject_spine_retrieval_search_page import SpineSearchPage
+from pages.screening_subject_search.subject_screening_summary_page import SubjectScreeningSummaryPage
+
+@pytest.mark.regression
+@pytest.mark.spine_retrieval_search_tests
+def test_user_can_search_for_subject_spine_retrieval(page: Page) -> None:
+    """
+    Tests to ensure that Spine searching is enabled for English users.
+    """
+    # Step 1: Log in as Hub Manager - State Registered (England)
+    UserTools.user_login(page, "Hub Manager State Registered at BCS01")
+    BasePage(page).go_to_screening_subject_search_page()
+
+    # Step 2: Perform spine demographic search
+    spine_page = SpineSearchPage(page)
+    spine_page_summary = SubjectScreeningSummaryPage(page)
+    spine_page_summary.navigate_to_spine_search()
+    spine_page.select_demographic_search()
+    spine_page.enter_search_criteria(
+        dob="06 May 1940",
+        surname="vickers",
+        forename="rob",
+        gender="Male",
+        postcode="ex25se"
+    )
+    spine_page.perform_search()
+
+    # Step 3: Assert in-page alert message
+    alert_message = spine_page.get_spine_alert_message()
+    assert not alert_message, f"Unexpected alert shown: '{alert_message}'"
+    f"Expected alert message not found. Got: '{alert_message}'"

utils/calendar_picker.py

@@ -302,7 +302,7 @@ def v2_calendar_picker_traverse_forward(
         if click_decade:
             self.click(self.page.get_by_text(str(decade), exact=True).first)
         if click_year:
-            self.click(self.page.get_by_text(str(year), exact=True))
+            self.click(self.page.locator("span.year", has_text=str(year)).first)
         if click_month:
             self.click(self.page.get_by_text(str(month_short)))