Feature/bcss 20580 selenium to playwright call and recall (create a plan) (#93)

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

<!-- Describe your changes in detail. -->
Migration of the call and recall (create a plan) tests from Selenium to
Playwright. As part of this PR I have also refactored the Table Util to
be able to extract values from tables with 2 header rows. I have also
added 2 functions to the create_a_plan_page.py.

I will create new branches for the remaining call and recall scenarios
(non-invitation days and generate fobt invitations)

## Context

<!-- Why is this change required? What problem does it solve? -->
This is part of the Selenium to Playwright migration work. 

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

pages/base_page.py

@@ -239,9 +239,30 @@ def safe_accept_dialog(self, locator: Locator) -> None:
         Safely accepts a dialog triggered by a click, avoiding the error:
         playwright._impl._errors.Error: Dialog.accept: Cannot accept dialog which is already handled!
         If no dialog appears, continues without error.
+        Args:
+            locator (Locator): The locator that triggers the dialog when clicked.
+            example: If clicking a save button opens a dialog, pass that save button's locator.
         """
         self.page.once("dialog", self._accept_dialog)
         try:
             self.click(locator)
         except Exception as e:
             logging.error(f"Click failed: {e}")
+
+
+    def assert_dialog_text(self, expected_text: str) -> None:
+        """
+        Asserts that a dialog appears and contains the expected text.
+        If no dialog appears, logs an error.
+        Args:
+            expected_text (str): The text that should be present in the dialog.
+        """
+
+        def handle_dialog(dialog):
+            actual_text = dialog.message
+            assert (
+                actual_text == expected_text
+            ), f"Expected '{expected_text}', but got '{actual_text}'"
+            dialog.dismiss()  # Dismiss dialog
+
+        self.page.once("dialog", handle_dialog)

pages/call_and_recall/create_a_plan_page.py

@@ -1,5 +1,6 @@
 from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
+from utils.table_util import TableUtils
 
 
 class CreateAPlanPage(BasePage):
@@ -23,6 +24,20 @@ def __init__(self, page: Page):
         self.save_note_button = self.page.locator("#saveNote").get_by_role(
             "button", name="Save"
         )
+        # Create A Plan Table Locators
+        self.weekly_invitation_rate_field_on_table = self.page.locator(
+            "#invitationPlan > tbody > tr:nth-child(1) > td.input.border-right.dt-type-numeric > input"
+        )
+        self.invitations_sent_value = self.page.locator(
+            "tbody tr:nth-child(1) td:nth-child(8)"
+        )
+
+        self.resulting_position_value = self.page.locator(
+            "#invitationPlan > tbody > tr:nth-child(1) > td:nth-child(9)"
+        )
+
+        # Initialize TableUtils for different tables
+        self.create_a_plan_table = TableUtils(page, "#invitationPlan")
 
     def click_set_all_button(self) -> None:
         """Clicks the Set all button to set all values"""
@@ -59,3 +74,106 @@ def click_save_note_button(self) -> None:
     def verify_create_a_plan_title(self) -> None:
         """Verifies the Create a Plan page title"""
         self.bowel_cancer_screening_page_title_contains_text("View a plan")
+
+    def verify_weekly_invitation_rate_for_weeks(
+        self, start_week: int, end_week: int, expected_weekly_rate: str
+    ) -> None:
+        """
+        Verifies that the weekly invitation rate is correctly calculated and displayed for the specified range of weeks.
+
+        Args:
+        start_week (int): The starting week of the range.
+        end_week (int): The ending week of the range.
+        expected_weekly_rate (str): The expected weekly invitation rate.
+        """
+
+        # Verify the rate for the starting week
+        weekly_invitation_rate_selector = "#invitationPlan > tbody > tr:nth-child(2) > td.input.border-right.dt-type-numeric > input"
+        self.page.wait_for_selector(weekly_invitation_rate_selector)
+        weekly_invitation_rate = self.page.locator(
+            weekly_invitation_rate_selector
+        ).input_value()
+
+        assert (
+            weekly_invitation_rate == expected_weekly_rate
+        ), f"Expected weekly invitation rate '{expected_weekly_rate}' for week {start_week} but got '{weekly_invitation_rate}'"
+        # Verify the rate for the specified range of weeks
+        for week in range(start_week + 1, end_week + 1):
+            weekly_rate_locator = f"#invitationPlan > tbody > tr:nth-child({week + 2}) > td.input.border-right.dt-type-numeric > input"
+
+            # Wait for the element to be available
+            self.page.wait_for_selector(weekly_rate_locator)
+
+            # Get the input value safely
+            weekly_rate_element = self.page.locator(weekly_rate_locator)
+            assert (
+                weekly_rate_element.is_visible()
+            ), f"Week {week} rate element not visible"
+
+            # Verify the value
+            actual_weekly_rate = weekly_rate_element.input_value()
+            assert (
+                actual_weekly_rate == expected_weekly_rate
+            ), f"Week {week} invitation rate should be '{expected_weekly_rate}', but found '{actual_weekly_rate}'"
+
+            # Get the text safely
+        # Get the frame first
+        frame = self.page.frame(
+            url="https://bcss-bcss-18680-ddc-bcss.k8s-nonprod.texasplatform.uk/invitation/plan/23159/23162/create"
+        )
+
+        # Ensure the frame is found before proceeding
+        assert frame, "Frame not found!"
+
+        # Now locate the input field inside the frame and get its value
+        weekly_invitation_rate_selector = "#invitationPlan > tbody > tr:nth-child(2) > td.input.border-right.dt-type-numeric > input"
+        weekly_invitation_rate = frame.locator(
+            weekly_invitation_rate_selector
+        ).input_value()
+
+        # Assert the expected value
+        assert (
+            weekly_invitation_rate == expected_weekly_rate
+        ), f"Week 2 invitation rate should be '{expected_weekly_rate}', but found '{weekly_invitation_rate}'"
+
+    def increment_invitation_rate_and_verify_changes(self) -> None:
+        """
+        Increments the invitation rate by 1, then verifies that both the
+        'Invitations Sent' has increased by 1 and 'Resulting Position' has decreased by 1.
+        """
+        # Capture initial values before any changes
+        initial_invitations_sent = int(self.invitations_sent_value.inner_text().strip())
+        initial_resulting_position = int(
+            self.resulting_position_value.inner_text().strip()
+        )
+
+        # Increment the invitation rate
+        current_rate = int(
+            self.create_a_plan_table.get_cell_value("Invitation Rate", 1)
+        )
+        new_rate = str(current_rate + 1)
+        self.weekly_invitation_rate_field_on_table.fill(new_rate)
+        self.page.keyboard.press("Tab")
+
+        # Wait dynamically for updates
+        expect(self.invitations_sent_value).to_have_text(
+            str(initial_invitations_sent + 1)
+        )
+        expect(self.resulting_position_value).to_have_text(
+            str(initial_resulting_position + 1)
+        )
+
+        # Capture updated values
+        updated_invitations_sent = int(self.invitations_sent_value.inner_text().strip())
+        updated_resulting_position = int(
+            self.resulting_position_value.inner_text().strip()
+        )
+
+        # Assert changes
+        assert (
+            updated_invitations_sent == initial_invitations_sent + 1
+        ), f"Expected Invitations Sent to increase by 1. Was {initial_invitations_sent}, now {updated_invitations_sent}."
+
+        assert (
+            updated_resulting_position == initial_resulting_position + 1
+        ), f"Expected Resulting Position to increase by 1. Was {initial_resulting_position}, now {updated_resulting_position}."

pages/call_and_recall/non_invitations_days_page.py

@@ -1,5 +1,6 @@
 from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
+from utils.date_time_utils import DateTimeUtils
 
 
 class NonInvitationDaysPage(BasePage):
@@ -9,7 +10,54 @@ def __init__(self, page: Page):
         super().__init__(page)
         self.page = page
         # Non Invitation Days - page locators, methods
+        self.enter_note_field = self.page.get_by_role("textbox", name="note")
+        self.enter_date_field = self.page.get_by_role("textbox", name="date")
+        self.add_non_invitation_day_button = self.page.get_by_role(
+            "button", name="Add Non-Invitation Day"
+        )
+        self.non_invitation_day_delete_button = self.page.get_by_role(
+            "button", name="Delete"
+        )
+        self.created_on_date_locator = self.page.locator("#displayRS")
 
     def verify_non_invitation_days_tile(self) -> None:
         """Verifies the page title of the Non Invitation Days page"""
         self.bowel_cancer_screening_page_title_contains_text("Non-Invitation Days")
+
+    def enter_date(self, date: str) -> None:
+        """Enters a date in the date input field
+        Args:
+            date (str): The date to enter in the field, formatted as 'dd/mm/yyyy'.
+        """
+        self.enter_date_field.fill(date)
+
+    def enter_note(self, note: str) -> None:
+        """Enters a note in the note input field
+        Args:
+            note (str): The note to enter in the field.
+        """
+        self.enter_note_field.fill(note)
+
+    def click_add_non_invitation_day_button(self) -> None:
+        """Clicks the Add Non-Invitation Day button"""
+        self.click(self.add_non_invitation_day_button)
+
+    def click_delete_button(self) -> None:
+        """Clicks the Delete button for a non-invitation day"""
+        self.click(self.non_invitation_day_delete_button)
+
+    def verify_date_is_visible(self) -> None:
+        """Verifies that the specified date is visible on the page
+        Args:
+            date (str): The date to verify, formatted as 'dd/mm/yyyy'.
+        """
+        date = DateTimeUtils.current_datetime("dd/mm/yyyy")
+        expect(self.created_on_date_locator).to_have_text(date)
+
+    def verify_date_is_not_visible(self) -> None:
+        """Verifies that the specified date is not visible on the page
+        Args:
+            date (str): The date to verify, formatted as 'dd/mm/yyyy'.
+        """
+        date = DateTimeUtils.current_datetime("dd/mm/yyyy")
+        expect(self.created_on_date_locator).not_to_have_text(date)

pytest.ini

@@ -37,3 +37,5 @@ markers =
     compartment6: only for compartment 6
     compartment1_plan_creation: to run the plan creation for compartment 1
     vpn_required: for tests that require a VPN connection
+    regression: tests that are part of the regression test suite
+    call_and_recall: tests that are part of the call and recall test suite

tests/bcss_tests.properties

@@ -21,3 +21,9 @@ forename=Pentagram
 surname=Absurd
 subject_dob=11/01/1934
 episode_closed_date=22/09/2020
+
+# ----------------------------------
+# CALL AND RECALL TEST DATA
+# ----------------------------------
+daily_invitation_rate=28
+weekly_invitation_rate=130

tests/regression/call_and_recall/test_create_a_plan_regression.py

@@ -0,0 +1,109 @@
+import pytest
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+from pages.call_and_recall.call_and_recall_page import CallAndRecallPage
+from pages.call_and_recall.invitations_monitoring_page import InvitationsMonitoringPage
+from pages.call_and_recall.invitations_plans_page import InvitationsPlansPage
+from pages.call_and_recall.create_a_plan_page import CreateAPlanPage
+from utils.user_tools import UserTools
+
+
+@pytest.fixture(scope="function", autouse=True)
+def before_each(page: Page):
+    """
+    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the call and recall page
+    """
+    # Log in to BCSS
+    UserTools.user_login(page, "Hub Manager State Registered at BCS01")
+
+    # Go to call and recall page
+    BasePage(page).go_to_call_and_recall_page()
+
+
+@pytest.mark.regression
+@pytest.mark.call_and_recall
+def test_create_a_plan_set_daily_rate(page: Page, general_properties: dict) -> None:
+    """
+    Verifies that a user is able to click on the Set all button and enter a daily rate.
+    """
+    # When I go to "Invitations Monitoring - Screening Centre"
+    CallAndRecallPage(page).go_to_planning_and_monitoring_page()
+
+    # And I click the link text "BCS001"
+    InvitationsMonitoringPage(page).go_to_invitation_plan_page(
+        general_properties["screening_centre_code"]
+    )
+    # And I click the "Create a Plan" button
+    InvitationsPlansPage(page).go_to_create_a_plan_page()
+
+    # And I click the set all button
+    CreateAPlanPage(page).click_set_all_button()
+
+    # And I enter "28" in the input box with id "dailyRate"
+    CreateAPlanPage(page).fill_daily_invitation_rate_field(
+        general_properties["daily_invitation_rate"]
+    )
+
+    # And I click the "Update" button
+    CreateAPlanPage(page).click_update_button()
+
+    # Then the Weekly Invitation Rate for weeks 1 to 50 is set correctly
+    # based on a set all daily rate of 28
+    CreateAPlanPage(page).verify_weekly_invitation_rate_for_weeks(1, 50, "140")
+
+
+@pytest.mark.regression
+@pytest.mark.call_and_recall
+def test_create_a_plan_weekly_rate(page: Page, general_properties: dict) -> None:
+    """
+    Verifies that a user can set a weekly invitation rate in Create a Plan.
+    """
+
+    # When I go to "Invitations Monitoring - Screening Centre"
+    CallAndRecallPage(page).go_to_planning_and_monitoring_page()
+
+    # And I click the link text "BCS001"
+    InvitationsMonitoringPage(page).go_to_invitation_plan_page(
+        general_properties["screening_centre_code"]
+    )
+    # And I click the "Create a Plan" button
+    InvitationsPlansPage(page).go_to_create_a_plan_page()
+
+    # And I click the set all button
+    CreateAPlanPage(page).click_set_all_button()
+
+    # And I enter "130" in the input box with id "weeklyRate"
+    CreateAPlanPage(page).fill_weekly_invitation_rate_field(
+        general_properties["weekly_invitation_rate"]
+    )
+
+    # And I click the "Update" button
+    CreateAPlanPage(page).click_update_button()
+
+    # And the Weekly Invitation Rate for weeks 1 to 50 is set to the set all weekly rate of 130
+    CreateAPlanPage(page).verify_weekly_invitation_rate_for_weeks(1, 50, "130")
+
+
+@pytest.mark.regression
+@pytest.mark.call_and_recall
+def test_update_invitation_rate_weekly(page: Page, general_properties: dict) -> None:
+    """
+    Verifies that a Hub Manager State Registered is able to update a weekly Invitation rate
+    and the Cumulative 'Invitations sent' and 'Resulting Position' values are updated.
+    """
+
+    # When I go to "Invitations Monitoring - Screening Centre"
+    CallAndRecallPage(page).go_to_planning_and_monitoring_page()
+
+    # And I click the link text "BCS001"
+    InvitationsMonitoringPage(page).go_to_invitation_plan_page(
+        general_properties["screening_centre_code"]
+    )
+
+    # And I click the "Create a Plan" button
+    InvitationsPlansPage(page).go_to_create_a_plan_page()
+
+    # When I increase the Weekly Invitation Rate for week 1 by 1 and tab out of the cell
+    # Then the Cumulative Invitations Sent is incremented by 1 for week 1
+    # And the Cumulative Resulting Position is incremented by 1 for week 1
+    CreateAPlanPage(page).increment_invitation_rate_and_verify_changes()