adding supplier contract

Signed-off-by: Tim Ireland <[email protected]>

Author: timireland

.gitignore

@@ -22,6 +22,8 @@ node_modules
 /.pnp
 .pnp.js
 
+/pact
+
 # testing
 /coverage
 

lambdas/backend-api/package.json

@@ -6,13 +6,18 @@
     "test:unit": "jest",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "pact:publish": "",
+    "pact:publish1": "../../pact/bin/pactflow publish-provider-contract ../../infrastructure/terraform/modules/backend-api/spec.tmpl.json --provider=TemplateService  --provider-app-version=1.0.0 --broker-base-url=https://nhs-england-notify.pactflow.io --content-type application/yaml --branch $(git rev-parse --abbrev-ref HEAD)",
+    "generate-dependencies": "npx openapi-typescript-codegen --exportCore false --exportServices false --input ../../infrastructure/terraform/modules/backend-api/spec.tmpl.json --output ./src/types/generated"
   },
   "dependencies": {
     "@aws-sdk/client-cognito-identity-provider": "^3.699.0",
     "@aws-sdk/client-dynamodb": "^3.696.0",
     "@aws-sdk/client-ses": "^3.699.0",
     "@aws-sdk/lib-dynamodb": "^3.698.0",
+    "@pact-foundation/pact": "13.1.4",
+    "@pact-foundation/pact-cli": "16.0.1",
     "handlebars": "^4.7.8",
     "html-entities": "^2.5.2",
     "jsonwebtoken": "^9.0.2",

lambdas/backend-api/src/__tests__/templates/api/api.pact.test.ts

@@ -0,0 +1,26 @@
+import { Verifier } from '@pact-foundation/pact';
+
+describe('Pact Verification', () => {
+  it('should validate the expectations of the consumer', async () => {
+    const opts = {
+      provider: 'TemplateService',
+      consumerVersionSelectors: [
+        {
+          latest: true,
+        },
+      ],
+      providerBaseUrl: 'http://localhost:8080',
+      pactBrokerUrl: process.env.PACT_BROKER_URL || 'http://127.0.0.1:8000',
+      pactBrokerUsername: process.env.PACT_BROKER_USERNAME || 'pact_workshop',
+      pactBrokerPassword: process.env.PACT_BROKER_PASSWORD || 'pact_workshop',
+      publishVerificationResult: true,
+      providerVersion: '1.0.0',
+    };
+
+    const verifier = new Verifier(opts);
+
+    await verifier.verifyProvider();
+
+    throw error;
+  });
+});

lambdas/backend-client/package.json

@@ -9,6 +9,7 @@
     "lint:fix": "eslint . --fix",
     "test:unit": "jest",
     "typecheck": "tsc --noEmit",
+    "pact:publish": "pact-broker publish ./pacts --consumer-app-version=\"1.0.1\" --auto-detect-version-properties --broker-base-url=https://nhs-england-notify.pactflow.io",
     "generate-dependencies": "npx openapi-typescript-codegen --exportCore false --exportServices false --input ../../infrastructure/terraform/modules/backend-api/spec.tmpl.json --output ./src/types/generated"
   },
   "files": [
@@ -24,6 +25,8 @@
     "@swc/core": "^1.10.1",
     "@swc/jest": "^0.2.37",
     "@tsconfig/node20": "^20.1.4",
+    "@pact-foundation/pact": "13.1.4",
+    "@pact-foundation/pact-cli": "16.0.1",
     "axios-mock-adapter": "^2.1.0",
     "esbuild": "^0.24.0",
     "jest-mock-extended": "^4.0.0-beta1",

lambdas/backend-client/pacts/README.MD

@@ -0,0 +1,17 @@
+# Contracts
+This folder comntains the consumer cretaed contracts (pacts) these are created from lambdas/backend-client/src/__tests__/api.pact.spec.ts
+
+
+
+# Verifier
+
+This runs against the api /lambdas/backend-api/src/__tests__/templates/api/api.pact.test.ts.
+
+
+# Bi-directional contract testing
+
+This verifies that the consumer tests are comptibale with the provider OAS spec  infrastructure/terraform/modules/backend-api/spec.tmpl.json
+
+This bi-directional contract testing is only available as SAAS see https://pactflow.io/oss/
+
+See https://docs.pactflow.io/docs/bi-directional-contract-testing

lambdas/backend-client/pacts/TemplateClient-TemplateService.json

@@ -7,6 +7,14 @@
       "description": "get all templates",
       "providerState": "templates exist",
       "request": {
+        "headers": {
+          "Authorization": "Bearer 2019-01-14T11:34:18.045Z"
+        },
+        "matchingRules": {
+          "$.header.Authorization": {
+            "match": "type"
+          }
+        },
         "method": "GET",
         "path": "/v1/templates"
       },
@@ -37,6 +45,14 @@
       "description": "get template with ID 10",
       "providerState": "template  with ID 10 exists",
       "request": {
+        "headers": {
+          "Authorization": "Bearer 2019-01-14T11:34:18.045Z"
+        },
+        "matchingRules": {
+          "$.header.Authorization": {
+            "match": "type"
+          }
+        },
         "method": "GET",
         "path": "/v1/template/10"
       },
@@ -64,7 +80,7 @@
   ],
   "metadata": {
     "pact-js": {
-      "version": "13.2.0"
+      "version": "13.1.4"
     },
     "pactRust": {
       "ffi": "0.4.22",
@@ -77,4 +93,4 @@
   "provider": {
     "name": "TemplateService"
   }
-}
+}

lambdas/backend-client/src/__tests__/api.pact.spec.ts

@@ -5,6 +5,7 @@ import {
   MatchersV3,
   SpecificationVersion,
 } from '@pact-foundation/pact';
+
 import { TemplateClient } from 'nhs-notify-backend-client/src/template-api-client';
 import { TemplateStatus, TemplateType } from 'nhs-notify-backend-client';
 
@@ -33,7 +34,11 @@ describe('API Pact test', () => {
         withRequest: {
           method: 'GET',
           path: '/v1/templates',
+          headers: {
+            Authorization: like('Bearer 2019-01-14T11:34:18.045Z'),
+          },
         },
+
         willRespondWith: {
           status: 200,
           headers: {
@@ -78,6 +83,9 @@ describe('API Pact test', () => {
         withRequest: {
           method: 'GET',
           path: '/v1/template/10',
+          headers: {
+            Authorization: like('Bearer 2019-01-14T11:34:18.045Z'),
+          },
         },
         willRespondWith: {
           status: 200,