Making test_properties into its own util: BCSS-20024

Author: adrianoaru-nhs

tests/smokescreen/test_compartment_1.py

@@ -1,7 +1,5 @@
-from sys import platform
 import pytest
 import logging
-from jproperties import Properties
 from pages.logout.log_out_page import Logout
 from utils.user_tools import UserTools
 from pages.base_page import BasePage
@@ -12,28 +10,13 @@
 from pages.call_and_recall.generate_invitations_page import GenerateInvitations
 from playwright.sync_api import Page
 from utils.batch_processing import batch_processing
+from utils.load_properties_file import PropertiesFile
 
 
 @pytest.fixture
 def smokescreen_properties() -> dict:
-    """
-    Reads the 'bcss_smokescreen_tests.properties' file and populates a 'Properties' object.
-    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()
-    if platform == "win32":  # File path from content root is required on Windows OS
-        with open(
-            "tests/smokescreen/bcss_smokescreen_tests.properties", "rb"
-        ) as read_prop:
-            configs.load(read_prop)
-    elif platform == "darwin":  # Only the filename is required on macOS
-        with open("bcss_smokescreen_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    return configs.properties
-
+    properties = PropertiesFile().smokescreen_properties("compartment")
+    return properties
 
 @pytest.mark.smoke
 @pytest.mark.compartment1

tests/smokescreen/test_compartment_2.py

@@ -10,29 +10,13 @@
 from utils.fit_kit_generation import create_fit_id_df
 from utils.screening_subject_page_searcher import verify_subject_event_status_by_nhs_no
 from utils.user_tools import UserTools
-from jproperties import Properties
-from sys import platform
+from utils.load_properties_file import PropertiesFile
 
 
 @pytest.fixture
 def smokescreen_properties() -> dict:
-    """
-    Reads the 'bcss_smokescreen_tests.properties' file and populates a 'Properties' object.
-    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()
-    if platform == "win32":  # File path from content root is required on Windows OS
-        with open(
-            "tests/smokescreen/bcss_smokescreen_tests.properties", "rb"
-        ) as read_prop:
-            configs.load(read_prop)
-    elif platform == "darwin":  # Only the filename is required on macOS
-        with open("bcss_smokescreen_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    return configs.properties
+    properties = PropertiesFile().smokescreen_properties("compartment")
+    return properties
 
 
 @pytest.mark.smoke

tests/smokescreen/test_compartment_3.py

@@ -10,29 +10,13 @@
     execute_fit_kit_stored_procedures,
 )
 from utils.user_tools import UserTools
-from jproperties import Properties
-from sys import platform
+from utils.load_properties_file import PropertiesFile
 
 
 @pytest.fixture
 def smokescreen_properties() -> dict:
-    """
-    Reads the 'bcss_smokescreen_tests.properties' file and populates a 'Properties' object.
-    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()
-    if platform == "win32":  # File path from content root is required on Windows OS
-        with open(
-            "tests/smokescreen/bcss_smokescreen_tests.properties", "rb"
-        ) as read_prop:
-            configs.load(read_prop)
-    elif platform == "darwin":  # Only the filename is required on macOS
-        with open("bcss_smokescreen_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    return configs.properties
+    properties = PropertiesFile().smokescreen_properties("compartment")
+    return properties
 
 
 @pytest.mark.smokescreen

tests/test_call_and_recall_page.py

@@ -1,5 +1,4 @@
 import pytest
-from sys import platform
 from playwright.sync_api import Page
 from pages.base_page import BasePage
 from pages.call_and_recall.call_and_recall_page import CallAndRecall
@@ -10,26 +9,13 @@
 from pages.call_and_recall.invitations_plans_page import InvitationsPlans
 from pages.call_and_recall.create_a_plan_page import CreateAPlan
 from utils.user_tools import UserTools
-from jproperties import Properties
+from utils.load_properties_file import PropertiesFile
 
 
 @pytest.fixture
-def tests_properties() -> dict:
-    """
-    Reads the 'bcss_tests.properties' file and populates a 'Properties' object.
-    Returns a dictionary of properties for use in tests.
-
-    Returns:
-        dict: A dictionary containing the values loaded from the 'bcss_tests.properties' file.
-    """
-    configs = Properties()
-    if platform == "win32":  # File path from content root is required on Windows OS
-        with open("tests/bcss_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    elif platform == "darwin":  # Only the filename is required on macOS
-        with open("bcss_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    return configs.properties
+def smokescreen_properties() -> dict:
+    properties = PropertiesFile().smokescreen_properties("smoke")
+    return properties
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -79,7 +65,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, tests_properties: dict) -> None:
+def test_view_an_invitation_plan(page: Page, smokescreen_properties: dict) -> None:
     """
     Confirms that an invitation plan can be viewed via a screening centre from the planning ad monitoring page
     """
@@ -88,7 +74,7 @@ def test_view_an_invitation_plan(page: Page, tests_properties: dict) -> None:
 
     # Select a screening centre
     InvitationsMonitoring(page).go_to_invitation_plan_page(
-        tests_properties["screening_centre_code"]
+        smokescreen_properties["screening_centre_code"]
     )
 
     # Select an invitation plan

tests/test_organisations_page.py

@@ -1,29 +1,15 @@
-from sys import platform
 import pytest
-from jproperties import Properties
 from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
 from pages.organisations.organisations_page import OrganisationsPage
 from utils.user_tools import UserTools
+from utils.load_properties_file import PropertiesFile
 
 
 @pytest.fixture
-def tests_properties() -> dict:
-    """
-    Reads the 'bcss_tests.properties' file and populates a 'Properties' object.
-    Returns a dictionary of properties for use in tests.
-
-    Returns:
-        dict: A dictionary containing the values loaded from the 'bcss_tests.properties' file.
-    """
-    configs = Properties()
-    if platform == "win32":  # File path from content root is required on Windows OS
-        with open("tests/bcss_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    elif platform == "darwin":  # Only the filename is required on macOS
-        with open("bcss_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    return configs.properties
+def smokescreen_properties() -> dict:
+    properties = PropertiesFile().smokescreen_properties("smoke")
+    return properties
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -86,7 +72,7 @@ def test_organisations_page_navigation(page: Page) -> None:
 
 
 def test_view_an_organisations_system_parameters(
-    page: Page, tests_properties: dict
+    page: Page, smokescreen_properties: dict
 ) -> None:
     """
     Confirms that an organisation's system parameters can be accessed and viewed
@@ -95,7 +81,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=tests_properties["screening_centre_code"]).click()
+    page.get_by_role("link", name=smokescreen_properties["screening_centre_code"]).click()
     BasePage(page).bowel_cancer_screening_ntsh_page_title_contains_text(
         "System Parameters"
     )

tests/test_reports_page.py

@@ -1,30 +1,16 @@
 import pytest
 from playwright.sync_api import Page, expect
-from sys import platform
 from pages.base_page import BasePage
 from pages.reports.reports_page import ReportsPage
 from utils.date_time_utils import DateTimeUtils
 from utils.user_tools import UserTools
-from jproperties import Properties
+from utils.load_properties_file import PropertiesFile
 
 
 @pytest.fixture
-def tests_properties() -> dict:
-    """
-    Reads the 'bcss_tests.properties' file and populates a 'Properties' object.
-    Returns a dictionary of properties for use in tests.
-
-    Returns:
-        dict: A dictionary containing the values loaded from the 'bcss_tests.properties' file.
-    """
-    configs = Properties()
-    if platform == "win32":  # File path from content root is required on Windows OS
-        with open("tests/bcss_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    elif platform == "darwin":  # Only the filename is required on macOS
-        with open("bcss_tests.properties", "rb") as read_prop:
-            configs.load(read_prop)
-    return configs.properties
+def smokescreen_properties() -> dict:
+    properties = PropertiesFile().smokescreen_properties("smoke")
+    return properties
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -204,7 +190,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, tests_properties: dict
+    page: Page, smokescreen_properties: dict
 ) -> None:
     """
     Confirms 'allocate_sc_for_patient_movements_within_hub_boundaries' page loads,
@@ -247,15 +233,15 @@ def test_failsafe_reports_allocate_sc_for_patient_movements_within_hub_boundarie
 
     # Select another screening centre
     set_patients_screening_centre_dropdown.select_option(
-        tests_properties["coventry_and_warwickshire_bcs_centre"]
+        smokescreen_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(
-        tests_properties["coventry_and_warwickshire_bcs_centre"]
+        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
 
@@ -346,7 +332,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, tests_properties: dict
+    page: Page, smokescreen_properties: dict
 ) -> None:
     """
     Confirms 'appointment_attendance_not_updated' page loads,
@@ -375,7 +361,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(
-        tests_properties["coventry_and_warwickshire_bcs_centre"]
+        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click "Generate Report" button
@@ -447,7 +433,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, tests_properties: dict
+    page: Page, smokescreen_properties: dict
 ) -> None:
     """
     Confirms 'screening_practitioner_6_weeks_availability_not_set_up_report' page loads,
@@ -474,7 +460,7 @@ def test_operational_reports_screening_practitioner_6_weeks_availability_not_set
 
     # Select a screening centre
     set_patients_screening_centre_dropdown.select_option(
-        tests_properties["coventry_and_warwickshire_bcs_centre"]
+        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click "Generate Report"
@@ -494,7 +480,7 @@ def test_operational_reports_screening_practitioner_6_weeks_availability_not_set
 
 @pytest.mark.only
 def test_operational_reports_screening_practitioner_appointments(
-    page: Page, tests_properties: dict
+    page: Page, smokescreen_properties: dict
 ) -> None:
     """
     Confirms 'screening_practitioner_appointments' page loads,
@@ -523,12 +509,12 @@ def test_operational_reports_screening_practitioner_appointments(
 
     # Select a screening centre
     set_patients_screening_centre_dropdown.select_option(
-        tests_properties["coventry_and_warwickshire_bcs_centre"]
+        smokescreen_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Select a screening practitioner
     screening_practitioner_dropdown.select_option(
-        tests_properties["screening_practitioner_named_another_stubble"]
+        smokescreen_properties["screening_practitioner_named_another_stubble"]
     )
 
     # Click "Generate Report"