CCM-13038: LetterRequestPrepared PACT tests (#296)

* CCM-13038: initial

* CCM-13038: implement parsing on PACT consumer test

* suppress leak warning for test data

* CCM-13038: generate correct consumer pacts

* CCM-13038: set GITHUB token when reading packages

* CCM-13038: use node action

* CCM-13038: use node action

* CCM-13038: test publish contracts on package contract change

* CCM-13038: set _authToken on gpr repo on CI

* CCM-13038: pass GITHUB token to action

* CCM-13038: ignore EOF lines for contracts

* CCM-13038: use branch version of internal repo

* CCM-13038: use script in pre.sh

* CCM-13038: revert back to main

* CCM-13038: redeploy

* CCM-13038: update source

* CCM-13038: loosen restrictions on dataschema minor and patch

* CCM-13038: remove setup-github-token.sh from install action and use passed in node_version

* CCM-13038: use NODE_AUTH_TOKEN for pact-test job

---------

Co-authored-by: Mark Slowey <[email protected]>

Author: bhansell1

.editorconfig

@@ -70,3 +70,6 @@ generated_code = true
 
 [/internal/events/**/*.schema.json]
 insert_final_newline = unset
+
+[/pact-contracts/pacts/**/*.json]
+insert_final_newline = unset

.github/actions/node-install/action.yaml

@@ -0,0 +1,27 @@
+name: 'npm install and setup'
+description: 'Setup node, authenticate github package repository and perform clean npm install'
+
+inputs:
+  node-version:
+    description: 'Node.js version'
+    required: true
+  GITHUB_TOKEN:
+    description: "Token for access to github package registry"
+    required: true
+
+runs:
+  using: 'composite'
+  steps:
+    - name: 'Use Node.js'
+      uses: actions/setup-node@v6
+      with:
+        node-version: '${{ inputs.node-version }}'
+        registry-url: 'https://npm.pkg.github.com'
+        scope: '@nhsdigital'
+
+    - name: 'Install dependencies'
+      shell: bash
+      env:
+        NODE_AUTH_TOKEN: ${{ inputs.GITHUB_TOKEN }}
+      run: |
+        npm ci

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

@@ -58,10 +58,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-${{ inputs.nodejs_version }}-
       - name: "Repo setup"
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm ci
+        uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Generate dependencies"
         run: |
           npm run generate-dependencies --workspaces --if-present
@@ -82,10 +82,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-${{ inputs.nodejs_version }}-
       - name: "Repo setup"
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm ci
+        uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Generate dependencies"
         run: |
           npm run generate-dependencies --workspaces --if-present
@@ -104,6 +104,37 @@ jobs:
         with:
           name: code-coverage-report
           path: ".reports/lcov.info"
+  test-pact:
+    name: "Pact tests"
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    env:
+      NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v5
+      - name: "Cache node_modules"
+        uses: actions/cache@v4
+        with:
+          path: |
+            **/node_modules
+          key: ${{ runner.os }}-node-${{ inputs.nodejs_version }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-${{ inputs.nodejs_version }}-
+      - name: "Repo setup"
+        uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: "Generate dependencies"
+        run: npm run generate-dependencies --workspaces --if-present
+      - name: "Run PACT tests"
+        run: npm run test:pact --workspace tests
+      - name: Publish Pact Contracts
+        run: ./scripts/publish-pact-contracts.sh
   test-lint:
     name: "Linting"
     runs-on: ubuntu-latest
@@ -120,10 +151,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-${{ inputs.nodejs_version }}-
       - name: "Repo setup"
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm ci
+        uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Generate dependencies"
         run: |
           npm run generate-dependencies --workspaces --if-present
@@ -146,10 +177,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-node-${{ inputs.nodejs_version }}-
       - name: "Repo setup"
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: |
-          npm ci
+        uses: ./.github/actions/node-install
+        with:
+          node-version: ${{ inputs.nodejs_version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Generate dependencies"
         run: |
           npm run generate-dependencies --workspaces --if-present

.gitignore

@@ -32,3 +32,6 @@ dist
 /specification/api/components/security/security.yml
 /specification/api/components/parameters/authorization/authorization.yml
 /scripts/JWT/*.pem
+
+# ignore PACTS
+.pacts

infrastructure/terraform/components/api/pre.sh

@@ -2,6 +2,16 @@
 # # It ensures all Node.js dependencies are installed, generates any required dependencies,
 # # and builds all Lambda functions in the workspace before Terraform provisions infrastructure.
 
+echo "Running Pre.sh"
+
+ROOT_DIR="$(git rev-parse --show-toplevel)"
+
+echo "Running set-github-token.sh"
+
+$ROOT_DIR/scripts/set-github-token.sh
+
+echo "Completed."
+
 npm ci
 
 npm run generate-dependencies --workspaces --if-present