CCM-10483: add to CI

Author: harrim91

.github/workflows/stage-2-test.yaml

@@ -153,3 +153,60 @@ jobs:
           sonar_organisation_key: "${{ vars.SONAR_ORGANISATION_KEY }}"
           sonar_project_key: "${{ vars.SONAR_PROJECT_KEY }}"
           sonar_token: "${{ secrets.SONAR_TOKEN }}"
+
+
+  consumer-contracts:
+    name: Consumer Contract Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/${{ secrets.AWS_ASSUME_ROLE_NAME }}
+          role-session-name: templates-ci-contract-tests
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Run consumer contract tests
+        run: npm run test:contracts:consumers
+
+      - name: Upload consumer Pact files
+        run: |
+          export PACT_BUCKET="nhs-notify-${{ secrets.AWS_ACCOUNT_ID }}-${{ env.AWS_REGION }}-main-acct-artefacts"
+          npm run test:contracts:upload:consumer
+
+      - name: Upload Pact contracts as artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: consumer-pacts
+          path: tests/contracts/tests/*/consumer/pacts/*.json
+          if-no-files-found: warn
+
+
+  provider-contracts:
+    name: Provider Contract Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/${{ secrets.AWS_ASSUME_ROLE_NAME }}
+          role-session-name: templates-ci-contract-tests
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Download consumer generated Pact files and run provider contract tests
+        env:
+        run: |
+          export PACT_BUCKET="nhs-notify-${{ secrets.AWS_ACCOUNT_ID }}-${{ env.AWS_REGION }}-main-acct-artefacts"
+          npm run test:contracts:provider:ci

package.json

@@ -43,9 +43,10 @@
     "start": "npm run start --workspace frontend",
     "test:contracts:clean": "npm --workspace=tests/contracts run pact:clean",
     "test:contracts:consumers": "npm --workspace=tests/contracts run test:consumers",
-    "test:contracts:download": "npm --workspace=tests/contracts run pact:download",
+    "test:contracts:download:consumer": "npm --workspace=tests/contracts run pact:download:consumer",
     "test:contracts:provider": "npm --workspace=tests/contracts run test:provider",
-    "test:contracts:upload": "npm --workspace=tests/contracts run pact:upload",
+    "test:contracts:provider:ci": "npm --workspace=tests/contracts run test:provider:ci",
+    "test:contracts:upload:consumer": "npm --workspace=tests/contracts run pact:upload:consumer",
     "test:unit": "npm run test:unit --workspaces",
     "typecheck": "npm run typecheck --workspaces"
   },

tests/contracts/package.json

@@ -11,10 +11,11 @@
   "private": true,
   "scripts": {
     "pact:clean": "./scripts/clean.sh",
-    "pact:download:consumer": "./scripts/download-pacts.sh",
-    "pact:upload:consumer": "./scripts/upload-pacts.sh",
+    "pact:download:consumer": "./scripts/download-consumer-pacts.sh",
+    "pact:upload:consumer": "./scripts/upload-consumer-pacts.sh",
     "test:consumers": "jest consumer.pact.test.ts",
-    "test:provider": "jest provider.pact.test.ts"
+    "test:provider": "jest provider.pact.test.ts",
+    "test:provider:ci": "./scripts/ci-verify-provider.sh"
   },
   "version": "1.0.0"
 }

tests/contracts/scripts/ci-verify-provider.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+set -euo pipefail
+
+script_path="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
+
+source "${script_path}/lib/download-consumer-pacts.sh"
+
+contract_tests_root_dir=$(realpath "${script_path}/..")
+
+SUMMARY_FILE="${GITHUB_STEP_SUMMARY:-"$HOME/Desktop/summary.md"}"
+# SUMMARY_FILE="${GITHUB_STEP_SUMMARY:-/dev/null}"
+
+provider="templates"
+
+echo "Downloading Pact files for provider: ${provider}"
+
+count=$(download_consumer_pacts $provider)
+
+echo "Downloaded ${count} Pact files for provider: ${provider}"
+
+if [[ "$count" -gt 0 ]]; then
+  echo "Pact contracts found — running provider contract tests..."
+
+  echo "### 🟢 Pact contracts found for provider \`$provider\`" >> "$SUMMARY_FILE"
+
+  if npm run test:contracts:provider; then
+    echo "### 🟢 Provider contract tests: **PASSED**" >> "$SUMMARY_FILE"
+  else
+    echo "### 🔴 Provider contract tests: **FAILED**" >> "$SUMMARY_FILE"
+    exit 1
+  fi
+else
+  echo "### 🟡 No contracts found for \`$provider\` — skipping provider contract tests" >> "$SUMMARY_FILE"
+  echo "### 🟡 Provider contract tests: **SKIPPED**" >> "$SUMMARY_FILE"
+fi

tests/contracts/scripts/download-consumer-pacts.sh

@@ -1,22 +1,15 @@
 #!/bin/bash
 set -euo pipefail
 
-# Downloads all consumer-generated Pact contract files for a provider, for use in producer-side tests
-
 script_path="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
 
-provider="templates"
-
-provider_dir=$(realpath "${script_path}/../tests/${provider}")
+source "${script_path}/lib/download-consumer-pacts.sh"
 
-target_dir="${provider_dir}/provider/pacts"
-
-echo "Downloading Pact files for provider: $provider"
+# Downloads all consumer-generated Pact contract files for a provider, for use in producer-side tests
+provider="templates"
 
-mkdir -p "$target_dir"
+echo "Downloading Pact files for provider: ${provider}"
 
-aws s3 sync "s3://$PACT_BUCKET/pacts/$provider/" "$target_dir/" \
-  --exclude "*" \
-  --include "*.json"
+count=$(download_consumer_pacts $provider)
 
-echo "Pact files downloaded to $target_dir"
+echo "Downloaded ${count} Pact files for provider: ${provider}"

tests/contracts/scripts/lib/download-consumer-pacts.sh

@@ -0,0 +1,16 @@
+function download_consumer_pacts {
+  local provider=$1
+
+  script_path="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
+  contract_tests_root_dir=$(realpath "${script_path}/../..")
+  target_dir="${contract_tests_root_dir}/tests/${provider}/provider/pacts"
+
+  rm -rf $target_dir
+  mkdir -p "$target_dir"
+
+  aws s3 sync "s3://$PACT_BUCKET/pacts/$provider/" "$target_dir/" \
+    --exclude "*" \
+    --include "*.json" 1>/dev/null
+
+  find "$target_dir" -maxdepth 1 -name '*.json' -type f | wc -l | xargs
+}