Feature/bcss 20580 selenium to playwright generate fobt invitations (#95)

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

<!-- Describe your changes in detail. -->
This is part of the selenium to playwright migration and includes the
migration of the generate fobt invitations scenario. Also includes a new
function "open_letter_batch" on the batch_list_page to open a batch on
the table by matching given criteria.

## 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/call_and_recall/generate_invitations_page.py

@@ -91,7 +91,7 @@ def wait_for_invitation_generation_complete(
         value = value.strip()  # Get text and remove extra spaces
         if int(value) < number_of_invitations:
             pytest.fail(
-                f"There are less than {number_of_invitations} invitations generated"
+                f"Expected {number_of_invitations} invitations generated but got {value}"
             )
 
         self_referrals_total_text = self.self_referrals_total.text_content()

pages/communication_production/batch_list_page.py

@@ -93,6 +93,33 @@ def clear_deadline_filter_date(self) -> None:
     def verify_deadline_date_filter_input(self, expected_text: str) -> None:
         expect(self.deadline_date_filter_with_input).to_have_value(expected_text)
 
+    def open_letter_batch(
+        self, batch_type: str, status: str, level: str, description: str
+    ) -> None:
+        """
+        Finds and opens the batch row based on type, status, level, and description.
+        Args:
+            batch_type (str): The type of the batch (e.g., "Original").
+            status (str): The status of the batch (e.g., "Open").
+            level (str): The level of the batch (e.g., "S1").
+            description (str): The description of the batch (e.g., "Pre-invitation (FIT)").
+        """
+        # Step 1: Match the row using nested filters, one per column value
+        row = (
+            self.page.locator("table tbody tr")
+            .filter(has=self.page.locator("td", has_text=batch_type))
+            .filter(has=self.page.locator("td", has_text=status))
+            .filter(has=self.page.locator("td", has_text=level))
+            .filter(has=self.page.locator("td", has_text=description))
+        )
+
+        # Step 2: Click the "View" link in the matched row
+        view_link = row.locator(
+            "a"
+        )  # Click the first link in the row identified in step 1
+        expect(view_link).to_be_visible()
+        view_link.click()
+
 
 class ActiveBatchListPage(BatchListPage):
     """Active Batch List Page locators, and methods for interacting with the Active Batch List page"""

tests/bcss_tests.properties

@@ -25,5 +25,5 @@ episode_closed_date=22/09/2020
 # ----------------------------------
 # CALL AND RECALL TEST DATA
 # ----------------------------------
-daily_invitation_rate=28
+daily_invitation_rate=6
 weekly_invitation_rate=130

tests/regression/call_and_recall/test_generate_fobt_invitation_regression.py

@@ -1,12 +1,16 @@
 import pytest
 from playwright.sync_api import Page
+import logging
 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.generate_invitations_page import GenerateInvitationsPage
-from pages.call_and_recall.non_invitations_days_page import NonInvitationDaysPage
-from pages.call_and_recall.invitations_plans_page import InvitationsPlansPage
-from pages.call_and_recall.create_a_plan_page import CreateAPlanPage
+from pages.communication_production.batch_list_page import BatchListPage
+from pages.communication_production.communications_production_page import (
+    CommunicationsProductionPage,
+)
+from pages.communication_production.manage_active_batch_page import (
+    ManageActiveBatchPage,
+)
 from utils.user_tools import UserTools
 
 
@@ -22,43 +26,41 @@ def before_each(page: Page):
     BasePage(page).go_to_call_and_recall_page()
 
 
-# Scenario: Run FOBT invitations and process the S1 letter batch
-# Many feature scenarios need a subject at S9.
-#     When I generate invitations
-#     And I view the active batch list
-#     And I view the "Original" type "Open" status active letter batch for "S1" "Pre-invitation (FIT)"
-#     And I prepare the letter batch
-#     And I retrieve and confirm the letters
-#     Then there is a subject who meets the following criteria:
-#         | Latest episode kit class  | FIT   |
-#         | Latest event status       | S9    |
-#         | Latest episode type       | FOBT  |
-#         | Subject hub code          | BCS01 |
-
-# Scenario: User generates invitations for screening episodes (#3)
-# # Version copied from now-deleted UserPathway.feature - duplicate steps etc need to be sorted out
-#     Given I log in to BCSS "England" as user role "Hub Manager - State Registered"
-#     When I navigate to the Call and Recall > Generate Invitations Page
-#     And I press the Generate Invitations button and generate invitations
-#     Then Invitations are successfully generated
-
-
 @pytest.mark.regression
 @pytest.mark.call_and_recall
-def test_generate_fobt_invitations(page: Page) -> None:
+def test_run_fobt_invitations_and_process_s1_batch(
+    page: Page, general_properties: dict
+):
     """
-    Verifies that a user can generate FOBT invitations and process the S1 letter batch.
+    Run FOBT invitations, open the S1 batch, prepare, retrieve and confirm.
     """
+    # Navigate to generate invitations
     CallAndRecallPage(page).go_to_generate_invitations_page()
-    GenerateInvitationsPage(page).click_generate_invitations_button()
 
-    GenerateInvitationsPage(page).view_active_batch_list()
-    GenerateInvitationsPage(page).view_original_open_status_batch(
-        "S1", "Pre-invitation (FIT)"
+    # When I generate invitations
+    logging.info("Generating invitations based on the invitation plan")
+    GenerateInvitationsPage(page).click_generate_invitations_button()
+    GenerateInvitationsPage(page).wait_for_invitation_generation_complete(
+        int(general_properties["daily_invitation_rate"])
     )
-    GenerateInvitationsPage(page).prepare_letter_batch()
-    GenerateInvitationsPage(page).retrieve_and_confirm_letters()
+    logging.info("Invitations generated successfully")
+
+    # And I view the active batch list
+    BasePage(page).click_main_menu_link()
+    BasePage(page).go_to_communications_production_page()
+    CommunicationsProductionPage(page).go_to_active_batch_list_page()
 
-    GenerateInvitationsPage(page).verify_subject_meets_criteria(
-        kit_class="FIT", event_status="S9", episode_type="FOBT", hub_code="BCS01"
+    # And I open the "Original" / "Open" / "S1" / "Pre-invitation (FIT)" batch
+    BatchListPage(page).open_letter_batch(
+        batch_type="Original",
+        status="Open",
+        level="S1",
+        description="Pre-invitation (FIT)",
     )
+
+    # Then I retrieve and confirm the letters
+    ManageActiveBatchPage(page).click_prepare_button()
+    ManageActiveBatchPage(page).click_retrieve_button()
+    BasePage(page).safe_accept_dialog(
+        page.get_by_role("button", name="Confirm Printed")
+    )  # Click the confirm button and accept the confirmation dialog