Feature/bcss 20589 new regression release standard tests (#123)

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

## Context

<!-- Why is this change required? What problem does it solve? -->
As per JIRA Ticket, BCSS - 20589 New Code is implemented & also existing
code is Refactored in below files.
1) subject_diagnosis_date/test_subject_hub_user_national.py
2) utils/screening_subject_page_searcher.py
3) pytest.ini

## 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)
- [X] 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.

---------

Co-authored-by: AndyG <[email protected]>

Author: vidhya-chandra1

pages/alerts/alerts_page.py

@@ -0,0 +1,16 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+
+
+class AlertsPage(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.refresh_alerts_link = self.page.get_by_role("link", name="Refresh alerts")
+
+    def click_refresh_alerts(self) -> None:
+        """Clicks the 'Refresh Alerts' link to trigger an update of alert messages."""
+        self.refresh_alerts_link.click()
+
+    def is_refresh_alerts_visible(self, timeout=5000) -> bool:
+        """Returns True if the 'Refresh Alerts' link is visible within the given timeout."""
+        return self.refresh_alerts_link.is_visible(timeout=timeout)

pages/gfobt_test_kits/gfobt_test_kits_page.py

@@ -8,7 +8,7 @@ class GFOBTTestKitsPage(BasePage):
     def __init__(self, page: Page):
         super().__init__(page)
         self.page = page
-
+        self.test_kits_header = self.page.get_by_text("gFOBT Test Kits")
         self.test_kit_logging_page = self.page.get_by_role(
             "link", name="Test Kit Logging"
         )
@@ -35,3 +35,9 @@ def go_to_test_kit_result_page(self) -> None:
     def go_to_create_qc_kit_page(self) -> None:
         """Navigate to the Create QC Kit page."""
         self.click(self.create_qc_kit_page)
+
+    def open_test_kits_report(self) -> None:
+        """Clicks the 'Test Kits' header to open the corresponding report section."""
+        self.click(self.test_kits_header)
+
+

pages/organisations/organisations_page.py

@@ -2,11 +2,29 @@
 from pages.base_page import BasePage
 from typing import List
 
+
 class OrganisationsPage(BasePage):
     """Organisations Page locators, and methods for interacting with the page."""
 
     def __init__(self, page: Page):
         super().__init__(page)
+        self.page = page
+        self.org_and_site_details_link = self.page.get_by_role(
+            "link", name="Organisation and Site Details"
+        )
+        self.list_all_orgs_link = self.page.get_by_role(
+            "link", name="List All Organisations"
+        )
+        self.list_all_sites_link = self.page.get_by_role("link", name="List All Sites")
+        self.surveillance_link = self.page.get_by_role(
+            "link", name="Surveillance", exact=True
+        )
+        self.manage_surveillance_review_link = self.page.get_by_role(
+            "link", name="Manage Surveillance Review"
+        )
+        self.surveillance_review_summary_header = self.page.get_by_text(
+            "Surveillance Review Summary"
+        )
 
         # Organisations page links
         self.screening_centre_parameters_page = self.page.get_by_role(
@@ -50,6 +68,21 @@ def go_to_bureau_page(self) -> None:
         """Clicks the 'Bureau' link."""
         self.click(self.bureau_page)
 
+    def navigate_to_surveillance_review_summary(self) -> None:
+        """Navigates through the organisation pages to the Surveillance Review Summary."""
+        self.click(self.org_and_site_details_link)
+        self.click(self.list_all_orgs_link)
+        self.click_back_button()
+        self.click(self.list_all_sites_link)
+        for _ in range(3):
+            self.click_back_button()
+        self.click(self.surveillance_link)
+        self.click(self.manage_surveillance_review_link)
+        self.page.goto(
+            "https://bcss-bcss-18680-ddc-bcss.k8s-nonprod.texasplatform.uk/surveillance/review/summary"
+        )
+
+
 class OrganisationSwitchPage:
     """Page Object Model for interacting with the Organisation Switch page."""
 
@@ -120,5 +153,3 @@ def get_logged_in_text(self) -> str:
             str: The text indicating the logged-in user's role or name.
         """
         return self.login_info.inner_text()
-
-

pages/screening_practitioner_appointments/screening_practitioner_appointments_page.py

@@ -10,6 +10,8 @@ def __init__(self, page: Page):
         self.page = page
         # ScreeningPractitionerAppointments Page
         self.log_in_page = self.page.get_by_role("button", name="Log in")
+        self.appointments_header = self.page.get_by_text("Screening Practitioner Appointments")
+
         self.view_appointments_page = self.page.get_by_role(
             "link", name="View appointments"
         )
@@ -43,3 +45,9 @@ def go_to_patients_that_require_page(self) -> None:
     def go_to_set_availability_page(self) -> None:
         """Click on the Set Availability link to navigate to the set availability page."""
         self.click(self.set_availability_link)
+
+    def open_appointments_report(self) -> None:
+        """Clicks the 'Appointments' header to open the related report section."""
+        self.click(self.appointments_header)
+
+

pages/screening_subject_search/subject_screening_search_page.py

@@ -3,6 +3,7 @@
 from pages.base_page import BasePage
 from enum import Enum
 from utils.calendar_picker import CalendarPicker
+from typing import Optional
 
 
 class SubjectScreeningPage(BasePage):
@@ -65,6 +66,13 @@ def __init__(self, page: Page):
             "textarea[data-testid='reasonNote']"
         )
 
+        self.surname_field = self.page.locator("#A_C_Surname")
+        self.forename_field = self.page.locator("#A_C_Forename")
+        self.screening_status_dropdown = self.page.locator("#A_C_ScreeningStatus")
+        self.episode_status_dropdown = self.page.locator("#A_C_EpisodeStatus")
+        self.search_button = self.page.get_by_role("button", name="Search")
+        self.back_link = self.page.get_by_role("link", name="Back", exact=True)
+
     def click_clear_filters_button(self) -> None:
         """Click the 'Clear Filters' button."""
         self.click(self.clear_filters_button)
@@ -206,6 +214,38 @@ def complete_send_kit_form(
 
         logging.info("[KIT REQUEST] 'Send a kit' form submitted successfully")
 
+    def search_subject_with_args(
+        self,
+        surname: Optional[str] = None,
+        forename: Optional[str] = None,
+        screening_status: Optional[str] = None,
+        episode_status: Optional[str] = None,
+    ) -> None:
+        """
+        Searches for a subject using any combination of the provided criteria.
+
+        Args:
+            surname (Optional[str]): Subject's surname.
+            forename (Optional[str]): Subject's forename.
+            screening_status (Optional[str]): Screening status code.
+            episode_status (Optional[str]): Episode status code.
+        """
+        # Fill in all provided fields before triggering any search
+        if surname:
+            self.surname_field.fill(surname)
+        if forename:
+            self.forename_field.fill(forename)
+        if screening_status:
+            self.screening_status_dropdown.select_option(screening_status)
+            self.click(self.screening_status_dropdown)
+        if episode_status:
+            self.episode_status_dropdown.select_option(episode_status)
+
+        # Only click search if at least one field was filled
+        if any([surname, forename, screening_status, episode_status]):
+            self.click(self.search_button)
+            self.click(self.back_link)
+
 
 class ScreeningStatusSearchOptions(Enum):
     """Enum for Screening Status Search Options"""

pages/surveillance/surveillance_summary_review_page.py

@@ -0,0 +1,39 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+
+
+class SurveillanceSummaryPage(BasePage):
+    """Page object for navigating to and interacting with the Surveillance Review Summary section."""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+
+        # Locators
+        self.org_and_site_details_link = self.page.get_by_role(
+            "link", name="Organisation and Site Details"
+        )
+        self.list_all_orgs_link = self.page.get_by_role(
+            "link", name="List All Organisations"
+        )
+        self.list_all_sites_link = self.page.get_by_role("link", name="List All Sites")
+        self.surveillance_link = self.page.get_by_role(
+            "link", name="Surveillance", exact=True
+        )
+        self.manage_surveillance_review_link = self.page.get_by_role(
+            "link", name="Manage Surveillance Review"
+        )
+        self.surveillance_review_summary_header = self.page.get_by_text(
+            "Surveillance Review Summary"
+        )
+        self.back_link = self.page.get_by_role("link", name="Back", exact=True)
+
+    def navigate_to_surveillance_review_summary(self):
+        """Navigates through multiple UI steps to reach the Surveillance Review Summary section."""
+        self.click(self.org_and_site_details_link)
+        self.click(self.list_all_orgs_link)
+        self.click(self.back_link)
+        self.click(self.list_all_sites_link)
+        for _ in range(3):
+            self.click(self.back_link)
+        self.click(self.surveillance_link)
+        self.click(self.manage_surveillance_review_link)

pytest.ini

@@ -53,4 +53,5 @@ markers =
     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
+    hub_user_tests: tests that are part of the hub user test suite
     fobt_regression_tests: tests that are part of the fobt regression test suite

tests/regression/subject_diagnosis_date/test_subject_hub_user_national.py

@@ -0,0 +1,105 @@
+import pytest
+from playwright.sync_api import Page, expect
+from utils.user_tools import UserTools
+from pages.base_page import BasePage
+from pages.alerts.alerts_page import AlertsPage
+from pages.gfobt_test_kits.gfobt_test_kits_page import GFOBTTestKitsPage
+from pages.screening_practitioner_appointments.screening_practitioner_appointments_page import (
+    ScreeningPractitionerAppointmentsPage,
+)
+from pages.screening_subject_search.subject_screening_search_page import (
+    SubjectScreeningPage,
+)
+from pages.surveillance.surveillance_summary_review_page import SurveillanceSummaryPage
+
+
+# Scenario 1
+@pytest.mark.regression
+@pytest.mark.hub_user_tests
+def test_hub_user_alerts_populated(page: Page) -> None:
+    """
+    Scenario: Hub User - Alerts populated
+    This test ensures that the alerts have at least been populated for the user within a reasonable amount of time.
+    """
+    # Step 1: Log in as Hub Manager - State Registered (England)
+    UserTools.user_login(page, "Hub Manager State Registered at BCS01")
+    BasePage(page).click_refresh_alerts_link()
+
+    # Step 2: Assert the refresh alerts button is visible
+    alerts_page = AlertsPage(page)
+    alerts_page.click_refresh_alerts()
+    expect(alerts_page.refresh_alerts_link).to_be_visible(timeout=5000)
+
+
+# Scenario 2
+@pytest.mark.regression
+@pytest.mark.hub_user_tests
+def test_hub_user_kits_logged_not_read_report(page: Page) -> None:
+    """
+    Scenario: Hub User - Kits Logged Not Read report
+    This test ensures that if available, the Kits Logged Not Read report loads within a reasonable amount of time.
+    """
+    # Step 1: Log in as Hub Manager - State Registered (England)
+    UserTools.user_login(page, "Hub Manager State Registered at BCS01")
+    BasePage(page).go_to_gfobt_test_kits_page()
+
+    # Step 2: Assert the Kits Logged Not Read report loads as expected
+    test_kits_page = GFOBTTestKitsPage(page)
+    test_kits_page.open_test_kits_report()
+    expect(test_kits_page.test_kits_header).to_be_visible(timeout=5000)
+
+
+# Scenario 3
+@pytest.mark.regression
+@pytest.mark.hub_user_tests
+def test_hub_user_people_requiring_colonoscopy_assessment_report(page: Page) -> None:
+    """
+    Scenario: Hub User - People Requiring Colonoscopy Assessment report
+    This test ensures that if available, the People Requiring Colonoscopy Assessment report loads within a reasonable amount of time.
+    """
+    # 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_practitioner_appointments_page()
+
+    # Step 2: Assert the People Requiring Colonoscopy Assessment report loads as expected
+    appointments_page = ScreeningPractitionerAppointmentsPage(page)
+    appointments_page.open_appointments_report()
+    expect(appointments_page.appointments_header).to_be_visible(timeout=5000)
+
+
+# Scenario 4
+@pytest.mark.regression
+@pytest.mark.hub_user_tests
+def test_screening_centre_user_subject_search_and_summary(page: Page) -> None:
+    """
+    Scenario: Screening Centre User - Subject Search & Subject Summary
+    This test ensures that the subject search works as expected and the subject summary loads and displays data correctly
+    """
+    # Step 1: Log in as Screening Centre Manager (England)
+    UserTools.user_login(page, "Screening Centre Manager at BCS001")
+    BasePage(page).go_to_screening_subject_search_page()
+
+    # Step 2: Use POM for subject search
+    search_page = SubjectScreeningPage(page)
+    """screening_status=4004 value represents 'Recall' & episode_status=2 value represents 'Closed'"""
+    search_page.search_subject_with_args(
+        surname="A*", forename="A*", screening_status="4004", episode_status="2"
+    )
+
+
+# Scenario 5
+@pytest.mark.regression
+@pytest.mark.hub_user_tests
+def test_screening_centre_user_subject_search_and_surveillance(page: Page) -> None:
+    """
+    Scenario: Screening Centre User - Organisation Search & Surveillance Review Summary
+    This test ensures that the organisation search works as expected and the surveillance review summary loads and displays data correctly
+    """
+    # Step 1: Log in as Screening Centre Manager (England)
+    UserTools.user_login(page, "Screening Centre Manager at BCS001")
+    BasePage(page).go_to_organisations_page()
+
+    # Step 2: Use POM for navigation and assertion
+    sur_page = SurveillanceSummaryPage(page)
+    sur_page.navigate_to_surveillance_review_summary()
+    expect(sur_page.surveillance_review_summary_header).to_be_visible(timeout=5000)