BCSS-19934 - BCSS - Review / Refactor Compartment 1 data management

Author: adrianoaru-nhs

pages/generate_invitations_page.py

@@ -35,13 +35,13 @@ def wait_for_invitation_generation_complete(self):
         logging.info(f"Waiting for successful generation")
         while elapsed < timeout: # there may be a stored procedure to speed this process up
             table_text = self.displayRS.text_content()
-            if "Queued" in table_text or "In Progress" in table_text:
+            if "Failed" in table_text:
+                pytest.fail("Invitation has failed to generate")
+            elif "Queued" in table_text or "In Progress" in table_text:
                 # Click the Refresh button
                 self.click_refresh_button()
                 self.page.wait_for_timeout(wait_interval)
                 elapsed += wait_interval
-            elif "Failed" in table_text:
-                pytest.fail("Invitation has failed to generate")
             else:
                 break
 

pages/log_out_page.py

@@ -1,5 +1,6 @@
 from playwright.sync_api import Page,expect
-
+from pages.navigation_bar_links import NavigationBar
+import logging
 class Logout:
     def __init__(self, page: Page):
         self.page = page
@@ -9,7 +10,8 @@ def __init__(self, page: Page):
     def verify_log_out_page(self):
         expect(self.log_out_msg).to_be_visible()
 
-
-
-
-
+    def log_out(self):
+        logging.info("Test Complete - Logging Out")
+        NavigationBar(self.page).click_log_out_link()
+        expect(self.log_out_msg).to_be_visible()
+        self.page.close()

tests/Smokescreen/test_compartment_1.py

@@ -5,11 +5,10 @@
 from utils.oracle import OracleDB
 
 @pytest.mark.smoke
-@pytest.mark.smokescreen
 @pytest.mark.compartment1
-def test_compartment_1(page: Page) -> None:
+def test_create_invitations_plan(page: Page) -> None:
+    logging.info("Compartment 1 - Create Invitations Plan")
     UserTools.user_login(page, "Hub Manager State Registered")
-
     # Create plan - England
     MainMenu(page).go_to_call_and_recall_page()
     CallAndRecall(page).go_to_planning_and_monitoring_page()
@@ -24,29 +23,36 @@ def test_compartment_1(page: Page) -> None:
     CreateAPlan(page).fill_note_field("test data")
     CreateAPlan(page).click_saveNote_button()
     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:
+    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")
+    logging.info("Generating invitations based on the invitations plan")
     GenerateInvitations(page).click_generate_invitations_button()
     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)
 
     # 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)
 
     # Print a set of reminder letters
+    logging.info("Compartment 1 - Process S10 Batch")
     batch_processing(page, "S10", "Test Kit Reminder", "S19 - Reminder of Initial Test Sent")
 
     # Log out
-    logging.info("Logging Out")
-    NavigationBar(page).click_log_out_link()
-    Logout(page).verify_log_out_page()
-    page.close()
+    Logout(page).log_out()

tests/Smokescreen/test_compartment_2.py

@@ -56,7 +56,4 @@ def test_compartment_2(page: Page) -> None:
     batch_processing(page, "S3", "Retest (Spoilt) (FIT)", "S11 - Retest Kit Sent (Spoilt)")
 
     # Log out
-    logging.info("Logging Out")
-    NavigationBar(page).click_log_out_link()
-    Logout(page).verify_log_out_page()
-    page.close()
+    Logout(page).log_out()

tests/Smokescreen/test_compartment_3.py

@@ -56,7 +56,4 @@ def test_compartment_3(page: Page) -> None:
     OracleDB().exec_bcss_timed_events(nhs_number_df)
 
     # Log out
-    logging.info("Logging Out")
-    NavigationBar(page).click_log_out_link()
-    Logout(page).verify_log_out_page()
-    page.close()
+    Logout(page).log_out()

utils/batch_processing.py

@@ -34,12 +34,13 @@ def batch_processing(page: Page, batch_type: str, batch_description: str, latest
             # Find the first link in that row and click it
             link = row.locator("a").first
             link_text = link.inner_text()  # Get the batch id dynamically
+            logging.info(f"Successfully found open '{batch_type} - {batch_description}' batch")
             try:
-                logging.info(f"Attempting to get NHS Numbers for batch: {link_text} from the DB")
+                logging.info(f"Attempting to get NHS Numbers for batch {link_text} from the DB")
                 nhs_no_df = get_nhs_no_from_batch_id(link_text)
-                logging.info(f"Successfully retrieved NHS Numbers from batch: {link_text}")
+                logging.info(f"Successfully retrieved NHS Numbers from batch {link_text}")
             except Exception as e:
-                pytest.fail(f"Failed to retrieve NHS Numbers from batch: {link_text}, {str(e)}")
+                pytest.fail(f"Failed to retrieve NHS Numbers from batch {link_text}, {str(e)}")
             link.click()
             break
         else:

utils/oracle.py

@@ -23,7 +23,7 @@ def exec_bcss_timed_events(self, nhs_number_df): # Executes bcss_timed_events wh
                     cursor.execute(f"SELECT SCREENING_SUBJECT_ID FROM SCREENING_SUBJECT_T WHERE SUBJECT_NHS_NUMBER = {int(row["subject_nhs_number"])}")
                     result = cursor.fetchall()
                     subject_id = result[0][0]
-                    logging.info("Able to extract subject ID")
+                    logging.info(f"Able to extract subject ID: {subject_id}")
                     try:
                         logging.info(f"Attempting to execute stored procedure: {f"'bcss_timed_events', [{subject_id},'Y']"}")
                         cursor = conn.cursor()