Merge pull request #999 from NHSDigital/click-secondary-navigation-item

Add `click_secondary_navigation_item`

Author: thomasleese

mavis/test/pages/children/child_record_page.py

@@ -5,7 +5,7 @@
 from mavis.test.annotations import step
 from mavis.test.constants import Programme
 from mavis.test.pages.header_component import HeaderComponent
-from mavis.test.utils import get_todays_date
+from mavis.test.utils import click_secondary_navigation_item, get_todays_date
 
 
 class ChildRecordPage:
@@ -33,17 +33,12 @@ def __init__(self, page: Page) -> None:
 
     @step("Click on Child record")
     def click_child_record(self) -> None:
-        self._click_tab(self.child_record_link)
+        click_secondary_navigation_item(self.child_record_link)
 
     @step("Click on {1}")
     def click_programme(self, programme: Programme) -> None:
         link = self.secondary_menu.get_by_role("link", name=str(programme))
-        self._click_tab(link)
-
-    def _click_tab(self, link: Locator) -> None:
-        link.click()
-        link.get_by_role("strong").wait_for()
-        self.page.wait_for_load_state()
+        click_secondary_navigation_item(link)
 
     @step("Click on Edit child record")
     def click_edit_child_record(self) -> None:

mavis/test/pages/imports/import_records_wizard_page.py

@@ -9,7 +9,10 @@
 from mavis.test.data.file_mappings import ImportFormatDetails
 from mavis.test.data_models import Child
 from mavis.test.pages.header_component import HeaderComponent
-from mavis.test.utils import reload_until_element_is_visible
+from mavis.test.utils import (
+    click_secondary_navigation_item,
+    reload_until_element_is_visible,
+)
 
 
 class ImportRecordsWizardPage:
@@ -274,8 +277,7 @@ def click_import_link(self, file_path: Path) -> None:
         self.page.wait_for_load_state()
 
         if not import_link.is_visible():
-            self.completed_imports_tab.click()
-            self.completed_imports_tab.get_by_role("strong").wait_for()
+            click_secondary_navigation_item(self.completed_imports_tab)
 
         import_link.click()
         self.page.wait_for_load_state()

mavis/test/pages/reports/reports_tabs.py

@@ -1,6 +1,7 @@
 from playwright.sync_api import Page
 
 from mavis.test.annotations import step
+from mavis.test.utils import click_secondary_navigation_item
 
 
 class ReportsTabs:
@@ -15,10 +16,8 @@ def __init__(self, page: Page) -> None:
 
     @step("Click on Vaccinations tab")
     def click_vaccinations_tab(self) -> None:
-        self.vaccinations_tab.click()
-        self.vaccinations_tab.get_by_role("strong").wait_for()
+        click_secondary_navigation_item(self.vaccinations_tab)
 
     @step("Click on Download Data tab")
     def click_download_data_tab(self) -> None:
-        self.download_data_tab.click()
-        self.download_data_tab.get_by_role("strong").wait_for()
+        click_secondary_navigation_item(self.download_data_tab)

mavis/test/pages/schools/schools_tabs.py

@@ -1,26 +1,22 @@
 from playwright.sync_api import Page
 
 from mavis.test.annotations import step
+from mavis.test.utils import click_secondary_navigation_item
 
 
 class SchoolsTabs:
-    def __init__(
-        self,
-        page: Page,
-    ) -> None:
+    def __init__(self, page: Page) -> None:
         self.page = page
 
-    def _select_tab(self, name: str) -> None:
-        link = self.page.get_by_label("Secondary menu").get_by_role("link", name=name)
-        if link.get_by_role("strong").is_visible():
-            return
-        link.click()
-        link.get_by_role("strong").wait_for()
+        secondary_menu = page.get_by_label("Secondary menu")
+
+        self.sessions_link = secondary_menu.get_by_role("link", name="Sessions")
+        self.children_link = secondary_menu.get_by_role("link", name="Children")
 
     @step("Click on Sessions tab")
     def click_sessions_tab(self) -> None:
-        self._select_tab("Sessions")
+        click_secondary_navigation_item(self.sessions_link)
 
     @step("Click on Children tab")
     def click_children_tab(self) -> None:
-        self._select_tab("Children")
+        click_secondary_navigation_item(self.children_link)

mavis/test/pages/sessions/sessions_patient_page.py

@@ -17,6 +17,7 @@
 )
 from mavis.test.pages.header_component import HeaderComponent
 from mavis.test.utils import (
+    click_secondary_navigation_item,
     expect_alert_text,
     expect_details,
     reload_until_element_is_visible,
@@ -109,17 +110,11 @@ def __init__(self, page: Page) -> None:
             "link", name="Record as already vaccinated"
         )
 
-    def _select_tab(self, name: str) -> None:
-        link = self.page.get_by_label("Secondary menu").get_by_role("link", name=name)
-        if link.get_by_role("strong").is_visible():
-            return
-        link.click()
-        link.get_by_role("strong").wait_for()
-
     @step("Click on {1} tab")
     def click_programme_tab(self, programme: Programme) -> None:
-        tab_name = "MMR" if programme is Programme.MMR else str(programme)
-        self._select_tab(tab_name)
+        name = "MMR" if programme is Programme.MMR else str(programme)
+        link = self.page.get_by_label("Secondary menu").get_by_role("link", name=name)
+        click_secondary_navigation_item(link)
 
     @step("Click on Update triage outcome")
     def click_update_triage_outcome(self) -> None:
@@ -319,4 +314,7 @@ def set_up_vaccination(
 
     @step("Click on Session activity and notes tab")
     def click_session_activity_and_notes(self) -> None:
-        self._select_tab("Session activity and notes")
+        link = self.page.get_by_label("Secondary menu").get_by_role(
+            "link", name="Session activity and notes"
+        )
+        click_secondary_navigation_item(link)

mavis/test/pages/sessions/sessions_tabs.py

@@ -1,34 +1,34 @@
 from playwright.sync_api import Page
 
 from mavis.test.annotations import step
+from mavis.test.utils import click_secondary_navigation_item
 
 
 class SessionsTabs:
-    def __init__(
-        self,
-        page: Page,
-    ) -> None:
+    def __init__(self, page: Page) -> None:
         self.page = page
 
-    def _select_tab(self, name: str) -> None:
-        link = self.page.get_by_label("Secondary menu").get_by_role("link", name=name)
-        if link.get_by_role("strong").is_visible():
-            return
-        link.click()
-        link.get_by_role("strong").wait_for()
+        secondary_menu = page.get_by_label("Secondary menu")
+
+        self.overview_link = secondary_menu.get_by_role("link", name="Overview")
+        self.psds_link = secondary_menu.get_by_role("link", name="PSDs")
+        self.record_vaccinations_link = secondary_menu.get_by_role(
+            "link", name="Record vaccinations"
+        )
+        self.children_link = secondary_menu.get_by_role("link", name="Children")
 
     @step("Click on Overview tab")
     def click_overview_tab(self) -> None:
-        self._select_tab("Overview")
+        click_secondary_navigation_item(self.overview_link)
 
     @step("Click on PSDs tab")
     def click_psds_tab(self) -> None:
-        self._select_tab("PSDs")
+        click_secondary_navigation_item(self.psds_link)
 
     @step("Click on Record vaccinations")
     def click_record_vaccinations_tab(self) -> None:
-        self._select_tab("Record vaccinations")
+        click_secondary_navigation_item(self.record_vaccinations_link)
 
     @step("Click on Children tab")
     def click_children_tab(self) -> None:
-        self._select_tab("Children")
+        click_secondary_navigation_item(self.children_link)

mavis/test/pages/team/team_links_component.py

@@ -1,6 +1,7 @@
 from playwright.sync_api import Page
 
 from mavis.test.annotations import step
+from mavis.test.utils import click_secondary_navigation_item
 
 
 class TeamLinksComponent:
@@ -18,20 +19,16 @@ def __init__(self, page: Page) -> None:
 
     @step("Click on Contact details")
     def click_contact_details(self) -> None:
-        self.contact_details_link.click()
-        self.contact_details_link.get_by_role("strong").wait_for()
+        click_secondary_navigation_item(self.contact_details_link)
 
     @step("Click on Schools")
     def click_schools(self) -> None:
-        self.schools_link.click()
-        self.schools_link.get_by_role("strong").wait_for()
+        click_secondary_navigation_item(self.schools_link)
 
     @step("Click on Clinics")
     def click_clinics(self) -> None:
-        self.clinics_link.click()
-        self.clinics_link.get_by_role("strong").wait_for()
+        click_secondary_navigation_item(self.clinics_link)
 
     @step("Click on Sessions")
     def click_sessions(self) -> None:
-        self.sessions_link.click()
-        self.sessions_link.get_by_role("strong").wait_for()
+        click_secondary_navigation_item(self.sessions_link)

mavis/test/utils.py

@@ -232,3 +232,10 @@ def expect_details(page: Page, key: str, value: str) -> None:
     detail_value = detail_key.locator("xpath=following-sibling::*[1]")
 
     expect(detail_value).to_contain_text(value)
+
+
+def click_secondary_navigation_item(link: Locator) -> None:
+    if link.get_by_role("strong").is_visible():
+        return
+    link.click()
+    link.get_by_role("strong").wait_for()