Removed hard coded values from tests, added properties files for tests and smokescreen tests.

Changed properties keys from camel case to snake case, to be consistent with Python's naming conventions.
Some general refactoring.

Author: adrianoaru-nhs

pages/create_a_plan_page.py

@@ -1,6 +1,7 @@
 from playwright.sync_api import Page
 from utils.click_helper import click
 
+
 class CreateAPlan:
     def __init__(self, page: Page):
         self.page = page
@@ -17,7 +18,7 @@ def __init__(self, page: Page):
     def click_set_all_button(self):
         click(self.page, self.set_all_button)
 
-    def fill_daily_invitation_rate_field(self,value):
+    def fill_daily_invitation_rate_field(self,value: str):
         self.daily_invitation_rate_field.fill(value)
 
     def fill_weekly_invitation_rate_field(self,value):

pages/invitations_monitoring_page.py

@@ -1,18 +1,10 @@
 from playwright.sync_api import Page
 from utils.click_helper import click
 
+
 class InvitationsMonitoring:
     def __init__(self, page: Page):
         self.page = page
-        # Call and Recall - page links
-        self.bcss009_invitations_plan = self.page.get_by_role("link", name="BCS009")
-        self.bcss001_invitations_plan = self.page.get_by_role("link", name="BCS001")
-
-    def go_to_bcss009_invitations_plan_page(self):
-        click(self.page, self.bcss009_invitations_plan)
-
-    def go_to_bcss001_invitations_plan_page(self):
-        click(self.page, self.bcss001_invitations_plan)
-
-
 
+    def go_to_invitation_plan_page(self, sc_id):
+        self.page.get_by_role("link", name=sc_id).click()

requirements.txt

@@ -1,8 +1,9 @@
 pytest-playwright>=0.5.1
 pytest-html>=4.1.1
 pytest-json-report>=1.5.0
-oracledb>=2.5.1
-pandas>=2.2.3
+oracledb~=3.0.0
+pandas~=2.2.3
 python-dotenv~=1.0.1
 Flask~=3.0.3
 sqlalchemy>=2.0.38
+jproperties~=2.1.2

tests/Smokescreen/test_compartment_1.py

@@ -1,8 +1,25 @@
 import pytest
-from playwright.sync_api import Page
+from jproperties import Properties
+
 from my_pages import *
 from utils.batch_processing import batch_processing
 
+
+@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()
+    with open('bcss_smokescreen_tests.properties', 'rb') as read_prop:
+        configs.load(read_prop)
+    return configs.properties
+
+
 @pytest.mark.smoke
 @pytest.mark.compartment1
 def test_create_invitations_plan(page: Page) -> None:
@@ -14,11 +31,11 @@ def test_create_invitations_plan(page: Page) -> None:
     # Create plan - England
     MainMenu(page).go_to_call_and_recall_page()
     CallAndRecall(page).go_to_planning_and_monitoring_page()
-    InvitationsMonitoring(page).go_to_bcss001_invitations_plan_page()
+    InvitationsMonitoring(page).go_to_invitation_plan_page(smokescreen_properties["c1_screening_centre_code"])
     InvitationsPlans(page).go_to_create_a_plan_page()
     logging.info("Setting daily invitation rate")
     CreateAPlan(page).click_set_all_button()
-    CreateAPlan(page).fill_daily_invitation_rate_field("10")
+    CreateAPlan(page).fill_daily_invitation_rate_field(smokescreen_properties["c1_daily_invitation_rate"])
     CreateAPlan(page).click_update_button()
     CreateAPlan(page).click_confirm_button()
     CreateAPlan(page).click_save_button()

tests/Smokescreen/test_compartment_2.py

@@ -7,6 +7,7 @@
 from utils.fit_kit_generation import create_fit_id_df
 import logging
 
+
 @pytest.mark.smoke
 @pytest.mark.smokescreen
 @pytest.mark.compartment2
@@ -22,7 +23,7 @@ def test_compartment_2(page: Page) -> None:
         logging.info(f"Logging FIT Device ID: {fit_device_id}")
         LogDevices(page).fill_fit_device_id_field(fit_device_id)
         sample_date = datetime.now().strftime("%#d %b %Y")
-        logging.info("Setting sample date to todays date")
+        logging.info("Setting sample date to today's date")
         LogDevices(page).fill_sample_date_field(sample_date)
         try:
             LogDevices(page).verify_successfully_logged_device_text()
@@ -33,7 +34,8 @@ def test_compartment_2(page: Page) -> None:
     nhs_no = subjectdf["subject_nhs_number"].iloc[0]
     try:
         verify_subject_event_status_by_nhs_no(page, nhs_no, "S43 - Kit Returned and Logged (Initial Test)")
-        logging.info(f"Successfully verified NHS number {nhs_no} with status S43 - Kit Returned and Logged (Initial Test)")
+        logging.info(
+            f"Successfully verified NHS number {nhs_no} with status S43 - Kit Returned and Logged (Initial Test)")
     except Exception as e:
         pytest.fail(f"Verification failed for NHS number {nhs_no}: {str(e)}")
 
@@ -50,8 +52,7 @@ def test_compartment_2(page: Page) -> None:
         LogDevices(page).verify_successfully_logged_device_text()
         logging.info(f"{spoilt_fit_device_id} Successfully logged")
     except:
-        pytest.fail(f"{spoilt_fit_device_id} unsuccessfully logged")
-
+        pytest.fail(f"{spoilt_fit_device_id} Unsuccessfully logged")
 
     batch_processing(page, "S3", "Retest (Spoilt) (FIT)", "S11 - Retest Kit Sent (Spoilt)")
 

tests/Smokescreen/test_compartment_3.py

@@ -0,0 +1,62 @@
+import logging
+from datetime import datetime
+
+from my_pages import *
+from utils import fit_kit_logged
+from utils.batch_processing import batch_processing
+from utils.fit_kit_generation import create_fit_id_df
+from utils.fit_kit_logged import process_kit_data, update_kit_service_management_entity
+from utils.oracle import OracleDB
+from utils.screening_subject_page_searcher import verify_subject_event_status_by_nhs_no
+
+
+@pytest.mark.smokescreen
+@pytest.mark.compartment3
+def test_compartment_3(page: Page) -> None:
+    UserTools.user_login(page, "Hub Manager State Registered")
+
+    # (STEP 1 ,2 & 3) find data , separate it into normal and abnormal, Add results to the test records in the KIT_QUEUE table (i.e. mimic receiving results from the middleware)
+    # and get device IDs and their flags
+    device_ids = process_kit_data()
+    # Retrieve NHS numbers for each device_id and determine normal/abnormal status
+    nhs_numbers = []
+    normal_flags = []
+
+    for device_id, is_normal in device_ids:
+        nhs_number = update_kit_service_management_entity(device_id, is_normal)
+        nhs_numbers.append(nhs_number)
+        normal_flags.append(is_normal)  # Store the flag (True for normal, False for abnormal)
+
+    # (STEP - 4) Run two stored procedures to process any kit queue records at status BCSS_READY
+    try:
+        fit_kit_logged.execute_stored_procedures()
+        logging.info("Stored procedures executed successfully.")
+    except Exception as e:
+        logging.error(f"Error executing stored procedures: {str(e)}")
+        raise
+
+    # (STEP - 5) Check the results of the processed FIT kits have correctly updated the status of the associated subjects
+    # Verify subject event status based on normal or abnormal classification
+    for nhs_number, is_normal in zip(nhs_numbers, normal_flags):
+        expected_status = "S2 - Normal" if is_normal else "A8 - Abnormal"  # S2 for normal, A8 for abnormal
+        logging.info(f"Verifying NHS number: {nhs_number} with expected status: {expected_status}")
+
+        try:
+            verify_subject_event_status_by_nhs_no(page, nhs_number, expected_status)
+            logging.info(f"Successfully verified NHS number {nhs_number} with status {expected_status}")
+        except Exception as e:
+            logging.error(f"Verification failed for NHS number {nhs_number} with status {expected_status}: {str(e)}")
+            raise
+
+    # (Step 12) - Process S2 batch
+    # Run batch processing function on S2 batch
+    nhs_number_df = batch_processing(page, "S2", "Subject Result (Normal)", "S158 - Subject Discharge Sent (Normal)")
+    OracleDB().exec_bcss_timed_events(nhs_number_df)
+
+    # (Step 13) - Process S158 batch
+    # Run batch processing function on S158 batch
+    nhs_number_df = batch_processing(page, "S158", "GP Result (Normal)", "S159 - GP Discharge Sent (Normal)")
+    OracleDB().exec_bcss_timed_events(nhs_number_df)
+
+    # Log out
+    Logout(page).log_out()

tests/bcss_tests.properties

@@ -0,0 +1,17 @@
+# ----------------------------------
+# SCREENING CENTRES, CCGs, HUBS & GPs
+# ----------------------------------
+screening_centre_code=BCS001
+eng_screening_centre_id=23162
+eng_hub_id=23159
+gp_practice_code=C81001
+ccg_code=Z1Z1Z
+
+# ----------------------------------
+# SUBJECT / PATIENT SEARCH TEST DATA
+# ----------------------------------
+nhs_number=966 529 9271
+forename=Pentagram
+surname=Absurd
+subject_dob=11/01/1934
+episode_closed_date=22/09/2020

tests/smokescreen/bcss_smokescreen_tests.properties

@@ -0,0 +1,89 @@
+# ----------------------------------
+#   compartment 1
+# ----------------------------------
+    c1_daily_invitation_rate=10
+    c1_screening_centre_code=BCS001
+
+# ----------------------------------
+#   compartment 2
+# ----------------------------------
+#    c2_fit_kit_logging_test_org_id=23159
+#    c2_eng_gfobt_kit_logging_test_org_id=23159
+
+# ----------------------------------
+#   compartment 3
+# ----------------------------------
+#    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
+
+# ----------------------------------
+#   compartment 4
+# ----------------------------------
+#    c4_eng_org_id=23159
+#    c4_eng_centre_name=Wolverhampton
+#    c4_eng_site_name=Royal Hospital
+#    c4_eng_practitioner_id=243
+#    c4_eng_practitioner_name=Arvind, Vanaja
+#    c4_eng_practitioner_name=Macarena, Gave  #use this for anonymised
+#    c4_eng_practitioner_id_for_rebooking=870
+#    c4_eng_practitioner_name_for_rebookings=Burns, Harriet
+
+# ----------------------------------
+#   compartment 6
+# ----------------------------------
+#    c6_eng_org_id=23159
+#    c6_eng_site_id=35317
+#    c6_eng_practitioner_id=243
+#    c6_eng_testing_clinician_id=805
+#    c6_eng_aspirant_endoscopist_id=1731
+
+# ----------------------------------
+#   NUMBER OF KITS / SUBJECTS TO PROCESS IN EACH COMPARTMENT
+# ----------------------------------
+# NOTE: England gFOBT has been turned off (all values set to 0), properties have been left just in case for now
+
+# ----------------------------------
+#   compartment 1
+# ----------------------------------
+#    c1_eng_number_of_batches_to_create=1
+
+# ----------------------------------
+#   compartment 2
+# ----------------------------------
+#    c2_eng_number_of_fit_kits_to_log=8
+#    c2_eng_number_of_gfobt_kits_to_log=0
+#    ## Spare subjects (subjects required for subject creation check = fit kits to log + gfobt kits to log + spare subject count)
+#    ## NOTE: Should be at least 1 due to poke the beast requiring a subject to log a fit kit for on National
+#    c2_spare_subject_count=5
+
+# ----------------------------------
+#   compartment 3
+# ----------------------------------
+#    c3_eng_number_of_abnormal_gfobt_kits_to_log=0
+#    c3_eng_number_of_normal_gfobt_kits_to_log=0
+#    c3_eng_number_of_weak_positive_gfobt_kits_to_log=0
+#    c3_eng_number_of_abnormal_fit_kits=7
+#    c3_eng_number_of_normal_fit_kits=1
+
+# ----------------------------------
+#   compartment 4
+# ----------------------------------
+#    # note there is a max of 16 slots available each day
+#    c4_eng_number_of_appointments_to_book=6
+
+# ----------------------------------
+#   compartment 5
+# ----------------------------------
+#    c5_eng_number_of_screening_appts_to_attend=6
+
+# ----------------------------------
+#   compartment 6
+# ----------------------------------
+#    c6_eng_number_of_normal_results_to_record=2
+#    c6_eng_number_of_lnpcp_results_to_record=1
+#    c6_eng_number_of_high_risk_findings_results_to_record=1
+#    c6_eng_number_of_lnpcp_results_over_74_to_record=1
+#    c6_eng_number_of_high_risk_findings_results_over_74_to_record=1

tests/test_call_and_recall_page.py

@@ -2,7 +2,23 @@
 from playwright.sync_api import Page, expect
 from utils.click_helper import click
 from pages.bcss_home_page import MainMenu
-from pages.login_page import BcssLoginPage
+from utils.user_tools import UserTools
+from jproperties import Properties
+
+
+@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()
+    with open('bcss_tests.properties', 'rb') as read_prop:
+        configs.load(read_prop)
+    return configs.properties
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -55,15 +71,15 @@ def test_call_and_recall_page_navigation(page: Page) -> None:
     expect(page.locator("#ntshPageTitle")).to_contain_text("Main Menu")
 
 
-def test_view_an_invitation_plan(page: Page) -> None:
+def test_view_an_invitation_plan(page: Page, tests_properties: dict) -> None:
     """
     Confirms that an invitation plan can be viewed via a screening centre from the planning ad monitoring page
     """
     # Go to planning and monitoring page
     click(page, page.get_by_role("link", name="Planning and Monitoring"))
 
     # Select a screening centre
-    click(page, page.get_by_role("link", name="BCS009"))
+    page.get_by_role("link", name=tests_properties["screening_centre_code"]).click()
 
     # Select an invitation plan
     click(page, page.get_by_role("row").nth(1).get_by_role("link"))

tests/test_gfobt_test_kits_page.py

@@ -52,16 +52,24 @@ def test_create_a_qc_kit(page: Page) -> None:
     """
     Confirms that a qc test kit can be created and that each of the dropdowns has an option set available for selection
     """
+    # 'Reading' dropdown locators
+    reading1dropdown = page.locator("#A_C_Reading_999_0_0")
+    reading2dropdown = page.locator("#A_C_Reading_999_0_1")
+    reading3dropdown = page.locator("#A_C_Reading_999_1_0")
+    reading4dropdown = page.locator("#A_C_Reading_999_1_1")
+    reading5dropdown = page.locator("#A_C_Reading_999_2_0")
+    reading6dropdown = page.locator("#A_C_Reading_999_2_1")
+
     # Navigate to create QC kit page
     click(page, page.get_by_role("link", name="Create QC Kit"))
 
     # Select QC kit drop down options
-    page.locator("#A_C_Reading_999_0_0").select_option("NEGATIVE")
-    page.locator("#A_C_Reading_999_0_1").select_option("POSITIVE")
-    page.locator("#A_C_Reading_999_1_0").select_option("POSITIVE")
-    page.locator("#A_C_Reading_999_1_1").select_option("UNUSED")
-    page.locator("#A_C_Reading_999_2_0").select_option("NEGATIVE")
-    page.locator("#A_C_Reading_999_2_1").select_option("POSITIVE")
+    reading1dropdown.select_option("NEGATIVE")
+    reading2dropdown.select_option("POSITIVE")
+    reading3dropdown.select_option("POSITIVE")
+    reading4dropdown.select_option("UNUSED")
+    reading5dropdown.select_option("NEGATIVE")
+    reading6dropdown.select_option("POSITIVE")
 
     # Click save
     click(page, page.get_by_role("button", name="Save Kit"))