BCSS-20020: Compartment 1 Smokescreen Tests (#7)

<!-- markdownlint-disable-next-line first-line-heading -->
## Description
Compartment 1 Smokescreen Tests

<!-- Describe your changes in detail. -->

## Context
This pr covers the addition of tests and functions required for the
Compartment 1 Smokescreen Tests



<!-- Why is this change required? What problem does it solve? -->

## Type of changes
This completes the migration of the compartment 1 tests from selenium to
playwright



<!-- 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
- [x] 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: Dave Harding <[email protected]>

Author: Andyg79

pages/age_extension_rollout_plans_page.py

@@ -0,0 +1,12 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class AgeExtensionRolloutPlans(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Age Extension Rollout Plans - page locators
+        self.age_extension_rollout_plans_title = self.page.locator("#page-title")
+
+    def verify_age_extension_rollout_plans_title(self) -> None:
+        expect(self.age_extension_rollout_plans_title).to_contain_text("Age Extension Rollout Plans")

pages/base_page.py

@@ -0,0 +1,146 @@
+from playwright.sync_api import Page, expect
+import logging
+
+
+class BasePage:
+    def __init__(self, page: Page):
+        self.page = page
+        # Homepage/Navigation Bar links
+        self.sub_menu_link = self.page.get_by_role("link", name="Show Sub-menu")
+        self.hide_sub_menu_link = self.page.get_by_role("link", name="Hide Sub-menu")
+        self.select_org_link = self.page.get_by_role("link", name="Select Org")
+        self.back_button = self.page.get_by_role("link", name="Back", exact=True)
+        self.release_notes_link = self.page.get_by_role("link", name="- Release Notes")
+        self.refresh_alerts_link = self.page.get_by_role("link", name="Refresh alerts")
+        self.user_guide_link = self.page.get_by_role("link", name="User guide")
+        self.help_link = self.page.get_by_role("link", name="Help")
+        self.main_menu_link = self.page.get_by_role("link", name="Main Menu")
+        self.log_out_link = self.page.get_by_role("link", name="Log-out")
+        # Main menu - page links
+        self.contacts_list_page = self.page.get_by_role("link", name="Contacts List")
+        self.bowel_scope_page = self.page.get_by_role("link", name="Bowel Scope")
+        self.call_and_recall_page = self.page.get_by_role("link", name="Call and Recall")
+        self.communications_production_page = self.page.get_by_role("link", name="Communications Production")
+        self.download_page = self.page.get_by_role("link", name="Download")
+        self.fit_test_kits_page = self.page.get_by_role("link", name="FIT Test Kits")
+        self.gfobt_test_kits_page = self.page.get_by_role("link", name="gFOBT Test Kits")
+        self.lynch_surveillance_page = self.page.get_by_role("link", name="Lynch Surveillance")
+        self.organisations_page = self.page.get_by_role("link", name="Organisations")
+        self.reports_page = self.page.get_by_role("link", name="Reports")
+        self.screening_practitioner_appointments_page = self.page.get_by_role("link", name="Screening Practitioner")
+        self.screening_subject_search_page = self.page.get_by_role("link", name="Screening Subject Search")
+        # Bowel Cancer Screening System header
+        self.bowel_cancer_screening_system_header = self.page.locator("#ntshAppTitle")
+        # Bowel Cancer Screening Page header
+        self.bowel_cancer_screening_page_title = self.page.locator("#page-title")
+        self.bowel_cancer_screening_ntsh_page_title = self.page.locator("#ntshPageTitle")
+        self.main_menu__header = self.page.locator("#ntshPageTitle")
+
+    def click_main_menu_link(self) -> None:
+        for _ in range(3):  # Try up to 3 times
+            if self.main_menu_link.is_visible():
+                self.click(self.main_menu_link)
+                return  # Exit if successful
+
+    def click_log_out_link(self) -> None:
+        self.click(self.log_out_link)
+
+    def click_sub_menu_link(self) -> None:
+        self.click(self.sub_menu_link)
+
+    def click_hide_sub_menu_link(self) -> None:
+        self.click(self.hide_sub_menu_link)
+
+    def click_select_org_link(self) -> None:
+        self.click(self.select_org_link)
+
+    def click_back_button(self) -> None:
+        self.click(self.back_button)
+
+    def click_release_notes_link(self) -> None:
+        self.click(self.release_notes_link)
+
+    def click_refresh_alerts_link(self) -> None:
+        self.click(self.refresh_alerts_link)
+
+    def click_user_guide_link(self) -> None:
+        self.click(self.user_guide_link)
+
+    def click_help_link(self) -> None:
+        self.click(self.help_link)
+
+    def bowel_cancer_screening_system_header_is_displayed(self) -> None:
+        expect(self.bowel_cancer_screening_system_header).to_contain_text("Bowel Cancer Screening System")
+
+    def main_menu_header_is_displayed(self) -> None:
+        expect(self.main_menu__header).to_contain_text("Main Menu")
+
+    def bowel_cancer_screening_page_title_contains_text(self, text: str) -> None:
+        """Asserts that the page title contains the specified text.
+
+            Args:
+                text (str): The expected text that you want to assert for the page title ("#page-title") element.
+        """
+        expect(self.bowel_cancer_screening_page_title).to_contain_text(text)
+
+    def bowel_cancer_screening_ntsh_page_title_contains_text(self, text: str) -> None:
+        """Asserts that the page title contains the specified text.
+
+            Args:
+                text (str): The expected text that you want to assert for the page title ("#ntshPageTitle") element.
+        """
+        expect(self.bowel_cancer_screening_ntsh_page_title).to_contain_text(text)
+
+    def go_to_contacts_list_page(self) -> None:
+        self.click(self.contacts_list_page)
+
+    def go_to_bowel_scope_page(self) -> None:
+        self.click(self.bowel_scope_page)
+
+    def go_to_call_and_recall_page(self) -> None:
+        self.click(self.call_and_recall_page)
+
+    def go_to_communications_production_page(self) -> None:
+        self.click(self.communications_production_page)
+
+    def go_to_download_page(self) -> None:
+        self.click(self.download_page)
+
+    def go_to_fit_test_kits_page(self) -> None:
+        self.click(self.fit_test_kits_page)
+
+    def go_to_gfobt_test_kits_page(self) -> None:
+        self.click(self.gfobt_test_kits_page)
+
+    def go_to_lynch_surveillance_page(self) -> None:
+        self.click(self.lynch_surveillance_page)
+
+    def go_to_organisations_page(self) -> None:
+        self.click(self.organisations_page)
+
+    def go_to_reports_page(self) -> None:
+        self.click(self.reports_page)
+
+    def go_to_screening_practitioner_appointments_page(self) -> None:
+        self.click(self.screening_practitioner_appointments_page)
+
+    def go_to_screening_subject_search_page(self) -> None:
+        self.click(self.screening_subject_search_page)
+
+    def click(self, locator) -> None:
+        """
+        This is used to click on a locator
+        The reason for this being used over the normal playwright click method is due to:
+        - BCSS sometimes takes a while to render and so the normal click function 'clicks' on a locator before its available
+        - Increases the reliability of clicks to avoid issues with the normal click method
+        """
+        try:
+            self.page.wait_for_load_state('load')
+            self.page.wait_for_load_state('domcontentloaded')
+            locator.wait_for(state="attached")
+            locator.wait_for(state="visible")
+            locator.click()
+
+        except Exception as locatorClickError:
+            logging.warning(f"Failed to click element with error: {locatorClickError}, trying again...")
+            locator.click()

pages/batch_download_request_and_retrieval_page.py

@@ -0,0 +1,16 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class BatchDownloadRequestAndRetrieval(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Batch Download Request And Retrieval - page locators
+        self.batch_download_request_and_retrieval_title = self.page.locator("#ntshPageTitle")
+        self.page_form = self.page.locator("form[name=\"frm\"]")
+
+    def expect_form_to_have_warning(self) -> None:
+        expect(self.page_form).to_contain_text("Warning - FS Screening data will not be downloaded")
+
+    def verify_batch_download_request_and_retrieval_title(self) -> None:
+        expect(self.batch_download_request_and_retrieval_title).to_contain_text("Batch Download Request and Retrieval")

pages/batch_list_page.py

@@ -0,0 +1,65 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class BatchList(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Batch List - page filters
+        self.id_filter = self.page.locator("#batchIdFilter")
+        self.type_filter = self.page.locator("#batchTypeFilter")
+        self.original_filter = self.page.locator("#originalBatchIdFilter")
+        self.event_code_filter = self.page.locator("#eventCodeFilter")
+        self.description_filter = self.page.locator("#eventDescriptionFilter")
+        self.batch_split_by_filter = self.page.locator("#splitByFilter")
+        self.screening_centre_filter = self.page.locator("#screeningCentreFilter")
+        self.count_filter = self.page.locator("#countFilter")
+        self.table_data = self.page.locator("td")
+        self.batch_successfully_archived_msg = self.page.locator('text="Batch Successfully Archived and Printed"')
+        self.batch_list_page_title = self.page.locator("#page-title")
+
+    def verify_batch_list_page_title(self, text) -> None:
+        expect(self.batch_list_page_title).to_contain_text(text)
+
+    def verify_table_data(self, value)->None:
+        expect(self.table_data.filter(has_text=value)).to_be_visible()
+
+    def enter_id_filter(self, search_text: str)->None:
+        self.id_filter.fill(search_text)
+        self.id_filter.press("Enter")
+
+    def enter_type_filter(self, search_text: str)->None:
+        self.type_filter.fill(search_text)
+        self.type_filter.press("Enter")
+
+    def enter_original_filter(self, search_text: str)->None:
+        self.original_filter.fill(search_text)
+        self.original_filter.press("Enter")
+
+    def enter_event_code_filter(self, search_text: str)->None:
+        self.event_code_filter.fill(search_text)
+        self.event_code_filter.press("Enter")
+
+    def enter_description_filter(self, search_text: str)->None:
+        self.description_filter.fill(search_text)
+        self.description_filter.press("Enter")
+
+    def enter_batch_split_by_filter(self, search_text: str)->None:
+        self.batch_split_by_filter.fill(search_text)
+        self.batch_split_by_filter.press("Enter")
+
+    def enter_screening_centre_filter(self, search_text: str)->None:
+        self.screening_centre_filter.fill(search_text)
+        self.screening_centre_filter.press("Enter")
+
+    def enter_count_filter(self, search_text: str)->None:
+        self.count_filter.fill(search_text)
+        self.count_filter.press("Enter")
+
+class ActiveBatchList(BatchList):
+    def __init__(self, page):
+        super().__init__(page)
+
+class ArchivedBatchList(BatchList):
+    def __init__(self, page):
+        super().__init__(page)

pages/bcss_home_page.py

@@ -0,0 +1,12 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class BowelScopeAppointments(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Bowel Scope Appointments - page locators
+        self.page_title = self.page.locator("#ntshPageTitle")
+
+    def verify_page_title(self) -> None:
+        expect(self.page_title).to_contain_text("Appointment Calendar")

pages/bowel_scope_appointments_page.py

@@ -0,0 +1,12 @@
+from playwright.sync_api import Page, expect, Locator
+from pages.base_page import BasePage
+
+class BowelScope(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Bowel Scope - page locators
+        self.view_bowel_scope_appointments_page = self.page.get_by_role("link", name="View Bowel Scope Appointments")
+
+    def go_to_view_bowel_scope_appointments_page(self) -> None:
+        self.click(self.view_bowel_scope_appointments_page)

pages/bowel_scope_page.py

@@ -0,0 +1,28 @@
+from playwright.sync_api import Page
+from pages.base_page import BasePage
+
+class CallAndRecall(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        # Call and Recall - page links
+        self.planning_and_monitoring_page = self.page.get_by_role("link", name="Planning and Monitoring")
+        self.generate_invitations_page = self.page.get_by_role("link", name="Generate Invitations")
+        self.invitation_generation_progress_page = self.page.get_by_role("link", name="Invitation Generation Progress")
+        self.non_invitation_days_page = self.page.get_by_role("link", name="Non Invitation Days")
+        self.age_extension_rollout_plans_page = self.page.get_by_role("link", name="Age Extension Rollout Plans")
+
+    def go_to_planning_and_monitoring_page(self)->None:
+        self.click(self.planning_and_monitoring_page)
+
+    def go_to_generate_invitations_page(self)->None:
+        self.click(self.generate_invitations_page)
+
+    def go_to_invitation_generation_progress_page(self)->None:
+        self.click(self.invitation_generation_progress_page)
+
+    def go_to_non_invitation_days_page(self)->None:
+        self.click(self.non_invitation_days_page)
+
+    def go_to_age_extension_rollout_plans_page(self)->None:
+        self.click(self.age_extension_rollout_plans_page)