Adding more POMs for compartment 1.

Altering the login and database connection functions to use environment variables

Author: adrianoaru-nhs

pages/active_batch_list_page.py

@@ -12,10 +12,6 @@ def __init__(self, page: Page):
         self.batch_split_by_filter = self.page.locator("#splitByFilter")
         self.screening_centre_filter = self.page.locator("#screeningCentreFilter")
         self.count_filter = self.page.locator("#countFilter")
-    #     self.td = self.page.locator("td")
-
-    # def filter_td(self, filter):
-    #     self.td.
 
     def enter_id_filter(self, search_text: str):
         self.id_filter.click()

pages/create_a_plan_page.py

@@ -1,6 +1,6 @@
 from playwright.sync_api import Page
 
-class CreateaPlan:
+class CreateAPlan:
     def __init__(self, page: Page):
         self.page = page
         # Call and Recall - page links

pages/login_page.py

@@ -1,5 +1,8 @@
-from playwright.sync_api import Page
+import os
 
+from playwright.sync_api import Page
+from utils.user_tools import UserTools
+from dotenv import load_dotenv
 
 class BcssLoginPage:
 
@@ -23,6 +26,26 @@ def login(self, username, password):
 
     def login_as_user_bcss401(self):
         """Logs in to bcss as the test user 'BCSS401'"""
-        self.username.fill("BCSS401")
-        self.password.fill("changeme")
+        # Take environment variables from .env
+        load_dotenv()
+        # Retrieve and enter username from users.json
+        user_details = UserTools.retrieve_user("BCSS401")
+        self.username.fill(user_details["username"])
+        # Retrieve and enter password from .env file
+        password = os.getenv("BCSS401_PASS")
+        self.password.fill(password)
+        # Click submit button
+        self.submit_button.click()
+
+    def login_as_user_bcss118(self):
+        """Logs in to bcss as the test user 'BCSS118'"""
+        # Take environment variables from .env
+        load_dotenv()
+        # Retrieve and enter username from users.json
+        user_details = UserTools.retrieve_user("BCSS118")
+        self.username.fill(user_details["username"])
+        # Retrieve and enter password from .env file
+        password = os.getenv("BCSS118_PASS")
+        self.password.fill(password)
+        # Click submit button
         self.submit_button.click()

pages/manage_active_batch_page.py

@@ -0,0 +1,22 @@
+from playwright.sync_api import Page
+
+class ManageActiveBatch:
+    def __init__(self, page: Page):
+        self.page = page
+        # Manage Active Batch - page buttons
+        self.prepare_button = self.page.get_by_role("button", name="Prepare Batch")
+        self.retrieve_button = self.page.get_by_role("button", name="Retrieve")
+        self.confirm_button = self.page.get_by_role("button", name="Confirm Printed")
+        # Manage Active Batch - page buttons (text)
+        self.prepare_button_text = self.page.locator('text="Prepare Batch"')
+        self.retrieve_button_text = self.page.locator('text="Retrieve"')
+        self.confirm_button_text = self.page.locator('text="Confirm Printed"')
+
+    def click_prepare_button(self):
+        self.prepare_button.click()
+
+    def click_retrieve_button(self):
+        self.retrieve_button.click()
+
+    def click_confirm_button(self):
+        self.confirm_button.click()

requirements.txt

@@ -4,3 +4,6 @@ pytest-json-report>=1.5.0
 pypdf>=5.3.0
 oracledb>=2.5.1
 pandas>=2.2.3
+dotenv~=0.9.9
+python-dotenv~=1.0.1
+Flask~=3.0.3

tests/Smokescreen/test_compartment_1.py

@@ -14,50 +14,37 @@
 from pages.archived_batch_list_page import *
 from pages.navigation_bar_links import *
 from pages.subject_screening_page import *
-
-# @pytest.mark.wip2 # Not working at the moment
-# def test_prereq():
-#     database_connection_exec("prereq_check")
-
-#     paramater_32 = database_connection_query("select DEFAULT_VALUE from PARAMETERS where PARAM_ID = 32")
-#     print(f"paramater_32: {paramater_32}")
-#     if paramater_32[0] != "-1":
-#         database_connection_query("UPDATE PARAMETERS SET DEFAULT_VALUE = -1 WHERE PARAM_ID = 32")
-#         database_connection_query("COMMIT")
-#     paramater_31 = database_connection_query("select DEFAULT_VALUE from PARAMETERS where PARAM_ID = 31")
-#     print(f"paramater_31: {paramater_31}")
-#     if paramater_31[0] != "-1":
-#         database_connection_query("UPDATE PARAMETERS SET DEFAULT_VALUE = -1 WHERE PARAM_ID = 31")
-#         database_connection_query("COMMIT")
-
+from pages.manage_active_batch_page import *
+from pages.invitations_monitoring_page import *
+from pages.create_a_plan_page import *
+from pages.invitations_plans_page import *
 
 # To Do:
-# Create more POM
-# Remove as many hard coded timeouts as possible
+# Create more POMs
 # Add more fail states
 # Add more logging to understand what is going on
 # Convert import pages * into 1 line
 # Move functions to utils
+# Remove as many hard coded timeouts as possible
+# Create a generic click() function -> this aims to solve an issue where sometimes it thinks it has clicked the element but the page does not change
 
 @pytest.mark.wip
 def test_example(page: Page) -> None:
     page.goto("/")
     BcssLoginPage(page).login_as_user_bcss401()
 
-    # 2 - Create plan
+    # Create plan
     MainMenu(page).go_to_call_and_recall_page()
     CallAndRecall(page).go_to_planning_and_monitoring_page()
-    page.get_by_role("link", name="BCS001").click()
-    page.get_by_role("button", name="Create a Plan").click()
-    page.get_by_role("link", name="Set all").click()
-    page.get_by_placeholder("Enter daily invitation rate").fill("1")
-    page.get_by_role("button", name="Update").click()
-    page.get_by_role("button", name="Confirm").click()
-    page.get_by_role("link", name="Set all").click()
-    page.get_by_role("button", name="Close").click()
-    page.get_by_role("button", name="Save").click()
-    page.get_by_placeholder("Enter note").fill("test data")
-    page.locator("#saveNote").get_by_role("button", name="Save").click()
+    InvitationsMonitoring(page).go_to_bcss001_invitations_plan_page()
+    InvitationsPlans(page).go_to_create_a_plan_page()
+    CreateAPlan(page).click_set_all_button()
+    CreateAPlan(page).fill_daily_invitation_rate_field("1")
+    CreateAPlan(page).click_update_button()
+    CreateAPlan(page).click_confirm_button()
+    CreateAPlan(page).click_save_button()
+    CreateAPlan(page).fill_note_field("test data")
+    CreateAPlan(page).click_saveNote_button()
 
     # Generate Invitations
     NavigationBar(page).click_main_menu_link()
@@ -135,21 +122,21 @@ def batch_processing(page: Page, batch_type: str, batch_description: str, latest
 
     # Checks to see if batch is already prepared
     page.wait_for_timeout(3000) # Without this timeout prepare_button is always set to false
-    prepare_button = page.get_by_role("button", name="Prepare Batch").is_visible()
+    prepare_button = ManageActiveBatch(page).prepare_button_text.is_visible()
 
     #If not prepared it will click on the prepare button
     if prepare_button:
-        page.get_by_role("button", name="Prepare Batch").click()
+        ManageActiveBatch(page).click_prepare_button()
 
-    page.locator('text="Retrieve"').nth(0).wait_for()
+    ManageActiveBatch(page).retrieve_button_text.nth(0).wait_for()
     page.wait_for_timeout(5000) # This 5 second wait is to allow other Retrieve buttons to show as they do not show up at the same time
 
     # This loops through each Retrieve button and clicks each one
-    for retrieve_button in range (page.get_by_role("button", name="Retrieve").count()):
+    for retrieve_button in range (ManageActiveBatch(page).retrieve_button.count()):
         # Start waiting for the pdf download
         with page.expect_download() as download_info:
             # Perform the action that initiates download
-            page.get_by_role("button", name="Retrieve").nth(retrieve_button-1).click()
+            ManageActiveBatch(page).retrieve_button.nth(retrieve_button-1).click()
         download_file = download_info.value
         file = download_file.suggested_filename
         # Wait for the download process to complete and save the downloaded file in a temp folder
@@ -162,13 +149,13 @@ def batch_processing(page: Page, batch_type: str, batch_description: str, latest
             csv_df = csv_Reader(file) # Currently no use in compartment 1, will be necessary for future compartments
             os.remove(file) # Deletes the file after extracting the necessary data
 
-    page.locator('text="Confirm Printed"').nth(0).wait_for()
+    ManageActiveBatch(page).confirm_button_text.nth(0).wait_for()
     page.wait_for_timeout(1000) # This 1 second wait is to allow other Confirm printed buttons to show as they do not show up at the same time
 
     # This loops through each Confirm printed button and clicks each one
-    for _ in range (page.get_by_role("button", name="Confirm Printed").count()):
+    for _ in range (ManageActiveBatch(page).confirm_button.count()):
         page.on("dialog", lambda dialog: dialog.accept())
-        page.get_by_role("button", name="Confirm Printed").nth(0).click()
+        ManageActiveBatch(page).confirm_button.nth(0).click()
         page.wait_for_timeout(1000)
 
     # Add wait for batch successfully archived
@@ -193,7 +180,7 @@ def pdf_Reader(file: str):
             for split_text in text:
                 if "NHS No" in split_text:
                     # If a string is found containing "NHS No" only digits are stored into nhs_no
-                    nhs_no = res = "".join([ele for ele in split_text if ele.isdigit()])
+                    nhs_no = "".join([ele for ele in split_text if ele.isdigit()])
                     break
     return nhs_no
 

tests/test_login_to_bcss.py

@@ -1,3 +1,6 @@
+import os
+
+from dotenv import load_dotenv
 from playwright.sync_api import Page, expect
 from pages.login_page import BcssLoginPage
 
@@ -16,9 +19,13 @@ def test_login_to_bcss_with_invalid_username(page: Page) -> None:
     """
     Confirms that a user with a valid password, and invalid username, can NOT log in to bcss
     """
-    # Enter a valid password with an invalid username and click 'sign in' button
+    # Take environment variables from .env
+    load_dotenv()
+    # Set an invalid username
     username = "BCSSZZZ"
-    password = "changeme"
+    # Retrieve valid password from .env file
+    password = os.getenv("BCSS_PASS")
+    # Enter valid password with an invalid username and click 'sign in' button
     BcssLoginPage(page).login(username, password)
     # Confirm error message is displayed
     expect(page.locator("body")).to_contain_text("Incorrect username or password.")

users.json

@@ -1,11 +1,16 @@
 {
-    "_comment": "This file can be used to store data on users for your application, and then pulled through using the utils.user_tools UserTools utility. The documentation for this utility explains how this file is read.",
-    "Example User 1": {
-        "username": "EXAMPLE_USER1",
-        "roles": ["Example Role A"]
-    },
-    "Example User 2": {
-        "username": "EXAMPLE_USER2",
-        "roles": ["Example Role B", "Example Role C"]
-    }
+  "_comment": "This file can be used to store data on users for your application, and then pulled through using the utils.user_tools UserTools utility. The documentation for this utility explains how this file is read.",
+
+  "BCSS401": {
+    "username": "BCSS401",
+    "roles": [
+      "Hub Manager State Registered, Midlands and North West"
+    ]
+  },
+  "BCSS118": {
+    "username": "BCSS118",
+    "roles": [
+      "Screening Centre Manager for Wolverhampton, Midlands and North West"
+    ]
+  }
 }

utils/oracle.py

@@ -1,19 +1,23 @@
 import oracledb
+import os
+from dotenv import load_dotenv
 
 def database_connection_exec(procedure: str): # To use when "exec xxxx" (stored procedures)
-    un = 'MPI'
-    cs = 'bcss-oracle-bcss-bcss-18680.cqger35bxcwy.eu-west-2.rds.amazonaws.com/TSTBCS01'
-    pw = 'g0blin'
+    load_dotenv()
+    un = os.getenv("un")
+    cs = os.getenv("cs")
+    pw = os.getenv("pw")
 
     with oracledb.connect(user=un, password=pw, dsn=cs) as connection:
         with connection.cursor() as cursor:
             for r in cursor.callproc(procedure):
                 print(r)
 
 def database_connection_query(sql: str): # To use when "select a from b"
-    un = 'MPI'
-    cs = 'bcss-oracle-bcss-bcss-18680.cqger35bxcwy.eu-west-2.rds.amazonaws.com/TSTBCS01'
-    pw = 'g0blin'
+    load_dotenv()
+    un = os.getenv("un")
+    cs = os.getenv("cs")
+    pw = os.getenv("pw")
 
     with oracledb.connect(user=un, password=pw, dsn=cs) as connection:
         with connection.cursor() as cursor: