Removing hardcoded locators from tests and creating new POMs

adrianoaru-nhs · adrianoaru-nhs · commit 2085060cc9ad · 2025-04-02T09:07:14.000+01:00
diff --git a/pages/age_extension_rollout_plans_page.py b/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")
diff --git a/pages/base_page.py b/pages/base_page.py
@@ -8,7 +8,7 @@ def __init__(self, page: Page):
         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")
+        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")
@@ -30,6 +30,7 @@ def __init__(self, page: Page):
         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")
+        self.main_menu__header = self.page.locator("#ntshPageTitle")
 
     def click_main_menu_link(self)->None:
         for _ in range(3):  # Try up to 3 times
@@ -67,6 +68,9 @@ def click_help_link(self)->None:
     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 go_to_contacts_list_page(self)->None:
         self.click(self.contacts_list_page)
 
diff --git a/pages/batch_list_page.py b/pages/batch_list_page.py
@@ -16,6 +16,10 @@ def __init__(self, page: Page):
         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()
diff --git a/pages/bowel_scope_appointments_page.py b/pages/bowel_scope_appointments_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")
diff --git a/pages/bowel_scope_page.py b/pages/bowel_scope_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)
diff --git a/pages/communications_production_page.py b/pages/communications_production_page.py
@@ -1,4 +1,4 @@
-from playwright.sync_api import Page
+from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
 
 class CommunicationsProduction(BasePage):
@@ -11,6 +11,10 @@ def __init__(self, page: Page):
         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")
+        self.manage_individual_letter_page = self.page.get_by_text("Manage Individual Letter")
+
+    def verify_manage_individual_letter_page_visible(self) -> None:
+        expect(self.manage_individual_letter_page).to_be_visible()
 
     def go_to_active_batch_list_page(self)->None:
         self.click(self.active_batch_list_page)
diff --git a/pages/create_a_plan_page.py b/pages/create_a_plan_page.py
@@ -1,4 +1,4 @@
-from playwright.sync_api import Page
+from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
 
 class CreateAPlan(BasePage):
@@ -14,6 +14,7 @@ def __init__(self, page: Page):
         self.save_button = self.page.get_by_role("button", name="Save")
         self.note_field = self.page.get_by_placeholder("Enter note")
         self.save_note_button = self.page.locator("#saveNote").get_by_role("button", name="Save")
+        self.create_a_plan_title = self.page.locator("#page-title")
 
     def click_set_all_button(self)->None:
         self.click(self.set_all_button)
@@ -38,3 +39,6 @@ def fill_note_field(self, value)->None:
 
     def click_save_note_button(self)->None:
         self.click(self.save_note_button)
+
+    def verify_create_a_plan_title(self) -> None:
+        expect(self.create_a_plan_title).to_contain_text("View a plan")
diff --git a/pages/electronic_communications_management.py b/pages/electronic_communications_management.py
@@ -0,0 +1,12 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class ElectronicCommunicationManagement(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Electronic Communication Management - page locators
+        self.electronic_communication_management_title = page.locator("#page-title")
+
+    def verify_electronic_communication_management_title(self) -> None:
+        expect(self.electronic_communication_management_title).to_contain_text("Electronic Communication Management")
diff --git a/pages/generate_invitations_page.py b/pages/generate_invitations_page.py
@@ -13,13 +13,20 @@ def __init__(self, page: Page):
         self.refresh_button = self.page.get_by_role("button", name="Refresh")
         self.planned_invitations_total = self.page.locator("#col8_total")
         self.self_referrals_total = self.page.locator("#col9_total")
+        self.generate_invitations_title = self.page.locator("#ntshPageTitle")
 
     def click_generate_invitations_button(self)->None:
         self.click(self.generate_invitations_button)
 
     def click_refresh_button(self)->None:
         self.click(self.refresh_button)
 
+    def verify_generate_invitations_title(self) -> None:
+        expect(self.generate_invitations_title).to_contain_text("Generate Invitations")
+
+    def verify_invitation_generation_progress_title(self) -> None:
+        expect(self.generate_invitations_title).to_contain_text("Invitation Generation Progress")
+
     def wait_for_invitation_generation_complete(self) -> bool:
         """
         This function is used to wait for the invitations to be generated.
diff --git a/pages/invitations_monitoring_page.py b/pages/invitations_monitoring_page.py
@@ -1,10 +1,14 @@
-from playwright.sync_api import Page
+from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
 
 class InvitationsMonitoring(BasePage):
     def __init__(self, page: Page):
         super().__init__(page)
         self.page = page
+        self.invitations_monitoring_title = page.locator("#page-title")
 
     def go_to_invitation_plan_page(self, sc_id)->None:
         self.click(self.page.get_by_role("link", name=sc_id))
+
+    def verify_invitations_monitoring_title(self) -> None:
+        expect(self.invitations_monitoring_title).to_contain_text("Invitations Monitoring - Screening Centre")
diff --git a/pages/invitations_plans_page.py b/pages/invitations_plans_page.py
@@ -8,6 +8,10 @@ def __init__(self, page: Page):
         # Call and Recall - page links
         self.create_a_plan = self.page.get_by_role("button", name="Create a Plan")
         self.invitations_plans_title = self.page.locator('#page-title:has-text("Invitation Plans")')
+        self.first_available_plan = self.page.get_by_role("row").nth(1).get_by_role("link")
 
     def go_to_create_a_plan_page(self)->None:
         self.click(self.create_a_plan)
+
+    def go_to_first_available_plan(self) -> None:
+        self.click(self.first_available_plan)
diff --git a/pages/letter_library_index_page.py b/pages/letter_library_index_page.py
@@ -0,0 +1,12 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class LetterLibraryIndex(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Letter Library Index - page locators
+        self.letter_library_index_title = page.locator("#ntshPageTitle")
+
+    def verify_letter_library_index_title(self) -> None:
+        expect(self.letter_library_index_title).to_contain_text("Letter Library Index")
diff --git a/pages/letter_signatory_page.py b/pages/letter_signatory_page.py
@@ -0,0 +1,12 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class LetterSignatory(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Letter Signatory - page locators
+        self.letter_signatory_title = page.locator("#ntshPageTitle")
+
+    def verify_letter_signatory_title(self) -> None:
+        expect(self.letter_signatory_title).to_contain_text("Letter Signatory")
diff --git a/pages/non_invitations_days_page.py b/pages/non_invitations_days_page.py
@@ -0,0 +1,12 @@
+from playwright.sync_api import Page, expect
+from pages.base_page import BasePage
+
+class NonInvitationDays(BasePage):
+    def __init__(self, page: Page):
+        super().__init__(page)
+        self.page = page
+        #Non Invitation Days - page locators
+        self.non_invitations_days_title = self.page.locator("#ntshPageTitle")
+
+    def verify_non_invitation_days_tile(self) -> None:
+        expect(self.non_invitations_days_title).to_contain_text("Non-Invitation Days")
diff --git a/tests/test_bowel_scope_page.py b/tests/test_bowel_scope_page.py
@@ -1,7 +1,8 @@
 import pytest
 from playwright.sync_api import Page, expect
-from utils.click_helper import click
 from pages.base_page import BasePage
+from pages.bowel_scope_page import BowelScope
+from pages.bowel_scope_appointments_page import BowelScopeAppointments
 from utils.user_tools import UserTools
 
 
@@ -24,9 +25,9 @@ def test_bowel_scope_page_navigation(page: Page) -> None:
     main menu button returns the user to the main menu
     """
     # Bowel scope appointments page loads as expected
-    click(page, page.get_by_role("link", name="View Bowel Scope Appointments"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Appointment Calendar")
+    BowelScope(page).go_to_bowel_scope_page()
+    BowelScopeAppointments(page).verify_page_title()
 
     # Return to main menu
-    click(page, page.get_by_role("link", name="Main Menu"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Main Menu")
+    BasePage(page).click_main_menu_link()
+    BasePage(page).main_menu_header_is_displayed()
diff --git a/tests/test_call_and_recall_page.py b/tests/test_call_and_recall_page.py
@@ -1,8 +1,14 @@
 import pytest
 from sys import platform
-from playwright.sync_api import Page, expect
-from utils.click_helper import click
+from playwright.sync_api import Page
 from pages.base_page import BasePage
+from pages.call_and_recall_page import CallAndRecall
+from pages.invitations_monitoring_page import InvitationsMonitoring
+from pages.generate_invitations_page import GenerateInvitations
+from pages.non_invitations_days_page import NonInvitationDays
+from pages.age_extension_rollout_plans_page import AgeExtensionRolloutPlans
+from pages.invitations_plans_page import InvitationsPlans
+from pages.create_a_plan_page import CreateAPlan
 from utils.user_tools import UserTools
 from jproperties import Properties
 
@@ -44,47 +50,47 @@ def test_call_and_recall_page_navigation(page: Page) -> None:
     Confirms that the Call and Recall menu displays all menu options and confirms they load the correct pages
     """
     # Planning and monitoring page loads as expected
-    click(page, page.get_by_role("link", name="Planning and Monitoring"))
-    expect(page.locator("#page-title")).to_contain_text("Invitations Monitoring - Screening Centre")
-    click(page, page.get_by_role("link", name="Back"))
+    CallAndRecall(page).go_to_planning_and_monitoring_page()
+    InvitationsMonitoring(page).verify_invitations_monitoring_title()
+    BasePage(page).click_back_button()
 
     # Generate invitations page loads as expected
-    click(page, page.get_by_role("link", name="Generate Invitations"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Generate Invitations")
-    click(page, page.get_by_role("link", name="Back"))
+    CallAndRecall(page).go_to_generate_invitations_page()
+    GenerateInvitations(page).verify_generate_invitations_title()
+    BasePage(page).click_back_button()
 
     # Invitation generation progress page loads as expected
-    click(page, page.get_by_role("link", name="Invitation Generation Progress"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Invitation Generation Progress")
-    click(page, page.get_by_role("link", name="Back"))
+    CallAndRecall(page).go_to_invitation_generation_progress_page()
+    GenerateInvitations(page).verify_invitation_generation_progress_title()
+    BasePage(page).click_back_button()
 
     # Non invitation days page loads as expected
-    click(page, page.get_by_role("link", name="Non Invitation Days"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Non-Invitation Days")
-    click(page, page.get_by_role("link", name="Back"))
+    CallAndRecall(page).go_to_non_invitation_days_page()
+    NonInvitationDays(page).verify_non_invitation_days_tile()
+    BasePage(page).click_back_button()
 
     # Age extension rollout page loads as expected
-    click(page, page.get_by_role("link", name="Age Extension Rollout Plans"))
-    expect(page.locator("#page-title")).to_contain_text("Age Extension Rollout Plans")
-    click(page, page.get_by_role("link", name="Back"))
+    CallAndRecall(page).go_to_age_extension_rollout_plans_page()
+    AgeExtensionRolloutPlans(page).verify_age_extension_rollout_plans_title()
+    BasePage(page).click_back_button()
 
     # Return to main menu
-    click(page, page.get_by_role("link", name="Main Menu"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Main Menu")
+    BasePage(page).click_main_menu_link()
+    BasePage(page).main_menu_header_is_displayed()
 
 
 def test_view_an_invitation_plan(page: Page, tests_properties: dict) -> None:
     """
     Confirms that an invitation plan can be viewed via a screening centre from the planning ad monitoring page
     """
     # Go to planning and monitoring page
-    click(page, page.get_by_role("link", name="Planning and Monitoring"))
+    CallAndRecall(page).go_to_planning_and_monitoring_page()
 
     # Select a screening centre
-    page.get_by_role("link", name=tests_properties["screening_centre_code"]).click()
+    InvitationsMonitoring(page).go_to_invitation_plan_page(tests_properties["screening_centre_code"])
 
     # Select an invitation plan
-    click(page, page.get_by_role("row").nth(1).get_by_role("link"))
+    InvitationsPlans(page).go_to_first_available_plan()
 
     # Verify invitation page is displayed
-    expect(page.locator("#page-title")).to_contain_text("View a plan")
+    CreateAPlan(page).verify_create_a_plan_title()
diff --git a/tests/test_communications_production_page.py b/tests/test_communications_production_page.py
@@ -1,8 +1,11 @@
 import pytest
 from playwright.sync_api import Page, expect
-from pages.login_page import BcssLoginPage
 from pages.base_page import BasePage
-from utils.click_helper import click
+from pages.communications_production_page import CommunicationsProduction
+from pages.batch_list_page import ActiveBatchList,ArchivedBatchList
+from pages.letter_library_index_page import LetterLibraryIndex
+from pages.letter_signatory_page import LetterSignatory
+from pages.electronic_communications_management import ElectronicCommunicationManagement
 from utils.user_tools import UserTools
 
 
@@ -26,33 +29,33 @@ def test_communications_production_page_navigation(page: Page) -> None:
     are loaded when the links are clicked
     """
     # Active batch list page loads as expected
-    click(page, page.get_by_role("link", name="Active Batch List"))
-    expect(page.locator("#page-title")).to_contain_text("Active Batch List")
-    click(page, page.get_by_role("link", name="Back"))
+    CommunicationsProduction(page).go_to_active_batch_list_page()
+    ActiveBatchList(page).verify_batch_list_page_title("Active Batch List")
+    BasePage(page).click_back_button()
 
     # Archived batch list page loads as expected
-    click(page, page.get_by_role("link", name="Archived Batch List"))
-    expect(page.locator("#page-title")).to_contain_text("Archived Batch List")
-    click(page, page.get_by_role("link", name="Back"))
+    CommunicationsProduction(page).go_to_archived_batch_list_page()
+    ArchivedBatchList(page).verify_batch_list_page_title("Archived Batch List")
+    BasePage(page).click_back_button()
 
     # Letter library index page loads as expected
-    click(page, page.get_by_role("link", name="Letter Library Index"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Letter Library Index")
-    click(page, page.get_by_role("link", name="Back", exact=True))
+    CommunicationsProduction(page).go_to_letter_library_index_page()
+    LetterLibraryIndex(page).verify_letter_library_index_title()
+    BasePage(page).click_back_button()
 
     # Manage individual letter link is visible (not clickable due to user role permissions)
-    expect(page.get_by_text("Manage Individual Letter")).to_be_visible()
+    CommunicationsProduction(page).verify_manage_individual_letter_page_visible()
 
     # Letter signatory page loads as expected
-    click(page, page.get_by_role("link", name="Letter Signatory"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Letter Signatory")
-    click(page, page.get_by_role("link", name="Back"))
+    CommunicationsProduction(page).go_to_letter_signatory_page()
+    LetterSignatory(page).verify_letter_signatory_title()
+    BasePage(page).click_back_button()
 
     # Electronic communication management page loads as expected
-    click(page, page.get_by_role("link", name="Electronic Communication"))
-    expect(page.locator("#page-title")).to_contain_text("Electronic Communication Management")
+    CommunicationsProduction(page).go_to_electronic_communication_management_page()
+    ElectronicCommunicationManagement(page).verify_electronic_communication_management_title()
 
     # Return to main menu
     # main_menu_link = page.get_by_role("link", name="Main Menu")
-    click(page, page.get_by_role("link", name="Main Menu"))
-    expect(page.locator("#ntshPageTitle")).to_contain_text("Main Menu")
+    BasePage(page).click_main_menu_link()
+    BasePage(page).main_menu_header_is_displayed()
