Merge branch 'main' into feature/smokescreen_compartment_3

Andyg79 · Andyg79 · commit 5e235a0e9e3f · 2025-03-21T10:28:18.000Z
# Conflicts:
#	pages/bcss_home_page.py
#	pytest.ini
#	requirements.txt
#	tests/test_bowel_scope_page.py
#	tests/test_call_and_recall_page.py
#	tests/test_communications_production_page.py
#	tests/test_contacts_list_page.py
#	tests/test_download_page.py
#	tests/test_fit_test_kits_page.py
#	tests/test_gfobt_test_kits_page.py
#	tests/test_home_page_links.py
#	tests/test_login_to_bcss.py
#	tests/test_lynch_surveillance_page.py
#	tests/test_organisations_page.py
#	tests/test_reports_page.py
#	tests/test_screening_practitioner_appointments_page.py
#	tests/test_screening_subject_search_page.py
#	users.json
diff --git a/.env b/.env
@@ -0,0 +1,3 @@
+# DO NOT COMMIT THIS FILE
+
+BCSS_PASS=
diff --git a/.github/workflows/stage-3-build.yaml b/.github/workflows/stage-3-build.yaml
@@ -30,7 +30,7 @@ on:
 
 jobs:
   run-tests:
-    name: "Run Util & Example Tests"
+    name: "Run Util Tests"
     runs-on: ubuntu-latest
     timeout-minutes: 3
     steps:
@@ -43,12 +43,8 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt
-      - name: Ensure browsers are installed
-        run: python -m playwright install --with-deps
       - name: Run util tests
         run: pytest -m "utils" --ignore=tests/
-      - name: Run example tests
-        run: pytest
       - uses: actions/upload-artifact@v4
         if: ${{ !cancelled() }}
         with:
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,4 @@ __pycache__/
 .pytest_cache/
 test-results/
 axe-reports/
+.env
diff --git a/LICENCE.md b/LICENCE.md
@@ -1,6 +1,6 @@
 # MIT Licence
 
-Copyright (c) 2024 Crown Copyright NHS England.
+Copyright (c) 2025 Crown Copyright NHS England.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -2,11 +2,9 @@
 
 [![CI/CD Pull Request](https://github.com/nhs-england-tools/repository-template/actions/workflows/cicd-1-pull-request.yaml/badge.svg)](https://github.com/nhs-england-tools/playwright-python-blueprint/actions/workflows/cicd-1-pull-request.yaml)
 
-This project is designed to provide a blueprint to allow for development teams to start quickly developing UI tests using [Playwright Python](https://playwright.dev/python/), providing the base framework and utilities to allow for initial focus on writing tests, rather than configuration of the framework itself.
+This project is designed to provide a blueprint to allow for development teams to start quickly developing UI tests using [Playwright Python](https://playwright.dev/python/), providing the base framework and utilities to allow for initial focus on writing tests, rather than configuration of the framework itself. Playwright is the current mainstream UI testing tool for NHS England, as outlined on the [NHS England Tech Radar](https://radar.engineering.england.nhs.uk/).
 
-NOTE: This project is currently under initial development so isn't finalised, but should work if you want to experiment with Playwright Python.
-
-> **NOTE: When considering this project, please be advised that currently Playwright is a "proposed" tool within the [NHS England Tech Radar](https://radar.engineering.england.nhs.uk/).  Whilst we are taking steps to get Playwright moved to the "mainstream" section of the radar, as it has not yet been formally adopted it is possible that Playwright may not be fully endorsed by NHS England as a standard tool going forward, and using this framework for an NHS England project is currently at your own risk.**
+> NOTE: This project is currently under initial development so isn't finalised, but should work if you want to experiment with Playwright Python.
 
 ## Table of Contents
 
diff --git a/buildBase.dockerfile b/buildBase.dockerfile
@@ -1,4 +1,4 @@
-FROM python:3.12-slim
+FROM python:3.13-slim
 
 WORKDIR /test
 
diff --git a/pages/bcss_home_page.py b/pages/bcss_home_page.py
@@ -1,4 +1,4 @@
-from playwright.sync_api import Page, expect
+from playwright.sync_api import Page
 
 
 class BcssHomePage:
@@ -13,8 +13,6 @@ def __init__(self, page: Page):
         self.refresh_alerts_link = self.page.get_by_role("link", name="Refresh alerts")
         self.user_guide_link = self.page.get_by_role("link", name="User guide")
         self.help_link = self.page.get_by_role("link", name="Help")
-        # Bowel Cancer Screening System header
-        self.bowel_cancer_screening_system_header = self.page.locator("#ntshAppTitle")
 
     def click_sub_menu_link(self):
         self.sub_menu_link.click()
@@ -40,9 +38,6 @@ def click_user_guide_link(self):
     def click_help_link(self):
         self.help_link.click()
 
-    def bowel_cancer_screening_system_header_is_displayed(self):
-        expect(self.bowel_cancer_screening_system_header).to_contain_text("Bowel Cancer Screening System")
-
 
 class MainMenu:
     def __init__(self, page: Page):
diff --git a/pages/cognito_login_page.py b/pages/cognito_login_page.py
@@ -0,0 +1,25 @@
+import os
+
+from playwright.sync_api import Page
+
+
+class CognitoLoginPage:
+
+    def __init__(self, page: Page):
+        self.page = page
+        self.username = page.get_by_role("textbox", name="Username")
+        self.password = page.get_by_role("textbox", name="Password")
+        self.submit_button = page.get_by_role("button", name="submit")
+
+    def login_as_user(self, username: str, password: str) -> None:
+        """Logs in to bcss with specified user credentials
+        Args:
+            username (str) enter a username that exists in users.json
+            password (str) the password for the user provided
+        """
+        # Retrieve and enter username from users.json
+        self.username.fill(username)
+        # Retrieve and enter password from .env file
+        self.password.fill(password)
+        # Click Submit
+        self.submit_button.click()
diff --git a/pytest.ini b/pytest.ini
@@ -17,7 +17,6 @@ addopts =
 # Allows pytest to identify the base of this project as the pythonpath
 pythonpath = .
 
-
 # These are the tags that pytest will recognise when using @pytest.mark
 markers =
     #example: tests used for example purposes by this blueprint
@@ -28,4 +27,3 @@ markers =
     utils: test setup and support methods
     smoke: tests designed to run as part of the smokescreen regression test suite
     wip: tests that are currently in progress
-    smokescreen: test containing the compartment smokescreen tests
diff --git a/requirements.txt b/requirements.txt
@@ -1,9 +1,4 @@
 pytest-playwright>=0.5.1
 pytest-html>=4.1.1
 pytest-json-report>=1.5.0
-pypdf>=5.3.0
-oracledb>=2.5.1
-pandas>=2.2.3
 python-dotenv~=1.0.1
-Flask~=3.0.3
-sqlalchemy>=2.0.38
diff --git a/scripts/docker/examples/python/assets/hello_world/requirements.txt b/scripts/docker/examples/python/assets/hello_world/requirements.txt
@@ -3,7 +3,7 @@ click==8.1.7
 Flask-WTF==1.2.0
 Flask==2.3.3
 itsdangerous==2.1.2
-Jinja2==3.1.4
+Jinja2==3.1.6
 MarkupSafe==2.1.3
 pip==23.3
 setuptools==70.0.0
diff --git a/tests/test_bowel_scope_page.py b/tests/test_bowel_scope_page.py
@@ -1,17 +1,16 @@
 import pytest
 from playwright.sync_api import Page, expect
-
 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)
 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
+    Before every test is executed, this fixture logs in to BCSS as the specified 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,17 +1,16 @@
 import pytest
 from playwright.sync_api import Page, expect
-
 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)
 def before_each(page: Page):
     """
-    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the call and recall page
+    Before every test is executed, this fixture logs in to BCSS as the specified user and navigates to the call and recall page
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
     # Go to call and recall page
     MainMenu(page).go_to_call_and_recall_page()
diff --git a/tests/test_communications_production_page.py b/tests/test_communications_production_page.py
@@ -1,17 +1,17 @@
 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 MainMenu
 
 
 @pytest.fixture(scope="function", autouse=True)
 def before_each(page: Page):
     """
-    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the communications
+    Before every test is executed, this fixture logs in to BCSS as the specified user and navigates to the communications
     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()
diff --git a/tests/test_contacts_list_page.py b/tests/test_contacts_list_page.py
@@ -1,17 +1,16 @@
 import pytest
 from playwright.sync_api import Page, expect
-
 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)
 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
+    Before every test is executed, this fixture logs in to BCSS as the specified 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
@@ -1,17 +1,16 @@
 import pytest
 from playwright.sync_api import Page, expect
-
 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)
 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
+    Before every test is executed, this fixture logs in to BCSS as the specified 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
@@ -1,18 +1,17 @@
 import pytest
 from playwright.sync_api import Page, expect
-
 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)
 def before_each(page: Page):
     """
-    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the
+    Before every test is executed, this fixture logs in to BCSS as the specified user and navigates to the
     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
@@ -1,18 +1,17 @@
 import pytest
 from playwright.sync_api import Page, expect
-
 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)
 def before_each(page: Page):
     """
-    Before every test is executed, this fixture logs in to BCSS as a test user and navigates to the
+    Before every test is executed, this fixture logs in to BCSS as the specified user and navigates to the
     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,18 +1,18 @@
 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
 
 
 @pytest.fixture(scope="function", autouse=True)
 def before_each(page: Page):
     """
-    Before every test is executed, this fixture logs in to BCSS as a test user and results in the home page
+    Before every test is executed, this fixture logs in to BCSS as the specified user and results in the home page
     being displayed
     """
     # Log in to BCSS
-    BcssLoginPage(page).login_as_user("BCSS401")
+    UserTools.user_login(page, "Hub Manager State Registered")
 
 
 @pytest.mark.smoke
@@ -52,8 +52,9 @@ def test_home_page_links_navigation(page: Page) -> None:
     # Click the refresh alerts link
     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()))
+    expect(page.locator("form[name=\"refreshCockpit\"]")).to_contain_text(
+        f"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,54 +1,13 @@
-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
+
 
 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
diff --git a/tests/test_organisations_page.py b/tests/test_organisations_page.py
diff --git a/tests/test_reports_page.py b/tests/test_reports_page.py
diff --git a/tests/test_screening_practitioner_appointments_page.py b/tests/test_screening_practitioner_appointments_page.py
diff --git a/tests/test_screening_subject_search_page.py b/tests/test_screening_subject_search_page.py
diff --git a/users.json b/users.json
diff --git a/utils/axe.py b/utils/axe.py
diff --git a/utils/user_tools.py b/utils/user_tools.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# DO NOT COMMIT THIS FILE`
	`2`	`+`
	`3`	`+BCSS_PASS=`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-FROM python:3.12-slim`
	`1`	`+FROM python:3.13-slim`
`2`	`2`
`3`	`3`	`WORKDIR /test`
`4`	`4`