Refactoring test_compartment_1.py to make use of the Page Object Models.

Adding additional page object models

Author: adrianoaru-nhs

pages/active_batch_list_page.py

@@ -0,0 +1,15 @@
+from playwright.sync_api import Page
+
+class ActiveBatchList:
+    def __init__(self, page: Page):
+        self.page = page
+        # Active 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.status_filter = self.page.locator("#batchStatusFilter")
+        self.count_filter = self.page.locator("#countFilter")

pages/archived_batch_list_page.py

@@ -0,0 +1,15 @@
+from playwright.sync_api import Page
+
+class ArchivedBatchList:
+    def __init__(self, page: Page):
+        self.page = page
+        # Archived 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.status_filter = self.page.locator("#batchStatusFilter")
+        self.count_filter = self.page.locator("#countFilter")

pages/call_and_recall_page.py

@@ -0,0 +1,27 @@
+from playwright.sync_api import Page
+
+class CallAndRecall:
+    def __init__(self, page: 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):
+        self.planning_and_monitoring_page.click()
+
+    def go_to_generate_invitations_page(self):
+        self.generate_invitations_page.click()
+
+    def go_to_invitation_generation_progress_page(self):
+        self.invitation_generation_progress_page.click()
+
+    def go_to_non_invitation_days_page(self):
+        self.non_invitation_days_page.click()
+
+    def go_to_age_extension_rollout_plans_page(self):
+        self.age_extension_rollout_plans_page.click()

pages/communications_production_page.py

@@ -0,0 +1,27 @@
+from playwright.sync_api import Page
+
+class CommunicationsProduction:
+    def __init__(self, page: Page):
+        self.page = page
+        # Communication Production - page links
+        self.active_batch_list_page = self.page.get_by_role("link", name="Active Batch List")
+        self.archived_batch_list_page = self.page.get_by_role("link", name="Archived Batch List")
+        self.letter_library_index_page = self.page.get_by_role("link", name="Letter Library Index")
+        self.letter_signatory_page = self.page.get_by_role("link", name="Letter Signatory")
+        self.electronic_communication_management_page = self.page.get_by_role("link", name="Electronic Communication Management")
+
+
+    def go_to_active_batch_list_page(self):
+        self.active_batch_list_page.click()
+
+    def go_to_archived_batch_list_page(self):
+        self.archived_batch_list_page.click()
+
+    def go_to_letter_library_index_page(self):
+        self.letter_library_index_page.click()
+
+    def go_to_letter_signatory_page(self):
+        self.letter_signatory_page.click()
+
+    def go_to_electronic_communication_management_page(self):
+        self.electronic_communication_management_page.click()

pages/navigation_bar_links.py

@@ -0,0 +1,31 @@
+from playwright.sync_api import Page
+
+class NavigationBar:
+    def __init__(self, page: Page):
+        self.page = page
+        # Navigation Bar - links
+        self.back_link = self.page.get_by_role("link", name="Back")
+        self.main_menu_link = self.page.get_by_role("link", name="Main Menu")
+        self.select_org_link = self.page.get_by_role("link", name="Select Org")
+        self.help_link = self.page.get_by_role("link", name="Help")
+        self.log_out_link = self.page.get_by_role("link", name="Log-out")
+
+    def click_main_menu_link(self):
+        for _ in range(3):  # Try up to 3 times
+            if self.main_menu_link.is_visible():
+                self.main_menu_link.click()
+                return  # Exit if successful
+            self.page.wait_for_timeout(200)  # Wait for 0.2 seconds before retrying
+        print("Already on Main Menu")
+
+    def click_back_link(self):
+        self.back_link.click()
+
+    def click_select_org_link(self):
+        self.select_org_link.click()
+
+    def click_help_link(self):
+        self.help_link.click()
+
+    def click_log_out_link(self):
+        self.log_out_link.click()

pages/subject_screening_page.py

@@ -0,0 +1,78 @@
+from playwright.sync_api import Page
+
+class SubjectScreeningPage:
+    def __init__(self, page: Page):
+        self.page = page
+        # Subject Search Criteria - page filters
+        self.episodes_filter = self.page.get_by_role("radio", name="Episodes")
+        self.demographics_filter = self.page.get_by_role("radio", name="Demographics")
+        self.datasets_filter = self.page.get_by_role("radio", name="Datasets")
+        self.nhs_number_filter = self.page.get_by_role("textbox", name="NHS Number")
+        self.surname_filter = self.page.locator("#A_C_Surname")
+        self.soundex_filter = self.page.get_by_role("checkbox", name="Use soundex")
+        self.forename_filter = self.page.get_by_role("textbox", name="Forename")
+        self.date_of_birth_filter = self.page.locator("#A_C_DOB_From")
+        self.data_of_birth_range_filter = self.page.get_by_role("textbox", name="(for a date range, enter a to")
+        self.postcode_filter = self.page.get_by_role("textbox", name="Postcode")
+        self.episode_closed_date_filter = self. page.get_by_role("textbox", name="Episode Closed Date")
+        self.kit_batch_number_filter = self.page.get_by_role("textbox", name="Kit Batch Number")
+        self.kit_number_filter = self.page.get_by_role("textbox", name="Kit Number")
+        self.fit_device_id_filter = self.page.get_by_role("textbox", name="FIT Device ID")
+        self.laboratory_name_filter = self.page.get_by_role("textbox", name="Laboratory Name")
+        self.laboratory_test_date_filter = self.page.get_by_role("textbox", name="Laboratory Test Date")
+        self.diagnostic_test_actual_date_filter = self.page.get_by_role("textbox", name="Diagnostic Test Actual Date")
+        self.search_button = self.page.get_by_role("button", name="Search")
+
+    def click_search_button(self):
+        self.search_button.click()
+
+    def click_episodes_filter(self):
+        self.episodes_filter.check()
+
+    def click_demographics_filter(self):
+        self.demographics_filter.check()
+
+    def click_datasets_filter(self):
+        self.datasets_filter.check()
+
+    def click_nhs_number_filter(self):
+        self.nhs_number_filter.click()
+
+    def click_surname_filter(self):
+        self.surname_filter.click()
+
+    def click_soundex_filter(self):
+        self.soundex_filter.check()
+
+    def click_forename_filter(self):
+        self.forename_filter.click()
+
+    def click_date_of_birth_filter(self):
+        self.date_of_birth_filter.click()
+
+    def click_date_of_birth_range_filter(self):
+        self.data_of_birth_range_filter.click()
+
+    def click_postcode_filter(self):
+        self.postcode_filter.click()
+
+    def click_episodes_closed_date_filter(self):
+        self.episode_closed_date_filter.click()
+
+    def click_kit_batch_number_filter(self):
+        self.kit_batch_number_filter.click()
+
+    def click_kit_number_filter(self):
+        self.kit_number_filter.click()
+
+    def click_fit_device_id_filter(self):
+        self.fit_device_id_filter.click()
+
+    def click_laboratory_name_filter(self):
+        self.laboratory_name_filter.click()
+
+    def click_laboratory_test_date_filter(self):
+        self.laboratory_test_date_filter.click()
+
+    def click_diagnostic_test_actual_date_filter(self):
+        self.diagnostic_test_actual_date_filter.click()

tests/Smokescreen/test_compartment_1.py

@@ -2,22 +2,27 @@
 from pypdf import PdfReader
 from playwright.sync_api import Page, expect
 import pandas as pd
+import os
 import sys
-sys.path.append("../utils")
+sys.path.append("../")
 from utils.oracle import *
+from pages.bcss_home_page import *
+from pages.login_page import *
+from pages.communications_production_page import *
+from pages.call_and_recall_page import *
+from pages.active_batch_list_page import *
+from pages.archived_batch_list_page import *
+from pages.navigation_bar_links import *
+from pages.subject_screening_page import *
 
 @pytest.mark.wip
 def test_example(page: Page) -> None:
     page.goto("/")
-    page.get_by_role("textbox", name="Username").click()
-    page.get_by_role("textbox", name="Username").fill("BCSS401")
-    page.get_by_role("textbox", name="Username").press("Tab")
-    page.get_by_role("textbox", name="Password").fill("changeme")
-    page.get_by_role("button", name="submit").click()
+    BcssLoginPage(page).login_as_user_bcss401()
 
     # Create plan
-    page.get_by_role("link", name="Call and Recall").click()
-    page.get_by_role("link", name="Planning and Monitoring").click()
+    MainMenu(page).go_to_call_and_recall_page()
+    CallAndRecall(page).go_to_planning_and_monitoring_page()
     page.get_by_role("link", name="BCS001").click()
     page.get_by_role("button", name="Create a Plan").click()
     page.get_by_role("link", name="Set all").click()
@@ -31,9 +36,9 @@ def test_example(page: Page) -> None:
     page.locator("#saveNote").get_by_role("button", name="Save").click()
 
     # Generate Invitations
-    main_menu_available(page)
-    page.get_by_role("link", name="Call and Recall").click()
-    page.get_by_role("link", name="Generate Invitations").click()
+    NavigationBar(page).click_main_menu_link()
+    MainMenu(page).go_to_call_and_recall_page()
+    CallAndRecall(page).go_to_generate_invitations_page()
     page.get_by_role("button", name="Generate Invitations").click()
 
     page.wait_for_selector("#displayRS", timeout=5000)
@@ -64,7 +69,7 @@ def test_example(page: Page) -> None:
 
     # Print the batch of Pre-Invitation Letters
     batch_processing(page, "S1", "Pre-invitation (FIT)", "S9 - Pre-invitation Sent")
-    batch_processing(page, "S1", "Pre-invitation (FIT) (digital leaflet)", "S9 - Pre-invitation Sent") # Sometimes it is "S10 - Invitation & Test Kit Sent"
+    batch_processing(page, "S1", "Pre-invitation (FIT) (digital leaflet)", "S9 - Pre-invitation Sent")
 
     database_connection_exec("bcss_timed_events")
 
@@ -75,16 +80,15 @@ def test_example(page: Page) -> None:
     batch_processing(page, "S10", "Test Kit Reminder", "S19 - Reminder of Initial Test Sent")
 
     # Log out
-    page.get_by_role("link", name="Log-out").click()
+    NavigationBar(page).click_log_out_link()
     expect(page.get_by_role("heading", name="You have logged out")).to_be_visible()
 
 def batch_processing(page: Page, batch_type: str, batch_description: str, latest_event_status: str):
-    main_menu_available(page)
-    page.get_by_role("link", name="Communications Production").click()
-    page.get_by_role("link", name="Active Batch List").click()
-    page.locator("#eventCodeFilter").click()
-    page.locator("#eventCodeFilter").fill(batch_type)
-    page.locator("#eventCodeFilter").press("Enter")
+    NavigationBar(page).click_main_menu_link()
+    MainMenu(page).go_to_communications_production_page()
+    CommunicationsProduction(page).go_to_active_batch_list_page()
+    ActiveBatchList(page).event_code_filter.click()
+    ActiveBatchList(page).event_code_filter.fill(batch_type)
     pre_invitation_cells = page.locator(f"//td[text()='{batch_description}']")
 
     for i in range(pre_invitation_cells.count()):
@@ -94,14 +98,14 @@ def batch_processing(page: Page, batch_type: str, batch_description: str, latest
         if row.locator("td", has_text="Prepared").count() > 0 or row.locator("td", has_text="Open").count() > 0 or row.locator("td", has_text="Closed").count() > 0:
             # Find the first link in that row and click it
             link = row.locator("a").first
-            link_text = link.inner_text()  # Get the link text dynamically
+            link_text = link.inner_text()  # Get the batch id dynamically
             link.click()
             break
         else:
-            pytest.fail(f"No {batch_type} batch found")
+            pytest.fail(f"No open/prepared {batch_type} batch found")
 
     # Checks to see if batch is already prepared
-    page.wait_for_timeout(3000) # Without this timeout prepare_button is always set to false
+    page.wait_for_timeout(1000) # Without this timeout prepare_button is always set to false
     prepare_button = page.get_by_role("button", name="Prepare Batch").is_visible()
 
     #If not prepared it will click on the prepare button
@@ -124,24 +128,25 @@ def batch_processing(page: Page, batch_type: str, batch_description: str, latest
         page.wait_for_timeout(1000)
         if file.endswith(".pdf"):
             nhs_no = pdf_Reader(file)
+            os.remove(file) # Deletes the file after extracting the necessary data
         elif file.endswith(".csv"):
-            csv_df = csv_Reader(file)
+            csv_df = csv_Reader(file) # Currently no use in compartment 1, will be necessary for future compartments
+            os.remove(file) # Deletes the file after extracting the necessary data
 
     page.locator('text="Confirm Printed"').nth(0).wait_for()
     page.wait_for_timeout(1000) # This 1 second wait is to allow other Confirm printed buttons to show as they do not show up at the same time
 
     # This loops through each Confirm printed button and clicks each one
-    for confirm_button in range (page.get_by_role("button", name="Confirm Printed").count()):
+    for _ in range (page.get_by_role("button", name="Confirm Printed").count()):
         page.on("dialog", lambda dialog: dialog.accept())
         page.get_by_role("button", name="Confirm Printed").nth(0).click()
         page.wait_for_timeout(1000)
 
-    main_menu_available(page)
-    page.get_by_role("link", name="Communications Production").click()
-    page.get_by_role("link", name="Archived Batch List").click()
-    page.locator("#batchIdFilter").click()
-    page.locator("#batchIdFilter").fill(link_text)
-    page.locator("#batchIdFilter").press("Enter")
+    NavigationBar(page).click_main_menu_link()
+    MainMenu(page).go_to_communications_production_page()
+    CommunicationsProduction(page).go_to_archived_batch_list_page()
+    ArchivedBatchList(page).event_code_filter.click()
+    ArchivedBatchList(page).event_code_filter.fill(link_text)
     expect(page.locator("td").filter(has_text=link_text)).to_be_visible() # Checks to see if the batch is now archived
 
     subject_search_by_nhs_no(page, nhs_no, latest_event_status)
@@ -167,18 +172,12 @@ def csv_Reader(file: str):
     return csv_df
 
 def subject_search_by_nhs_no(page: Page, nhs_no: str, latest_event_status: str):
-    main_menu_available(page)
-    page.get_by_role("link", name="Screening Subject Search").click()
-    page.get_by_role("textbox", name="NHS Number").click()
-    page.get_by_role("textbox", name="NHS Number").fill(nhs_no)
-    page.get_by_role("textbox", name="NHS Number").press("Enter")
-    page.get_by_role("button", name="Search").click()
+    NavigationBar(page).click_main_menu_link()
+    MainMenu(page).go_to_screening_subject_search_page()
+    SubjectScreeningPage(page).click_nhs_number_filter()
+    SubjectScreeningPage(page).nhs_number_filter.fill(nhs_no)
+    SubjectScreeningPage(page).nhs_number_filter.press("Enter")
+    SubjectScreeningPage(page).click_search_button()
     expect(page.get_by_role("cell", name="Subject Screening Summary", exact=True)).to_be_visible()
     expect(page.get_by_role("cell", name="Latest Event Status", exact=True)).to_be_visible()
     expect(page.get_by_role("cell", name=latest_event_status, exact=True)).to_be_visible()
-
-def main_menu_available(page: str):
-    is_main_menu_available = page.get_by_role("link", name="Main Menu").is_visible()
-
-    if is_main_menu_available:
-        page.get_by_role("link", name="Main Menu").click()