Merge pull request #214 from pact-foundation/pact-js-v3+master_merge

Pact js v3+master merge

Author: YOU54F

.github/workflows/build-and-test.yml

@@ -10,12 +10,13 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
+      fail-fast: false
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - run: scripts/ci/build-and-test.sh
@@ -32,14 +33,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
+      fail-fast: false
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set MSVS version
-        run: npm config set msvs_version 2017
+      # - name: Set MSVS version
+      #   run: npm config set msvs_version 2017
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
       - run: scripts/ci/build-and-test.sh
@@ -56,14 +58,20 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x]
+      fail-fast: false
 
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
+      - name: Fix node-gyp
+        run: |-
+          npm install --global node-gyp@latest
+          npm prefix -g | % {npm config set node_gyp "$_\node_modules\node-gyp\bin\node-gyp.js"}
+        shell: pwsh
       - run: bash scripts/ci/build-and-test.sh
         shell: bash
         env:

README.md

@@ -27,20 +27,15 @@
 ## Adapter Installation
 
 ```
-# For pact @ 9.x
 npm install --save-dev jest-pact
 yarn add jest-pact --dev
-
-# For pact @ 10.0.0-beta.x
-npm install --save-dev jest-pact@beta
-yarn add jest-pact@beta --dev
 ```
 
 If you have more than one file with pact tests for the same consumer/provider
 pair, you will also need to add `--runInBand` to your `jest` or `react-scripts test` command in your package.json. This avoids race conditions with the mock
 server writing to the pact file.
 
-## Usage
+## Usage - Pact-JS V2
 
 Say that your API layer looks something like this:
 
@@ -113,9 +108,49 @@ pactWith({ consumer: 'MyConsumer', provider: 'MyProvider' }, provider => {
   });
 ```
 
-## V3 Pact spec with 10.0.0-beta.x
+## Usage - Pact-JS V3
+
+We also include a wrapper for Pact-JS V3.
+
+**Note: The API is NOT finalised. Feedback welcome**
+
+If you have thoughts or feedback about the DSL, please let us know via slack or open issue.
+
+Currently, only a default for the pact directory is provided by the jest-pact wrapper `jest-pact/v3`.
+
+```js
+import { pactWith } from 'jest-pact/v3';
+import { MatchersV3 } from '@pact-foundation/pact';
+import api from 'yourCode';
+
+pactWith({ consumer: 'MyConsumer', provider: 'MyProvider' }, (interaction) => {
+  interaction('A request for API health', ({ provider, execute }) => {
+    beforeEach(() =>
+      provider
+        .given('Server is healthy')
+        .uponReceiving('A request for API health')
+        .withRequest({
+          method: 'GET',
+          path: '/health',
+        })
+        .willRespondWith({
+          status: 200,
+          body: {
+            status: MatchersV3.like('up'),
+          },
+        })
+    );
 
-See [the usage instructions here](https://github.com/pact-foundation/jest-pact/blob/pact-js-v3/README.md)
+    execute('some api call', (mockserver) =>
+      api(mockserver.url)
+        .health()
+        .then((health) => {
+          expect(health).toEqual('up');
+        })
+    );
+  });
+});
+```
 
 # Best practices
 

RELEASING.md

@@ -85,4 +85,4 @@ git push origin master --follow-tags
 
 Depending on the nature of the new commits to master after the release, you
 may need to rebase them on top of the tagged release commit and force push (only do this
-if the released version would be different to the version tagged by `npm run release`)
+if the released version would be different to the version tagged by `npm run release`)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-pact",
-  "version": "0.9.4",
+  "version": "0.10.0",
   "description": "a pact adaptor for jest",
   "main": "dist/index.js",
   "scripts": {
@@ -39,7 +39,7 @@
   "devDependencies": {
     "@commitlint/cli": "^10.0.0",
     "@commitlint/config-conventional": "^10.0.0",
-    "@pact-foundation/pact": "9.17.3",
+    "@pact-foundation/pact": "^10.0.2",
     "@pact-foundation/pact-js-prettier-config": "^1.0.0",
     "@types/jest": "^27.1.3",
     "@types/supertest": "2.0.8",
@@ -60,7 +60,7 @@
     "typescript": "4.6.4"
   },
   "peerDependencies": {
-    "@pact-foundation/pact": "^9.12.2",
+    "@pact-foundation/pact": "^v10.0.0-beta.61 || ^10.0.2",
     "jest": "^24.0.0 || ^25.0.0 || ^26.0.0 || ^27.0.0 || ^28.0.0"
   },
   "lint-staged": {

src/test/fpactwith.test.ts

@@ -1,11 +1,18 @@
 import { Pact } from '@pact-foundation/pact';
 import { fpactWith } from '../index';
+import { getClient, postValidRequest } from './pactwith.test';
 
 describe('fpactwith', () => {
   fpactWith(
     { consumer: 'MyConsumer', provider: 'NoProvider' },
     (provider: Pact) => {
-      it('should only run this test', () => {});
+      beforeEach(() => provider.addInteraction(postValidRequest));
+
+      it('should only run this test', () =>
+        getClient(provider)
+          .get('/v2/pet/1845563262948980200')
+          .set('api_key', '[]')
+          .expect(200));
     }
   );
 

src/test/messagePactWith.test.ts

@@ -3,6 +3,7 @@ import {
   MessageConsumerPact,
   synchronousBodyHandler,
 } from '@pact-foundation/pact';
+import { AnyJson } from '@pact-foundation/pact/src/common/jsonTypes';
 import { messagePactWith } from '../index';
 
 interface Dog {
@@ -35,7 +36,11 @@ const arbitraryPact = (provider: MessageConsumerPact) => {
         .withMetadata({
           'content-type': 'application/json',
         })
-        .verify(synchronousBodyHandler(dogApiHandler));
+        .verify(
+          synchronousBodyHandler(
+            (dogApiHandler as unknown) as (body: AnyJson | Buffer) => void
+          )
+        );
     });
   });
 };

src/test/pactwith.only.test.ts

@@ -1,11 +1,17 @@
 import { Pact } from '@pact-foundation/pact';
 import { pactWith } from '../index';
+import { getClient, postValidRequest } from './pactwith.test';
 
 describe('pactwith.only', () => {
   pactWith.only(
     { consumer: 'MyConsumer', provider: 'NoProvider' },
     (provider: Pact) => {
-      it('should only run this test', () => {});
+      beforeEach(() => provider.addInteraction(postValidRequest));
+      it('should only run this test', () =>
+        getClient(provider)
+          .get('/v2/pet/1845563262948980200')
+          .set('api_key', '[]')
+          .expect(200));
     }
   );
 

src/test/pactwith.test.ts

@@ -2,10 +2,11 @@ import { InteractionObject, Pact } from '@pact-foundation/pact';
 import * as supertest from 'supertest';
 import { getProviderBaseUrl, pactWith } from '../index';
 
-const getClient = (provider: Pact) => supertest(provider.mockService.baseUrl);
+export const getClient = (provider: Pact) =>
+  supertest(provider.mockService.baseUrl);
 const pactPort: number = 5001;
 
-const postValidRequest: InteractionObject = {
+export const postValidRequest: InteractionObject = {
   state: 'A pet 1845563262948980200 exists',
   uponReceiving: 'A get request to get a pet 1845563262948980200',
   willRespondWith: {
@@ -32,15 +33,25 @@ pactWith(
     });
 
     describe('provider object', () => {
+      beforeEach(() => provider.addInteraction(postValidRequest));
+
       test('should show the specified port in the URL', () => {
         expect(provider.mockService.baseUrl).toMatch(
           new RegExp(`${pactPort}$`)
         );
+        return getClient(provider)
+          .get('/v2/pet/1845563262948980200')
+          .set('api_key', '[]')
+          .expect(200);
       });
       test('should return the port on getProviderBaseUrl', () => {
         expect(getProviderBaseUrl(provider)).toEqual(
           `http://127.0.0.1:${pactPort}`
         );
+        return getClient(provider)
+          .get('/v2/pet/1845563262948980200')
+          .set('api_key', '[]')
+          .expect(200);
       });
     });
   }
@@ -60,14 +71,24 @@ pactWith(
     });
 
     describe('provider object', () => {
+      beforeEach(() => provider.addInteraction(postValidRequest));
+
       test('should show the randomly assigned port in the URL', () => {
         expect(provider.mockService.baseUrl).toMatch(new RegExp(`\\d{4,5}$`));
+        return getClient(provider)
+          .get('/v2/pet/1845563262948980200')
+          .set('api_key', '[]')
+          .expect(200);
       });
 
       test('should return the host on getProviderBaseUrl', () => {
         expect(getProviderBaseUrl(provider)).toMatch(
           new RegExp('^http://127.0.0.1:\\d{4,5}$')
         );
+        return getClient(provider)
+          .get('/v2/pet/1845563262948980200')
+          .set('api_key', '[]')
+          .expect(200);
       });
     });
   }

src/v3/index.ts

@@ -0,0 +1,98 @@
+import * as pactV3 from '@pact-foundation/pact';
+import * as path from 'path';
+
+export type JestPactOptionsV3 = Omit<pactV3.PactV3Options, 'dir'> & {
+  dir?: string;
+  timeout?: number;
+};
+
+type ExecuteTestFn = (mockServer: pactV3.V3MockServer) => Promise<unknown>;
+
+interface DescibeArg {
+  provider: pactV3.PactV3;
+  execute: JestPactExecuteTestFn;
+}
+
+type JestPactExecuteTestFn = (description: string, fn: ExecuteTestFn) => void;
+
+export type JestProvidedPactFnV3 = (D: DescibeArg) => void;
+export type JestDescribePactFnV3 = (
+  description: string,
+  fn: JestProvidedPactFnV3
+) => void;
+
+export type JestProvidedDescribeFnV3 = (
+  pactDescribe: JestDescribePactFnV3
+) => void;
+
+const applyDefaults = (options: JestPactOptionsV3): pactV3.PactV3Options => ({
+  dir: path.resolve(process.cwd(), 'pact/pacts'),
+  ...options,
+});
+
+const setupProvider = (options: pactV3.PactV3Options) => {
+  const pactDescribe: JestDescribePactFnV3 = (
+    describeDescription: string,
+    fn: JestProvidedPactFnV3
+  ) => {
+    describe(describeDescription, () => {
+      const provider = new pactV3.PactV3(options);
+      const execute = (testDescription: string, executeTest: ExecuteTestFn) => {
+        it(testDescription, () => provider.executeTest(executeTest));
+      };
+      fn({ provider, execute });
+    });
+  };
+  return pactDescribe;
+};
+
+const jestPactWrapper = (
+  options: JestPactOptionsV3,
+  tests: JestProvidedDescribeFnV3
+): void => {
+  const pactTestTimeout = options.timeout || 30000;
+
+  describe(`with ${pactTestTimeout} ms timeout for Pact`, () => {
+    let originalTimeout: number;
+
+    beforeAll(() => {
+      // Jest's default timeout is 5000, and jest doesn't provide a way of
+      // asking what the current timeout is. In Jest 24 and 25, Jasmine was probably
+      // the test runner, so we can ask Jasmine if it is there. In later versions of
+      // Jest (eg 26 and up), Jasmine may not be defined.
+      // See https://github.com/pact-foundation/jest-pact/issues/197 for discussion
+      //
+      // For now, we just assume that 5000 was the original timeout.
+      // The impact is likely to be small, as `jest.setTimeout()` only works for the
+      // current test file
+      originalTimeout = global.jasmine
+        ? global.jasmine.DEFAULT_TIMEOUT_INTERVAL
+        : 5000;
+      jest.setTimeout(pactTestTimeout);
+    });
+
+    afterAll(() => {
+      jest.setTimeout(originalTimeout);
+    });
+
+    tests(setupProvider(applyDefaults(options)));
+  });
+};
+
+const describeString = (options: JestPactOptionsV3) =>
+  `Pact between ${options.consumer} and ${options.provider}`;
+
+export const pactWith = (
+  options: JestPactOptionsV3,
+  tests: JestProvidedDescribeFnV3
+) => describe(describeString(options), () => jestPactWrapper(options, tests));
+
+export const xpactWith = (
+  options: JestPactOptionsV3,
+  tests: JestProvidedDescribeFnV3
+) => xdescribe(describeString(options), () => jestPactWrapper(options, tests));
+
+export const fpactWith = (
+  options: JestPactOptionsV3,
+  tests: JestProvidedDescribeFnV3
+) => fdescribe(describeString(options), () => jestPactWrapper(options, tests));