Moving generic pytest fixtures to conftest (#52)

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

<!-- Describe your changes in detail. -->
Moving generic pytest fixtures into conftest.py

## Context

<!-- Why is this change required? What problem does it solve? -->
Reduces the amount of repeat code

## Type of changes

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

- [x] Refactoring (non-breaking change)
- [ ] 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)

## Checklist

<!-- 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)
- [ ] I have updated the documentation accordingly
- [ ] This PR is a result of pair or mob programming

---

## Sensitive Information Declaration

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

conftest.py

@@ -8,8 +8,9 @@
 import os
 from dotenv import load_dotenv
 from pathlib import Path
+from utils.load_properties_file import PropertiesFile
 
-LOCAL_ENV_PATH = Path(os.getcwd()) / 'local.env'
+LOCAL_ENV_PATH = Path(os.getcwd()) / "local.env"
 
 
 @pytest.fixture(autouse=True, scope="session")
@@ -24,3 +25,13 @@ def import_local_env_file() -> None:
     """
     if Path.is_file(LOCAL_ENV_PATH):
         load_dotenv(LOCAL_ENV_PATH, override=False)
+
+
+@pytest.fixture
+def smokescreen_properties() -> dict:
+    return PropertiesFile().get_smokescreen_properties()
+
+
+@pytest.fixture
+def general_properties() -> dict:
+    return PropertiesFile().get_general_properties()

setup_env_file.py

@@ -11,19 +11,26 @@
 import os
 from pathlib import Path
 
-REQUIRED_KEYS = ["USER_PASS"]
-DEFAULT_LOCAL_ENV_PATH = Path(os.getcwd()) / 'local.env'
+REQUIRED_KEYS = ["BCSS_PASS", "ORACLE_USERNAME", "ORACLE_DB", "ORACLE_PASS"]
+DEFAULT_LOCAL_ENV_PATH = Path(os.getcwd()) / "local.env"
+
 
 def create_env_file():
     """
     Create a local.env file with the required keys.
     """
-    with open(DEFAULT_LOCAL_ENV_PATH, 'w') as f:
-        f.write("# Use this file to populate secrets without committing them to the codebase (as this file is set in .gitignore).\n")
-        f.write("# To retrieve values as part of your tests, use os.getenv('VARIABLE_NAME').\n")
-        f.write("# Note: When running in a pipeline or workflow, you should pass these variables in at runtime.\n\n")
+    with open(DEFAULT_LOCAL_ENV_PATH, "w") as f:
+        f.write(
+            "# Use this file to populate secrets without committing them to the codebase (as this file is set in .gitignore).\n"
+        )
+        f.write(
+            "# To retrieve values as part of your tests, use os.getenv('VARIABLE_NAME').\n"
+        )
+        f.write(
+            "# Note: When running in a pipeline or workflow, you should pass these variables in at runtime.\n\n"
+        )
         for key in REQUIRED_KEYS:
-            f.write(f'{key}=\n')
+            f.write(f"{key}=\n")
 
 
 if __name__ == "__main__":

tests/smokescreen/test_compartment_1.py

@@ -10,12 +10,6 @@
 from pages.call_and_recall.generate_invitations_page import GenerateInvitationsPage
 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:
-    return PropertiesFile().get_smokescreen_properties()
 
 
 @pytest.mark.smoke

tests/smokescreen/test_compartment_2.py

@@ -10,12 +10,6 @@
 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 utils.load_properties_file import PropertiesFile
-
-
-@pytest.fixture
-def smokescreen_properties() -> dict:
-    return PropertiesFile().get_smokescreen_properties()
 
 
 @pytest.mark.vpn_required

tests/smokescreen/test_compartment_3.py

@@ -10,12 +10,6 @@
     execute_fit_kit_stored_procedures,
 )
 from utils.user_tools import UserTools
-from utils.load_properties_file import PropertiesFile
-
-
-@pytest.fixture
-def smokescreen_properties() -> dict:
-    return PropertiesFile().get_smokescreen_properties()
 
 
 @pytest.mark.vpn_required

tests/smokescreen/test_compartment_4.py

@@ -24,7 +24,6 @@
     EpisodeEventsAndNotesPage,
 )
 from utils.user_tools import UserTools
-from utils.load_properties_file import PropertiesFile
 from utils.calendar_picker import CalendarPicker
 from utils.batch_processing import batch_processing
 from datetime import datetime
@@ -33,11 +32,6 @@
 import logging
 
 
-@pytest.fixture
-def smokescreen_properties() -> dict:
-    return PropertiesFile().get_smokescreen_properties()
-
-
 @pytest.mark.vpn_required
 @pytest.mark.smokescreen
 @pytest.mark.compartment4

tests/smokescreen/test_compartment_5.py

@@ -49,19 +49,13 @@
 )
 
 from utils.user_tools import UserTools
-from utils.load_properties_file import PropertiesFile
 from utils.screening_subject_page_searcher import verify_subject_event_status_by_nhs_no
 from utils.calendar_picker import CalendarPicker
 from utils.oracle.oracle_specific_functions import get_subjects_with_booked_appointments
 from datetime import datetime, timedelta
 import logging
 
 
-@pytest.fixture
-def smokescreen_properties() -> dict:
-    return PropertiesFile().get_smokescreen_properties()
-
-
 @pytest.mark.vpn_required
 @pytest.mark.smokescreen
 @pytest.mark.compartment5

tests/test_call_and_recall_page.py

@@ -11,12 +11,6 @@
 from pages.call_and_recall.invitations_plans_page import InvitationsPlansPage
 from pages.call_and_recall.create_a_plan_page import CreateAPlanPage
 from utils.user_tools import UserTools
-from utils.load_properties_file import PropertiesFile
-
-
-@pytest.fixture
-def general_properties() -> dict:
-    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)

tests/test_fit_test_kits_page.py

@@ -15,12 +15,6 @@
 from pages.fit_test_kits.manage_qc_products_page import ManageQCProductsPage
 from pages.fit_test_kits.maintain_analysers_page import MaintainAnalysersPage
 from utils.user_tools import UserTools
-from utils.load_properties_file import PropertiesFile
-
-
-@pytest.fixture
-def general_properties() -> dict:
-    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)

tests/test_organisations_page.py

@@ -3,12 +3,6 @@
 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 general_properties() -> dict:
-    return PropertiesFile().get_general_properties()
 
 
 @pytest.fixture(scope="function", autouse=True)