Refacoring util to work for surveillance regression tests

Author: adrianoaru-nhs

pages/datasets/investigation_dataset_page.py

@@ -96,6 +96,7 @@ def __init__(self, page: Page):
         self.diagnostic_test_result = self.page.locator(
             "#datasetContent > div:nth-child(1) > div:nth-child(7) > span.userInput"
         )
+        self.show_details_links = self.page.locator('a:has-text("Show details")')
 
         # Repeat strings:
         self.bowel_preparation_administered_string = "Bowel Preparation Administered"
@@ -361,10 +362,13 @@ def select_diagnostic_procedure_type(self) -> None:
 
     def click_show_completion_proof_information(self) -> None:
         """
-        This method is designed to click on the show completion proof information link.
-        It clicks on the show completion proof information link.
+        Clicks on the show completion proof information link if it contains the text "show" (case-insensitive).
         """
-        self.click(self.show_completion_proof_information_details)
+        if (
+            "show"
+            in self.show_completion_proof_information_details.inner_text().lower()
+        ):
+            self.click(self.show_completion_proof_information_details)
 
     def click_show_failure_information(self) -> None:
         """
@@ -416,6 +420,16 @@ def click_save_dataset_button(self) -> None:
         """
         self.safe_accept_dialog(self.save_dataset_button)
 
+    def click_save_dataset_button_assert_dialog(self, expected_text: str) -> None:
+        """
+        Clicks on the save dataset button and performs an assertion of the resulting dialog text.
+        Once done dismissed the dialog.
+        Args:
+            expected_text (str): The expected text in the resultant dialog
+        """
+        self.assert_dialog_text("High-risk findings")
+        self.click(self.save_dataset_button)
+
     def expect_text_to_be_visible(self, text: str) -> None:
         """
         This method is designed to expect a text to be visible on the page.
@@ -1193,6 +1207,24 @@ def assert_test_result(self, expected_text: str) -> None:
             actual_text.lower() == expected_text.lower()
         ), f"Expected '{expected_text}', but found '{actual_text}'"
 
+    def open_all_details_tabs(self) -> None:
+        """
+        Clicks all visible "Show details" links on the page to open all details tabs.
+        """
+        count = self.show_details_links.count()
+        for i in range(count):
+            link = self.show_details_links.nth(i)
+            if link.is_visible():
+                self.click(link)
+
+    def open_all_minimized_sections(self) -> None:
+        """
+        Opens all the minimized sections in the investigation dataset form.
+        """
+        self.open_all_details_tabs()
+        # Then do it again to get the internal sections
+        self.open_all_details_tabs()
+
 
 def normalize_label(text: str) -> str:
     """

tests/regression/regression_tests/surveillance_regression_tests/test_surveillance_scenario_10.py

@@ -243,6 +243,9 @@ def test_scenario_10(page: Page, general_properties: dict) -> None:
         "Investigation Datasets"
     )
 
+    # And I open all minimized sections on the dataset
+    InvestigationDatasetsPage(page).open_all_minimized_sections()
+
     # Then I confirm the "Investigation Dataset" section of the dataset contains the field "Actual Type of Test" with the value of "Flexible Sigmoidoscopy"
     DatasetFieldUtil(page).assert_cell_to_right_has_expected_text(
         "Actual Type of Test", "Flexible Sigmoidoscopy"
@@ -256,7 +259,6 @@ def test_scenario_10(page: Page, general_properties: dict) -> None:
     )
 
     # When I set the following fields and values within the Investigation Dataset for this subject:
-    InvestigationDatasetsPage(page).click_show_endoscopy_information()
     DatasetFieldUtil(page).populate_select_locator_for_field(
         "Endoscopist defined extent", EndoscopyLocationOptions.APPENDIX
     )
@@ -267,10 +269,12 @@ def test_scenario_10(page: Page, general_properties: dict) -> None:
     )
 
     # When I add the following bowel preparation drugs and values within the Investigation Dataset for this subject:
-    drug_information = {
-        "drug_dose1": "3",
-        "drug_type1": DrugTypeOptions.MANNITOL,
-    }
+    InvestigationDatasetCompletion(page).fill_out_drug_information(
+        {
+            "drug_dose1": "3",
+            "drug_type1": DrugTypeOptions.MANNITOL,
+        }
+    )
 
     # And there is a clinician who meets the following criteria:
     user = User.from_user_role_type(user_role)
@@ -288,92 +292,104 @@ def test_scenario_10(page: Page, general_properties: dict) -> None:
     )
 
     # And I set the following fields and values within the Investigation Dataset for this subject:
-    general_information = {
-        "practitioner": 1,
-        "site": 1,
-        "testing clinician": person_name,
-        "aspirant endoscopist": None,
-    }
+    InvestigationDatasetCompletion(page).fill_out_general_information(
+        {
+            "practitioner": 1,
+            "site": 1,
+            "testing clinician": person_name,
+            "aspirant endoscopist": None,
+        }
+    )
 
-    endoscopy_information = {
-        "endoscope inserted": "yes",
-        "procedure type": "therapeutic",
-        "bowel preparation quality": BowelPreparationQualityOptions.GOOD,
-        "comfort during recovery": ComfortOptions.NO_DISCOMFORT,
-        "comfort during examination": ComfortOptions.NO_DISCOMFORT,
-        "scope imager used": YesNoOptions.YES,
-        "retroverted view": YesNoOptions.NO,
-        "start of intubation time": "09:00",
-        "start of extubation time": "09:30",
-        "end time of procedure": "10:00",
-        "scope id": "Autotest",
-        "insufflation": InsufflationOptions.AIR,
-        "outcome at time of procedure": OutcomeAtTimeOfProcedureOptions.LEAVE_DEPARTMENT,
-        "late outcome": LateOutcomeOptions.NO_COMPLICATIONS,
-    }
+    InvestigationDatasetCompletion(page).fill_endoscopy_information(
+        {
+            "endoscope inserted": "yes",
+            "procedure type": "therapeutic",
+            "bowel preparation quality": BowelPreparationQualityOptions.GOOD,
+            "comfort during recovery": ComfortOptions.NO_DISCOMFORT,
+            "comfort during examination": ComfortOptions.NO_DISCOMFORT,
+            "scope imager used": YesNoOptions.YES,
+            "retroverted view": YesNoOptions.NO,
+            "start of intubation time": "09:00",
+            "start of extubation time": "09:30",
+            "end time of procedure": "10:00",
+            "scope id": "Autotest",
+            "insufflation": InsufflationOptions.AIR,
+            "outcome at time of procedure": OutcomeAtTimeOfProcedureOptions.LEAVE_DEPARTMENT,
+            "late outcome": LateOutcomeOptions.NO_COMPLICATIONS,
+        }
+    )
 
     # And I set the following completion proof values within the Investigation Dataset for this subject:
-    completion_information = {"completion proof": CompletionProofOptions.VIDEO_APPENDIX}
+    InvestigationDatasetCompletion(page).fill_out_completion_information(
+        {"completion proof": CompletionProofOptions.VIDEO_APPENDIX}
+    )
 
     # And I set the following failure reasons within the Investigation Dataset for this subject:
-    failure_information = {"failure reasons": FailureReasonsOptions.NO_FAILURE_REASONS}
+    InvestigationDatasetCompletion(page).fill_out_failure_information(
+        {"failure reasons": FailureReasonsOptions.NO_FAILURE_REASONS}
+    )
 
-    # And I add new polyps 1-2 with the following fields and values within the Investigation Dataset for this subject:
-    polyp_information = [
+    # And I add new polyp 1 with the following fields and values within the Investigation Dataset for this subject:
+    InvestigationDatasetCompletion(page).fill_polyp_x_information(
         {
             "location": EndoscopyLocationOptions.CAECUM,
             "classification": PolypClassificationOptions.LST_NG,
             "estimate of whole polyp size": "10",
             "polyp access": PolypAccessOptions.EASY,
             "left in situ": YesNoOptions.NO,
         },
+        1,
+    )
+
+    # And I add intervention 1 for polyp 1 with the following fields and values within the Investigation Dataset for this subject:
+    InvestigationDatasetCompletion(page).fill_polyp_x_intervention(
+        {
+            "modality": PolypInterventionModalityOptions.EMR,
+            "device": PolypInterventionDeviceOptions.HOT_SNARE,
+            "excised": YesNoOptions.YES,
+            "retrieved": PolypInterventionRetrievedOptions.NO,
+            "excision technique": PolypInterventionExcisionTechniqueOptions.EN_BLOC,
+        },
+        1,
+    )
+
+    # And I add new polyp 2 with the following fields and values within the Investigation Dataset for this subject:
+    InvestigationDatasetCompletion(page).fill_polyp_x_information(
         {
             "location": EndoscopyLocationOptions.ASCENDING_COLON,
             "classification": PolypClassificationOptions.IIA,
             "estimate of whole polyp size": "12",
             "polyp access": PolypAccessOptions.EASY,
             "left in situ": YesNoOptions.NO,
         },
-    ]
+        2,
+    )
 
-    # And I add intervention 1 for polyps 1-2 with the following fields and values within the Investigation Dataset for this subject:
-    polyp_intervention = [
-        [
-            {
-                "modality": PolypInterventionModalityOptions.EMR,
-                "device": PolypInterventionDeviceOptions.HOT_SNARE,
-                "excised": YesNoOptions.YES,
-                "retrieved": PolypInterventionRetrievedOptions.NO,
-                "excision technique": PolypInterventionExcisionTechniqueOptions.EN_BLOC,
-            }
-        ],
-        [
-            {
-                "modality": PolypInterventionModalityOptions.POLYPECTOMY,
-                "device": PolypInterventionDeviceOptions.HOT_SNARE,
-                "excised": YesNoOptions.YES,
-                "retrieved": PolypInterventionRetrievedOptions.NO,
-                "excision technique": PolypInterventionExcisionTechniqueOptions.PIECE_MEAL,
-                "polyp appears fully resected endoscopically": YesNoUncertainOptions.UNCERTAIN,
-            }
-        ],
-    ]
+    # And I add intervention 1 for polyp 2 with the following fields and values within the Investigation Dataset for this subject:
+    InvestigationDatasetCompletion(page).fill_polyp_x_intervention(
+        {
+            "modality": PolypInterventionModalityOptions.POLYPECTOMY,
+            "device": PolypInterventionDeviceOptions.HOT_SNARE,
+            "excised": YesNoOptions.YES,
+            "retrieved": PolypInterventionRetrievedOptions.NO,
+            "excision technique": PolypInterventionExcisionTechniqueOptions.PIECE_MEAL,
+            "polyp appears fully resected endoscopically": YesNoUncertainOptions.UNCERTAIN,
+        },
+        2,
+    )
 
     # And I mark the Investigation Dataset as completed
+    InvestigationDatasetsPage(page).check_dataset_complete_checkbox()
+
+    # When I press the save Investigation Dataset button
+    # Then the Investigation Dataset result message, which I will cancel, is "High-risk findings"
+    InvestigationDatasetsPage(page).click_save_dataset_button_assert_dialog(
+        "High-risk findings"
+    )
+
     # When I press the save Investigation Dataset button
-    InvestigationDatasetsPage(page).click_show_endoscopy_information()
-    InvestigationDatasetCompletion(page).complete_dataset_with_args(
-        endoscopy_information=endoscopy_information,
-        drug_information=drug_information,
-        general_information=general_information,
-        failure_information=failure_information,
-        completion_information=completion_information,
-        polyp_information=polyp_information,
-        polyp_intervention=polyp_intervention,
-    )
-
-    # Then the Investigation Dataset result message is "High-risk findings"
-    InvestigationDatasetsPage(page).assert_test_result("High-risk findings")
+    InvestigationDatasetsPage(page).click_save_dataset_button()
 
     # Then I confirm the Polyp Algorithm Size for Polyp 1 is 10
     InvestigationDatasetsPage(page).assert_polyp_algorithm_size(1, "10")

utils/investigation_dataset.py

@@ -363,7 +363,6 @@ def complete_dataset_with_args(
 
         # Drug Information
         if drug_information is not None:
-            InvestigationDatasetsPage(self.page).click_show_drug_information()
             self.fill_out_drug_information(drug_information)
 
         if endoscopy_information:
@@ -373,17 +372,13 @@ def complete_dataset_with_args(
         # Completion Proof Information
         if completion_information is not None:
             logging.info("Filling out completion proof information")
-            InvestigationDatasetsPage(
-                self.page
-            ).click_show_completion_proof_information()
             DatasetFieldUtil(self.page).populate_select_locator_for_field(
                 "Proof Parameters", completion_information["completion proof"]
             )
 
         # Failure Information
         if failure_information is not None:
             logging.info("Filling out failure information")
-            self.investigation_datasets_pom.click_show_failure_information()
             DatasetFieldUtil(self.page).populate_select_locator_for_field_inside_div(
                 self.failure_reasons_string,
                 "divFailureSection",
@@ -424,14 +419,6 @@ def fill_out_suspected_findings(self, suspected_findings: dict) -> None:
         """
         Populates the Suspected Findings section of the Investigation Dataset form.
         """
-        logging.info("Starting fill_out_suspected_findings")
-        try:
-            logging.info("About to click suspected findings details")
-            self.investigation_datasets_pom.click_show_suspected_findings_details()
-            logging.info("Clicked suspected findings details successfully")
-        except Exception as e:
-            logging.error(f"Error clicking on Show Suspected Findings Details: {e}")
-            raise
         for key, value in suspected_findings.items():
             match key:
                 case "extracolonic summary code":
@@ -500,12 +487,40 @@ def fill_out_general_information(self, general_information: dict) -> None:
                     self.page
                 ).select_aspirant_endoscopist_option_index(aspirant)
 
+    def fill_out_completion_information(self, completion_information: dict) -> None:
+        """
+        This method completes the Completion Proof Information section of the investigation dataset.
+        Args:
+            completion_information (dict): A dictionary containing completion proof parameters.
+        """
+        logging.info("Filling out completion proof information")
+        self.investigation_datasets_pom.click_show_completion_proof_information()
+        DatasetFieldUtil(self.page).populate_select_locator_for_field(
+            "Proof Parameters", completion_information["completion proof"]
+        )
+
+    def fill_out_failure_information(self, failure_information: dict) -> None:
+        """
+        This method completes the Failure Information section of the investigation dataset.
+        Args:
+            failure_information (dict): A dictionary containing failure reasons and related information.
+        """
+        logging.info("Filling out failure information")
+        DatasetFieldUtil(self.page).populate_select_locator_for_field_inside_div(
+            self.failure_reasons_string,
+            "divFailureSection",
+            failure_information["failure reasons"],
+        )
+
     def fill_out_contrast_tagging_and_drug_information(
         self, contrast_tagging_and_drug: dict
     ) -> None:
+        """
+        This method completes the Contrast, Tagging & Drug Information section of the investigation dataset.
+        Args:
+            contrast_tagging_and_drug (dict): A dictionary containing contrast, tagging agent, and drug information.
+        """
         logging.info("🧪 Filling out Contrast, Tagging & Drug Information")
-        self.investigation_datasets_pom.click_show_contrast_tagging_and_drug_information()
-
         # Use for loop and match-case for endoscopy_information fields
         for key, value in contrast_tagging_and_drug.items():
             match key:
@@ -635,9 +650,6 @@ def fill_out_radiology_information(self, radiology_data: dict) -> None:
         """
         logging.info("Filling out Radiology Information")
 
-        self.investigation_datasets_pom.click_show_radiology_information()
-        self.investigation_datasets_pom.click_show_radiology_failure_information()
-
         # Use for loop and match-case for radiology data fields
         for key, value in radiology_data.items():
             match key:
@@ -722,8 +734,6 @@ def fill_endoscopy_information(self, endoscopy_information: dict) -> None:
             endoscopy_information (dict): A dictionary containing the endoscopy information to be filled in the form.
         """
         # Endoscopy Information
-        self.investigation_datasets_pom.click_show_endoscopy_information()
-
         # Use for loop and match-case for endoscopy_information fields
         for key, value in endoscopy_information.items():
             match key: