Code Refactoring is Implemented for JIRA Ticket - https://nhsd-jira.d… (#96)

BCSS-20611 - Selenium to Playwright - Regression Tests - Subject -
Subject Search

<!-- markdownlint-disable-next-line first-line-heading -->
## Description
Selenium to Playwright - Regression Tests - Subject - Subject Search

<!-- Describe your changes in detail. -->

## Context

<!-- Why is this change required? What problem does it solve? -->
Feature: Subject Search Screen

Scenario: User can search for a subject and results are returned (#?)
Given I log in to BCSS "England" as user role "Hub Manager - State
Registered"
When I navigate to the Subject Search Criteria Page
    And I add value "S*" to the "Surname" search field
    And I click the search button on the subject search criteria page
Then Some subject search criteria results are returned

## 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_search_page.py

@@ -10,6 +10,8 @@ class SubjectScreeningPage(BasePage):
     def __init__(self, page: Page):
         super().__init__(page)
         self.page = page
+        self.results_table_locator = "table#subject-search-results"
+
         # Subject Search Criteria - page filters
         self.episodes_filter = self.page.get_by_role("radio", name="Episodes")
         self.demographics_filter = self.page.get_by_role("radio", name="Demographics")
@@ -149,6 +151,7 @@ def select_dob_using_calendar_picker(self, date) -> None:
         CalendarPicker(self.page).v1_calender_picker(date)
 
     def verify_date_of_birth_filter_input(self, expected_text: str) -> None:
+        """Verifies that the Date of Birth filter input field has the expected value."""
         expect(self.date_of_birth_filter).to_have_value(expected_text)
 
 

tests/regression/subject_search_criteria/test_screening_subject_search_criteria_page_regression.py

@@ -0,0 +1,34 @@
+import pytest
+from playwright.sync_api import Page
+from utils.user_tools import UserTools
+from utils.table_util import TableUtils
+from pages.base_page import BasePage
+from utils.screening_subject_page_searcher import search_subject_by_surname
+from pages.screening_subject_search.subject_screening_search_page import (
+    SubjectScreeningPage,
+)
+
+@pytest.mark.regression
+@pytest.mark.subject_search
+def test_user_can_search_for_subject_and_results_are_returned(page: Page):
+    """
+    Verify that User can log in to BCSS "England" as user role "Hub Manager - State Registered"
+    Navigate it to the Subject Search Criteria Page & added value "S*" to the "Surname" search field
+    Clicking on the search button on the subject search criteria page
+    Then Verifies that search results contain Surnames beginning with S
+    """
+
+    # Log in as Hub Manager - State Registered (England)
+    UserTools.user_login(page, "Hub Manager State Registered at BCS01")
+
+    # Navigate to the Subject Search Criteria Page
+    BasePage(page).go_to_screening_subject_search_page()
+
+    # Add value "S*" to the "Surname" search field
+    # click search button on the subject search criteria page
+    search_subject_by_surname(page, "S*")
+
+    # Assert that some results are returned with the surname starting with "S*"
+    TableUtils(
+        page, SubjectScreeningPage(page).results_table_locator
+    ).assert_surname_in_table("S*")

utils/table_util.py

@@ -234,3 +234,26 @@ def get_cell_value(self, column_name: str, row_index: int) -> str:
             raise ValueError(
                 f"No cell found at column '{column_name}' and row index {row_index}"
             )
+
+    def assert_surname_in_table(self, surname_pattern):
+        """
+        Asserts that a surname matching the given pattern exists in the table.
+        Args:
+            surname_pattern (str): The surname or pattern to search for (supports '*' as a wildcard at the end).
+        """
+        # Locate all surname cells (adjust selector as needed)
+        surname_criteria = self.page.locator(
+            "//table//tr[position()>1]/td[3]"
+        )  # Use the correct column index
+        if surname_pattern.endswith("*"):
+            prefix = surname_pattern[:-1]
+            found = any(
+                cell.inner_text().startswith(prefix)
+                for cell in surname_criteria.element_handles()
+            )
+        else:
+            found = any(
+                surname_pattern == cell.inner_text()
+                for cell in surname_criteria.element_handles()
+            )
+        assert found, f"No surname matching '{surname_pattern}' found in table."

utils/user_tools.py

@@ -36,6 +36,27 @@ def user_login(page: Page, username: str) -> None:
             raise ValueError("Environment variable 'BCSS_PASS' is not set")
         CognitoLoginPage(page).login_as_user(user_details["username"], password)
 
+    @staticmethod
+    def get_subject_with_criteria(episode_type, episode_status, has_referral_date, has_diagnosis_date, diagnosis_date_reason):
+        # Example implementation: fetch NHS number from a test data file based on criteria
+        test_data_file = Path(os.getcwd()) / "test_subjects.json"
+        if not test_data_file.exists():
+            # Fallback to dummy NHS number if file does not exist
+            return "1234567890"
+        with open(test_data_file, "r") as file:
+            subjects = json.load(file)
+        for subject in subjects:
+            if (
+                subject.get("episode_type") == episode_type and
+                subject.get("episode_status") == episode_status and
+                subject.get("has_referral_date") == has_referral_date and
+                subject.get("has_diagnosis_date") == has_diagnosis_date and
+                subject.get("diagnosis_date_reason") == diagnosis_date_reason
+            ):
+                return subject.get("nhs_number", "1234567890")
+        # If no match found, then exception is raised
+        raise SubjectNotFoundError("No NHS number found using the provided criteria.")
+
     @staticmethod
     def retrieve_user(user: str) -> dict:
         """
@@ -59,3 +80,7 @@ def retrieve_user(user: str) -> dict:
 
 class UserToolsException(Exception):
     pass
+
+class SubjectNotFoundError(Exception):
+    """Raised when no subject matches the provided criteria."""
+    pass