add and use page object for session wizard

Author: jf-x-dev

mavis/test/fixtures/helpers.py

@@ -19,11 +19,10 @@
     ProgrammesListPage,
     SchoolsChildrenPage,
     SchoolsSearchPage,
-    SessionsEditPage,
     SessionsOverviewPage,
-    SessionsSearchPage,
     VaccinesPage,
 )
+from mavis.test.pages.utils import schedule_school_session_if_needed
 from mavis.test.utils import get_offset_date
 
 
@@ -57,23 +56,16 @@ def wrapper(vaccine: Vaccine, batch_name: str = "ABC123"):
 
 @pytest.fixture
 def schedule_session_and_get_consent_url(
-    set_feature_flags,
-    nurse,
-    team,
-    page,
+    set_feature_flags, nurse, team, page, year_groups
 ):
     def wrapper(school: School, *programmes: Programme):
+        year_group = year_groups[programmes[0].group]
+
         LogInPage(page).navigate()
         LogInPage(page).log_in_and_choose_team_if_necessary(nurse, team)
-        DashboardPage(page).click_sessions()
-        SessionsSearchPage(page).click_session_for_programme_group(
-            school, programmes[0].group
+        schedule_school_session_if_needed(
+            page, school, list(programmes), [year_group], date_offset=7
         )
-        if not SessionsOverviewPage(page).is_date_scheduled(get_offset_date(7)):
-            SessionsOverviewPage(page).schedule_or_edit_session()
-            SessionsEditPage(page).schedule_a_valid_session(
-                offset_days=7, skip_weekends=False
-            )
         url = SessionsOverviewPage(page).get_online_consent_url(*programmes)
         LogInPage(page).log_out()
         yield url
@@ -83,21 +75,17 @@ def wrapper(school: School, *programmes: Programme):
 
 @pytest.fixture
 def schedule_mmr_session_and_get_consent_url(
-    set_feature_flags,
-    nurse,
-    team,
-    page,
+    set_feature_flags, nurse, team, page, year_groups
 ):
     def wrapper(school: School, *programmes: Programme):
         try:
+            year_group = year_groups[programmes[0].group]
+
             LogInPage(page).navigate()
             LogInPage(page).log_in_and_choose_team_if_necessary(nurse, team)
-            DashboardPage(page).click_sessions()
-            SessionsSearchPage(page).click_session_for_programme_group(
-                school, programmes[0].group
+            schedule_school_session_if_needed(
+                page, school, list(programmes), [year_group], date_offset=7
             )
-            SessionsOverviewPage(page).schedule_or_edit_session()
-            SessionsEditPage(page).schedule_a_valid_mmr_session()
             url = SessionsOverviewPage(page).get_online_consent_url(*programmes)
             LogInPage(page).log_out()
             yield url
@@ -173,14 +161,7 @@ def wrapper(
             child.year_group,
             programme.group,
         )
-        ImportsPage(page).header.click_mavis_header()
-        DashboardPage(page).click_sessions()
-        SessionsSearchPage(page).click_session_for_programme_group(school, programme)
-        if not SessionsOverviewPage(page).is_date_scheduled(get_offset_date(0)):
-            SessionsOverviewPage(page).schedule_or_edit_session()
-            SessionsEditPage(page).schedule_a_valid_session(
-                offset_days=0, skip_weekends=False
-            )
+        schedule_school_session_if_needed(page, school, [programme], [child.year_group])
         session_id = SessionsOverviewPage(page).get_session_id_from_offline_excel()
         SessionsOverviewPage(page).header.click_mavis_header()
         DashboardPage(page).click_imports()
@@ -228,14 +209,14 @@ def _setup(programme_group):
             }
             VaccinesPage(page).header.click_mavis_header()
             DashboardPage(page).click_sessions()
-            SessionsSearchPage(page).click_session_for_programme_group(
-                school, programme_group
+            session_programmes = [
+                programme
+                for programme in Programme
+                if programme.group == programme_group
+            ]
+            schedule_school_session_if_needed(
+                page, school, session_programmes, [child.year_group]
             )
-            if not SessionsOverviewPage(page).is_date_scheduled(get_offset_date(0)):
-                SessionsOverviewPage(page).schedule_or_edit_session()
-                SessionsEditPage(page).schedule_a_valid_session(
-                    offset_days=0, skip_weekends=False
-                )
             SessionsOverviewPage(page).header.click_mavis_header()
             DashboardPage(page).click_schools()
             SchoolsSearchPage(page).click_school(school)

mavis/test/pages/__init__.py

@@ -1,3 +1,4 @@
+from .add_session_wizard_page import AddSessionWizardPage
 from .children import (
     ChildActivityLogPage,
     ChildArchivePage,
@@ -48,6 +49,7 @@
 
 __all__ = [
     "AddBatchPage",
+    "AddSessionWizardPage",
     "ArchiveBatchPage",
     "ArchiveConsentResponsePage",
     "BadRequestPage",

mavis/test/pages/add_session_wizard_page.py

@@ -0,0 +1,127 @@
+from playwright.sync_api import Page
+
+from mavis.test.annotations import step
+from mavis.test.constants import Programme
+from mavis.test.data_models import School
+from mavis.test.pages.header_component import HeaderComponent
+from mavis.test.utils import (
+    get_day_month_year_from_compact_date,
+    get_offset_date_compact_format,
+)
+
+
+class AddSessionWizardPage:
+    def __init__(
+        self,
+        page: Page,
+    ) -> None:
+        self.page = page
+        self.header = HeaderComponent(page)
+
+        self.continue_button = self.page.get_by_role("button", name="Continue")
+        self.day_textbox = self.page.get_by_role("textbox", name="Day")
+        self.month_textbox = self.page.get_by_role("textbox", name="Month")
+        self.year_textbox = self.page.get_by_role("textbox", name="Year")
+        self.add_another_date_button = self.page.get_by_role(
+            "button",
+            name="Add another date",
+        )
+        self.school_session_radio = self.page.get_by_role(
+            "radio",
+            name="School session",
+        )
+        self.community_clinic_radio = self.page.get_by_role(
+            "radio",
+            name="Community clinic",
+        )
+        self.select_a_school_combobox = self.page.get_by_role(
+            "combobox",
+            name="Select a school",
+        )
+        self.keep_session_dates_button = self.page.get_by_role(
+            "button", name="Keep session dates"
+        )
+
+    @step("Select School session")
+    def select_school_session(self) -> None:
+        self.school_session_radio.check()
+        self.click_continue()
+
+    @step("Select Community clinic")
+    def select_community_clinic(self) -> None:
+        self.community_clinic_radio.check()
+        self.click_continue()
+
+    def select_school(self, school: School) -> None:
+        self.fill_school_name(school)
+        self.click_continue()
+
+    @step("Fill school name")
+    def fill_school_name(self, school: School) -> None:
+        self.page.reload()  # to allow combobox to be interactable
+        self.select_a_school_combobox.fill(str(school))
+        self.page.get_by_role("option", name=str(school)).click()
+
+    @step("Click Continue")
+    def click_continue(self) -> None:
+        self.continue_button.click()
+
+    @step("Select year groups {1}")
+    def select_year_groups(self, year_groups: list[int]) -> None:
+        for year_group in year_groups:
+            self.page.locator(f'input[type="checkbox"][value="{year_group}"]').check()
+
+        self.click_continue()
+
+    @step("Choose programmes {1}")
+    def choose_programmes(self, programmes: list[Programme]) -> None:
+        for programme in programmes:
+            self.page.get_by_role("checkbox", name=programme).check()
+        self.click_continue()
+
+    @step("Click on Add another date")
+    def click_add_another_date(self) -> None:
+        self.add_another_date_button.click()
+
+    @step("Fill date fields with {1}")
+    def fill_date_fields(self, date: str) -> None:
+        day, month, year = get_day_month_year_from_compact_date(date)
+
+        self.day_textbox.last.fill(str(day))
+        self.month_textbox.last.fill(str(month))
+        self.year_textbox.last.fill(str(year))
+
+        self.click_continue()
+
+    @step("Click Keep session dates")
+    def click_keep_session_dates(self) -> None:
+        self.keep_session_dates_button.click()
+
+    def schedule_school_session(
+        self,
+        school: School,
+        programmes: list[Programme],
+        year_groups: list[int],
+        date_offset: int,
+    ) -> None:
+        self.select_school_session()
+        self.select_school(school)
+        self.choose_programmes(programmes)
+        self.select_year_groups(year_groups)
+        self.fill_date_fields(get_offset_date_compact_format(date_offset))
+
+        if self.keep_session_dates_button.is_visible():
+            self.click_keep_session_dates()  # MAV-2066
+
+        self.click_continue()
+
+    def schedule_clinic_session(
+        self,
+        programmes: list[Programme],
+        date_offset: int,
+    ) -> None:
+        self.select_community_clinic()
+        self.choose_programmes(programmes)
+        self.fill_date_fields(get_offset_date_compact_format(date_offset))
+
+        self.click_continue()

mavis/test/pages/imports/import_records_wizard_page.py

@@ -43,9 +43,9 @@ def __init__(
         self.continue_button = self.page.get_by_role("button", name="Continue")
         self.file_input = self.page.locator('input[type="file"]')
         self.location_combobox = self.page.get_by_role("combobox")
-        self.imported_records_tab = self.page.get_by_role(
+        self.completed_imports_tab = self.page.get_by_role(
             "link",
-            name="Imported records",
+            name="Completed imports",
         )
 
         # Pattern to match dynamic text (s is optional for records)
@@ -217,7 +217,7 @@ def click_uploaded_file_datetime(self, date_time: datetime) -> None:
         if first_link.or_(second_link).first.is_visible():
             first_link.or_(second_link).first.click()
         else:
-            self.imported_records_tab.click()
+            self.completed_imports_tab.click()
             first_link.or_(second_link).first.click()
 
     @step("Verify upload output for {file_path}")

mavis/test/pages/schools/schools_sessions_page.py

@@ -1,5 +1,6 @@
 from playwright.sync_api import Page
 
+from mavis.test.annotations import step
 from mavis.test.pages.header_component import HeaderComponent
 from mavis.test.pages.schools.schools_tabs import SchoolsTabs
 
@@ -9,3 +10,8 @@ def __init__(self, page: Page) -> None:
         self.page = page
         self.header = HeaderComponent(page)
         self.tabs = SchoolsTabs(page)
+        self.add_a_new_session_link = page.get_by_role("link", name="Add a new session")
+
+    @step("Click Add a new session")
+    def click_add_a_new_session(self) -> None:
+        self.add_a_new_session_link.click()

mavis/test/pages/sessions/sessions_search_page.py

@@ -7,13 +7,19 @@
 from mavis.test.data_models import Location
 from mavis.test.pages.header_component import HeaderComponent
 from mavis.test.pages.search_components import BaseSearchComponent
+from mavis.test.utils import get_formatted_date_without_year, get_offset_date
 
 
 class SessionsSearchPage:
     def __init__(self, page: Page) -> None:
         self.page = page
         self.search = BaseSearchComponent(page)
         self.header = HeaderComponent(page)
+        self.add_a_new_session_link = page.get_by_role("link", name="Add a new session")
+
+    @step("Click Add a new session")
+    def click_add_a_new_session(self) -> None:
+        self.add_a_new_session_link.click()
 
     @step("Click on {2} session at {1}")
     def click_session_for_programme_group(
@@ -35,3 +41,29 @@ def click_session_for_programme_group(
         expect(self.page.locator("h1", has_text=str(location))).to_be_visible(
             timeout=ten_seconds_ms,
         )
+
+    @step("Check if session exists")
+    def click_session_if_exists(
+        self,
+        location: Location,
+        programmes: list[Programme],
+        year_groups: list[int],
+        date_offset: int,
+    ) -> bool:
+        self.search.search_for(str(location))
+        self.page.wait_for_load_state()
+        session_locators = self.page.locator(
+            "div.nhsuk-card--clickable.app-card.app-card--compact"
+        )
+        session_date = get_formatted_date_without_year(get_offset_date(date_offset))
+
+        for i in range(session_locators.count()):
+            card_text = session_locators.nth(i).inner_text()
+            if (
+                all(str(programme) in card_text for programme in programmes)
+                and session_date in card_text
+                and all(str(year_group) in card_text for year_group in year_groups)
+            ):
+                session_locators.nth(i).get_by_role("link").click()
+                return True
+        return False

mavis/test/pages/utils.py

@@ -0,0 +1,38 @@
+
+from playwright.sync_api import Page
+
+from mavis.test.constants import Programme
+from mavis.test.data_models import Clinic, School
+from mavis.test.pages import AddSessionWizardPage, DashboardPage, SessionsSearchPage
+
+
+def schedule_school_session_if_needed(
+    page: Page,
+    school: School,
+    programmes: list[Programme],
+    year_groups: list[int],
+    date_offset: int = 0,
+) -> None:
+    DashboardPage(page).header.click_mavis_header()
+    DashboardPage(page).click_sessions()
+    if not SessionsSearchPage(page).click_session_if_exists(
+        school, programmes, year_groups, date_offset
+    ):
+        SessionsSearchPage(page).click_add_a_new_session()
+        AddSessionWizardPage(page).schedule_school_session(
+            school, programmes, year_groups, date_offset
+        )
+
+
+def schedule_community_clinic_session_if_needed(
+    page: Page,
+    programmes: list[Programme],
+    date_offset: int = 0,
+) -> None:
+    DashboardPage(page).header.click_mavis_header()
+    DashboardPage(page).click_sessions()
+    if not SessionsSearchPage(page).click_session_if_exists(
+        Clinic("community clinic"), programmes, [], date_offset
+    ):
+        SessionsSearchPage(page).click_add_a_new_session()
+        AddSessionWizardPage(page).schedule_clinic_session(programmes, date_offset)