Altering code to address review comments on #15

Author: adrianoaru-nhs

tests/smokescreen/test_compartment_1.py

@@ -15,8 +15,7 @@
 
 @pytest.fixture
 def smokescreen_properties() -> dict:
-    properties = PropertiesFile().smokescreen_properties("compartment")
-    return properties
+    return PropertiesFile().get_smokescreen_properties()
 
 @pytest.mark.smoke
 @pytest.mark.compartment1

tests/smokescreen/test_compartment_2.py

@@ -15,8 +15,7 @@
 
 @pytest.fixture
 def smokescreen_properties() -> dict:
-    properties = PropertiesFile().smokescreen_properties("compartment")
-    return properties
+    return PropertiesFile().get_smokescreen_properties()
 
 
 @pytest.mark.smoke

tests/smokescreen/test_compartment_3.py

@@ -15,8 +15,7 @@
 
 @pytest.fixture
 def smokescreen_properties() -> dict:
-    properties = PropertiesFile().smokescreen_properties("compartment")
-    return properties
+    return PropertiesFile().get_smokescreen_properties()
 
 
 @pytest.mark.smokescreen

tests/test_call_and_recall_page.py

@@ -13,9 +13,8 @@
 
 
 @pytest.fixture
-def smokescreen_properties() -> dict:
-    properties = PropertiesFile().smokescreen_properties("smoke")
-    return properties
+def general_properties() -> dict:
+    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -65,7 +64,7 @@ def test_call_and_recall_page_navigation(page: Page) -> None:
     BasePage(page).main_menu_header_is_displayed()
 
 
-def test_view_an_invitation_plan(page: Page, smokescreen_properties: dict) -> None:
+def test_view_an_invitation_plan(page: Page, general_properties: dict) -> None:
     """
     Confirms that an invitation plan can be viewed via a screening centre from the planning ad monitoring page
     """
@@ -74,7 +73,7 @@ def test_view_an_invitation_plan(page: Page, smokescreen_properties: dict) -> No
 
     # Select a screening centre
     InvitationsMonitoring(page).go_to_invitation_plan_page(
-        smokescreen_properties["screening_centre_code"]
+        general_properties["screening_centre_code"]
     )
 
     # Select an invitation plan

tests/test_organisations_page.py

@@ -7,9 +7,8 @@
 
 
 @pytest.fixture
-def smokescreen_properties() -> dict:
-    properties = PropertiesFile().smokescreen_properties("smoke")
-    return properties
+def general_properties() -> dict:
+    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -72,7 +71,7 @@ def test_organisations_page_navigation(page: Page) -> None:
 
 
 def test_view_an_organisations_system_parameters(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms that an organisation's system parameters can be accessed and viewed
@@ -81,7 +80,7 @@ def test_view_an_organisations_system_parameters(
     OrganisationsPage(page).go_to_screening_centre_parameters_page()
 
     # View an Organisation
-    page.get_by_role("link", name=smokescreen_properties["screening_centre_code"]).click()
+    page.get_by_role("link", name=general_properties["screening_centre_code"]).click()
     BasePage(page).bowel_cancer_screening_ntsh_page_title_contains_text(
         "System Parameters"
     )

tests/test_reports_page.py

@@ -8,9 +8,8 @@
 
 
 @pytest.fixture
-def smokescreen_properties() -> dict:
-    properties = PropertiesFile().smokescreen_properties("smoke")
-    return properties
+def general_properties() -> dict:
+    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -190,7 +189,7 @@ def test_failsafe_reports_subjects_ceased_due_to_date_of_birth_changes(
 
 
 def test_failsafe_reports_allocate_sc_for_patient_movements_within_hub_boundaries(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms 'allocate_sc_for_patient_movements_within_hub_boundaries' page loads,
@@ -233,15 +232,15 @@ def test_failsafe_reports_allocate_sc_for_patient_movements_within_hub_boundarie
 
     # Select another screening centre
     set_patients_screening_centre_dropdown.select_option(
-        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click update
     failsafe_report_page.click_reports_pages_update_button()
 
     # Verify new screening centre has saved
     expect(ReportsPage(page).set_patients_screening_centre_dropdown).to_have_value(
-        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
 
@@ -332,7 +331,7 @@ def test_failsafe_reports_identify_and_link_new_gp(page: Page) -> None:
 
 # Operational Reports
 def test_operational_reports_appointment_attendance_not_updated(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms 'appointment_attendance_not_updated' page loads,
@@ -361,7 +360,7 @@ def test_operational_reports_appointment_attendance_not_updated(
 
     # Select a screening centre from the drop-down options
     set_patients_screening_centre_dropdown.select_option(
-        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click "Generate Report" button
@@ -433,7 +432,7 @@ def test_operational_reports_demographic_update_inconsistent_with_manual_update(
 
 
 def test_operational_reports_screening_practitioner_6_weeks_availability_not_set_up(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms 'screening_practitioner_6_weeks_availability_not_set_up_report' page loads,
@@ -460,7 +459,7 @@ def test_operational_reports_screening_practitioner_6_weeks_availability_not_set
 
     # Select a screening centre
     set_patients_screening_centre_dropdown.select_option(
-        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click "Generate Report"
@@ -480,7 +479,7 @@ def test_operational_reports_screening_practitioner_6_weeks_availability_not_set
 
 @pytest.mark.only
 def test_operational_reports_screening_practitioner_appointments(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms 'screening_practitioner_appointments' page loads,
@@ -509,12 +508,12 @@ def test_operational_reports_screening_practitioner_appointments(
 
     # Select a screening centre
     set_patients_screening_centre_dropdown.select_option(
-        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Select a screening practitioner
     screening_practitioner_dropdown.select_option(
-        smokescreen_properties["screening_practitioner_named_another_stubble"]
+        general_properties["screening_practitioner_named_another_stubble"]
     )
 
     # Click "Generate Report"

tests/test_screening_subject_search_page.py

@@ -24,9 +24,8 @@
 
 
 @pytest.fixture
-def smokescreen_properties() -> dict:
-    properties = PropertiesFile().smokescreen_properties("smoke")
-    return properties
+def general_properties() -> dict:
+    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -44,7 +43,7 @@ def before_each(page: Page):
 
 @pytest.mark.smoke
 def test_search_screening_subject_by_nhs_number(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms a screening subject can be searched for, using their nhs number by doing the following:
@@ -54,11 +53,11 @@ def test_search_screening_subject_by_nhs_number(
     - Click search button
     - Verify the Subject Screening Summary page is displayed
     """
-    search_subject_by_nhs_number(page, smokescreen_properties["nhs_number"])
+    search_subject_by_nhs_number(page, general_properties["nhs_number"])
 
 
 def test_search_screening_subject_by_surname(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms a screening subject can be searched for, using their surname by doing the following:
@@ -68,11 +67,11 @@ def test_search_screening_subject_by_surname(
     - Click search button
     - Verify the subject summary page is displayed
     """
-    search_subject_by_surname(page, smokescreen_properties["surname"])
+    search_subject_by_surname(page, general_properties["surname"])
 
 
 def test_search_screening_subject_by_forename(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms a screening subject can be searched for, using their forename by doing the following:
@@ -82,10 +81,10 @@ def test_search_screening_subject_by_forename(
     - Click search button
     - Verify the subject summary page is displayed
     """
-    search_subject_by_forename(page, smokescreen_properties["forename"])
+    search_subject_by_forename(page, general_properties["forename"])
 
 
-def test_search_screening_subject_by_dob(page: Page, smokescreen_properties: dict) -> None:
+def test_search_screening_subject_by_dob(page: Page, general_properties: dict) -> None:
     """
     Confirms a screening subject can be searched for, using their date of birth by doing the following:
     - Clear filters
@@ -94,7 +93,7 @@ def test_search_screening_subject_by_dob(page: Page, smokescreen_properties: dic
     - Click search button
     - Verify the subject search results page is displayed
     """
-    search_subject_by_dob(page, smokescreen_properties["subject_dob"])
+    search_subject_by_dob(page, general_properties["subject_dob"])
 
 
 def test_search_screening_subject_by_postcode(page: Page) -> None:
@@ -110,7 +109,7 @@ def test_search_screening_subject_by_postcode(page: Page) -> None:
 
 
 def test_search_screening_subject_by_episode_closed_date(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms a screening subject can be searched for, using their episode closed date by doing the following:
@@ -121,18 +120,18 @@ def test_search_screening_subject_by_episode_closed_date(
     - Verify the subject search results page is displayed
     - Verify the results contain the date that was searched for
     """
-    search_subject_by_episode_closed_date(page, smokescreen_properties["episode_closed_date"])
+    search_subject_by_episode_closed_date(page, general_properties["episode_closed_date"])
 
 
 def test_search_criteria_clear_filters_button(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms the 'clear filters' button on the search page works as expected by doing the following:
     - Enter number in NHS field and verify value
     - Click clear filters button and verify field is empty
     """
-    check_clear_filters_button_works(page, smokescreen_properties["nhs_number"])
+    check_clear_filters_button_works(page, general_properties["nhs_number"])
 
 
 # Tests searching via the "Screening Status" drop down list
@@ -345,7 +344,7 @@ def test_search_screening_subject_by_home_hub(page: Page) -> None:
 
 
 def test_search_screening_subject_by_gp_practice(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms screening subjects can be searched for, using the search area (home hub) by doing the following:
@@ -361,12 +360,12 @@ def test_search_screening_subject_by_gp_practice(
         page,
         ScreeningStatusSearchOptions.CALL_STATUS.value,
         SearchAreaSearchOptions.SEARCH_AREA_GP_PRACTICE.value,
-        smokescreen_properties["gp_practice_code"],
+        general_properties["gp_practice_code"],
     )
     SubjectScreeningSummary(page).verify_result_contains_text("SPRINGS HEALTH CENTRE")
 
 
-def test_search_screening_subject_by_ccg(page: Page, smokescreen_properties: dict) -> None:
+def test_search_screening_subject_by_ccg(page: Page, general_properties: dict) -> None:
     """
     Confirms screening subjects can be searched for, using the search area (ccg) by doing the following:
     - Clear filters
@@ -381,13 +380,13 @@ def test_search_screening_subject_by_ccg(page: Page, smokescreen_properties: dic
         page,
         ScreeningStatusSearchOptions.CALL_STATUS.value,
         SearchAreaSearchOptions.SEARCH_AREA_CCG.value,
-        smokescreen_properties["ccg_code"],
-        smokescreen_properties["gp_practice_code"],
+        general_properties["ccg_code"],
+        general_properties["gp_practice_code"],
     )
 
 
 def test_search_screening_subject_by_screening_centre(
-    page: Page, smokescreen_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms screening subjects can be searched for, using the search area (screening centre) by doing the following:
@@ -402,7 +401,7 @@ def test_search_screening_subject_by_screening_centre(
         page,
         ScreeningStatusSearchOptions.CALL_STATUS.value,
         SearchAreaSearchOptions.SEARCH_AREA_CCG.value,
-        smokescreen_properties["screening_centre_code"],
+        general_properties["screening_centre_code"],
     )
 
 

utils/load_properties_file.py

@@ -4,22 +4,33 @@
 
 class PropertiesFile():
     def __init__(self):
-        self.compartment_properties_file = "tests/smokescreen/bcss_smokescreen_tests.properties"
-        self.smokescreen_properties_file = "tests/bcss_tests.properties"
+        self.smokescreen_properties_file = "tests/smokescreen/bcss_smokescreen_tests.properties"
+        self.general_properties_file = "tests/bcss_tests.properties"
 
 
-    def smokescreen_properties(self, type_of_properties_file: str) -> dict:
+    def get_properties(self, type_of_properties_file: str | None = None) -> dict:
         """
-        Reads the 'bcss_smokescreen_tests.properties' file or 'bcss_tests.properties' and populates a 'Properties' object depending on whether "compartment" is given
+        Reads the 'bcss_smokescreen_tests.properties' file or 'bcss_tests.properties' and populates a 'Properties' object depending on whether "smokescreen" is given
         Returns a dictionary of properties for use in tests.
 
         Returns:
             dict: A dictionary containing the values loaded from the 'bcss_smokescreen_tests.properties' file.
         """
         configs = Properties()
-        path =  f"{os.getcwd()}/{self.compartment_properties_file if type_of_properties_file == "compartment" else self.smokescreen_properties_file}"
+        path =  f"{os.getcwd()}/{self.smokescreen_properties_file if type_of_properties_file == "smokescreen" else self.general_properties_file}"
         with open(
             path, "rb"
             ) as read_prop:
             configs.load(read_prop)
         return configs.properties
+
+
+    def get_smokescreen_properties(self) -> dict:
+        "This is used to get the `tests/smokescreen/bcss_smokescreen_tests.properties` file"
+        return self.get_properties("smokescreen")
+    
+
+    def get_general_properties(self) -> dict:
+        "This is used to get the `tests/bcss_tests.properties` file"
+        return self.get_properties()
+