Merge pull request #791 from NHSDigital/containerized_regression_tests_for_PRs

jf-x-dev · web-flow · commit 9443259ee1bb · 2025-12-04T10:55:06.000Z
Containerized regression tests for p rs
diff --git a/.github/actions/deploy-reports/action.yml b/.github/actions/deploy-reports/action.yml
@@ -23,14 +23,16 @@ runs:
       id: set-pages-dir
       run: |
         sanitized_device=$(echo "${{ inputs.device }}" | tr -cd '[:alnum:]_-')
-        echo "dir=${{ github.ref_name }}/${{ inputs.environment }}/$sanitized_device" >> $GITHUB_OUTPUT
+        echo "dir=${{ github.head_ref }}/${{ inputs.environment }}/$sanitized_device" >> $GITHUB_OUTPUT
       shell: bash
 
     - name: Checkout gh-pages branch
-      uses: actions/checkout@v4
+      uses: actions/checkout@v6
       with:
+        repository: NHSDigital/manage-vaccinations-in-schools-testing
         ref: gh-pages
         path: gh-pages
+        token: ${{ env.GITHUB_TOKEN }}
 
     - name: Replace existing report
       run: |
@@ -53,8 +55,6 @@ runs:
         git push origin gh-pages --force
         git branch -D temp-pages
       shell: bash
-      env:
-        GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }}
 
     - name: Set Job Summary
       run: |
diff --git a/.github/actions/run-functional-tests/action.yml b/.github/actions/run-functional-tests/action.yml
@@ -3,8 +3,15 @@ description: 'Execute tests'
 inputs:
   tests:
     default: ''
+  github_ref:
+    default: 'main'
+    required: false
   accessibility_tests:
     default: 'false'
+  reporting_tests:
+    default: 'false'
+  imms_api_tests:
+    default: 'false'
   device:
     required: true
   base_url:
@@ -43,11 +50,28 @@ runs:
     - name: Choose test suite to run
       id: marker
       run: |
-        if [ "${{ inputs.accessibility_tests }}" = "true" ]; then
-          echo "marker=accessibility" >> $GITHUB_OUTPUT
-        else
-          echo "marker=not accessibility" >> $GITHUB_OUTPUT
+        exclude=""
+        if [ "${{ inputs.accessibility_tests }}" = "false" ]; then
+          exclude="not accessibility"
+        fi
+        if [ "${{ inputs.reporting_tests }}" = "false" ]; then
+          if [ -n "$exclude" ]; then
+            exclude="$exclude and not reporting"
+          else
+            exclude="not reporting"
+          fi
+        fi
+        if [ "${{ inputs.imms_api_tests }}" = "false" ]; then
+          if [ -n "$exclude" ]; then
+            exclude="$exclude and not imms_api"
+          else
+            exclude="not imms_api"
+          fi
+        fi
+        if [ -z "$exclude" ]; then
+          exclude="True"
         fi
+        echo "marker=$exclude" >> $GITHUB_OUTPUT
       shell: bash
 
     - name: Determine if reruns are enabled
diff --git a/.github/workflows/functional_selected_device.yaml b/.github/workflows/functional_selected_device.yaml
@@ -1,12 +1,84 @@
 name: Functional tests
 
 on:
+  workflow_call:
+    inputs:
+      tests:
+        description: 'Tests to run (leave blank to run all tests!)'
+        required: false
+        default: ''
+        type: string
+      cross_service_tests:
+        description: 'Include imms api and reporting tests'
+        required: false
+        default: false
+        type: boolean
+      github_ref:
+        description: 'Github reference to get tests from'
+        required: false
+        default: 'main'
+        type: string
+      device:
+        description: 'Device to test'
+        required: false
+        default: 'Desktop Chrome'
+        type: string
+      programmes:
+        description: Programmes to use (FLU, HPV, MENACWY, MMR or TD_IPV)
+        required: false
+        default: FLU,HPV,MENACWY,MMR,TD_IPV
+        type: string
+      endpoint:
+        description: 'Environment to run tests against'
+        required: false
+        default: 'https://qa.mavistesting.com'
+        type: string
+      screenshot_all_steps:
+        description: 'Take screenshots for all steps (in addition to failures)'
+        required: false
+        default: false
+        type: boolean
+      enable_reruns:
+        description: 'Enable test reruns on failure (up to 3 attempts)'
+        required: false
+        default: true
+        type: boolean
+      test_workers:
+        description: 'Number of parallel test workers to use'
+        required: false
+        default: '4'
+        type: string
+      set_feature_flags:
+        description: 'Set feature flags in the flipper page before running tests (affects all users of the environment being tested!)'
+        required: false
+        default: false
+        type: boolean
+      additional_feature_flags:
+        description: '(If enabled above) Additional feature flags to set. api, basic_auth, dev_tools will be set by default'
+        required: false
+        default: ''
+        type: string
+    secrets:
+      HTTP_AUTH_TOKEN_FOR_TESTS:
+        description: 'HTTP Basic Auth token for the environment under test'
+        required: true
+      MAVIS_TESTING_REPO_ACCESS_TOKEN:
+        description: 'Git token with access to the mavis testing repo'
+        required: false
   workflow_dispatch:
     inputs:
       tests:
         description: 'Tests to run (leave blank to run all tests!)'
         required: false
         default: ''
+      cross_service_tests:
+        description: 'Include imms api and reporting tests'
+        required: false
+        default: 'true'
+        type: choice
+        options:
+          - true
+          - false
       device:
         description: 'Device to test'
         required: true
@@ -73,7 +145,6 @@ on:
         description: '(If enabled above) Additional feature flags to set. api, basic_auth, dev_tools will be set by default'
         required: false
         default: ''
-  pull_request:
 
 jobs:
   test:
@@ -96,8 +167,9 @@ jobs:
             [sandbox-alpha]="https://sandbox-alpha.mavistesting.com"
             [sandbox-beta]="https://sandbox-beta.mavistesting.com"
           )
-          if [ "${{ github.event_name }}" = "pull_request" ]; then
+          if [ "${{ github.event_name }}" = "push" ]; then
             echo "tests=" >> $GITHUB_OUTPUT
+            echo "cross_service_tests=true" >> $GITHUB_OUTPUT
             echo "device=Desktop Chrome" >> $GITHUB_OUTPUT
             echo "environment=${env_map[qa]}" >> $GITHUB_OUTPUT
             echo "programmes=FLU,HPV,MENACWY,MMR,TD_IPV" >> $GITHUB_OUTPUT
@@ -108,23 +180,32 @@ jobs:
             echo "enable_reruns=true" >> $GITHUB_OUTPUT
             echo "test_workers=4" >> $GITHUB_OUTPUT
           else
-            echo "tests=${{ github.event.inputs.tests }}" >> $GITHUB_OUTPUT
-            echo "device=${{ github.event.inputs.device }}" >> $GITHUB_OUTPUT
-
-            input_env="${{ github.event.inputs.environment }}"
-            url="${env_map[$input_env]:-${env_map[qa]}}"
-            echo "environment=$url" >> $GITHUB_OUTPUT
+            echo "tests=${{ inputs.tests }}" >> $GITHUB_OUTPUT
+            echo "cross_service_tests=${{ inputs.cross_service_tests }}" >> $GITHUB_OUTPUT
+            echo "device=${{ inputs.device }}" >> $GITHUB_OUTPUT
+          
+            input_env="${{ inputs.environment }}"
+            if [ -n "$input_env" ]; then
+              url="${env_map[$input_env]:-${env_map[qa]}}"
+              echo "environment=$url" >> $GITHUB_OUTPUT
+            else
+              echo "environment=${{ inputs.endpoint }}" >> $GITHUB_OUTPUT
+            fi
 
-            echo "programmes=${{ github.event.inputs.programmes }}" >> $GITHUB_OUTPUT
-            echo "set_feature_flags=${{ github.event.inputs.set_feature_flags }}" >> $GITHUB_OUTPUT
-            echo "additional_feature_flags=${{ github.event.inputs.additional_feature_flags }}" >> $GITHUB_OUTPUT
+            echo "programmes=${{ inputs.programmes }}" >> $GITHUB_OUTPUT
+            echo "set_feature_flags=${{ inputs.set_feature_flags }}" >> $GITHUB_OUTPUT
+            echo "additional_feature_flags=${{ inputs.additional_feature_flags }}" >> $GITHUB_OUTPUT
             echo "deploy_report=true" >> $GITHUB_OUTPUT
-            echo "screenshot_all_steps=${{ github.event.inputs.screenshot_all_steps }}" >> $GITHUB_OUTPUT
-            echo "enable_reruns=${{ github.event.inputs.enable_reruns }}" >> $GITHUB_OUTPUT
-            echo "test_workers=${{ github.event.inputs.test_workers }}" >> $GITHUB_OUTPUT
+            echo "screenshot_all_steps=${{ inputs.screenshot_all_steps }}" >> $GITHUB_OUTPUT
+            echo "enable_reruns=${{ inputs.enable_reruns }}" >> $GITHUB_OUTPUT
+            echo "test_workers=${{ inputs.test_workers }}" >> $GITHUB_OUTPUT
           fi
 
-      - uses: actions/checkout@v6
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          repository: NHSDigital/manage-vaccinations-in-schools-testing
+          ref: ${{ inputs.github_ref || github.head_ref }}
 
       - name: Cache Playwright browsers
         uses: actions/cache@v4
@@ -137,6 +218,9 @@ jobs:
         uses: ./.github/actions/run-functional-tests
         with:
           tests: ${{ steps.set-variables.outputs.tests }}
+          imms_api_tests: ${{ steps.set-variables.outputs.cross_service_tests }}
+          reporting_tests: ${{ steps.set-variables.outputs.cross_service_tests }}
+          github_ref: ${{ inputs.github_ref || github.head_ref }}
           device: ${{ steps.set-variables.outputs.device }}
           base_url: ${{ steps.set-variables.outputs.environment }}
           programmes_enabled: ${{ steps.set-variables.outputs.programmes }}
@@ -160,4 +244,5 @@ jobs:
           device: ${{ steps.set-variables.outputs.device }}
           environment: ${{ github.event.inputs.environment }}
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.MAVIS_TESTING_REPO_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
+
diff --git a/.github/workflows/pull_request_validation.yaml b/.github/workflows/pull_request_validation.yaml
@@ -0,0 +1,63 @@
+name: Pull Request Validation
+
+on: pull_request
+
+permissions: { }
+
+jobs:
+  identify-target-environment:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    outputs:
+      environment: ${{ steps.identify-target-environment.outputs.environment }}
+      mavis_branch: ${{ steps.check-branch.outputs.mavis_branch }}
+    steps:
+      - name: Check if branch exists
+        id: check-branch
+        run: |
+          if git ls-remote --exit-code --heads https://github.com/nhsuk/manage-vaccinations-in-schools.git ${{ github.head_ref }} > /dev/null 2>&1; then
+            echo "mavis_branch=${{ github.head_ref }}" >> $GITHUB_OUTPUT
+          else
+            echo "mavis_branch=main" >> $GITHUB_OUTPUT
+          fi
+      - name: Identify target environment
+        id: identify-target-environment
+        run: |
+          environment='qa'
+          if [[ -n "${{ steps.check-branch.outputs.mavis_branch }}" ]]; then
+            environment='container'
+          fi
+          echo "environment=$environment" >> $GITHUB_OUTPUT
+  run-tests-against-staging:
+    needs: identify-target-environment
+    if: needs.identify-target-environment.outputs.environment != 'container'
+    uses: ./.github/workflows/functional_selected_device.yaml
+    permissions:
+      contents: write
+    with:
+      tests: ''
+      cross_service_tests: false
+      github_ref: ${{ github.ref }}
+      endpoint: 'https://qa.mavistesting.com'
+      device: 'Desktop Chrome'
+      programmes: 'FLU,HPV,MENACWY,MMR,TD_IPV'
+      screenshot_all_steps: false
+      enable_reruns: false
+      test_workers: '4'
+      set_feature_flags: false
+      additional_feature_flags: ''
+    secrets:
+      HTTP_AUTH_TOKEN_FOR_TESTS: ${{ secrets.HTTP_AUTH_TOKEN_FOR_TESTS }}
+  run-tests-against-container:
+    needs: identify-target-environment
+    if: needs.identify-target-environment.outputs.environment == 'container'
+    uses: nhsuk/manage-vaccinations-in-schools/.github/workflows/end-to-end-tests.yml@containerized_regression_tests_for_PRs #TODO: Change once this is in main
+    permissions:
+      id-token: write
+      contents: write
+    with:
+      github_ref: ${{ needs.identify-target-environment.outputs.mavis_branch }}
+    secrets:
+      HTTP_AUTH_TOKEN_FOR_TESTS: ${{ secrets.HTTP_AUTH_TOKEN_FOR_TESTS }}
+      MAVIS_TESTING_REPO_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -165,7 +165,7 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
 
 # Visual Studio Code
 #  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
