feat: support GraphQL for PactV3 and PactV4

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

@@ -69,6 +69,8 @@ jobs:
         run: cd examples/v4/plugins && npm install --ignore-scripts && npm test
       - name: example_v4_matchers
         run: cd examples/v4/matchers && npm install --ignore-scripts && npm test
+      - name: example_v4_graphql
+        run: cd examples/v4/graphql && npm install --ignore-scripts && npm test
       # - name: Upload dist folder
       #   if: runner.os == 'Linux'
       #   uses: actions/upload-artifact@v3

examples/graphql/src/consumer.spec.ts

@@ -3,12 +3,7 @@ import * as chai from 'chai';
 import * as path from 'path';
 import * as chaiAsPromised from 'chai-as-promised';
 import { query } from './consumer';
-import {
-  Pact,
-  GraphQLInteraction,
-  Matchers,
-  LogLevel,
-} from '@pact-foundation/pact';
+import { Matchers, LogLevel, GraphQLPactV3 } from '@pact-foundation/pact';
 const { like } = Matchers;
 const LOG_LEVEL = process.env.LOG_LEVEL || 'TRACE';
 
@@ -17,21 +12,18 @@ const expect = chai.expect;
 chai.use(chaiAsPromised);
 
 describe('GraphQL example', () => {
-  const provider = new Pact({
+  const provider = new GraphQLPactV3({
     port: 4000,
-    log: path.resolve(process.cwd(), 'logs', 'mockserver-integration.log'),
     dir: path.resolve(process.cwd(), 'pacts'),
     consumer: 'GraphQLConsumer',
     provider: 'GraphQLProvider',
     logLevel: LOG_LEVEL as LogLevel,
   });
 
-  before(() => provider.setup());
-  after(() => provider.finalize());
-
-  describe('query hello on /graphql', () => {
+  describe('When the "hello" query on /graphql is made', () => {
     before(() => {
-      const graphqlQuery = new GraphQLInteraction()
+      provider
+        .given('the world exists')
         .uponReceiving('a hello request')
         .withQuery(
           `
@@ -59,16 +51,14 @@ describe('GraphQL example', () => {
             },
           },
         });
-      return provider.addInteraction(graphqlQuery);
     });
 
-    it('returns the correct response', () => {
-      return expect(query()).to.eventually.deep.equal({
-        hello: 'Hello world!',
+    it('returns the correct response', async () => {
+      await provider.executeTest(async () => {
+        return expect(query()).to.eventually.deep.equal({
+          hello: 'Hello world!',
+        });
       });
     });
-
-    // verify with Pact, and reset expectations
-    afterEach(() => provider.verify());
   });
 });

examples/v4/graphql/.gitignore

@@ -0,0 +1,2 @@
+src/*.js
+src/*.d.ts

examples/v4/graphql/.mocharc.json

@@ -0,0 +1,8 @@
+{
+  "bail": true,
+  "reporter": "spec",
+  "colors": true,
+  "timeout": 60000,
+  "exit": true,
+  "require": ["ts-node/register", "source-map-support/register"]
+}

examples/v4/graphql/README.md

@@ -0,0 +1,10 @@
+# GraphQL + Pact
+
+Demonstrates how to do Pact testing against a GraphQL endpoint. This is a POC, demonstrating how PactJS could provide a simple helper function that wraps the GraphQL request into a basic Interaction suitable for Pact (after all, GraphQL is simply an interface over HTTP).
+
+Test it out here:
+
+```
+npm run test:consumer
+npm run test:provider
+```