Seperating out oracle_specific_functions into seperate files

Author: adrianoaru-nhs

conftest.py

@@ -15,7 +15,7 @@
 from _pytest.config.argparsing import Parser
 from _pytest.fixtures import FixtureRequest
 from playwright.sync_api import Page
-from utils.oracle.oracle_specific_functions import (
+from utils.oracle.oracle_specific_functions.organisation_parameters import (
     set_org_parameter_value,
     check_parameter,
 )

docs/utility-guides/FitKit.md

@@ -145,7 +145,7 @@ This example is showing how we are using this utility in compartment 3.
 
 ```python
 from utils.fit_kit import FitKitLogged
-from utils.oracle.oracle_specific_functions import update_kit_service_management_entity
+from utils.oracle.oracle_specific_functions.kit_management import update_kit_service_management_entity
 
 def test_compartment_3(page: Page, smokescreen_properties: dict):
     device_ids = FitKitLogged().process_kit_data(smokescreen_properties)

docs/utility-guides/Oracle.md

@@ -24,8 +24,8 @@ You might use this utility for:
   - [Oracle Utility Methods](#oracle-utility-methods)
   - [Example usage](#example-usage)
   - [Oracle Specific Functions](#oracle-specific-functions)
-  - [How to Add New Oracle-Specific Functions](#how-to-add-new-oracle-specific-functions)
-  - [Example Usage](#example-usage-1)
+    - [How to Add New Oracle-Specific Functions](#how-to-add-new-oracle-specific-functions)
+    - [Example Usage](#example-usage-1)
 
 ## Using the Oracle Utility
 
@@ -94,23 +94,45 @@ OracleDB().create_subjects_via_sspi(
 
 ## 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.
+Oracle-specific functions are now organized into separate files under `utils/oracle/oracle_specific_functions/` for better maintainability and discoverability.  
+Each file groups related functions by their domain or purpose.
 
-Common values are placed in the `SqlQueryValues` class to avoid repeating the same values in the queries.
+Below is a table showing the current structure and which functions are found in each file:
 
-## How to Add New Oracle-Specific Functions
+| File Name                                 | Functions/Classes Included                                                                                   |
+|--------------------------------------------|--------------------------------------------------------------------------------------------------------------|
+| **enums.py**                              | `SqlQueryValues` (common enum values for queries)                                                            |
+| **kit_management.py**                      | `get_kit_id_from_db`, `get_kit_id_logged_from_db`, `get_service_management_by_device_id`,<br>`update_kit_service_management_entity`, `execute_fit_kit_stored_procedures` |
+| **organisation_parameters.py**             | `set_org_parameter_value`, `get_org_parameter_value`, `check_parameter`                                      |
+| **screening_colonoscopist.py**             | `build_accredited_screening_colonoscopist_query`, `get_accredited_screening_colonoscopist_in_bcs001`         |
+| **subject_address.py**                     | `check_if_subject_has_temporary_address`                                                                     |
+| **subject_appointment.py**                 | `get_subjects_for_appointments`, `get_subjects_with_booked_appointments`                                     |
+| **subject_batch.py**                       | `get_nhs_no_from_batch_id`                                                                                   |
+| **supporting_notes.py**                    | `get_subjects_by_note_count`, `get_supporting_notes`, `get_subjects_with_multiple_notes`                     |
+| **investigation_dataset.py**               | `get_investigation_dataset_polyp_category`, `get_investigation_dataset_polyp_algorithm_size`,<br>`get_subjects_for_investigation_dataset_updates` |
+| **subject_selector.py**                    | `SubjectSelector` (class for subject selection logic)                                                        |
 
-- Define a new function in `utils/oracle/oracle_specific_functions.py`.
-- Create your SQL query, `parameterizing` as needed.
-- Call the  relevant methods from the oracle `util` based on your needs (e.g., `execute_query`, stored procedure methods, etc.).
-- Return the result in the appropriate format for your function.
-- Document the function with a clear docstring.
+> **Note:**  
+> If you are looking for a specific function, check the relevant file in `utils/oracle/oracle_specific_functions/`.  
+> Common values used in queries are placed in `enums.py` as the `SqlQueryValues` class.
 
-## Example Usage
+---
+
+### How to Add New Oracle-Specific Functions
+
+- Add your new function to the most appropriate file in `utils/oracle/oracle_specific_functions/`.
+- If your function does not fit an existing category, create a new file with a descriptive name.
+- Document your function with a clear docstring.
+- If your function uses common query values, consider adding them to `enums.py`.
+- Once done add the function to the table above
+
+---
+
+### Example Usage
 
 ```python
 from utils.oracle.oracle import OracleDB
+from utils.oracle.oracle_specific_functions.enums import SqlQueryValues
 
 def example_query() -> pd.DataFrame:
     """

pages/datasets/investigation_dataset_page.py

@@ -2,7 +2,7 @@
 from playwright.sync_api import Page, expect, Locator
 from pages.base_page import BasePage
 from enum import Enum, StrEnum
-from utils.oracle.oracle_specific_functions import (
+from utils.oracle.oracle_specific_functions.subject_datasets import (
     get_investigation_dataset_polyp_category,
     get_investigation_dataset_polyp_algorithm_size,
 )

tests/regression/communications_production/test_fit_self_refer_letter_processing.py

@@ -23,7 +23,9 @@
     SubjectScreeningSummaryPage,
 )
 from utils.table_util import TableUtils
-from utils.oracle.oracle_specific_functions import get_nhs_no_from_batch_id
+from utils.oracle.oracle_specific_functions.subject_batch import (
+    get_nhs_no_from_batch_id,
+)
 from utils import batch_processing
 from utils import screening_subject_page_searcher
 

tests/regression/manual_cease/test_manually_cease_a_subject.py

@@ -3,7 +3,7 @@
 import pandas as pd
 from playwright.sync_api import Page, expect
 from pages.base_page import BasePage
-from utils.oracle.oracle_specific_functions import SubjectSelector
+from utils.oracle.subject_selector import SubjectSelector
 from utils.oracle.oracle import OracleDB
 from pages.base_page import BasePage
 from pages.manual_cease.manual_cease_page import ManualCeasePage

tests/regression/notes/test_additional_care_notes.py

@@ -15,7 +15,7 @@
     SubjectEventsNotes,
     AdditionalCareNoteTypeOptions,
 )
-from utils.oracle.oracle_specific_functions import (
+from utils.oracle.oracle_specific_functions.subject_notes import (
     get_subjects_by_note_count,
     get_subjects_with_multiple_notes,
 )

tests/regression/notes/test_episode_notes.py

@@ -15,7 +15,9 @@
     SubjectEventsNotes,
 )
 from utils.table_util import TableUtils
-from utils.oracle.oracle_specific_functions import get_subjects_by_note_count
+from utils.oracle.oracle_specific_functions.subject_notes import (
+    get_subjects_by_note_count,
+)
 from utils.screening_subject_page_searcher import search_subject_episode_by_nhs_number
 from utils.subject_notes import (
     fetch_supporting_notes_from_db,

tests/regression/notes/test_kit_notes.py

@@ -15,7 +15,9 @@
     NotesStatusOptions,
     SubjectEventsNotes,
 )
-from utils.oracle.oracle_specific_functions import get_subjects_by_note_count
+from utils.oracle.oracle_specific_functions.subject_notes import (
+    get_subjects_by_note_count,
+)
 from utils.subject_notes import (
     fetch_supporting_notes_from_db,
     verify_note_content_matches_expected,

tests/regression/notes/test_subject_notes.py

@@ -15,7 +15,7 @@
     NotesStatusOptions,
     SubjectEventsNotes,
 )
-from utils.oracle.oracle_specific_functions import (
+from utils.oracle.oracle_specific_functions.subject_notes import (
     get_subjects_by_note_count,
     get_subjects_with_multiple_notes,
 )