Merge branch 'main' into feature/BCSS-20441-tableutil-markdown-doc-and-doc-strings

Author: mepr1

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()

docs/utility-guides/Oracle.md

@@ -0,0 +1,67 @@
+# Utility Guide: Oracle
+
+The Oracle Utility can be used to run SQL queries or stored procedures on the Oracle database.
+
+## Table of Contents
+
+- [Utility Guide: Oracle](#utility-guide-oracle)
+  - [Table of Contents](#table-of-contents)
+  - [Using the Oracle Utility](#using-the-oracle-utility)
+  - [Required arguments](#required-arguments)
+  - [Example usage](#example-usage)
+  - [Oracle Specific Functions](#oracle-specific-functions)
+  - [Example Usage](#example-usage-1)
+
+## Using the Oracle Utility
+
+To use the Oracle Utility, import the 'OracleDB' class into your test file and then call the OracleDB methods from within your tests, as required.
+
+## Required arguments
+
+The functions in this class require different arguments.<br>
+Look at the docstrings for each function to see what arguments are required.<br>
+The docstrings also specify when arguments are optional, and what the default values are when no argument is provided.
+
+## Example usage
+
+    from utils.oracle.oracle import OracleDB
+
+    def test_oracle_query() -> None:
+
+        query = """select column_a,
+        column_b,
+        column_c
+        from example_table
+        where condition_1 = :condition1
+        and condition_2 = :condition2"""
+
+        params = {
+        "condition1": 101,
+        "condition2": 202,
+        }
+
+        result_df = OracleDB().execute_query(query, params)
+
+    def run_stored_procedure() -> None:
+
+        OracleDB().execute_stored_procedure("bcss_timed_events")
+
+## Oracle Specific Functions
+
+This contains SQL queries that can be used to run tests.<br>
+These are all stored in one location to make it easier to edit the query at a later date and to make it accessible to multiple tests.
+
+Common values are placed in the `SqlQueryValues` class to avoid repeating the same values in the queries.
+
+## Example Usage
+
+    from oracle.oracle import OracleDB
+
+    def example_query() -> pd.DataFrame:
+
+        example_df = OracleDB().execute_query(
+            f"""subject_nhs_number
+        from ep_subject_episode_t
+        where se.latest_event_status_id in ({SqlQueryValues.S10_EVENT_STATUS}, {SqlQueryValues.S19_EVENT_STATUS})""")
+
+        return example_df

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/bcss_smokescreen_tests.properties

@@ -20,7 +20,7 @@
     c3_fit_kit_normal_result=75
     c3_fit_kit_abnormal_result=150
     c3_fit_kit_analyser_code=UU2_tdH3
-    c3_total_fit_kits_to_retieve=9
+    c3_total_fit_kits_to_retrieve=9
     c3_fit_kit_authorised_user=AUTO1
 
 # ----------------------------------

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)