VIA-245 AS Run snapshot tests after acceptance stage for preprod deployments only

Author: anoop-surej-nhs

.github/workflows/cicd-3-deploy.yaml

@@ -60,7 +60,7 @@ jobs:
     needs: [metadata]
     uses: ./.github/workflows/stage-4-deploy.yaml
     with:
-      environment: ${{ github.event.inputs.environment}}
+      environment: ${{ github.event.inputs.environment }}
       terraform_version: "${{ needs.metadata.outputs.terraform_version }}"
       tag: "${{ needs.metadata.outputs.tag }}"
     secrets: inherit
@@ -71,3 +71,10 @@ jobs:
     with:
       environment: ${{ github.event.inputs.environment}}
     secrets: inherit
+  snapshot-test-stage:
+    name: "Snapshot Test stage"
+    if: ${{ github.event.inputs.environment == 'preprod' }}
+    needs: [metadata, acceptance-stage]
+    uses: ./.github/workflows/stage-7-snapshot-test.yaml
+    with:
+      tag: "${{ needs.metadata.outputs.tag }}"

.github/workflows/cicd-5-snapshot-test.yaml

@@ -4,19 +4,19 @@ on:
   workflow_dispatch:
     inputs:
       tag:
-        description: "Tag"
+        description: "Tag of deployment"
         type: string
         required: true
 
 env:
   AWS_REGION: eu-west-2
-  AWS_S3_ARTEFACTS_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-artefacts-dev
+  AWS_S3_ARTEFACTS_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-artefacts-preprod
 
 jobs:
   snapshot-test:
     name: "Snapshot Test"
     runs-on: ubuntu-latest
-    environment: dev
+    environment: preprod
     timeout-minutes: 30
     permissions:
       id-token: write

.github/workflows/cicd-6-snapshot-update.yaml

@@ -1,22 +1,22 @@
-name: "CI/CD snapshot update"
+name: "CI/CD snapshot update (PreProd)"
 
 on:
   workflow_dispatch:
     inputs:
       tag:
-        description: "Tag"
+        description: "Tag of snapshots to set as reference"
         required: true
         type: string
 
 env:
   AWS_REGION: eu-west-2
-  AWS_S3_ARTEFACTS_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-artefacts-dev
+  AWS_S3_ARTEFACTS_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-artefacts-preprod
 
 jobs:
   upload-snapshots:
     name: "Update Snapshots in S3"
     runs-on: ubuntu-latest
-    environment: dev
+    environment: preprod
     timeout-minutes: 10
     permissions:
       id-token: write

.github/workflows/stage-7-snapshot-test.yaml

@@ -0,0 +1,70 @@
+name: "Snapshot Test stage"
+
+on:
+  workflow_call:
+    inputs:
+      tag:
+        description: "Tag of deployment"
+        required: true
+        type: string
+
+env:
+  AWS_REGION: eu-west-2
+  AWS_S3_ARTEFACTS_BUCKET: vita-${{ secrets.AWS_ACCOUNT_ID }}-artefacts-preprod
+
+jobs:
+  snapshot-test:
+    name: "Snapshot Test"
+    runs-on: ubuntu-latest
+    environment: preprod
+    timeout-minutes: 30
+    permissions:
+      id-token: write
+      contents: read
+    env:
+      TEST_NHS_APP_USERNAME: ${{ secrets.TEST_NHS_APP_USERNAME }}
+      TEST_NHS_APP_PASSWORD: ${{ secrets.TEST_NHS_APP_PASSWORD }}
+      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 }}
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v4
+
+      - name: "Install dependencies"
+        run: |
+          npm ci --ignore-scripts
+
+      - name: "Install Playwright browsers"
+        run: |
+          npx playwright install --with-deps
+
+      - name: "Configure AWS credentials for environment"
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-session-name: GitHubActionsSession
+          role-to-assume: ${{ secrets.IAM_ROLE }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: "Download snapshots from S3 bucket"
+        run: |
+          aws s3 sync s3://${{ env.AWS_S3_ARTEFACTS_BUCKET }}/playwright/reference/ ./e2e/snapshot/
+
+      - name: "Run Playwright snapshot tests (no update)"
+        run: |
+          npm run e2e:snapshot
+
+      - name: "Upload snapshots to S3 bucket with tag ${{ inputs.tag }}"
+        if: failure()
+        run: |
+          aws s3 sync ./e2e/snapshot/snapshot_review/ s3://${{ env.AWS_S3_ARTEFACTS_BUCKET }}/playwright/${{ inputs.tag }}/
+
+      - name: "Upload report"
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30