New: [AEA-4750] - CI for CPTS UI Automated Tests (#207)

## Summary

- 🤖 Operational or Infrastructure Change

### Details

Everything should be added to allow the CI to automatically execute the
E2E regression tests during deployment

Author: seansteberisal

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+max-line-length=120
+exclude = .*,venv,node_modules
+max-complexity = 10

.github/workflows/ci.yml

@@ -123,6 +123,7 @@ jobs:
       mockOidcClientId: ${{ secrets.PTL_MOCK_CLIENT_ID }}
       mockOidClientSecret: ${{ secrets.PTL_MOCK_CLIENT_SECRET }}
       CIS2_PRIVATE_KEY: ${{ secrets.PTL_CIS2_PRIVATE_KEY }}
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
 
   create_release_notes:
     needs: [tag_release, package_code, get_commit_id, release_dev]
@@ -169,4 +170,5 @@ jobs:
       mockOidcClientId: ${{ secrets.PTL_MOCK_CLIENT_ID }}
       mockOidClientSecret: ${{ secrets.PTL_MOCK_CLIENT_SECRET }}
       CIS2_PRIVATE_KEY: ${{ secrets.PTL_CIS2_PRIVATE_KEY }}
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
 

.github/workflows/pull_request.yml

@@ -88,3 +88,4 @@ jobs:
       mockOidcClientId: ${{ secrets.PTL_MOCK_CLIENT_ID }}
       mockOidClientSecret: ${{ secrets.PTL_MOCK_CLIENT_SECRET }}
       CIS2_PRIVATE_KEY: ${{ secrets.PTL_CIS2_PRIVATE_KEY }}
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}

.github/workflows/release.yml

@@ -142,6 +142,7 @@ jobs:
       mockOidcClientId: ${{ secrets.PTL_MOCK_CLIENT_ID }}
       mockOidClientSecret: ${{ secrets.PTL_MOCK_CLIENT_SECRET }}
       CIS2_PRIVATE_KEY: ${{ secrets.PTL_CIS2_PRIVATE_KEY }}
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
 
   create_release_notes:
     needs: [tag_release, package_code, get_commit_id, release_dev]
@@ -187,6 +188,7 @@ jobs:
       mockOidcClientId: ${{ secrets.PTL_MOCK_CLIENT_ID }}
       mockOidClientSecret: ${{ secrets.PTL_MOCK_CLIENT_SECRET }}
       CIS2_PRIVATE_KEY: ${{ secrets.PTL_CIS2_PRIVATE_KEY }}
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
 
   release_qa:
     needs: [tag_release, package_code, get_commit_id, release_dev]
@@ -217,6 +219,7 @@ jobs:
       mockOidcClientId: ${{ secrets.PTL_MOCK_CLIENT_ID }}
       mockOidClientSecret: ${{ secrets.PTL_MOCK_CLIENT_SECRET }}
       CIS2_PRIVATE_KEY: ${{ secrets.PTL_CIS2_PRIVATE_KEY }}
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
 
   release_int:
     needs: [tag_release, package_code, get_commit_id, release_qa]
@@ -247,6 +250,7 @@ jobs:
       mockOidcClientId: ${{ secrets.PTL_MOCK_CLIENT_ID }}
       mockOidClientSecret: ${{ secrets.PTL_MOCK_CLIENT_SECRET }}
       CIS2_PRIVATE_KEY: ${{ secrets.PTL_CIS2_PRIVATE_KEY }}
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}
 
   # release_prod:
   #   needs: [tag_release, package_code, get_commit_id, release_int]

.github/workflows/release_all_stacks.yml

@@ -42,6 +42,9 @@ on:
         type: boolean
       useCustomCognitoDomain:
         type: boolean
+      REGRESSION_TESTS_PEM:
+        type: string
+        default: false
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE:
         required: true
@@ -57,7 +60,8 @@ on:
         required: false
       CIS2_PRIVATE_KEY:
         required: true
-
+      REGRESSION_TESTS_PEM:
+        required: true
 
 jobs:
   check_first_deployment:
@@ -288,3 +292,14 @@ jobs:
           git add _data/${{ inputs.TARGET_ENVIRONMENT }}_deployments.csv
           git commit -m 'update releases for ${{ inputs.TARGET_ENVIRONMENT }}'
           parallel --retries 10 --delay 3 ::: "git pull --rebase && git push"
+
+  regression_tests:
+    name: Regression Tests
+    uses: ./.github/workflows/run_regression_tests.yml
+    if: ${{ always() && !failure() && !cancelled() }}
+    needs: [release_stateful_resources, release_stateless_resources, rerelease_stateful_resources, deploy_website_content, update_cloudfront_kvs]
+    with:
+      ENVIRONMENT: ${{ inputs.TARGET_ENVIRONMENT }}
+      VERSION_NUMBER: ${{ inputs.VERSION_NUMBER }}
+    secrets:
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}

.github/workflows/run_regression_tests.yml

@@ -0,0 +1,76 @@
+name: Run Regression Tests
+
+on:
+  workflow_call:
+    inputs:
+      ENVIRONMENT:
+        required: true
+        type: string
+      VERSION_NUMBER:
+        required: true
+        type: string
+      REGRESSION_TESTS_PEM:
+        type: string
+        default: false
+    secrets:
+      REGRESSION_TESTS_PEM:
+        required: true
+
+jobs:
+  run_regression_tests:
+    runs-on: ubuntu-latest
+    environment: ${{ inputs.ENVIRONMENT }}
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - name: Checkout local github actions
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ env.BRANCH_NAME }}
+          fetch-depth: 0
+
+      - name: Generate a token to authenticate regression testing
+        id: generate-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.REGRESSION_TESTS_APP_ID }}
+          private-key: ${{ secrets.REGRESSION_TESTS_PEM }}
+          owner: "NHSDigital"
+          repositories: "electronic-prescription-service-api-regression-tests"
+
+      # using git commit sha for version of action to ensure we have stable version
+      - name: Install asdf
+        uses: asdf-vm/actions/setup@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
+        with:
+          asdf_branch: v0.11.3
+
+      - name: Cache asdf
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.asdf
+          key: ${{ runner.os }}-asdf-${{ hashFiles('**/.tool-versions') }}
+          restore-keys: |
+            ${{ runner.os }}-asdf-
+
+      - name: Install asdf dependencies in .tool-versions
+        uses: asdf-vm/actions/install@05e0d2ed97b598bfce82fd30daf324ae0c4570e6
+        with:
+          asdf_branch: v0.11.3
+        env:
+          PYTHON_CONFIGURE_OPTS: --enable-shared
+
+      - name: Run Regression Testing
+        working-directory: scripts
+        env:
+          TARGET_ENVIRONMENT: ${{ inputs.ENVIRONMENT }}
+          VERSION_NUMBER: ${{ inputs.VERSION_NUMBER }}
+          GITHUB-TOKEN: ${{ steps.generate-token.outputs.token }}
+        run: |
+              if [[ "$TARGET_ENVIRONMENT" != "prod" && "$TARGET_ENVIRONMENT" != "ref" ]]; then
+                poetry install
+                echo Running regression tests in the "$TARGET_ENVIRONMENT" environment
+                poetry run python run_regression_tests.py --env="$TARGET_ENVIRONMENT" --pr_label="$VERSION_NUMBER" --token=${{ steps.generate-token.outputs.token }}
+              fi