AC - got basic login test working

Author: andrew-cleveland

.gitignore

@@ -15,3 +15,4 @@
 __pycache__/
 .pytest_cache/
 test-results/
+.env

buildBase.dockerfile DockerfilebuildBase.dockerfile renamed to Dockerfile

@@ -12,7 +12,11 @@ RUN mkdir -p /tests/
 COPY ./tests/ ./tests/
 RUN mkdir -p /utils/
 COPY ./utils/ ./utils/
+RUN mkdir -p /pages/
+COPY ./pages ./pages
 COPY ./pytest.ini ./pytest.ini
 COPY ./run_tests.sh ./run_tests.sh
+COPY ./.env ./.env
 
 RUN chmod +x ./run_tests.sh
+CMD bash run_tests.sh

Makefile

@@ -7,11 +7,19 @@ include scripts/init.mk
 
 # Example CI/CD targets are: dependencies, build, publish, deploy, clean, etc.
 
+test: # run tests in a local podman container
+	if podman inspect -f '{{.Name}}' playwright > /dev/null; then
+		podman rm playwright --force
+	fi
+		podman build -t bcss-playwright:latest .
+		podman run --name playwright bcss-playwright:latest
+		podman logs -f playwright
+		
 dependencies: # Install dependencies needed to build and test the project @Pipeline
 	# TODO: Implement installation of your project dependencies
 
 build: # Build the project artefact @Pipeline
-	# TODO: Implement the artefact build step
+	podman build -t bcss-playwright:latest .
 
 publish: # Publish the project artefact @Pipeline
 	# TODO: Implement the artefact publishing step

README.md

@@ -6,7 +6,7 @@ This project is designed to provide a blueprint to allow for development teams t
 
 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: 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.**
 
 ## Table of Contents
 
@@ -34,18 +34,26 @@ To utilise the blueprint code, you will need to have the following installed:
 - [Python](https://www.python.org/downloads/) 3.12 or greater
 
 Whilst not required to get started, you may also want to [configure a Python virtual environment for your project](https://docs.python.org/3/library/venv.html) before proceeding with
-the configuration.  If you are using an IDE such as Visual Studio Code or PyCharm, you will normally be prompted to do this automatically.
+the configuration. If you are using an IDE such as Visual Studio Code or PyCharm, you will normally be prompted to do this automatically.
 
 ### Configuration
 
-To get started using Playwright and with the examples provided, use the following commands:
+There is a makefile which has common commands to interface with the repository, to check if the tests are working you can run the command `make test`
 
-```shell
+The first time you run this it will create a container using buildah and podman, it will then install the prerequisites onto it and copy over the code before executing `pytest` to run all the tests. This is the reccomended way to run the tests
+
+If you prefer to run the tests locally you can do so by first assuming the python virtual environment, vscode should pick it up automatically in the `venv` directory but if you are using the terminal on linux or mac you can run `source venv/bin/activate` If you are using windows it may work the same for you or you may need to lookup how to assume a python virtual environment.
+
+Once that is done you can run the following commands to install the prerequisites:
+
+```bash
 pip install -r requirements.txt
 playwright install --with-deps
 ```
 
-This will install all the necessary packages for executing Playwright tests, and install Playwright ready for use by the framework.  You can test the configuration
+> **Note** I found that trying to run this on fedora let to some errors, only Ubuntu seems to be supported which is why I have setup a container using ubuntu to support other environments
+
+This will install all the necessary packages for executing Playwright tests, and install Playwright ready for use by the framework. You can test the configuration
 has worked by running our example tests, which can be done using the following command (this will run all tests with tracing reports turned on, and in headed mode
 so you can see the browser execution):
 

pages/bcss_home_page.py

@@ -0,0 +1,40 @@
+from playwright.sync_api import Page
+
+
+class BcssHomePage:
+
+    def __init__(self, page: Page):
+        self.page = page
+        self.sub_menu_link = self.page.get_by_role("link", name="Show Sub-menu")
+        self.hide_sub_menu_link = self.page.get_by_role("link", name="Hide Sub-menu")
+        self.select_org_link = self.page.get_by_role("link", name="Select Org")
+        self.back_button = self.page.get_by_role("link", name="Back")
+        self.release_notes_link = self.page.get_by_role("link", name="- Release Notes")
+        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")
+
+
+    def click_sub_menu_link(self):
+        self.sub_menu_link.click()
+
+    def click_hide_sub_menu_link(self):
+        self.hide_sub_menu_link.click()
+
+    def click_select_org_link(self):
+        self.select_org_link.click()
+
+    def click_back_button(self):
+        self.back_button.click()
+
+    def click_release_notes_link(self):
+        self.release_notes_link.click()
+
+    def click_refresh_alerts_link(self):
+        self.refresh_alerts_link.click()
+
+    def click_user_guide_link(self):
+        self.user_guide_link.click()
+
+    def click_help_link(self):
+        self.help_link.click()

pages/login.py

@@ -0,0 +1,15 @@
+from playwright.sync_api import Page, expect
+class BcssLoginPage:
+
+    def __init__(self, page: Page):
+        self.page = page
+        self.page.goto("/")
+        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(self, username, password):
+        self.username.fill(username)
+        self.password.fill(password)
+        self.submit_button.click()

pytest.ini

@@ -13,3 +13,4 @@ markers =
     branch: tests designed to run at a branch level
     main: tests designed to run against the main branch
     release: tests designed to run specifically against a release branch
+pythonpath = .

requirements.txt

@@ -1,3 +1,4 @@
 pytest-playwright>=0.5.1
 pytest-html>=4.1.1
 pytest-json-report>=1.5.0
+python-dotenv>=1.0.1

run_tests.sh

@@ -1,3 +1,3 @@
-#!/bin/sh
+#!/bin/bash
 
-pytest
+pytest

tests/test_login_to_bcss.py

@@ -0,0 +1,38 @@
+from os import environ
+from playwright.sync_api import Page, expect
+from pages.login import BcssLoginPage
+from dotenv import load_dotenv
+
+load_dotenv()
+
+def test_successful_login_to_bcss(page: Page) -> None:
+    username = environ.get("BCSS_USERNAME")
+    password = environ.get("BCSS_PASSWORD")
+    login_page = BcssLoginPage(page)
+    login_page.login(username, password)
+    expect(page.locator("#ntshAppTitle")).to_contain_text("Bowel Cancer Screening System")
+
+
+def test_login_to_bcss_with_invalid_username(page: Page) -> None:
+    username = "zzzzzz"
+    password = environ.get("BCSS_PASSWORD")
+    login_page = BcssLoginPage(page)
+    login_page.login(username, password)
+    expect(page.locator("body")).to_contain_text("Incorrect username or password.")
+
+
+def test_login_to_bcss_with_invalid_password(page: Page) -> None:
+    username = environ.get("BCSS_USERNAME")
+    password = "zzzzzz"
+    login_page = BcssLoginPage(page)
+    login_page.login(username, password)
+    expect(page.locator("body")).to_contain_text("Incorrect username or password.")
+
+
+def test_login_to_bcss_with_no_username_or_password(page: Page) -> None:
+    username = ""
+    password = ""
+    login_page = BcssLoginPage(page)
+    login_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()