Merge pull request #521 from NHSDigital/refactor-import-records

Refactor import records

Author: jf-x-dev

mavis/test/data/__init__.py

@@ -277,7 +277,7 @@ def get_file_paths(
 
         return _input_file_path, _output_file_path
 
-    def read_scenario_list_from_file(self, input_file_path: str) -> Optional[str]:
+    def read_scenario_list_from_file(self, input_file_path: Path) -> Optional[str]:
         try:
             _df = pd.read_csv(input_file_path)
             return (

mavis/test/pages/import_records.py

@@ -30,9 +30,6 @@ def __init__(
         self.import_records_button = self.page.get_by_role(
             "button", name="Import records"
         )
-        self.import_class_lists_link = self.page.get_by_role(
-            "link", name="Import class lists"
-        )
         self.child_records_radio_button = self.page.get_by_role(
             "radio", name="Child records"
         )
@@ -50,10 +47,6 @@ def __init__(
     def click_import_records(self):
         self.import_records_button.click()
 
-    @step("Click on Import class lists")
-    def click_import_class_lists(self):
-        self.import_class_lists_link.click()
-
     @step("Select Child Records")
     def select_child_records(self):
         self.child_records_radio_button.click()
@@ -67,7 +60,8 @@ def select_vaccination_records(self):
         self.vaccination_records_radio_button.click()
 
     @step("Click Continue")
-    def click_continue(self, coverage=""):
+    def click_continue(self, coverage: Optional[str] = None):
+        # coverage is only used for reporting
         self.continue_button.click()
 
     @step("Set input file to {1}")
@@ -94,16 +88,8 @@ def navigate_to_child_record_import(self):
         self.select_child_records()
         self.click_continue()
         self.click_add_to_current_year()
-        self.click_continue()
-
-    def navigate_to_class_list_record_import(
-        self,
-        location: str,
-        year_groups: Optional[list[int]] = None,
-    ):
-        if year_groups is None:
-            year_groups = [9, 10]
 
+    def navigate_to_class_list_record_import(self, location: str, *year_groups: int):
         self.click_import_records()
         self.select_class_list_records()
         self.click_continue()
@@ -112,15 +98,15 @@ def navigate_to_class_list_record_import(
 
         self.fill_location(location)
         self.page.get_by_role("option", name=str(location)).first.click()
-
         self.click_continue()
+
         self.click_add_to_current_year()
-        self.click_continue()
-        self._select_year_groups(*year_groups)
+        self.select_year_groups(*year_groups)
 
     @step("Click on 2024 to 2025")
     def click_add_to_current_year(self):
         self.current_year_radio.check()
+        self.click_continue()
 
     def navigate_to_vaccination_records_import(self):
         self.click_import_records()
@@ -184,10 +170,22 @@ def verify_upload_output(self, file_path: Path):
                 else:
                     expect(self.page.get_by_role("main")).to_contain_text(_msg)
 
-    def _select_year_groups(self, *year_groups: int) -> None:
+    def select_year_groups(self, *year_groups: int) -> None:
         for year_group in year_groups:
             if year_group == 0:
                 self.page.get_by_label("Reception").check()
             else:
                 self.page.get_by_label(text=f"Year {year_group}", exact=True).check()
         self.click_continue()
+
+    def import_class_list_for_current_year(
+        self,
+        class_list_file: FileMapping,
+        year_group: Optional[int] = None,
+        programme_group: str = Programme.HPV.group,
+    ):
+        self.click_add_to_current_year()
+        if year_group:
+            self.select_year_groups(year_group)
+
+        self.upload_and_verify_output(class_list_file, programme_group=programme_group)

mavis/test/pages/programmes.py

@@ -18,7 +18,6 @@ def __init__(self, page: Page, test_data: TestData):
             .filter(has_text="2024 to 2025")
             .locator("xpath=following-sibling::table[1]")
         )
-        self.current_year_radio = page.get_by_role("radio", name="2024 to 2025")
 
         programme_page_links = (
             page.get_by_role("main").get_by_role("listitem").get_by_role("link")
@@ -98,12 +97,6 @@ def navigate_to_cohort_import(self, programme: Programme):
         self.click_programme_current_year(programme)
         self.click_children()
         self.click_import_child_records()
-        self.click_add_to_current_year()
-        self.click_continue()
-
-    @step("Click on 2024 to 2025")
-    def click_add_to_current_year(self):
-        self.current_year_radio.check()
 
     @step("Click on Save changes")
     def click_save_changes(self):

mavis/test/pages/sessions.py

@@ -49,7 +49,6 @@ def __init__(
         self.conflicting_consent_checkbox = self.page.get_by_role(
             "checkbox", name="Conflicting consent"
         )
-        self.current_year_radio = page.get_by_role("radio", name="2024 to 2025")
 
         self.programme_tab_link = self.page.get_by_role("link", name="Programme")
         self.import_class_lists_link = self.page.get_by_role(
@@ -119,7 +118,6 @@ def __init__(
         self.update_results_button = self.page.get_by_role(
             "button", name="Update results"
         )
-        self.year_10_checkbox = self.page.get_by_role("checkbox", name="Year 10")
         self.confirm_button = self.page.get_by_role("button", name="Confirm")
         self.search_textbox = self.page.get_by_role("textbox", name="Search")
         self.search_button = self.page.get_by_role("button", name="Search")
@@ -183,6 +181,10 @@ def __init__(
         vaccinations_card = page.get_by_role("table", name="Vaccinations")
         self.vaccinations_card_row = vaccinations_card.get_by_role("row")
         self.sessions_link = page.get_by_role("link", name="Sessions", exact=True).first
+        self.advanced_filters_link = page.get_by_text("Advanced filters")
+        self.missing_nhs_no_checkbox = self.page.get_by_role(
+            "checkbox", name="Children missing an NHS number"
+        )
 
     def __get_display_formatted_date(self, date_to_format: str) -> str:
         _parsed_date = datetime.strptime(date_to_format, "%Y%m%d")
@@ -248,6 +250,7 @@ def click_session_for_programme_group(self, location: str, programme_group: str)
 
         self.search_textbox.fill(str(location))
         self.search_button.click()
+
         self.page.get_by_role("link", name=str(location)).click()
 
         expect(self.page.locator("h1", has_text=str(location))).to_be_visible(
@@ -395,17 +398,25 @@ def click_confirm_button(self):
 
     @step("Check box for year {1}")
     def check_year_checkbox(self, year: str):
-        self.page.get_by_role("checkbox", name=f"Year {year}").check()
+        if year == "0":
+            self.page.get_by_role("checkbox", name="Reception").check()
+        else:
+            self.page.get_by_role("checkbox", name=f"Year {year}").check()
 
     @step("Uncheck box for year {1}")
     def uncheck_year_checkbox(self, year: str):
-        self.page.get_by_role("checkbox", name=f"Year {year}").uncheck()
+        if year == "0":
+            self.page.get_by_role("checkbox", name="Reception").uncheck()
+        else:
+            self.page.get_by_role("checkbox", name=f"Year {year}").uncheck()
 
-    @step("Check box for year {1}")
-    def check_box_for_year_other_than(self, year: str):
-        self.page.get_by_role("checkbox", name="Year ").filter(
-            has_not_text=year
-        ).first.check()
+    @step("Click Advanced filters")
+    def click_advanced_filters(self):
+        self.advanced_filters_link.click()
+
+    @step("Check Children missing an NHS number")
+    def check_missing_nhs_no_checkbox(self):
+        self.missing_nhs_no_checkbox.check()
 
     @step("Click on Record vaccinations")
     def click_record_vaccinations_tab(self):
@@ -632,14 +643,6 @@ def verify_scheduled_date(self, message: str):
         self.expect_main_to_contain_text(message)
         self.click_continue_link()
 
-    @step("Click on 2024 to 2025")
-    def click_add_to_current_year(self):
-        self.current_year_radio.check()
-        self.click_continue_button()
-
-    def select_current_year(self):
-        self.page.get_by_role("radio", name="2024 to 2025").check()
-
     def schedule_a_valid_session(
         self, location: str, programme_group: str, for_today: bool = False
     ):
@@ -689,32 +692,6 @@ def get_online_consent_url(self, *programmes: list[Programme]) -> str:
         link_text = f"View the {' and '.join(str(programme) for programme in programmes)} online consent form"
         return str(self.page.get_by_role("link", name=link_text).get_attribute("href"))
 
-    def verify_attendance_filters(self):
-        self.click_register_tab()
-
-        search_summary = self.page.get_by_text("Showing 1 to")
-
-        expect(search_summary).not_to_have_text("Showing 1 to 1 of 1 children")
-        self.year_10_checkbox.check()
-        self.click_on_update_results()
-
-        expect(search_summary).to_have_text("Showing 1 to 1 of 1 children")
-
-        self.year_10_checkbox.uncheck()
-        self.click_on_update_results()
-
-        expect(search_summary).not_to_have_text("Showing 1 to 1 of 1 children")
-
-    def select_year_groups(self, *year_groups: int) -> None:
-        for year_group in year_groups:
-            if year_group == 0:
-                self.page.get_by_role("checkbox", name="Reception").check()
-            else:
-                self.page.get_by_role(
-                    "checkbox", name=f"Year {year_group}", exact=True
-                ).check()
-        self.click_continue_button()
-
     def register_child_as_attending(self, child: Child):
         self.click_register_tab()
         self.search_for(str(child))

tests/test_children.py

@@ -29,9 +29,9 @@ def _setup(class_list_file):
             dashboard_page.click_sessions()
             sessions_page.click_session_for_programme_group(school, Programme.HPV)
             sessions_page.click_import_class_lists()
-            sessions_page.click_add_to_current_year()
-            sessions_page.select_year_groups(year_group)
-            import_records_page.upload_and_verify_output(class_list_file)
+            import_records_page.import_class_list_for_current_year(
+                class_list_file, year_group
+            )
             dashboard_page.click_mavis()
             dashboard_page.click_children()
             yield
@@ -70,18 +70,18 @@ def setup_mav_853(
         dashboard_page.click_sessions()
         sessions_page.schedule_a_valid_session(school, Programme.HPV, for_today=True)
         sessions_page.click_import_class_lists()
-        sessions_page.click_add_to_current_year()
-        sessions_page.select_year_groups(year_group)
-        import_records_page.upload_and_verify_output(ClassFileMapping.RANDOM_CHILD)
+        import_records_page.import_class_list_for_current_year(
+            ClassFileMapping.RANDOM_CHILD, year_group
+        )
         dashboard_page.click_mavis()
         dashboard_page.click_sessions()
         sessions_page.click_session_for_programme_group(school, Programme.HPV)
         session_id = sessions_page.get_session_id_from_offline_excel()
         dashboard_page.click_mavis()
         dashboard_page.click_programmes()
         programmes_page.navigate_to_cohort_import(Programme.HPV)
-        import_records_page.upload_and_verify_output(
-            CohortsFileMapping.FIXED_CHILD,
+        import_records_page.import_class_list_for_current_year(
+            CohortsFileMapping.FIXED_CHILD
         )
         dashboard_page.click_mavis()
         dashboard_page.click_import_records()

tests/test_consent_responses.py

@@ -73,7 +73,9 @@ def test_match(
     dashboard_page.click_mavis()
     dashboard_page.click_programmes()
     programmes_page.navigate_to_cohort_import(Programme.HPV)
-    import_records_page.upload_and_verify_output(CohortsFileMapping.FIXED_CHILD)
+    import_records_page.import_class_list_for_current_year(
+        CohortsFileMapping.FIXED_CHILD
+    )
 
     dashboard_page.click_mavis()
     dashboard_page.click_unmatched_consent_responses()

tests/test_e2e.py

@@ -1,6 +1,6 @@
 import pytest
 
-from mavis.test.data import CohortsFileMapping
+from mavis.test.data import ClassFileMapping
 from mavis.test.models import Programme, ConsentOption
 
 pytestmark = pytest.mark.e2e
@@ -29,10 +29,8 @@ def _setup(programme_group):
         dashboard_page.click_sessions()
         sessions_page.click_session_for_programme_group(school, programme_group)
         sessions_page.click_import_class_lists()
-        sessions_page.click_add_to_current_year()
-        sessions_page.select_year_groups(child.year_group)
-        import_records_page.upload_and_verify_output(
-            CohortsFileMapping.FIXED_CHILD, programme_group=programme_group
+        import_records_page.import_class_list_for_current_year(
+            ClassFileMapping.FIXED_CHILD, child.year_group, programme_group
         )
         return batch_names
 

tests/test_imms.py

@@ -28,9 +28,9 @@ def setup_recording_hpv(
     dashboard_page.click_sessions()
     sessions_page.schedule_a_valid_session(school, Programme.HPV, for_today=True)
     sessions_page.click_import_class_lists()
-    sessions_page.click_add_to_current_year()
-    sessions_page.select_year_groups(year_group)
-    import_records_page.upload_and_verify_output(ClassFileMapping.FIXED_CHILD)
+    import_records_page.import_class_list_for_current_year(
+        ClassFileMapping.FIXED_CHILD, year_group
+    )
     dashboard_page.click_mavis()
     dashboard_page.click_sessions()
     sessions_page.click_session_for_programme_group(school, Programme.HPV)

tests/test_import_records.py

@@ -48,9 +48,9 @@ def setup_vaccs(
         dashboard_page.click_sessions()
         sessions_page.schedule_a_valid_session(school, Programme.HPV, for_today=True)
         sessions_page.click_import_class_lists()
-        sessions_page.click_add_to_current_year()
-        sessions_page.select_year_groups(year_group)
-        import_records_page.upload_and_verify_output(ClassFileMapping.RANDOM_CHILD)
+        import_records_page.import_class_list_for_current_year(
+            ClassFileMapping.RANDOM_CHILD, year_group
+        )
         dashboard_page.click_mavis()
         dashboard_page.click_sessions()
         sessions_page.click_session_for_programme_group(school, Programme.HPV)
@@ -136,7 +136,7 @@ def test_class_list_file_upload_positive(
     school = schools["doubles"][0]
     year_group = year_groups["doubles"]
 
-    import_records_page.navigate_to_class_list_record_import(str(school), [year_group])
+    import_records_page.navigate_to_class_list_record_import(str(school), year_group)
     import_records_page.upload_and_verify_output(
         ClassFileMapping.POSITIVE, programme_group="doubles"
     )
@@ -149,7 +149,7 @@ def test_class_list_file_upload_negative(
     school = schools["doubles"][0]
     year_group = year_groups["doubles"]
 
-    import_records_page.navigate_to_class_list_record_import(str(school), [year_group])
+    import_records_page.navigate_to_class_list_record_import(str(school), year_group)
     import_records_page.upload_and_verify_output(
         ClassFileMapping.NEGATIVE, programme_group="doubles"
     )
@@ -162,7 +162,7 @@ def test_class_list_file_structure(
     school = schools["doubles"][0]
     year_group = year_groups["doubles"]
 
-    import_records_page.navigate_to_class_list_record_import(str(school), [year_group])
+    import_records_page.navigate_to_class_list_record_import(str(school), year_group)
     import_records_page.upload_and_verify_output(
         ClassFileMapping.INVALID_STRUCTURE, programme_group="doubles"
     )
@@ -175,7 +175,7 @@ def test_class_list_no_record(
     school = schools["doubles"][0]
     year_group = year_groups["doubles"]
 
-    import_records_page.navigate_to_class_list_record_import(str(school), [year_group])
+    import_records_page.navigate_to_class_list_record_import(str(school), year_group)
     import_records_page.upload_and_verify_output(
         ClassFileMapping.HEADER_ONLY, programme_group="doubles"
     )
@@ -188,7 +188,7 @@ def test_class_list_empty_file(
     school = schools["doubles"][0]
     year_group = year_groups["doubles"]
 
-    import_records_page.navigate_to_class_list_record_import(str(school), [year_group])
+    import_records_page.navigate_to_class_list_record_import(str(school), year_group)
     import_records_page.upload_and_verify_output(
         ClassFileMapping.EMPTY_FILE, programme_group="doubles"
     )
@@ -201,7 +201,7 @@ def test_class_list_year_group(
     school = schools["doubles"][0]
     year_group = year_groups["doubles"]
 
-    import_records_page.navigate_to_class_list_record_import(str(school), [year_group])
+    import_records_page.navigate_to_class_list_record_import(str(school), year_group)
     import_records_page.upload_and_verify_output(
         ClassFileMapping.WRONG_YEAR_GROUP, programme_group="doubles"
     )
@@ -220,7 +220,7 @@ def test_class_list_space_normalization(
     school = schools["doubles"][0]
     year_group = year_groups["doubles"]
 
-    import_records_page.navigate_to_class_list_record_import(str(school), [year_group])
+    import_records_page.navigate_to_class_list_record_import(str(school), year_group)
     input_file, _ = import_records_page.upload_and_verify_output(
         ClassFileMapping.WHITESPACE, programme_group="doubles"
     )