Making test_properties into its own util: BCSS-20024 (#15)

<!-- markdownlint-disable-next-line first-line-heading -->

<!-- Describe your changes in detail. -->
This is moving all of the smokescreen_properties/test_properties methods
into a util to be used by all tests.
As there are two different property files, one for the compartments and
one for the rest I added an if statement to select between them
depending on the input provided

This change is tracked by the Jira ticket:
[BCSS-20024](https://nhsd-jira.digital.nhs.uk/browse/BCSS-20024)

<!-- Why is this change required? What problem does it solve? -->
This helps to reduce the number of duplicate code and we can easier load
the properties file across all of our tests with the same method,
instead of repeating it again for each test.

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply. -->

- [x] Refactoring (non-breaking change)
- [x] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would change existing
functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)

<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->

- [x] I am familiar with the [contributing
guidelines](https://github.com/nhs-england-tools/playwright-python-blueprint/blob/main/CONTRIBUTING.md)
- [x] I have followed the code style of the project
- [ ] I have added tests to cover my changes (where appropriate)
- [x] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming

---

To ensure the utmost confidentiality and protect your and others
privacy, we kindly ask you to NOT including [PII (Personal Identifiable
Information) / PID (Personal Identifiable
Data)](https://digital.nhs.uk/data-and-information/keeping-data-safe-and-benefitting-the-public)
or any other sensitive data in this PR (Pull Request) and the codebase
changes. We will remove any PR that do contain any sensitive
information. We really appreciate your cooperation in this matter.

- [x] I confirm that neither PII/PID nor sensitive data are included in
this PR and the codebase changes.

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,12 @@
 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
-
+    return PropertiesFile().get_smokescreen_properties()
 
 @pytest.mark.smoke
 @pytest.mark.compartment1

tests/smokescreen/test_compartment_2.py

@@ -10,29 +10,12 @@
 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
+    return PropertiesFile().get_smokescreen_properties()
 
 
 @pytest.mark.smoke

tests/smokescreen/test_compartment_3.py

@@ -10,29 +10,12 @@
     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
+    return PropertiesFile().get_smokescreen_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,12 @@
 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 general_properties() -> dict:
+    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -79,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, tests_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
     """
@@ -88,7 +73,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"]
+        general_properties["screening_centre_code"]
     )
 
     # Select an invitation plan

tests/test_organisations_page.py

@@ -1,29 +1,14 @@
-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 general_properties() -> dict:
+    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -86,7 +71,7 @@ def test_organisations_page_navigation(page: Page) -> None:
 
 
 def test_view_an_organisations_system_parameters(
-    page: Page, tests_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms that an organisation's system parameters can be accessed and viewed
@@ -95,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=tests_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

@@ -1,44 +1,15 @@
 import pytest
 from playwright.sync_api import Page, expect
-<<<<<<< HEAD
-=======
-from sys import platform
->>>>>>> 9311a0b (BCSS-20020: Compartment 1 Smokescreen Tests (#7))
 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
-<<<<<<< HEAD
-import os
-=======
->>>>>>> 9311a0b (BCSS-20020: Compartment 1 Smokescreen Tests (#7))
+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.
-    """
-<<<<<<< HEAD
-    path = f"{os.getcwd()}/tests/bcss_tests.properties"
-    configs = Properties()
-    with open(path, "rb") as read_prop:
-        configs.load(read_prop)
-=======
-    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)
->>>>>>> 9311a0b (BCSS-20020: Compartment 1 Smokescreen Tests (#7))
-    return configs.properties
+def general_properties() -> dict:
+    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -273,7 +244,7 @@ def test_failsafe_reports_allocate_sc_for_patient_movements_within_hub_boundarie
 
 
 def test_failsafe_reports_allocate_sc_for_patient_movements_within_hub_boundaries(
-    page: Page, tests_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms 'allocate_sc_for_patient_movements_within_hub_boundaries' page loads,
@@ -338,15 +309,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"]
+        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(
-        tests_properties["coventry_and_warwickshire_bcs_centre"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
 
@@ -478,7 +449,7 @@ def test_operational_reports_appointment_attendance_not_updated(
 
 # Operational Reports
 def test_operational_reports_appointment_attendance_not_updated(
-    page: Page, tests_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms 'appointment_attendance_not_updated' page loads,
@@ -508,17 +479,15 @@ def test_operational_reports_appointment_attendance_not_updated(
     )
 
     # Select a screening centre from the drop-down options
-    ReportsPage(
-        page
-    ).attendance_not_updated_set_patients_screening_centre_dropdown.select_option(
-        tests_properties["coventry_and_warwickshire_bcs_centre"]
+    set_patients_screening_centre_dropdown.select_option(
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 =======
     BasePage(page).bowel_cancer_screening_ntsh_page_title_contains_text("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"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click "Generate Report" button
@@ -606,7 +575,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, general_properties: dict
 ) -> None:
     """
     Confirms 'screening_practitioner_6_weeks_availability_not_set_up_report' page loads,
@@ -651,7 +620,19 @@ 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"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
+    )
+=======
+    ReportsPage(page).go_to_screening_practitioner_6_weeks_availability_not_set_up_report_page()
+
+    # Verify page title is "Screening Practitioner 6 Weeks Availability Not Set Up"
+    BasePage(page).bowel_cancer_screening_ntsh_page_title_contains_text(
+        "Screening Practitioner 6 Weeks Availability Not Set Up"
+    )
+
+    # Select a screening centre
+    set_patients_screening_centre_dropdown.select_option(
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Click "Generate Report"
@@ -691,7 +672,7 @@ def test_operational_reports_screening_practitioner_appointments(
 
 @pytest.mark.only
 def test_operational_reports_screening_practitioner_appointments(
-    page: Page, tests_properties: dict
+    page: Page, general_properties: dict
 ) -> None:
     """
     Confirms 'screening_practitioner_appointments' page loads,
@@ -749,12 +730,35 @@ 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"]
+        general_properties["coventry_and_warwickshire_bcs_centre"]
+    )
+
+    # Select a screening practitioner
+    ReportsPage(page).screening_practitioner_dropdown.select_option(
+        general_properties["screening_practitioner_named_another_stubble"]
+    )
+
+    # Click "Generate Report"
+    ReportsPage(page).operational_reports_sp_appointments_generate_report_button.click()
+
+    # Verify timestamp has updated to current date and time
+    report_timestamp = (
+        DateTimeUtils.screening_practitioner_appointments_report_timestamp_date_format()
+    )
+    expect(ReportsPage(Page).common_report_timestamp_element).to_contain_text(
+        report_timestamp
+    )
+=======
+    BasePage(page).bowel_cancer_screening_ntsh_page_title_contains_text("Screening Practitioner Appointments")
+
+    # Select a screening centre
+    set_patients_screening_centre_dropdown.select_option(
+        general_properties["coventry_and_warwickshire_bcs_centre"]
     )
 
     # Select a screening practitioner
     screening_practitioner_dropdown.select_option(
-        tests_properties["screening_practitioner_named_another_stubble"]
+        general_properties["screening_practitioner_named_another_stubble"]
     )
 
     # Click "Generate Report"