Feature/bcss 21278 selenium to playwright regression test setup (#121)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description

<!-- Describe your changes in detail. -->
Migrating the scenarios from RegressionTestSetupSteps.feature in the
playwright repo

## Context

<!-- Why is this change required? What problem does it solve? -->
Migrating the scenarios from RegressionTestSetupSteps.feature in the
playwright repo

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

Author: adrianoaru-nhs

pages/contacts_list/edit_contact_page.py

@@ -0,0 +1,33 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from utils.table_util import TableUtils
+
+
+class EditContactPage(BasePage):
+    """Edit Contact Page locators, and methods for interacting with the page"""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        # Edit Contact - page locators, methods
+        self.view_resect_and_discard_link = self.page.get_by_role(
+            "link", name="View Resect and Discard"
+        )
+
+        self.edit_contact_table = TableUtils(self.page, "#displayRS")
+
+    def click_view_resect_and_discard_link(self) -> None:
+        """Clicks on the 'View Resect and Discard' link"""
+        self.click(self.view_resect_and_discard_link)
+
+    def assert_value_for_label_in_edit_contact_table(
+        self, label_text: str, expected_text: str
+    ) -> None:
+        """
+        Asserts that the vlaue for a label is as expected in the edit contact table
+
+        Args:
+            label_text (str): The label text to look for in the first cell of a row.
+            expected_text (str): The text expected inside the adjacent cell.
+        """
+        self.edit_contact_table.verify_value_for_label(label_text, expected_text)

pages/contacts_list/maintain_contacts_page.py

@@ -1,5 +1,6 @@
-from playwright.sync_api import Page, expect
+from playwright.sync_api import Page
 from pages.base_page import BasePage
+from utils.table_util import TableUtils
 
 
 class MaintainContactsPage(BasePage):
@@ -10,6 +11,57 @@ def __init__(self, page: Page):
         self.page = page
         # Maintain Contacts - page locators, methods
 
+        self.surname_input_field = self.page.locator("#selPersonSurname")
+        self.forenames_input_field = self.page.locator("#selPersonForenames")
+        self.user_code_input_field = self.page.locator("#selUserCode")
+        self.search_button = self.page.get_by_role("button", name="Search")
+
+        self.search_table = TableUtils(self.page, "#displayRS")
+
     def verify_maintain_contacts_title(self) -> None:
         """Verify the Maintain Contacts page title is displayed correctly"""
         self.bowel_cancer_screening_page_title_contains_text("Maintain Contacts")
+
+    def fill_surname_input_field(self, surname: str) -> None:
+        """
+        Fill the surname input field with the provided surname
+        Args:
+            surname (str): The surname of the subject
+        """
+        self.surname_input_field.fill(surname)
+
+    def fill_forenames_input_field(self, forenames: str) -> None:
+        """
+        Fill the forenames input field with the provided forenames
+        Args:
+            forenames (str): The forenames of the subject
+        """
+        self.forenames_input_field.fill(forenames)
+
+    def fill_user_code_input_field(self, user_code: str) -> None:
+        """
+        Fill the user code input field with the provided user code
+        Args:
+            user_code (str): The user code of the subject
+        """
+        self.user_code_input_field.fill(user_code)
+
+    def click_search_button(self) -> None:
+        """Click the search button to perform a search"""
+        self.click(self.search_button)
+
+    def click_person_link_from_surname(self, surname: str) -> None:
+        """
+        Clicks on the link containing the person's surname to go to the edit contact page
+        Args:
+            surname (str): The surname of the subject
+        """
+        self.click(self.page.get_by_role("link", name=surname).last)
+
+    def click_person_link_from_forename(self, forename: str) -> None:
+        """
+        Clicks on the link containing the person's surname to go to the edit contact page
+        Args:
+            forename (str): The forename of the subject
+        """
+        self.click(self.page.get_by_role("link", name=forename).last)

pages/contacts_list/resect_and_discard_accreditation_history_page.py

@@ -0,0 +1,52 @@
+from playwright.sync_api import Page, expect
+from datetime import datetime
+from pages.base_page import BasePage
+from utils.calendar_picker import CalendarPicker
+
+
+class ResectAndDiscardAccreditationHistoryPage(BasePage):
+    """Resect And Discard Accreditation History Page locators, and methods for interacting with the page"""
+
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        # Resect And Discard Accreditation History - page locators, methods
+        self.heading = self.page.get_by_role("heading", name="Resect and Discard")
+        self.add_accreditation_button = self.page.get_by_role(
+            "button", name="+ Add Accreditation"
+        )
+        self.save_button = self.page.get_by_role("button", name="Save")
+        self.changes_saved_text = self.page.get_by_text("×Saved Changes")
+
+    def verify_heading_is_correct(self) -> None:
+        """Verifies the heading is visible and contains 'View Resect and Discard'"""
+        expect(self.heading).to_be_visible()
+
+    def verify_add_accreditation_button_exists(self) -> None:
+        """Verifies that the 'Add Accreditation' button exists"""
+        expect(self.add_accreditation_button).to_be_visible()
+
+    def click_add_accreditation_button(self) -> None:
+        """Clicks the 'Add Accreditation' button"""
+        self.click(self.add_accreditation_button)
+
+    def click_save_button(self) -> None:
+        """Clicks the 'Save' button"""
+        self.click(self.save_button)
+
+    def verify_changes_saved(self) -> None:
+        """Verifies the new period added has been saved"""
+        expect(self.changes_saved_text).to_be_visible()
+
+    def add_new_period_of_resect_and_discard_accerditation(
+        self, date: datetime
+    ) -> None:
+        """
+        Adds a new period of resect and discard accreditation
+        Args:
+            date (datetime): The date the period starts
+        """
+        self.click_add_accreditation_button()
+        CalendarPicker(self.page).v2_calendar_picker(date)
+        self.click_save_button()
+        self.verify_changes_saved()

tests/regression/regression_tests/test_regression_test_setup_steps.py

@@ -0,0 +1,97 @@
+import pytest
+import logging
+from datetime import datetime, timedelta
+from dateutil.relativedelta import relativedelta
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from pages.contacts_list.contacts_list_page import ContactsListPage
+from pages.contacts_list.maintain_contacts_page import MaintainContactsPage
+from pages.contacts_list.edit_contact_page import EditContactPage
+from pages.contacts_list.resect_and_discard_accreditation_history_page import (
+    ResectAndDiscardAccreditationHistoryPage,
+)
+from pages.logout.log_out_page import LogoutPage
+from utils.user_tools import UserTools
+from utils.oracle.oracle_specific_functions import (
+    set_org_parameter_value,
+    check_parameter,
+    build_accredited_screening_colonoscopist_query,
+    get_accredited_screening_colonoscopist_in_bcs001,
+)
+
+
+def test_allow_10_minute_colonsocopy_assessment_appointments(
+    page: Page, general_properties: dict
+) -> None:
+    """
+    Scenario: 1: Allow 10 minute colonoscopy assessment appointments between 7am and 8pm at BCS001
+
+    Given I log in to BCSS "England" as user role "Screening Centre Manager"
+        And I set the value of parameter 12 to "10" for my organisation with immediate effect
+        And I set the value of parameter 28 to "07:00" for my organisation with immediate effect
+        And I set the value of parameter 29 to "20:00" for my organisation with immediate effect
+    """
+    UserTools.user_login(page, "Screening Centre Manager at BCS001")
+    org_id = general_properties["eng_screening_centre_id"]
+    param_12_set_correctly = check_parameter(12, org_id, "10")
+    param_28_set_correctly = check_parameter(28, org_id, "07:00")
+    param_29_set_correctly = check_parameter(29, org_id, "20:00")
+    if not param_12_set_correctly:
+        set_org_parameter_value(12, "10", org_id)
+    if not param_28_set_correctly:
+        set_org_parameter_value(28, "07:00", org_id)
+    if not param_29_set_correctly:
+        set_org_parameter_value(29, "20:00", org_id)
+
+    LogoutPage(page).log_out()
+
+
+def test_asc_with_current_resect_and_discard_accreditation(
+    page: Page,
+) -> None:
+    """
+    Scenario: 2: Ensure there is an Accredited Screening Colonoscopist with current Resect & Discard accreditation
+    """
+    UserTools.user_login(page, "BCSS Bureau Staff at X26")
+
+    current_df = build_accredited_screening_colonoscopist_query("Current")
+    if current_df.empty:
+        pytest.skip(
+            "No Accredited Screening Colonoscopist with current Resect & Discard accreditation found."
+        )
+    expired_df = build_accredited_screening_colonoscopist_query("Expiring soon")
+    if expired_df.empty:
+        pytest.skip(
+            "No Accredited Screening Colonoscopist with expiring Resect & Discard accreditation found."
+        )
+    person_df = get_accredited_screening_colonoscopist_in_bcs001()
+    if person_df.empty:
+        pytest.fail("No Accredited Screening Colonoscopist found in the database.")
+
+    BasePage(page).go_to_contacts_list_page()
+    ContactsListPage(page).go_to_maintain_contacts_page()
+
+    surname = person_df.iloc[0]["person_family_name"]
+    forename = person_df.iloc[0]["person_given_name"]
+    MaintainContactsPage(page).fill_surname_input_field(surname)
+    MaintainContactsPage(page).fill_forenames_input_field(forename)
+    MaintainContactsPage(page).click_search_button()
+    MaintainContactsPage(page).click_person_link_from_surname(surname)
+
+    EditContactPage(page).click_view_resect_and_discard_link()
+    ResectAndDiscardAccreditationHistoryPage(page).verify_heading_is_correct()
+    ResectAndDiscardAccreditationHistoryPage(
+        page
+    ).verify_add_accreditation_button_exists()
+    yesterday = datetime.today() - timedelta(days=1)
+    ResectAndDiscardAccreditationHistoryPage(
+        page
+    ).add_new_period_of_resect_and_discard_accerditation(date=yesterday)
+
+    BasePage(page).click_back_button()
+    end_date = yesterday + relativedelta(years=2)
+    EditContactPage(page).assert_value_for_label_in_edit_contact_table(
+        "Resect & Discard Accreditation?",
+        f"Current: ends {end_date.strftime('%d/%m/%Y')}",
+    )
+    logging.info(f"Test person used in this scenario is: {forename} {surname}")

tests/regression/subject/episodes/datasets/investigation/endoscopy/polypcategories/test_setup.py

@@ -50,7 +50,7 @@
     update_kit_service_management_entity,
     execute_fit_kit_stored_procedures,
     set_org_parameter_value,
-    get_org_parameter_value,
+    check_parameter,
 )
 from utils.oracle.subject_selection_query_builder import SubjectSelectionQueryBuilder
 from utils.screening_subject_page_searcher import (
@@ -173,30 +173,6 @@ def test_setup_subjects_as_a259(page: Page, subjects_to_run_for: int) -> None:
     LogoutPage(page).log_out()
 
 
-def check_parameter(param_id: int, org_id: str, expected_param_value: str) -> bool:
-    """
-    Check if the organization parameter is set correctly.
-    Args:
-        param_id (int): The ID of the parameter to check.
-        org_id (str): The ID of the organization.
-        expected_param_value (str): The expected value of the parameter.
-
-    Returns:
-        bool: True if the parameter is set correctly, False otherwise.
-    """
-    df = get_org_parameter_value(param_id, org_id)
-    for _, row in df.iterrows():
-        val_matches = str(row["val"]) == expected_param_value
-        audit_reason_matches = row["audit_reason"] == "AUTOMATED TESTING - ADD"
-
-        if val_matches and audit_reason_matches:
-            logging.info(f"Parameter {param_id} is set correctly: {row['val']}")
-            return True
-
-    logging.warning(f"Parameter {param_id} is not set correctly, updating parameter.")
-    return False
-
-
 def setup_appointments(page: Page) -> None:
     """
     Set up appointments for multiple practitioners at a screening centre.

users.json

@@ -110,5 +110,11 @@
     "roles": [
       "Wolverhampton SC"
     ]
+  },
+  "BCSS Bureau Staff at X26": {
+    "username": "BCSS33",
+    "roles": [
+      "BCSS Bureau Staff at X26"
+    ]
   }
 }