Merge branch 'main' into dependabot/docker/python-3.13-slim

Author: davethepunkyone

.editorconfig

@@ -19,3 +19,11 @@ indent_size = 4
 
 [{Makefile,*.mk,go.mod,go.sum,*.go,.gitmodules}]
 indent_style = tab
+
+[{axe.js,axe.min.js}]
+charset = unset
+end_of_line = unset
+insert_final_newline = unset
+trim_trailing_whitespace = unset
+indent_style = unset
+indent_size = unset

.github/actions/check-axe-version/action.yaml

@@ -0,0 +1,42 @@
+name: "Check axe-core version"
+description: "Checks if our copy of axe-core is up to date"
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create dependency update branch
+        run: |
+          git checkout -b axe-dependency-check
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'latest'
+      - name: Install axe-core in temp dir
+        run: |
+          cd utils/resouces
+          mkdir temp
+          cd temp
+          npm install axe-core
+      - name: Retrieve axe.js file
+        run: |
+          cd node_modules/axe-core
+          mv axe.js ../../../
+      - name: Remove temp directory
+        run: |
+          cd ../../../
+          rm -rf temp
+      - name: Stage & commit file
+        run: |
+          git stage axe.js
+          git diff-index --quiet HEAD || (git commit -a -m "axe.js scheduled update" --allow-empty)
+      - name: Push changes to branch
+        uses: ad-m/github-push-action@v0.6.0
+        with:
+          github_token: ${{ secrets.PUSH_TOKEN }}
+          branch: axe-dependency-check

.github/workflows/axe-dependency-check.yaml

@@ -0,0 +1,40 @@
+name: Run Axe Dependency Check
+
+on: [workflow_dispatch]
+
+jobs:
+  axe-dependency-check:
+    name: "Axe Version Check"
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - run: |
+          git checkout ${{ github.head_ref || github.ref_name }}
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'latest'
+      - name: Install axe-core in temp dir
+        run: |
+          cd utils/resources
+          mkdir temp
+          cd temp
+          npm install axe-core
+      - name: Retrieve axe.js file
+        run: |
+          cd utils/resources/temp/node_modules/axe-core
+          mv axe.js ../../../
+      - name: Remove temp directory
+        run: |
+          cd utils/resources
+          rm -rf temp
+      - name: Commit to axe-dependency-check branch
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add utils/resources/axe.js
+          git commit -m "axe-core automated update"
+          git push

.github/workflows/stage-3-build.yaml

@@ -30,13 +30,13 @@ on:
 
 jobs:
   run-tests:
-    name: "Run Example Tests"
+    name: "Run Util & Example Tests"
     runs-on: ubuntu-latest
     timeout-minutes: 3
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.12'
       - name: Install dependencies
@@ -45,6 +45,8 @@ jobs:
           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

.gitignore

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

.gitleaks.toml

@@ -0,0 +1,7 @@
+# This allows for the ignoring of secret scanning against axe-core, as whilst it is in our code base we don't control it
+
+[allowlist]
+description = "global allow list"
+paths = [
+  '''(.*?)(axe.js|axe.min.js)'''
+]

.gitleaksignore

@@ -16,6 +16,7 @@ NOTE: This project is currently under initial development so isn't finalised, bu
     - [Prerequisites](#prerequisites)
     - [Configuration](#configuration)
   - [Getting Started](#getting-started)
+  - [Utilities](#utilities)
   - [Contacts](#contacts)
   - [Licence](#licence)
 
@@ -66,6 +67,15 @@ We've also created a [Quick Reference Guide](./docs/getting-started/Quick_Refere
 
 For additional reading and guidance on writing tests, we also recommend reviewing the [Playwright Python documentation](https://playwright.dev/python/docs/writing-tests).
 
+## Utilities
+
+This blueprint also provides the following utility classes, that can be used to aid in testing:
+
+|Utility|Description|
+|-------|-----------|
+|[Axe](./docs/utility-guides/Axe.md)|Accessibility scanning using axe-core.|
+|NHSNumberTools|Basic tools for working with NHS numbers.|
+
 ## Contacts
 
 If you have any queries regarding this blueprint, please contact [dave.harding1@nhs.net](mailto:dave.harding1@nhs.net).