CCM-13188: run producer pact tests (#372)

* init

* update examples

* init

* whitespace fix

* fmt fix

* add spec id to PENDING

* rm override

* add typecheck

* add cleanup utils

* add lint

* skip unit tests

* use install helper

* revert run-pact-test

* add NODE_AUTH_TOKEN

* rm PACKAGES_TOKEN

* fast xml parser cve override

* lockfile

Author: alexnuttall

.github/actions/acceptance-tests/action.yml

@@ -37,7 +37,6 @@ runs:
     - name: "Repo setup"
       uses: ./.github/actions/node-install
       with:
-        node-version: ${{ steps.nodejs_version.outputs.nodejs_version }}
         GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }}
 
     - name: "Set PR NUMBER"

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

@@ -2,9 +2,6 @@ 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
@@ -15,7 +12,7 @@ runs:
     - name: 'Use Node.js'
       uses: actions/setup-node@v6
       with:
-        node-version: '${{ inputs.node-version }}'
+        node-version-file: '.tool-versions'
         registry-url: 'https://npm.pkg.github.com'
         scope: '@nhsdigital'
 

.github/workflows/pr_closed.yaml

@@ -80,7 +80,7 @@ jobs:
       - name: Setup NodeJS
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ inputs.nodejs_version }}
+          node-version-file: '.tool-versions'
           registry-url: 'https://npm.pkg.github.com'
 
       - name: check if local version differs from latest published version
@@ -113,19 +113,14 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v5.0.0
-      - name: Setup NodeJS
-        uses: actions/setup-node@v4
+      - name: "Repo setup"
+        uses: ./.github/actions/node-install
         with:
-          node-version: ${{ inputs.nodejs_version }}
-          registry-url: 'https://npm.pkg.github.com'
-      - name: "Install dependencies"
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm ci
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "Run provider contract tests"
         run: make test-contract
         env:
-          GITHUB_PACKAGES_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   publish-event-schemas:
     name: Publish event schemas package to GitHub package registry
@@ -145,7 +140,7 @@ jobs:
       - name: Setup NodeJS
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ inputs.nodejs_version }}
+          node-version-file: '.tool-versions'
           registry-url: 'https://npm.pkg.github.com'
 
       - name: Install dependencies

Makefile

@@ -106,6 +106,9 @@ test-component:
 test-performance:
 	(cd tests && npm install && npm run test:performance)
 
+test-contract: # Run provider contract tests @Testing
+	npm run test:contracts --workspace tests/contracts/provider
+
 version:
 	rm -f .version
 	make version-create-effective-file dir=.

package-lock.json

@@ -51,6 +51,7 @@
   },
   "name": "nhs-notify-supplier-api",
   "overrides": {
+    "fast-xml-parser": "^5.3.4",
     "pretty-format": {
       "react-is": "19.0.0"
     },
@@ -89,6 +90,7 @@
     "lambdas/*",
     "pact-contracts",
     "scripts/utilities/*",
-    "tests"
+    "tests",
+    "tests/contracts/*"
   ]
 }

package.json

@@ -0,0 +1,23 @@
+import { MessageProviderPact } from "@pact-foundation/pact";
+import {
+  LETTER_STATUSES,
+  getMessageProviderForStatus,
+  getPactUrlForStatus,
+} from "./utils/utils";
+
+const CONSUMER_PACKAGE = "@nhsdigital/notify-core-consumer-contracts";
+
+describe("Supplier API letter status provider tests", () => {
+  describe.each(LETTER_STATUSES)("letter.%s event", (status) => {
+    test(`verifies letter-${status.toLowerCase()} pact`, async () => {
+      const p = new MessageProviderPact({
+        provider: `letter-${status.toLowerCase()}`,
+        messageProviders: getMessageProviderForStatus(status),
+        pactUrls: [getPactUrlForStatus(CONSUMER_PACKAGE, status)],
+        logLevel: "error",
+      });
+
+      await expect(p.verify()).resolves.not.toThrow();
+    }, 60_000);
+  });
+});

tests/contracts/provider/__tests__/letter-status.provider.pact.test.ts

@@ -0,0 +1,56 @@
+import path from "node:path";
+import fs from "node:fs";
+
+export const LETTER_STATUSES = [
+  "ACCEPTED",
+  "CANCELLED",
+  "DELIVERED",
+  "DISPATCHED",
+  "ENCLOSED",
+  "FAILED",
+  "FORWARDED",
+  "PENDING",
+  "PRINTED",
+  "REJECTED",
+  "RETURNED",
+] as const;
+
+type LetterStatus = (typeof LETTER_STATUSES)[number];
+
+export function getExampleEvent(status: LetterStatus): unknown {
+  const examplePath = path.join(
+    __dirname,
+    "../../../../../internal/events/schemas/examples",
+    `letter.${status}.json`,
+  );
+
+  const content = fs.readFileSync(examplePath, "utf8");
+  return JSON.parse(content);
+}
+
+export function getMessageProviderForStatus(
+  status: LetterStatus,
+): Record<string, () => Promise<unknown>> {
+  return {
+    [`letter-${status.toLowerCase()}`]: async () => getExampleEvent(status),
+  };
+}
+
+export function getPactUrlForStatus(
+  consumerPackage: string,
+  status: LetterStatus,
+): string {
+  return path.join(
+    __dirname,
+    "../../",
+    ".contracts",
+    consumerPackage,
+    "pacts",
+    "supplier-api",
+    `core-letter-${status.toLowerCase()}.json`,
+  );
+}
+
+export function getAllLetterStatuses(): readonly LetterStatus[] {
+  return LETTER_STATUSES;
+}

tests/contracts/provider/__tests__/utils/utils.ts

@@ -0,0 +1,15 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.tsx?$": "ts-jest",
+  },
+  testMatch: ["**/*.test.ts"],
+  moduleNameMapper: {
+    "@nhsdigital/nhs-notify-event-schemas-supplier-api$":
+      "<rootDir>/../../../internal/events/src",
+  },
+};
+
+export default config;