Addressing PR comments

Author: adrianoaru-nhs

tests/regression/subject/episodes/datasets/investigation/endoscopy/polypcategories/test_advanced_colorectal_polyp.py

@@ -1,7 +1,7 @@
 import logging
 import pytest
 import pandas as pd
-from _pytest.fixtures import FixtureRequest
+from pytest import FixtureRequest
 from datetime import datetime
 from playwright.sync_api import Page
 from classes.subject import Subject
@@ -103,6 +103,9 @@
 
 @pytest.fixture(autouse=True)
 def before_test(page: Page, request: FixtureRequest) -> None:
+    """
+    Before each test this will get the relevant subject and navigate to their investigation dataset
+    """
     if request.node.get_closest_marker("skip_before_test"):
         return
     df = obtain_test_data()
@@ -1174,6 +1177,9 @@ def assert_test_results(page: Page, expected_size: str) -> None:
     """
     This function asserts that the polyp algorithm size and category match the expected values.
     """
+    logging.info(
+        f"Asserting test results\nExpected result: Abnormal\nExpected size: {expected_size}\nExpected category: Advanced colorectal polyp"
+    )
     InvestigationDatasetsPage(page).expect_text_to_be_visible("Abnormal")
     InvestigationDatasetsPage(page).assert_polyp_alogrithm_size(1, expected_size)
     InvestigationDatasetsPage(page).assert_polyp_categrory(
@@ -1184,5 +1190,6 @@ def assert_test_results(page: Page, expected_size: str) -> None:
     InvestigationDatasetsPage(page).click_save_dataset_button()
     InvestigationDatasetsPage(page).assert_polyp_alogrithm_size(1, None)
     InvestigationDatasetsPage(page).assert_polyp_categrory(1, None)
+    logging.info("Test results asserted successfully.")
 
     LogoutPage(page).log_out()

utils/investigation_dataset.py

@@ -341,6 +341,7 @@ def complete_dataset_with_args(
             polyp_1_intervention (Optional[dict]): An optional dictionary containing the polyp 1 intervention to be filled in the form.
             polyp_1_histology (Optional[dict]): An optional dictionary containing the polyp 1 histology to be filled in the form.
         """
+        logging.info("Completing investigation dataset with the provided dictionaries")
         # Investigation Dataset
         InvestigationDatasetsPage(self.page).select_site_lookup_option_index(
             general_information["site"]
@@ -366,17 +367,20 @@ def complete_dataset_with_args(
         # Drug Information
         InvestigationDatasetsPage(self.page).click_show_drug_information()
         if drug_information.get("drug_type1"):
+            logging.info("Filling out drug information")
             InvestigationDatasetsPage(self.page).select_drug_type_option1(
                 drug_information["drug_type1"]
             )
             InvestigationDatasetsPage(self.page).fill_drug_type_dose1(
                 drug_information["drug_dose1"]
             )
 
+        logging.info("Filling out endoscopy information")
         self.fill_endoscopy_information(endoscopy_information)
 
         # Completion Proof Information
         if completion_information:
+            logging.info("Filling out completion proof information")
             InvestigationDatasetsPage(
                 self.page
             ).click_show_completion_proof_information()
@@ -385,6 +389,7 @@ def complete_dataset_with_args(
             )
 
         # Failure Information
+        logging.info("Filling out failure information")
         InvestigationDatasetsPage(self.page).click_show_failure_information()
         DatasetFieldUtil(self.page).populate_select_locator_for_field_inside_div(
             self.failure_reasons_string,
@@ -393,14 +398,18 @@ def complete_dataset_with_args(
         )
 
         if polyp_1_information:
+            logging.info("Filling out polyp 1 information")
             self.fill_polyp_1_information(polyp_1_information)
 
         if polyp_1_intervention:
+            logging.info("Filling out polyp 1 intervention")
             self.fill_polyp_1_intervention(polyp_1_intervention)
 
         if polyp_1_histology:
+            logging.info("Filling out polyp 1 histology")
             self.fill_polyp_1_histology(polyp_1_histology)
 
+        logging.info("Saving the investigation dataset")
         InvestigationDatasetsPage(self.page).check_dataset_complete_checkbox()
         InvestigationDatasetsPage(self.page).click_save_dataset_button()