Moving hard coded values from tests into the properties file (#20)

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

<!-- Describe your changes in detail. -->
Moving hard coded values from tests into the properties file. This is so
that if they are changed in the future, they only need to be changed in
the properties file

## Context

<!-- Why is this change required? What problem does it solve? -->
This was done is so that if they are changed in the future, they only
need to be changed in the properties file

## 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

pages/call_and_recall/generate_invitations_page.py

@@ -32,7 +32,9 @@ def verify_invitation_generation_progress_title(self) -> None:
             "Invitation Generation Progress"
         )
 
-    def wait_for_invitation_generation_complete(self) -> bool:
+    def wait_for_invitation_generation_complete(
+        self, number_of_invitations: int
+    ) -> bool:
         """
         This function is used to wait for the invitations to be generated.
         Every 5 seconds it refreshes the table and checks to see if the invitations have been generated.
@@ -78,8 +80,10 @@ def wait_for_invitation_generation_complete(self) -> bool:
         value = (
             self.planned_invitations_total.text_content().strip()
         )  # Get text and remove extra spaces
-        if int(value) < 5:
-            pytest.fail("There are less than 5 invitations generated")
+        if int(value) < number_of_invitations:
+            pytest.fail(
+                f"There are less than {number_of_invitations} invitations generated"
+            )
 
         self_referrals_total = int(self.self_referrals_total.text_content().strip())
         if self_referrals_total >= 1:

tests/smokescreen/bcss_smokescreen_tests.properties

@@ -8,7 +8,9 @@
 #   compartment 2
 # ----------------------------------
     c2_normal_kits_to_log=9
-#    c2_fit_kit_logging_test_org_id=23159
+    c2_total_fit_kits_to_retieve=10
+    c2_fit_kit_logging_test_org_id=23159
+    c2_fit_kit_tk_type_id=2
 #    c2_eng_gfobt_kit_logging_test_org_id=23159
 
 # ----------------------------------
@@ -17,8 +19,9 @@
     c3_fit_kit_results_test_org_id=23159
     c3_fit_kit_normal_result=75
     c3_fit_kit_abnormal_result=150
-#    c3_fit_kit_authorised_user=AUTO1
-#    c3_fit_kit_analyser_code=HMJackalt1
+    c3_fit_kit_analyser_code=UU2_tdH3
+    c3_total_fit_kits_to_retieve=9
+    c3_fit_kit_authorised_user=AUTO1
 
 # ----------------------------------
 #   compartment 4

tests/smokescreen/test_compartment_1.py

@@ -17,6 +17,7 @@
 def smokescreen_properties() -> dict:
     return PropertiesFile().get_smokescreen_properties()
 
+
 @pytest.mark.smoke
 @pytest.mark.compartment1
 @pytest.mark.compartment1_plan_creation
@@ -50,7 +51,7 @@ def test_create_invitations_plan(page: Page, smokescreen_properties: dict) -> No
 @pytest.mark.smoke
 @pytest.mark.smokescreen
 @pytest.mark.compartment1
-def test_compartment_1(page: Page) -> None:
+def test_compartment_1(page: Page, smokescreen_properties: dict) -> None:
     """
     This is the main compartment 1 function. It covers the following:
     - Generating invitations based on the invitation plan
@@ -69,7 +70,9 @@ def test_compartment_1(page: Page) -> None:
     GenerateInvitations(page).click_generate_invitations_button()
     self_referrals_available = GenerateInvitations(
         page
-    ).wait_for_invitation_generation_complete()
+    ).wait_for_invitation_generation_complete(
+        int(smokescreen_properties["c1_daily_invitation_rate"])
+    )
 
     # Print the batch of Pre-Invitation Letters - England
     logging.info("Compartment 1 - Process S1 Batch")

tests/smokescreen/test_compartment_2.py

@@ -34,7 +34,11 @@ def test_compartment_2(page: Page, smokescreen_properties: dict) -> None:
 
     BasePage(page).go_to_fit_test_kits_page()
     FITTestKits(page).go_to_log_devices_page()
-    subjectdf = create_fit_id_df()
+
+    tk_type_id = smokescreen_properties["c2_fit_kit_tk_type_id"]
+    hub_id = smokescreen_properties["c2_fit_kit_logging_test_org_id"]
+    no_of_kits_to_retrieve = smokescreen_properties["c2_total_fit_kits_to_retieve"]
+    subjectdf = create_fit_id_df(tk_type_id, hub_id, no_of_kits_to_retrieve)
 
     for subject in range(int(smokescreen_properties["c2_normal_kits_to_log"])):
         fit_device_id = subjectdf["fit_device_id"].iloc[subject]

utils/fit_kit_generation.py

@@ -4,13 +4,15 @@
 import logging
 
 
-def create_fit_id_df() -> pd.DataFrame:
+def create_fit_id_df(
+    tk_type_id: int, hub_id: int, no_of_kits_to_retrieve: int
+) -> pd.DataFrame:
     """
     The first step here is to get the relevant test data for compartment 2
     Then it calculates the check digit for each kit id retrieved
     Finally it adds the final part on the end (expiry date + random characters)
     """
-    df = get_kit_id_from_db()
+    df = get_kit_id_from_db(tk_type_id, hub_id, no_of_kits_to_retrieve)
     df["fit_device_id"] = df["kitid"].apply(calculate_check_digit)
     df["fit_device_id"] = df["fit_device_id"].apply(convert_kit_id_to_fit_device_id)
     return df

utils/oracle/oracle_specific_functions.py

@@ -2,9 +2,19 @@
 import logging
 import pandas as pd
 from datetime import datetime
+from enum import IntEnum
 
 
-def get_kit_id_from_db() -> pd.DataFrame:
+class SqlQueryValues(IntEnum):
+    S10_EVENT_STATUS = 11198
+    S19_EVENT_STATUS = 11213
+    S43_EVENT_STATUS = 11223
+    OPEN_EPISODE_STATUS_ID = 11352
+
+
+def get_kit_id_from_db(
+    tk_type_id: int, hub_id: int, no_of_kits_to_retrieve: int
+) -> pd.DataFrame:
     """
     This query is used to obtain test kits used in compartment 2
     It searches for kits that have not been logged and meet the following criteria:
@@ -14,19 +24,19 @@ def get_kit_id_from_db() -> pd.DataFrame:
     """
     logging.info("Retrieving useable test kit ids")
     kit_id_df = OracleDB().execute_query(
-        """select tk.kitid, tk.screening_subject_id, sst.subject_nhs_number
+        f"""select tk.kitid, tk.screening_subject_id, sst.subject_nhs_number
     from tk_items_t tk
     inner join ep_subject_episode_t se on se.screening_subject_id = tk.screening_subject_id
     inner join screening_subject_t sst on (sst.screening_subject_id = tk.screening_subject_id)
     inner join sd_contact_t sdc on (sdc.nhs_number = sst.subject_nhs_number)
-    where tk.tk_type_id = 2
+    where tk.tk_type_id = {tk_type_id}
     and tk.logged_in_flag = 'N'
-    and sdc.hub_id = 23159
+    and sdc.hub_id = {hub_id}
     and device_id is null
     and tk.invalidated_date is null
-    and se.latest_event_status_id in (11198, 11213)
+    and se.latest_event_status_id in ({SqlQueryValues.S10_EVENT_STATUS}, {SqlQueryValues.S19_EVENT_STATUS})
     order by tk.kitid DESC
-    fetch first 10 rows only"""
+    fetch first {no_of_kits_to_retrieve} rows only"""
     )
     return kit_id_df
 
@@ -65,13 +75,13 @@ def get_kit_id_logged_from_db(smokescreen_properties: dict) -> pd.DataFrame:
     INNER JOIN ep_subject_episode_t se ON se.screening_subject_id = tk.screening_subject_id
     WHERE tk.logged_in_flag = 'Y'
     AND kq.test_kit_status IN ('LOGGED', 'POSTED')
-    AND se.episode_status_id = 11352
+    AND se.episode_status_id = {SqlQueryValues.OPEN_EPISODE_STATUS_ID}
     AND tk.tk_type_id = 2
-    AND se.latest_event_status_id = 11223
+    AND se.latest_event_status_id = {SqlQueryValues.S43_EVENT_STATUS}
     AND tk.logged_in_at = {smokescreen_properties["c3_fit_kit_results_test_org_id"]}
     AND tk.reading_flag = 'N'
     AND tk.test_results IS NULL
-    fetch first 9 rows only
+    fetch first {smokescreen_properties["c3_total_fit_kits_to_retieve"]} rows only
     """
     )
 
@@ -113,9 +123,7 @@ def get_service_management_by_device_id(device_id: str) -> pd.DataFrame:
     LEFT OUTER JOIN ORG lo ON lo.org_code = kq.logged_by_hub
     WHERE kq.test_kit_type = 'FIT' AND kq.device_id = :device_id
     """
-    params = {
-        "device_id": device_id
-    }
+    params = {"device_id": device_id}
     get_service_management_df = OracleDB().execute_query(query, params)
     return get_service_management_df
 
@@ -160,9 +168,9 @@ def update_kit_service_management_entity(
     kq.test_result = :test_result,
     kq.calculated_result = :calculated_result,
     kq.error_code = NULL,
-    kq.analyser_code = 'UU2_tdH3',
+    kq.analyser_code = :analyser_code,
     kq.date_time_authorised = TO_TIMESTAMP(:date_time_authorised, 'DD-Mon-YY HH24.MI.SS.FF9'),
-    kq.authoriser_user_code = 'AUTO1',
+    kq.authoriser_user_code = :authoriser_user_code,
     kq.post_response = :post_response,
     kq.post_attempts = :post_attempts,
     kq.put_response = :put_response,
@@ -179,7 +187,9 @@ def update_kit_service_management_entity(
         "date_time_logged": date_time_logged,
         "test_result": int(test_result),
         "calculated_result": calculated_result,
+        "analyser_code": smokescreen_properties["c3_fit_kit_analyser_code"],
         "date_time_authorised": str(date_time_authorised),
+        "authoriser_user_code": smokescreen_properties["c3_fit_kit_authorised_user"],
         "post_response": int(post_response) if post_response is not None else 0,
         "post_attempts": int(post_attempts) if post_attempts is not None else 0,
         "put_response": put_response,