Removed my_pages.py and updated imports for compartment 3

# Conflicts:
#	tests/Smokescreen/my_pages.py
#	tests/Smokescreen/test_compartment_1.py

Author: Andyg79

tests/Smokescreen/my_pages.py

@@ -1,9 +1,17 @@
+import logging
+from sys import platform
 import pytest
 from jproperties import Properties
-
-from my_pages import *
+from pages.bcss_home_page import MainMenu
+from pages.call_and_recall_page import CallAndRecall
+from pages.create_a_plan_page import *
+from pages.generate_invitations_page import GenerateInvitations
+from pages.invitations_monitoring_page import InvitationsMonitoring
+from pages.invitations_plans_page import InvitationsPlans
+from pages.log_out_page import Logout
+from pages.navigation_bar_links import NavigationBar
 from utils.batch_processing import batch_processing
-from utils.oracle import OracleDB
+from utils.user_tools import UserTools
 
 
 @pytest.fixture
@@ -16,14 +24,21 @@ def smokescreen_properties() -> dict:
         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)
+    if platform == "win32": # File path from content root is required on Windows OS
+        with open('tests/smokescreen/bcss_smokescreen_tests.properties', 'rb') as read_prop:
+            configs.load(read_prop)
+    elif platform == "darwin": # Only the filename is required on macOS
+        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_compartment_1(page: Page, smokescreen_properties: dict) -> None:
+def test_create_invitations_plan(page: Page, smokescreen_properties: dict) -> None:
+    """
+    This is used to create the invitations plan. As it is not always needed it is separate to the main Compartment 1 function
+    """
     logging.info("Compartment 1 - Create Invitations Plan")
     UserTools.user_login(page, "Hub Manager State Registered")
     # Create plan - England
@@ -42,30 +57,41 @@ def test_compartment_1(page: Page, smokescreen_properties: dict) -> None:
     InvitationsPlans(page).invitations_plans_title.wait_for()
     logging.info("Invitation plan created")
 
+
 @pytest.mark.smoke
 @pytest.mark.smokescreen
 @pytest.mark.compartment1
 def test_compartment_1(page: Page) -> None:
+    """
+    This is the main compartment 1 function. It covers the following:
+    - Generating invitations based on the invitation plan
+    - Processes S1 (FIT) batches
+    - Processes S9 (FIT) batches
+    - Processes S10 (FIT) batches
+    """
     logging.info("Compartment 1 - Generate Invitations")
     UserTools.user_login(page, "Hub Manager State Registered")
 
     # Generate Invitations
+    NavigationBar(page).click_main_menu_link()
     MainMenu(page).go_to_call_and_recall_page()
     CallAndRecall(page).go_to_generate_invitations_page()
     logging.info("Generating invitations based on the invitations plan")
     GenerateInvitations(page).click_generate_invitations_button()
-    GenerateInvitations(page).wait_for_invitation_generation_complete()
+    self_referrals_available = GenerateInvitations(page).wait_for_invitation_generation_complete()
 
     # Print the batch of Pre-Invitation Letters - England
     logging.info("Compartment 1 - Process S1 Batch")
-    batch_processing(page, "S1", "Pre-invitation (FIT) (digital leaflet)", "S9 - Pre-invitation Sent")
-    nhs_number_df = batch_processing(page, "S1", "Pre-invitation (FIT)", "S9 - Pre-invitation Sent")
-    OracleDB().exec_bcss_timed_events(nhs_number_df)
+    if self_referrals_available:
+        batch_processing(page, "S1", "Pre-invitation (FIT) (digital leaflet)", "S9 - Pre-invitation Sent")
+    else:
+        logging.warning(
+            "Skipping S1 Pre-invitation (FIT) (digital leaflet) as no self referral invitations were generated")
+    batch_processing(page, "S1", "Pre-invitation (FIT)", "S9 - Pre-invitation Sent", True)
 
     # Print the batch of Invitation & Test Kit Letters - England
     logging.info("Compartment 1 - Process S9 Batch")
-    nhs_number_df = batch_processing(page, "S9", "Invitation & Test Kit (FIT)", "S10 - Invitation & Test Kit Sent")
-    OracleDB().exec_bcss_timed_events(nhs_number_df)
+    batch_processing(page, "S9", "Invitation & Test Kit (FIT)", "S10 - Invitation & Test Kit Sent", True)
 
     # Print a set of reminder letters
     logging.info("Compartment 1 - Process S10 Batch")

tests/Smokescreen/test_compartment_1.py

@@ -1,11 +1,16 @@
+import logging
+from datetime import datetime
 import pytest
 from playwright.sync_api import Page
-from my_pages import *
+from pages.fit_test_kits_page import FITTestKits
+from pages.bcss_home_page import MainMenu
+from pages.log_out_page import Logout
+from pages.navigation_bar_links import NavigationBar
+from pages.log_devices_page import LogDevices
 from utils.batch_processing import batch_processing
-from datetime import datetime
-from utils.screening_subject_page_searcher import verify_subject_event_status_by_nhs_no
 from utils.fit_kit_generation import create_fit_id_df
-import logging
+from utils.screening_subject_page_searcher import verify_subject_event_status_by_nhs_no
+from utils.user_tools import UserTools
 
 
 @pytest.mark.smoke

tests/Smokescreen/test_compartment_2.py

@@ -1,13 +1,13 @@
 import logging
-from datetime import datetime
-
-from my_pages import *
+import pytest
+from playwright.sync_api import Page
+from pages.log_out_page import Logout
 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
+from utils.user_tools import UserTools
 
 
 @pytest.mark.smokescreen
@@ -27,15 +27,15 @@ def test_compartment_3(page: Page) -> None:
         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
+    # (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
+    # (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

tests/Smokescreen/test_compartment_3.py

@@ -1,4 +1,5 @@
 import pytest
+from sys import platform
 from playwright.sync_api import Page, expect
 from pages.bcss_home_page import MainMenu
 from utils.user_tools import UserTools
@@ -15,8 +16,12 @@ def tests_properties() -> dict:
         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)
+    if platform == "win32": # File path from content root is required on Windows OS
+        with open('tests/bcss_tests.properties', 'rb') as read_prop:
+            configs.load(read_prop)
+    elif platform == "darwin": # Only the filename is required on macOS
+        with open('bcss_tests.properties', 'rb') as read_prop:
+            configs.load(read_prop)
     return configs.properties
 
 

tests/test_call_and_recall_page.py

@@ -1,4 +1,5 @@
 import pytest
+from sys import platform
 from playwright.sync_api import Page, expect
 from pages.bcss_home_page import MainMenu
 from utils.user_tools import UserTools
@@ -15,8 +16,12 @@ def tests_properties() -> dict:
         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)
+    if platform == "win32": # File path from content root is required on Windows OS
+        with open('tests/bcss_tests.properties', 'rb') as read_prop:
+            configs.load(read_prop)
+    elif platform == "darwin": # Only the filename is required on macOS
+        with open('bcss_tests.properties', 'rb') as read_prop:
+            configs.load(read_prop)
     return configs.properties
 
 

tests/test_organisations_page.py

@@ -1,4 +1,5 @@
 import pytest
+from sys import platform
 from playwright.sync_api import Page, expect
 from pages.bcss_home_page import MainMenu
 from pages.screening_subject_search_page import ScreeningStatusSearchOptions, LatestEpisodeStatusSearchOptions, \
@@ -17,8 +18,12 @@ def tests_properties() -> dict:
         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)
+    if platform == "win32":  # File path from content root is required on Windows OS
+        with open('tests/bcss_tests.properties', 'rb') as read_prop:
+            configs.load(read_prop)
+    elif platform == "darwin":  # Only the filename is required on macOS
+        with open('bcss_tests.properties', 'rb') as read_prop:
+            configs.load(read_prop)
     return configs.properties