AC - updated readme

Author: andrew-cleveland

Makefile

@@ -7,7 +7,10 @@ include scripts/init.mk
 
 # Example CI/CD targets are: dependencies, build, publish, deploy, clean, etc.
 
-test: # run tests in a local podman container
+test:
+	./run_tests.sh
+
+podman-test: # run tests in a local podman container
 	if podman inspect -f '{{.Name}}' playwright > /dev/null; then
 		podman rm playwright --force
 	fi

README.md

@@ -21,67 +21,63 @@ NOTE: This project is currently under initial development so isn't finalised, bu
 
 ## Setup
 
-You can clone this whole repository using the code below:
-
-```shell
-git clone https://github.com/nhs-england-tools/playwright-python-blueprint.git
-```
+You can clone this whole repository by clicking on the green `Code` button at near the top of the screen, then select either ssh or https, depending on if you have your ssh key setup
 
 ### Prerequisites
 
-To utilise the blueprint code, you will need to have the following installed:
+#### Python3
 
-- [Python](https://www.python.org/downloads/) 3.12 or greater
+To utilise the test for the BCSS app you will first of all require python3. The installation method changes based on operating systems but can usually be installed from a software store.
 
-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.
+#### Virtual Environment
 
-### Configuration
+To avoid conflicts with the rest of the operating system it is reccomended to create a python virtual environment, this isolates any packages installed and makes your life easier. To do that run the following command:
 
-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`
+`python -m venv .venv`
 
-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
+This will create a bunch of files under a directory called `.venv` if you are using Visual Studios Code then it should automatically detect this environment and use it, but you may need to restart VSCode to pick up this new virtual environment
 
-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.
+#### Python Packages
 
-Once that is done you can run the following commands to install the prerequisites:
+There are a bunch of packages that are required to run the tests in this repository, they have been tracked in the `requirements.txt` file. To install them run this command:
 
 ```bash
 pip install -r requirements.txt
-playwright install --with-deps
 ```
 
-> **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 then install all of the dependancies.
 
-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):
+#### Playwright
 
-```shell
-pytest --tracing on --headed
+Once all the pre-requisites have been installed then you can install playwright with the following command:
+
+```bash
+playwright install --with-deps
 ```
 
+This will take a while and will install playwright and its browsers which allow it to run the tests.
+
+### Configuration
+
+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`
+
+There is also a dockerised version which will create a container using podman and run it there, if you dont have a compatible OS or you dont want to install the dependancies directly, however you will need to install podman and podman-build, you can run that with `podman-test`
+
 ## Getting Started
 
 > NOTE: This section is currently under development and requires further work, so links to pages within this repository may not be very useful at this stage.
 
 Once you've confirmed your installation is working, please take a look at the following guides on getting started with Playwright Python.
 
-1. [Understanding Playwright Python](./docs/getting-started/1_Understanding_Playwright_Python.md)
-2. [Blueprint File Breakdown](./docs/getting-started/2_Blueprint_File_Breakdown.md)
-
-We've also created a [Quick Reference Guide](./docs/getting-started/Quick_Reference_Guide.md) for common commands and actions you may regularly perform using this blueprint.
-
-For additional reading and guidance on writing tests, we also recommend reviewing the [Playwright Python documentation](https://playwright.dev/python/docs/writing-tests).
+- [Quick Reference Guide](./docs/getting-started/Quick_Reference_Guide.md) for common commands and actions you may regularly perform using this blueprint.
+- [Playwright Python documentation](https://playwright.dev/python/docs/writing-tests) guidance on writing tests.
 
 ## Contacts
 
-If you have any queries regarding this blueprint, please contact [[email protected]](mailto:[email protected]).
+If you have any queries regarding these tests, please contact [[email protected]](mailto:[email protected]). or [[email protected]](mailto:[email protected])
 
 ## Licence
 
-> The [LICENCE.md](./LICENCE.md) file will need to be updated with the correct year and owner
-
 Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
 
 Any HTML or Markdown documentation is [© Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/) and available under the terms of the [Open Government Licence v3.0](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).

pages/bcss_home_page.py

@@ -53,3 +53,6 @@ def click_help_link(self):
 
     def click_screening_pracitioners_appointments(self):
         self.screening_pracitioners_appointments.click()
+
+    def click_logout(self):
+        self.log_out.click()

pages/screening_practitioner_appointments.py

@@ -28,11 +28,9 @@ def __init__(self, page: Page):
                 "link", name="Patients that Require Colonoscopy Assessment Appointments"
             )
         )
-        self.patients_that_require_colonoscopy_assessment_appointments_bowl_scope = (
-            self.page.get_by_role(
-                "link",
-                name="Bowel Scope",
-            )
+        self.patients_that_require_colonoscopy_assessment_appointments_bowl_scope = self.page.get_by_role(
+            "link",
+            name="Patients that Require Colonoscopy Assessment Appointments - Bowel Scope",
         )
         self.patients_that_require_surveillance_appointments = self.page.get_by_role(
             "link", name="Patients that Require Surveillance Appointments"

tests/test_homepage_links.py

@@ -80,3 +80,10 @@ def test_homepage_user_guide(page: Page) -> None:
         user_guide = popup_info.value
         # user_guide.screenshot(path="test-results/help_screen.png")
         expect(user_guide.get_by_text("Bowel Cancer Screening System"))
+
+
+def test_logout(page: Page) -> None:
+    homepage = BcssHomePage(page)
+    homepage.click_logout()
+    page.screenshot(path="test-results/logout_screen.png")
+    expect(page.get_by_role("link", name="Log in"))

tests/test_screening_practitioner_appointments.py

@@ -55,92 +55,3 @@ def test_patients_that_require_colonoscopy_assessment_appointments(page: Page) -
     table_locator = page.locator("table#booking tbody tr")
     child_count = table_locator.count()
     assert child_count > 0
-
-
-# def test_patients_that_require_colonoscopy_assessment_appointments_bowel_scope(
-#     page: Page,
-# ) -> None:
-#     get_to_screen(page)
-#     # homepage = BcssHomePage(page)
-#     screening_pracitioners_appointments = ScreeningPractitionerAppointments(page)
-#     # homepage.click_screening_pracitioners_appointments()
-#     # expect(page.get_by_role("link", name="View appointments")).to_be_visible()
-#     screening_pracitioners_appointments.click_patients_that_require_colonoscopy_assessment_appointments_bowl_scope()
-#     expect(
-#         page.get_by_text(
-#             "Patients that Require Colonoscopy Assessment Appointment Booking"
-#         )
-#     ).to_be_visible()
-#     # table_locator = page.locator("table#displayInputParameters tbody tr")
-#     # child_count = table_locator.count()
-#     # assert child_count > 0
-
-
-# def test_patients_that_require_surveillance_appointments(
-#     page: Page,
-# ) -> None:
-#     get_to_screen(page)
-#     screening_pracitioners_appointments = ScreeningPractitionerAppointments(page)
-#     screening_pracitioners_appointments.click_patients_that_require_surveillance_appointments()
-# expect(
-#     page.get_by_text("Patients that Require Surveillance Appointments")
-# ).to_be_visible()
-# table_locator = page.locator("table#displayInputParameters tbody tr")
-# child_count = table_locator.count()
-# assert child_count > 0
-
-
-# def test_view_appointments(page: Page) -> None:
-#     homepage = BcssHomePage(page)
-
-#     # Check the show and hide sub menu works
-#     homepage.click_sub_menu_link()
-#     expect(page.get_by_role("link", name="Organisation Parameters")).to_be_visible()
-#     homepage.click_hide_sub_menu_link()
-#     expect(page.get_by_role("cell", name="Alerts", exact=True)).to_be_visible()
-
-# def test_homepage_select_org(page: Page) -> None:
-#     homepage = BcssHomePage(page)
-
-#     # check the select org link works and then go back to homepage
-#     homepage.click_select_org_link()
-#     expect(page.locator("form")).to_contain_text("Choose an Organisation")
-#     homepage.click_back_button()
-#     expect(page.get_by_role("cell", name="Alerts", exact=True)).to_be_visible()
-
-# def test_homepage_release_notes(page: Page) -> None:
-#     homepage = BcssHomePage(page)
-
-#     # Click release notes link
-#     homepage.click_release_notes_link()
-#     expect(page.locator("#page-title")).to_contain_text("Release Notes")
-
-# def test_homepage_help(page: Page) -> None:
-#     homepage = BcssHomePage(page)
-
-#     # check the help link works
-#     with page.expect_popup() as popup_info:
-#         homepage.click_help_link()
-#         help_page = popup_info.value
-#         expect(help_page.get_by_text("Bowel Cancer Screening System Help")).to_be_visible
-
-
-# <input type="button" id="BTN_VIEW_LIST"
-# value="View appointments on this day"
-# onclick="inhibitOnXXXXXFunctionFor2MonthCalendar = false;
-# return doSubmit();">
-
-
-# def test_homepage_select_org(page: Page) -> None:
-#     homepage = BcssHomePage(page)
-
-#     # check the select org link works
-#     homepage.click_select_org_link()
-#     expect(page.locator("form[action*='/changeorg']")).to_contain_text("Choose an Organisation")
-#     # Check there is at least one entry in the organisation list
-#     table_locator = page.locator("table#organisations tr")
-#     row_count = table_locator.count()
-#     assert row_count > 0
-#     # Go back to the home page and make sure it loaded
-#     homepage.click_back_button()
-#     expect(page.get_by_role("cell", name="Alerts", exact=True)).to_be_visible()