Add Run Regression Tests workflow

Author: kris-szlapa

.github/workflows/cdk_release_code.yml

@@ -27,6 +27,9 @@ on:
       LOG_LEVEL:
         required: true
         type: string
+      RUN_REGRESSION_TESTS:
+        type: boolean
+        default: true
       MARK_JIRA_RELEASED:
         type: boolean
         default: false
@@ -176,3 +179,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() && inputs.RUN_REGRESSION_TESTS == true }}
+    needs: [release_code]
+    with:
+      ENVIRONMENT: ${{ inputs.TARGET_ENVIRONMENT }}
+      VERSION_NUMBER: ${{ inputs.VERSION_NUMBER }}
+    secrets:
+      REGRESSION_TESTS_PEM: ${{ secrets.REGRESSION_TESTS_PEM }}

.github/workflows/pull_request.yml

@@ -72,6 +72,7 @@ jobs:
       DEPLOY_CODE: true
       LOG_RETENTION_IN_DAYS: 30
       LOG_LEVEL: DEBUG
+      RUN_REGRESSION_TESTS: true
     secrets:
       CLOUD_FORMATION_DEPLOY_ROLE: ${{ secrets.DEV_CLOUD_FORMATION_DEPLOY_ROLE }}
       CDK_PULL_IMAGE_ROLE: ${{ secrets.DEV_CDK_PULL_IMAGE_ROLE }}

.github/workflows/run_regression_tests.yml

@@ -0,0 +1,90 @@
+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-22.04
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - name: Checkout local github actions
+        uses: actions/checkout@v5
+        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@v2
+        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@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        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@1902764435ca0dd2f3388eea723a4f92a4eb8302
+        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
+                # this should be the tag of the tests you want to run
+                REGRESSION_TEST_REPO_TAG=v3.4.0
+
+                # this should be the tag of the regression test workflow you want to run
+                # This will normally be the same as REGRESSION_TEST_REPO_TAG
+                REGRESSION_TEST_WORKFLOW_TAG=v3.4.0
+
+                curl https://raw.githubusercontent.com/NHSDigital/electronic-prescription-service-api-regression-tests/refs/tags/${REGRESSION_TEST_WORKFLOW_TAG}/scripts/run_regression_tests.py -o run_regression_tests.py
+                poetry install
+                echo Running regression tests in the "$TARGET_ENVIRONMENT" environment
+                poetry run python -u run_regression_tests.py \
+                --env="$TARGET_ENVIRONMENT" \
+                --pr_label="$VERSION_NUMBER" \
+                --token=${{ steps.generate-token.outputs.token }} \
+                --is_called_from_github=true \
+                --product=EPS-ASSIST-ME \
+                --regression_test_repo_tag "${REGRESSION_TEST_REPO_TAG}" \
+                --regression_test_workflow_tag "${REGRESSION_TEST_WORKFLOW_TAG}"
+              fi