Updated properties function and updated all tests to use the new login function on Compartment 1 branch

Andyg79 · Andyg79 · commit e0114127e642 · 2025-03-28T17:21:50.000Z
diff --git a/tests/smokescreen/test_compartment_1.py b/tests/smokescreen/test_compartment_1.py
@@ -25,15 +25,16 @@ def smokescreen_properties() -> dict:
         dict: A dictionary containing the values loaded from the 'bcss_smokescreen_tests.properties' file.
     """
     configs = Properties()
-    if platform == "win32":
+    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":
+    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_create_invitations_plan(page: Page, smokescreen_properties: dict) -> None:
diff --git a/tests/test_bcss_19181_users_permit_list.py b/tests/test_bcss_19181_users_permit_list.py
@@ -1,5 +1,6 @@
 import pytest
 from playwright.sync_api import Page
+from utils.user_tools import UserTools
 from pages import (login_page as login, bcss_home_page as bcss_home, navigation_bar_links as nav_bar_links,
                    log_out_page as logout, login_failure_screen as login_failure)
 from utils.oracle import OracleDB
@@ -11,7 +12,7 @@ def before_test(page: Page):
     This fixture confirms that users can log in successfully in to BCSS whilst the approved users list is empty
     """
     # Log in to BCSS as bcss401 user, then log out
-    login.BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
     bcss_home.BcssHomePage(page).bowel_cancer_screening_system_header_is_displayed()
     nav_bar_links.NavigationBar(page).click_log_out_link()
     logout.Logout(page).verify_log_out_page()
@@ -37,7 +38,7 @@ def test_only_users_on_approved_can_login_to_bcss(page: Page) -> None:
     logout.Logout(page).verify_log_out_page()
 
     # BCSS118 user fails to logs in to BCSS as they are not on the approved list
-    login.BcssLoginPage(page).login_as_user("BCSS118")
+    UserTools.user_login(page,"Screening Centre Manager")
     # Verify relevant error message is displayed
     login_failure.LoginFailureScreen(page).verify_login_failure_screen_is_displayed()
     page.close()
diff --git a/tests/test_bowel_scope_page.py b/tests/test_bowel_scope_page.py
@@ -2,7 +2,7 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -11,7 +11,7 @@ def before_each(page: Page):
     Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the bowel scope page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to bowel scope page
     MainMenu(page).go_to_bowel_scope_page()
diff --git a/tests/test_call_and_recall_page.py b/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 utils.click_helper import click
 from pages.bcss_home_page import MainMenu
@@ -16,8 +17,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
 
 
@@ -48,13 +53,11 @@ def test_call_and_recall_page_navigation(page: Page) -> None:
     expect(page.locator("#ntshPageTitle")).to_contain_text("Generate Invitations")
     click(page, page.get_by_role("link", name="Back"))
 
-
     # Invitation generation progress page loads as expected
     click(page, page.get_by_role("link", name="Invitation Generation Progress"))
     expect(page.locator("#ntshPageTitle")).to_contain_text("Invitation Generation Progress")
     click(page, page.get_by_role("link", name="Back"))
 
-
     # Non invitation days page loads as expected
     click(page, page.get_by_role("link", name="Non Invitation Days"))
     expect(page.locator("#ntshPageTitle")).to_contain_text("Non-Invitation Days")
@@ -65,7 +68,6 @@ def test_call_and_recall_page_navigation(page: Page) -> None:
     expect(page.locator("#page-title")).to_contain_text("Age Extension Rollout Plans")
     click(page, page.get_by_role("link", name="Back"))
 
-
     # Return to main menu
     click(page, page.get_by_role("link", name="Main Menu"))
     expect(page.locator("#ntshPageTitle")).to_contain_text("Main Menu")
diff --git a/tests/test_communications_production_page.py b/tests/test_communications_production_page.py
@@ -3,6 +3,7 @@
 from pages.login_page import BcssLoginPage
 from pages.bcss_home_page import MainMenu
 from utils.click_helper import click
+from utils.user_tools import UserTools
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -12,11 +13,12 @@ def before_each(page: Page):
     production page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to communications production page
     MainMenu(page).go_to_communications_production_page()
 
+
 @pytest.mark.smoke
 def test_communications_production_page_navigation(page: Page) -> None:
     """
diff --git a/tests/test_contacts_list_page.py b/tests/test_contacts_list_page.py
@@ -2,7 +2,7 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -11,7 +11,7 @@ def before_each(page: Page):
     Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the contacts list page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to contacts list page
     MainMenu(page).go_to_contacts_list_page()
diff --git a/tests/test_download_page.py b/tests/test_download_page.py
@@ -2,7 +2,7 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -11,7 +11,7 @@ def before_each(page: Page):
     Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the download page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to download page
     MainMenu(page).go_to_download_page()
diff --git a/tests/test_fit_test_kits_page.py b/tests/test_fit_test_kits_page.py
@@ -2,7 +2,7 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -12,7 +12,7 @@ def before_each(page: Page):
     fit test kits page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to fit test kits page
     MainMenu(page).go_to_fit_test_kits_page()
diff --git a/tests/test_gfobt_test_kits_page.py b/tests/test_gfobt_test_kits_page.py
@@ -2,7 +2,7 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -12,7 +12,7 @@ def before_each(page: Page):
     gfob test kits page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to gFOBT test kits page
     MainMenu(page).go_to_gfob_test_kits_page()
diff --git a/tests/test_home_page_links.py b/tests/test_home_page_links.py
@@ -1,6 +1,6 @@
 import pytest
 from playwright.sync_api import Page, expect
-from pages.login_page import BcssLoginPage
+from utils.user_tools import UserTools
 from pages.bcss_home_page import BcssHomePage
 from utils.date_time_utils import DateTimeUtils
 
@@ -12,7 +12,7 @@ def before_each(page: Page):
     being displayed
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
 
 @pytest.mark.smoke
@@ -53,7 +53,7 @@ def test_home_page_links_navigation(page: Page) -> None:
     homepage.click_refresh_alerts_link()
     # Verify that the 'last updated' timestamp matches the current date and time
     (expect(page.locator("form[name=\"refreshCockpit\"]")).to_contain_text
-    ("Refresh alerts (last updated :" + DateTimeUtils.current_datetime()))
+     ("Refresh alerts (last updated :" + DateTimeUtils.current_datetime()))
 
     # Click the user guide link
     with page.expect_popup() as page1_info:
diff --git a/tests/test_login_to_bcss.py b/tests/test_login_to_bcss.py
@@ -1,8 +1,6 @@
-import os
 import pytest
-from dotenv import load_dotenv
 from playwright.sync_api import Page, expect
-from pages.login_page import BcssLoginPage
+from utils.user_tools import UserTools
 
 
 @pytest.mark.smoke
@@ -11,46 +9,6 @@ def test_successful_login_to_bcss(page: Page) -> None:
     Confirms that a user with valid credentials can log in to bcss
     """
     # Enter a valid username and password and click 'sign in' button
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
     # Confirm user has successfully signed in and is viewing the bcss homepage
     expect(page.locator("#ntshAppTitle")).to_contain_text("Bowel Cancer Screening System")
-
-
-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
-    """
-    # Take environment variables from .env
-    load_dotenv()
-    # Set an invalid username
-    username = "BCSSZZZ"
-    # 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.")
-
-
-def test_login_to_bcss_with_invalid_password(page: Page) -> None:
-    """
-    Confirms that a user with a valid username, and invalid password, can NOT log in to bcss
-    """
-    # Enter a valid username with an invalid password and click 'sign in' button
-    username = "BCSS401"
-    password = "zzzzzz"
-    BcssLoginPage(page).login(username, password)
-    # Confirm error message is displayed
-    expect(page.locator("body")).to_contain_text("Incorrect username or password.")
-
-
-def test_login_to_bcss_with_no_username_or_password(page: Page) -> None:
-    """
-    Confirms that a user can NOT log in to bcss if no credentials are entered in the log in form
-    """
-    # At the login screen, leave the fields empty and click 'sign in' button
-    username = ""
-    password = ""
-    BcssLoginPage(page).login(username, password)
-    # Login should fail - verify that sign-in button is still visible
-    expect(page.get_by_role("button", name="submit")).to_be_visible()
diff --git a/tests/test_lynch_surveillance_page.py b/tests/test_lynch_surveillance_page.py
@@ -2,7 +2,7 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -12,7 +12,7 @@ def before_each(page: Page):
     lynch surveillance page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to Lynch Surveillance page
     MainMenu(page).go_to_lynch_surveillance_page()
diff --git a/tests/test_organisations_page.py b/tests/test_organisations_page.py
@@ -1,4 +1,5 @@
 import pytest
+from sys import platform
 from playwright.sync_api import Page, expect
 from utils.click_helper import click
 from pages.bcss_home_page import MainMenu
@@ -16,8 +17,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
 
 
diff --git a/tests/test_reports_page.py b/tests/test_reports_page.py
@@ -3,7 +3,7 @@
 from utils.click_helper import click
 from pages import reports_page
 from pages.bcss_home_page import MainMenu
-from pages.login_page import BcssLoginPage
+from utils.user_tools import UserTools
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -13,7 +13,7 @@ def before_each(page: Page):
     reports page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Open reports page
     MainMenu(page).go_to_reports_page()
diff --git a/tests/test_screening_practitioner_appointments_page.py b/tests/test_screening_practitioner_appointments_page.py
@@ -2,7 +2,7 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
@@ -12,7 +12,7 @@ def before_each(page: Page):
     screening_practitioner_appointments page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to screening practitioner appointments page
     MainMenu(page).go_to_screening_practitioner_appointments_page()
diff --git a/tests/test_screening_subject_search_page.py b/tests/test_screening_subject_search_page.py
@@ -1,8 +1,8 @@
 import pytest
+from sys import platform
 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 pages.screening_subject_search_page import ScreeningStatusSearchOptions, LatestEpisodeStatusSearchOptions, \
     SearchAreaSearchOptions
 from utils.user_tools import UserTools
@@ -19,8 +19,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
 
 
@@ -31,7 +35,7 @@ def before_each(page: Page):
     screening_subject_search page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to screening subject search page
     MainMenu(page).go_to_screening_subject_search_page()
