VIA-598 AJ/DB WIP add snapshot tests to scheduled assurances

ankur-jain-nhs · ankur-jain-nhs · commit 1762b8b60c03 · 2025-11-14T16:09:37.000Z
diff --git a/.github/actions/run-e2e-tests/action.yaml b/.github/actions/run-e2e-tests/action.yaml
@@ -1,5 +1,6 @@
 name: "Run E2E tests"
 description: "Run E2E tests"
+
 inputs:
   checkout_ref:
     description: "Ref to checkout"
diff --git a/.github/actions/run-snapshot-tests/action.yaml b/.github/actions/run-snapshot-tests/action.yaml
@@ -1,59 +1,66 @@
 name: "Run Snapshot Tests"
-description: "Run snapshot tests against Preprod environment"
+description: "Run snapshot tests"
 
 inputs:
   checkout_ref:
     description: "Ref to checkout"
     required: true
   release_name:
-    description: "S3 folder to use for references and storing results (e.g. 'release1', 'latest-main')"
+    description: "S3 folder to use for references and storing results ('release1' / 'latest-main-tag')"
     required: true
 
 runs:
   using: "composite"
+
   steps:
-    - name: "Checkout code"
+    - name: "Checkout target code"
       uses: actions/checkout@v5
       with:
         ref: ${{ inputs.checkout_ref }}
         path: "code-for-snapshot-tests"
 
-    - name: "Configure AWS credentials for environment"
+    - name: "Configure AWS credentials"
       uses: aws-actions/configure-aws-credentials@v5
       with:
         role-session-name: GitHubActionsSession
-        role-to-assume: ${{ secrets.IAM_ROLE }}
-        aws-region: ${{ env.AWS_REGION }}
+        role-to-assume: ${{ env.SECRET_IAM_ROLE }}
+        aws-region: eu-west-2
 
-    - name: Cache node modules
+    - name: "Cache node modules"
       id: cache-npm
       uses: actions/cache@v4
       env:
         cache-name: cache-node-modules
       with:
         path: ~/.npm
-        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('./code-for-snapshot-tests**/package-lock.json') }}
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('./code-for-snapshot-tests/**/package-lock.json') }}
 
     - name: "Install dependencies"
       shell: bash
       working-directory: "./code-for-snapshot-tests"
       run: |
+        echo "::group::Install dependencies"
         npm ci --ignore-scripts
+        echo "::endgroup::"
 
     - name: "Get current week number and playwright version"
-      id: cache_key_values
       shell: bash
       working-directory: "./code-for-snapshot-tests"
+      id: cache_key_values
       run: |
+        echo "::group::Get current week number and playwright version"
         echo "week_num=$(date -u +'%Y-%V')" | tee -a $GITHUB_OUTPUT
         echo "playwright_version=$(npm view @playwright/test version)" | tee -a $GITHUB_OUTPUT
+        echo "::endgroup::"
 
     - name: "Get current date"
-      id: folder_name_value
       shell: bash
       working-directory: "./code-for-snapshot-tests"
+      id: folder_name_value
       run: |
+        echo "::group::Get current date"
         echo "current_datetime=$(date -u +'%Y-%m-%dT%H%M%SZ')" | tee -a $GITHUB_OUTPUT
+        echo "::endgroup::"
 
     - name: "Cache Playwright browsers"
       uses: actions/cache@v4
@@ -67,15 +74,23 @@ runs:
       shell: bash
       working-directory: "./code-for-snapshot-tests"
       run: |
+        echo "::group::Install Playwright browsers (Chromium, Firefox)"
         npx playwright install chromium firefox --with-deps
+        EXIT_STATUS=$?
+        echo "::endgroup::"
+        exit $EXIT_STATUS
 
     - name: "Install Playwright browsers (Webkit)"
       shell: bash
       working-directory: "./code-for-snapshot-tests"
       run: |
+        echo "::group::Install Playwright browsers (Webkit)"
         npx playwright install webkit --with-deps
+        EXIT_STATUS=$?
+        echo "::endgroup::"
+        exit $EXIT_STATUS
 
-    - name: "Download snapshots from ${{ inputs.release_name }} S3 bucket"
+    - name: "Download reference snapshots from S3"
       shell: bash
       working-directory: "./code-for-snapshot-tests"
       run: |
@@ -90,17 +105,17 @@ runs:
         CURRENT_DATETIME: ${{ steps.folder_name_value.outputs.current_datetime }}
         CHECKOUT_REF: ${{ inputs.checkout_ref }}
 
-    - name: "Upload snapshots to ${{ inputs.release_name }} S3 bucket with tag ${{ steps.folder_name_value.outputs.current_datetime }}-${{ inputs.checkout_ref }}"
-      if: failure()
+    - name: "Upload snapshots to S3 bucket with tag ${{ steps.folder_name_value.outputs.current_datetime }}-${{ inputs.checkout_ref }}"
+      if: ${{ failure() }}
       shell: bash
       working-directory: "./code-for-snapshot-tests"
       run: |
         aws s3 sync --delete ./e2e/snapshot/snapshot_review/ s3://${{ env.AWS_S3_ARTEFACTS_BUCKET }}/playwright/snapshots-for-review/${{ inputs.release_name }}/${{ steps.folder_name_value.outputs.current_datetime }}-${{ inputs.checkout_ref }}/
 
     - name: "Upload report"
       uses: actions/upload-artifact@v5
-      if: always()
+      if: ${{ failure() }}
       with:
         name: playwright-report-snapshot-${{ inputs.release_name }}-${{ steps.folder_name_value.outputs.current_datetime }}-${{ inputs.checkout_ref }}
-        path: playwright-report/
+        path: ./code-for-snapshot-tests/playwright-report/
         retention-days: 30
diff --git a/.github/workflows/cicd-9-scheduled-wip.yaml b/.github/workflows/cicd-9-scheduled-wip.yaml
@@ -14,6 +14,10 @@ on:
           - All
 
 jobs:
+  ##########################################################
+  # R1.0 deployment and assurance (e2e+snapshots+contract)
+  ##########################################################
+
   deploy-and-test-r1:
     name: "R1.0 Assurance"
     runs-on: "ubuntu-latest"
@@ -43,7 +47,7 @@ jobs:
     - name: "Checkout code"
       uses: actions/checkout@v5
 
-    - name: "Deploy to AWS (preprod)"
+    - name: "Deploy ${{ steps.get-latest-tag-name.outputs.value }} to AWS (preprod)"
       timeout-minutes: 10
       uses: ./.github/actions/deploy
       with:
@@ -53,23 +57,6 @@ jobs:
         secret_aws_iam_role: ${{ secrets.IAM_ROLE }}
         secret_aws_slack_channel_id: ${{ secrets.ALARMS_SLACK_CHANNEL_ID }}
 
-    - name: "Run E2E tests on ${{ steps.get-latest-tag-name.outputs.value }} (preprod)"
-      timeout-minutes: 10
-      uses: ./.github/actions/run-e2e-tests
-      with:
-        checkout_ref: ${{ steps.get-latest-tag-name.outputs.value }}
-        cross_browser: true
-      env:
-        TEST_NHS_APP_URL: ${{ secrets.TEST_NHS_APP_URL }}
-        TEST_NHS_LOGIN_PASSWORD: ${{ secrets.TEST_NHS_LOGIN_PASSWORD }}
-        TEST_NHS_LOGIN_OTP: ${{ secrets.TEST_NHS_LOGIN_OTP }}
-        TEST_NBS_APP_USERNAME: ${{ secrets.TEST_NBS_APP_USERNAME }}
-        TEST_NBS_APP_PASSWORD: ${{ secrets.TEST_NBS_APP_PASSWORD }}
-        TEST_APP_URL: ${{ secrets.TEST_APP_URL }}
-        NHS_APP_REDIRECT_LOGIN_URL: ${{ secrets.NHS_APP_REDIRECT_LOGIN_URL }}
-        VITA_TEST_USER_PATTERN: ${{ secrets.VITA_TEST_USER_PATTERN }}
-        DEPLOY_ENVIRONMENT: "preprod"
-
     - name: "Run contract tests (sandpit+mocked)"
       timeout-minutes: 3
       uses: ./.github/actions/run-contract-tests
@@ -94,6 +81,41 @@ jobs:
         MAX_SESSION_AGE_MINUTES: 0
         AUTH_SECRET: "dummy"
 
+    - name: "Run E2E tests on ${{ steps.get-latest-tag-name.outputs.value }} (preprod)"
+      timeout-minutes: 10
+      uses: ./.github/actions/run-e2e-tests
+      with:
+        checkout_ref: ${{ steps.get-latest-tag-name.outputs.value }}
+        cross_browser: true
+      env:
+        TEST_NHS_APP_URL: ${{ secrets.TEST_NHS_APP_URL }}
+        TEST_NHS_LOGIN_PASSWORD: ${{ secrets.TEST_NHS_LOGIN_PASSWORD }}
+        TEST_NHS_LOGIN_OTP: ${{ secrets.TEST_NHS_LOGIN_OTP }}
+        TEST_NBS_APP_USERNAME: ${{ secrets.TEST_NBS_APP_USERNAME }}
+        TEST_NBS_APP_PASSWORD: ${{ secrets.TEST_NBS_APP_PASSWORD }}
+        TEST_APP_URL: ${{ secrets.TEST_APP_URL }}
+        NHS_APP_REDIRECT_LOGIN_URL: ${{ secrets.NHS_APP_REDIRECT_LOGIN_URL }}
+        VITA_TEST_USER_PATTERN: ${{ secrets.VITA_TEST_USER_PATTERN }}
+        DEPLOY_ENVIRONMENT: "preprod"
+
+    - name: "Run snapshot tests on ${{ steps.get-latest-tag-name.outputs.value }} (preprod)"
+      uses: ./.github/actions/run-snapshot-tests
+      with:
+        checkout_ref: ${{ inputs.checkout_ref }}
+        release_name: "release1"
+      env:
+        SECRET_IAM_ROLE: ${{ secrets.IAM_ROLE }}
+        TEST_NHS_APP_URL: ${{ secrets.TEST_NHS_APP_URL }}
+        TEST_NHS_LOGIN_PASSWORD: ${{ secrets.TEST_NHS_LOGIN_PASSWORD }}
+        TEST_NHS_LOGIN_OTP: ${{ secrets.TEST_NHS_LOGIN_OTP }}
+        TEST_APP_URL: ${{ secrets.TEST_APP_URL }}
+        VITA_TEST_USER_PATTERN: ${{ secrets.VITA_TEST_USER_PATTERN }}
+        AWS_S3_ARTEFACTS_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-artefacts-preprod
+
+  #################################################################
+  # Main branch deployment and assurance (e2e+snapshots+contract)
+  #################################################################
+
   deploy-and-test-main:
     name: "Main Branch Assurance"
     runs-on: "ubuntu-latest"
@@ -125,7 +147,7 @@ jobs:
       - name: "Checkout code"
         uses: actions/checkout@v5
 
-      - name: "Deploy to AWS (preprod)"
+      - name: "Deploy ${{ steps.get-latest-tag-name.outputs.value }} to AWS (preprod)"
         timeout-minutes: 10
         uses: ./.github/actions/deploy
         with:
@@ -135,23 +157,6 @@ jobs:
           secret_aws_iam_role: ${{ secrets.IAM_ROLE }}
           secret_aws_slack_channel_id: ${{ secrets.ALARMS_SLACK_CHANNEL_ID }}
 
-      - name: "Run E2E tests on ${{ steps.get-latest-tag-name.outputs.value }} (preprod)"
-        timeout-minutes: 10
-        uses: ./.github/actions/run-e2e-tests
-        with:
-          checkout_ref: ${{ steps.get-latest-tag-name.outputs.value }}
-          cross_browser: true
-        env:
-          TEST_NHS_APP_URL: ${{ secrets.TEST_NHS_APP_URL }}
-          TEST_NHS_LOGIN_PASSWORD: ${{ secrets.TEST_NHS_LOGIN_PASSWORD }}
-          TEST_NHS_LOGIN_OTP: ${{ secrets.TEST_NHS_LOGIN_OTP }}
-          TEST_NBS_APP_USERNAME: ${{ secrets.TEST_NBS_APP_USERNAME }}
-          TEST_NBS_APP_PASSWORD: ${{ secrets.TEST_NBS_APP_PASSWORD }}
-          TEST_APP_URL: ${{ secrets.TEST_APP_URL }}
-          NHS_APP_REDIRECT_LOGIN_URL: ${{ secrets.NHS_APP_REDIRECT_LOGIN_URL }}
-          VITA_TEST_USER_PATTERN: ${{ secrets.VITA_TEST_USER_PATTERN }}
-          DEPLOY_ENVIRONMENT: "preprod"
-
       - name: "Run contract tests (sandpit+mocked)"
         timeout-minutes: 3
         uses: ./.github/actions/run-contract-tests
@@ -175,3 +180,34 @@ jobs:
           NBS_BOOKING_PATH: "dummy"
           MAX_SESSION_AGE_MINUTES: 0
           AUTH_SECRET: "dummy"
+
+      - name: "Run E2E tests on ${{ steps.get-latest-tag-name.outputs.value }} (preprod)"
+        timeout-minutes: 10
+        uses: ./.github/actions/run-e2e-tests
+        with:
+          checkout_ref: ${{ steps.get-latest-tag-name.outputs.value }}
+          cross_browser: true
+        env:
+          TEST_NHS_APP_URL: ${{ secrets.TEST_NHS_APP_URL }}
+          TEST_NHS_LOGIN_PASSWORD: ${{ secrets.TEST_NHS_LOGIN_PASSWORD }}
+          TEST_NHS_LOGIN_OTP: ${{ secrets.TEST_NHS_LOGIN_OTP }}
+          TEST_NBS_APP_USERNAME: ${{ secrets.TEST_NBS_APP_USERNAME }}
+          TEST_NBS_APP_PASSWORD: ${{ secrets.TEST_NBS_APP_PASSWORD }}
+          TEST_APP_URL: ${{ secrets.TEST_APP_URL }}
+          NHS_APP_REDIRECT_LOGIN_URL: ${{ secrets.NHS_APP_REDIRECT_LOGIN_URL }}
+          VITA_TEST_USER_PATTERN: ${{ secrets.VITA_TEST_USER_PATTERN }}
+          DEPLOY_ENVIRONMENT: "preprod"
+
+      - name: "Run snapshot tests on ${{ steps.get-latest-tag-name.outputs.value }} (preprod)"
+        uses: ./.github/actions/run-snapshot-tests
+        with:
+          checkout_ref: ${{ inputs.checkout_ref }}
+          release_name: "latest-main-tag"
+        env:
+          SECRET_IAM_ROLE: ${{ secrets.IAM_ROLE }}
+          TEST_NHS_APP_URL: ${{ secrets.TEST_NHS_APP_URL }}
+          TEST_NHS_LOGIN_PASSWORD: ${{ secrets.TEST_NHS_LOGIN_PASSWORD }}
+          TEST_NHS_LOGIN_OTP: ${{ secrets.TEST_NHS_LOGIN_OTP }}
+          TEST_APP_URL: ${{ secrets.TEST_APP_URL }}
+          VITA_TEST_USER_PATTERN: ${{ secrets.VITA_TEST_USER_PATTERN }}
+          AWS_S3_ARTEFACTS_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-artefacts-preprod
