Batch Processing Util Rework (#62)

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

<!-- Describe your changes in detail. -->
Refactored the batch processing util to allow the latest_event_Status to
be passed on as a list.

## Context

<!-- Why is this change required? What problem does it solve? -->
As some batches have subjects with different statuses, this allows us to
check for all of the statuses against a subject.

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

docs/utility-guides/BatchProcessing.md

@@ -43,8 +43,8 @@ This will call the other two functions in order to successfully process a batch.
   - Type: `str`
   - This is the description of the batch. For example: **Pre-invitation (FIT)** or **Post-investigation Appointment NOT Required**
 - `latest_event_status`:
-  - Type: `str`
-  - This is the status the subject will get updated to after the batch has been processed. It is used to check that the subject has been updated to the correct status after a batch has been printed
+  - Type: `str | None`
+  - This is the status the subject will get updated to after the batch has been processed. It is used to check that the subject has been updated to the correct status after a batch has been printed. If there are multiple different status in the same batch, provide them all in a list.
 
 #### Optional Arguments
 

pages/screening_subject_search/subject_screening_summary_page.py

@@ -84,17 +84,36 @@ def verify_latest_event_status_header(self) -> None:
         """Verify that the latest event status header is visible."""
         expect(self.latest_event_status).to_be_visible()
 
-    def verify_latest_event_status_value(self, latest_event_status: str) -> None:
+    def verify_latest_event_status_value(self, latest_event_status: str | list) -> None:
         """Verify that the latest event status value is visible."""
-        logging.info(f"Verifying subject has the status: {latest_event_status}")
-        latest_event_status_cell = self.get_latest_event_status_cell(
+        latest_event_status_locator = self.get_visible_status_from_list(
             latest_event_status
         )
+        status = latest_event_status_locator.inner_text()
+        logging.info(f"Verifying subject has the status: {status}")
         try:
-            expect(latest_event_status_cell).to_be_visible()
-            logging.info(f"Subject has the status: {latest_event_status}")
+            expect(latest_event_status_locator).to_be_visible()
+            logging.info(f"Subject has the status: {status}")
         except Exception:
-            pytest.fail(f"Subject does not have the status: {latest_event_status}")
+            pytest.fail(f"Subject does not have the status: {status}")
+
+    def get_visible_status_from_list(self, latest_event_status) -> Locator:
+        """
+        Get the first visible status from the latest event status string or list.
+
+        Args:
+            latest_event_status (str | list): The latest event status to check.
+
+        Returns:
+            Locator: The locator for the first visible status.
+        """
+        if isinstance(latest_event_status, str):
+            latest_event_status = [latest_event_status]
+        for status in latest_event_status:
+            locator = self.page.get_by_role("cell", name=status, exact=True)
+            if locator.is_visible():
+                return locator
+        logging.error("Unable to find any of the listed statuses")
 
     def click_subjects_events_notes(self) -> None:
         """Click on the 'Subject Events & Notes' link."""

utils/batch_processing.py

@@ -24,7 +24,7 @@ def batch_processing(
     page: Page,
     batch_type: str,
     batch_description: str,
-    latest_event_status: str,
+    latest_event_status: str | list,
     run_timed_events: bool = False,
     get_subjects_from_pdf: bool = False,
 ) -> None:
@@ -35,7 +35,7 @@ def batch_processing(
         page (Page): This is the playwright page object
         batch_type (str): The event code of the batch. E.g. S1 or S9
         batch_description (str): The description of the batch. E.g. Pre-invitation (FIT)
-        latest_event_status (str): The status the subject will get updated to after the batch has been processed.
+        latest_event_status (str | list): The status the subject will get updated to after the batch has been processed.
         run_timed_events (bool): An optional input that executes bcss_timed_events if set to True
         get_subjects_from_pdf (bool): An optional input to change the method of retrieving subjects from the batch from the DB to the PDF file.
     """
@@ -79,8 +79,10 @@ def batch_processing(
 
     check_batch_in_archived_batch_list(page, link_text)
 
-    first_nhs_no = nhs_no_df["subject_nhs_number"].iloc[0]
-    verify_subject_event_status_by_nhs_no(page, first_nhs_no, latest_event_status)
+    for subject in range(len(nhs_no_df)):
+        nhs_no = nhs_no_df["subject_nhs_number"].iloc[subject]
+        logging.info(f"Verifying the event status for subject: {nhs_no}")
+        verify_subject_event_status_by_nhs_no(page, nhs_no, latest_event_status)
 
     if run_timed_events:
         OracleDB().exec_bcss_timed_events(nhs_no_df)

utils/screening_subject_page_searcher.py

@@ -10,7 +10,7 @@
 
 
 def verify_subject_event_status_by_nhs_no(
-    page: Page, nhs_no: str, latest_event_status: str
+    page: Page, nhs_no: str, latest_event_status: str | list
 ) -> None:
     """
     This is used to check that the latest event status of a subject has been updated to what is expected