init

Author: alexnuttall

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

@@ -89,6 +89,7 @@
     "lambdas/*",
     "pact-contracts",
     "scripts/utilities/*",
-    "tests"
+    "tests",
+    "tests/contracts/*"
   ]
 }

package.json

@@ -0,0 +1,7 @@
+# Downloaded contracts and packages
+.contracts/
+.packages/
+
+# Build artifacts
+dist/
+node_modules/

tests/contracts/provider/.gitignore

@@ -0,0 +1,25 @@
+import { MessageProviderPact } from "@pact-foundation/pact";
+import {
+  getAllLetterStatuses,
+  getMessageProviderForStatus,
+  getPactUrlForStatus,
+} from "./utils/utils";
+
+const CONSUMER_PACKAGE = "@nhsdigital/notify-core-consumer-contracts";
+
+describe("Supplier API letter status provider tests", () => {
+  const statuses = getAllLetterStatuses();
+
+  describe.each(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";
+import { globSync } from "glob";
+
+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, "utf-8");
+  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 {
+  const contractsDir = path.join(
+    __dirname,
+    "../../.contracts",
+    consumerPackage,
+    "pacts/supplier-api"
+  );
+
+  return path.join(contractsDir, `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;

tests/contracts/provider/jest.config.ts

@@ -0,0 +1,21 @@
+{
+  "name": "@sap/contracts-provider",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "test:contracts": "./scripts/test.sh"
+  },
+  "dependencies": {
+    "@nhsdigital/nhs-notify-event-schemas-supplier-api": "*",
+    "@pact-foundation/pact": "^16.0.4"
+  },
+  "devDependencies": {
+    "@tsconfig/node22": "^22.0.2",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.0.0",
+    "glob": "^11.0.0",
+    "jest": "^30.0.0",
+    "ts-jest": "^29.4.0",
+    "typescript": "^5.9.3"
+  }
+}

tests/contracts/provider/package.json

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+ROOT_DIR="$(git rev-parse --show-toplevel)"
+SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+TESTS_ROOT="$(dirname "$SCRIPT_DIR")"
+
+cd "$TESTS_ROOT"
+
+rm -rf .packages .contracts
+mkdir -p .packages
+
+# Use local tarball if available (for development), otherwise fetch from npm
+CORE_CONTRACTS_LOCAL="${CORE_CONTRACTS_LOCAL:-}"
+
+if [[ -n "$CORE_CONTRACTS_LOCAL" && -f "$CORE_CONTRACTS_LOCAL" ]]; then
+  echo "Using local core consumer contracts: $CORE_CONTRACTS_LOCAL"
+  PKG_NAME="@nhsdigital/notify-core-consumer-contracts"
+  mkdir -p ".contracts/$PKG_NAME"
+  tar -xvzf "$CORE_CONTRACTS_LOCAL" -C ".contracts/$PKG_NAME" --strip-components=1
+else
+  CONSUMER_PACKAGES=(
+    "@nhsdigital/notify-core-consumer-contracts"
+  )
+
+  for PKG in "${CONSUMER_PACKAGES[@]}"; do
+    mkdir -p ".contracts/$PKG"
+    TGZ_NAME=$(npm pack "$PKG" --pack-destination .packages)
+    tar -xvzf ".packages/$TGZ_NAME" -C ".contracts/$PKG" --strip-components=1
+  done
+fi
+
+npx jest --runInBand

tests/contracts/provider/scripts/test.sh

@@ -0,0 +1,12 @@
+{
+  "extends": "@tsconfig/node22/tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./",
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "isolatedModules": true
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}