test(): added pact utils

Author: ghermet

test/client/autosuggest-session.spec.ts renamed to __tests__/client/autosuggest-session.spec.ts

@@ -1,12 +1,5 @@
-import {
-  Matchers,
-  Pact,
-  RequestOptions,
-  ResponseOptions,
-} from '@pact-foundation/pact';
+import { Matchers, ResponseOptions } from '@pact-foundation/pact';
 import { Chance } from 'chance';
-import * as path from 'path';
-import { ApiVersion, AutosuggestClient } from '../../src';
 import {
   BadGatewayError,
   ForbiddenError,
@@ -15,18 +8,16 @@ import {
   NotFoundError,
   ServiceUnavailableError,
 } from '../../src/lib/transport/error';
+import {
+  createAutosuggestPact,
+  createPactMockRequest,
+  createPactMockResponse,
+} from '../pact/utils';
 
 const chance = new Chance();
 
 describe('Autosuggest Session Pact', () => {
-  const randomApiKey = chance.string({
-    length: 8,
-    alpha: true,
-    numeric: true,
-    symbols: false,
-    casing: 'upper',
-  });
-
+  const correlationId = Matchers.uuid().getValue();
   const genRandomDigit = () =>
     chance.string({
       length: 1,
@@ -35,11 +26,6 @@ describe('Autosuggest Session Pact', () => {
       symbols: false,
       casing: 'lower',
     });
-  const apiKey = Matchers.term({
-    matcher: '[a-zA-Z0-9]{8}',
-    generate: randomApiKey,
-  }).getValue();
-  const correlationId = Matchers.uuid().getValue();
   const randomVersion = [
     genRandomDigit(),
     genRandomDigit(),
@@ -57,21 +43,7 @@ describe('Autosuggest Session Pact', () => {
     chance.pickone(['default', 'inherit'])
   ).getValue() as never;
 
-  const apiVersion = ApiVersion.Version3;
-  const port = 9000;
-  const host = `http://localhost:${port}`;
-  const client = new AutosuggestClient(apiKey, { host, apiVersion, headers: {} });
-
-  // Create the Pact object to represent your provider
-  const provider = new Pact({
-    consumer: 'w3w-node-wrapper',
-    provider: 'api-server',
-    port,
-    log: path.resolve(process.cwd(), 'logs', 'pact.log'),
-    dir: path.resolve(process.cwd(), 'pacts'),
-    logLevel: 'info',
-    pactfileWriteMode: 'overwrite',
-  });
+  const { apiKey, apiVersion, client, provider } = createAutosuggestPact();
 
   // Start the mock server
   beforeAll(() => provider.setup());
@@ -88,8 +60,8 @@ describe('Autosuggest Session Pact', () => {
   afterAll(() => provider.finalize());
 
   describe('When I do not have a current autosuggest session', () => {
-    describe('And there is a sucessful request to start a session', () => {
-      const MOCK_REQUEST: RequestOptions = {
+    describe('And there is a successful request to start a session', () => {
+      const MOCK_REQUEST = createPactMockRequest({
         method: 'POST' as const,
         path: `/${apiVersion}/autosuggest-session`,
         query: {
@@ -105,8 +77,9 @@ describe('Autosuggest Session Pact', () => {
           variant,
           version,
         },
-      };
-      const MOCK_RESPONSE: ResponseOptions = {
+      });
+
+      const MOCK_RESPONSE = createPactMockResponse({
         status: 200,
         headers: {
           'Content-Type': 'application/json',
@@ -116,7 +89,7 @@ describe('Autosuggest Session Pact', () => {
           status: 200,
           message: 'ok',
         },
-      };
+      });
 
       // Add interactions to the Mock Server, as many as required
       beforeAll(() =>
@@ -148,7 +121,7 @@ describe('Autosuggest Session Pact', () => {
     });
 
     describe('And there is a failed request to update the session', () => {
-      const MOCK_REQUEST: RequestOptions = {
+      const MOCK_REQUEST = createPactMockRequest({
         method: 'POST' as const,
         path: `/${apiVersion}/autosuggest-session`,
         query: {
@@ -164,7 +137,7 @@ describe('Autosuggest Session Pact', () => {
           variant,
           version,
         },
-      };
+      });
 
       const errors = [
         new ForbiddenError(),
@@ -216,7 +189,7 @@ describe('Autosuggest Session Pact', () => {
 
     describe('And there is an unauthorized request', () => {
       it('should return a 401 error when apiKey is missing', async () => {
-        const MOCK_REQUEST: RequestOptions = {
+        const MOCK_REQUEST = createPactMockRequest({
           method: 'POST' as const,
           path: `/${apiVersion}/autosuggest-session`,
           headers: {
@@ -229,8 +202,8 @@ describe('Autosuggest Session Pact', () => {
             variant,
             version,
           },
-        };
-        const MOCK_RESPONSE: ResponseOptions = {
+        });
+        const MOCK_RESPONSE = createPactMockResponse({
           status: 401,
           headers: {
             'Content-Type': 'application/json',
@@ -240,7 +213,7 @@ describe('Autosuggest Session Pact', () => {
             status: 401,
             message: 'Unauthorized',
           },
-        };
+        });
         // Add interactions to the Mock Server, as many as required
         await provider.addInteraction({
           // The 'state' field specifies a "Provider State"
@@ -267,7 +240,7 @@ describe('Autosuggest Session Pact', () => {
 
     describe('And there is bad request ', () => {
       it('should return a 400 error when returnCoordinates is missing', async () => {
-        const MOCK_REQUEST: RequestOptions = {
+        const MOCK_REQUEST = createPactMockRequest({
           method: 'POST' as const,
           path: `/${apiVersion}/autosuggest-session`,
           headers: {
@@ -279,8 +252,8 @@ describe('Autosuggest Session Pact', () => {
             variant,
             version,
           },
-        };
-        const MOCK_RESPONSE: ResponseOptions = {
+        });
+        const MOCK_RESPONSE = createPactMockResponse({
           status: 400,
           headers: {
             'Content-Type': 'application/json',
@@ -290,7 +263,7 @@ describe('Autosuggest Session Pact', () => {
             status: 400,
             message: 'Bad Request',
           },
-        };
+        });
         // Add interactions to the Mock Server, as many as required
         await provider.addInteraction({
           // The 'state' field specifies a "Provider State"
@@ -315,7 +288,7 @@ describe('Autosuggest Session Pact', () => {
       });
 
       it('should return a 400 error when typeheadDelay is missing', async () => {
-        const MOCK_REQUEST: RequestOptions = {
+        const MOCK_REQUEST = createPactMockRequest({
           method: 'POST' as const,
           path: `/${apiVersion}/autosuggest-session`,
           headers: {
@@ -327,8 +300,8 @@ describe('Autosuggest Session Pact', () => {
             variant,
             version,
           },
-        };
-        const MOCK_RESPONSE: ResponseOptions = {
+        });
+        const MOCK_RESPONSE = createPactMockResponse({
           status: 400,
           headers: {
             'Content-Type': 'application/json',
@@ -338,7 +311,7 @@ describe('Autosuggest Session Pact', () => {
             status: 400,
             message: 'Bad Request',
           },
-        };
+        });
         // Add interactions to the Mock Server, as many as required
         await provider.addInteraction({
           // The 'state' field specifies a "Provider State"
@@ -366,7 +339,7 @@ describe('Autosuggest Session Pact', () => {
 
   describe('When I have a current autosuggest session', () => {
     describe('And there is a request to update the session', () => {
-      const MOCK_REQUEST: RequestOptions = {
+      const MOCK_REQUEST = createPactMockRequest({
         method: 'PUT' as const,
         path: `/${apiVersion}/autosuggest-session`,
         query: {
@@ -382,8 +355,8 @@ describe('Autosuggest Session Pact', () => {
           variant,
           version,
         },
-      };
-      const MOCK_RESPONSE: ResponseOptions = {
+      });
+      const MOCK_RESPONSE = createPactMockResponse({
         status: 200,
         headers: {
           'Content-Type': 'application/json',
@@ -392,7 +365,7 @@ describe('Autosuggest Session Pact', () => {
         body: {
           status: 200,
         },
-      };
+      });
 
       beforeAll(() =>
         provider.addInteraction({
@@ -422,7 +395,7 @@ describe('Autosuggest Session Pact', () => {
 
     describe('And there is an unauthorized request', () => {
       it('should return a 401 error when apiKey is missing', async () => {
-        const MOCK_REQUEST: RequestOptions = {
+        const MOCK_REQUEST = createPactMockRequest({
           method: 'PUT' as const,
           path: `/${apiVersion}/autosuggest-session`,
           headers: {
@@ -435,8 +408,8 @@ describe('Autosuggest Session Pact', () => {
             variant,
             version,
           },
-        };
-        const MOCK_RESPONSE: ResponseOptions = {
+        });
+        const MOCK_RESPONSE = createPactMockResponse({
           status: 401,
           headers: {
             'Content-Type': 'application/json',
@@ -446,7 +419,7 @@ describe('Autosuggest Session Pact', () => {
             status: 401,
             message: 'Unauthorized',
           },
-        };
+        });
         // Add interactions to the Mock Server, as many as required
         await provider.addInteraction({
           // The 'state' field specifies a "Provider State"
@@ -473,7 +446,7 @@ describe('Autosuggest Session Pact', () => {
 
     describe('And there is bad request ', () => {
       it('should return a 400 error when returnCoordinates is missing', async () => {
-        const MOCK_REQUEST: RequestOptions = {
+        const MOCK_REQUEST = createPactMockRequest({
           method: 'PUT' as const,
           path: `/${apiVersion}/autosuggest-session`,
           headers: {
@@ -485,8 +458,8 @@ describe('Autosuggest Session Pact', () => {
             variant,
             version,
           },
-        };
-        const MOCK_RESPONSE: ResponseOptions = {
+        });
+        const MOCK_RESPONSE = createPactMockResponse({
           status: 400,
           headers: {
             'Content-Type': 'application/json',
@@ -496,7 +469,7 @@ describe('Autosuggest Session Pact', () => {
             status: 400,
             message: 'Bad Request',
           },
-        };
+        });
         // Add interactions to the Mock Server, as many as required
         await provider.addInteraction({
           // The 'state' field specifies a "Provider State"
@@ -521,7 +494,7 @@ describe('Autosuggest Session Pact', () => {
       });
 
       it('should return a 400 error when typeheadDelay is missing', async () => {
-        const MOCK_REQUEST: RequestOptions = {
+        const MOCK_REQUEST = createPactMockRequest({
           method: 'PUT' as const,
           path: `/${apiVersion}/autosuggest-session`,
           headers: {
@@ -533,8 +506,8 @@ describe('Autosuggest Session Pact', () => {
             variant,
             version,
           },
-        };
-        const MOCK_RESPONSE: ResponseOptions = {
+        });
+        const MOCK_RESPONSE = createPactMockResponse({
           status: 400,
           headers: {
             'Content-Type': 'application/json',
@@ -544,7 +517,7 @@ describe('Autosuggest Session Pact', () => {
             status: 400,
             message: 'Bad Request',
           },
-        };
+        });
         // Add interactions to the Mock Server, as many as required
         await provider.addInteraction({
           // The 'state' field specifies a "Provider State"
@@ -570,7 +543,7 @@ describe('Autosuggest Session Pact', () => {
     });
 
     describe('And there is a failed request to update the session', () => {
-      const MOCK_REQUEST: RequestOptions = {
+      const MOCK_REQUEST = createPactMockRequest({
         method: 'PUT' as const,
         path: `/${apiVersion}/autosuggest-session`,
         query: {
@@ -586,7 +559,7 @@ describe('Autosuggest Session Pact', () => {
           variant,
           version,
         },
-      };
+      });
 
       const errors = [
         new ForbiddenError(),
@@ -600,7 +573,7 @@ describe('Autosuggest Session Pact', () => {
       errors.forEach(err => {
         // Write your test(s)
         it(`should return a ${err.status} error`, async () => {
-          const MOCK_RESPONSE: ResponseOptions = {
+          const MOCK_RESPONSE = createPactMockResponse({
             status: err.status,
             headers: {
               'Content-Type': 'application/json',
@@ -610,7 +583,7 @@ describe('Autosuggest Session Pact', () => {
               status: err.status,
               message: err.message,
             },
-          };
+          });
           // Add interactions to the Mock Server, as many as required
           await provider.addInteraction({
             // The 'state' field specifies a "Provider State"

test/client/autosuggest.spec.ts renamed to __tests__/client/autosuggest.spec.ts

@@ -30,7 +30,7 @@ describe('Autosuggest Client', () => {
         body: {} as never,
       })
     );
-    client = AutosuggestClient.init(apiKey, config, transportSpy);
+    client = AutosuggestClient.init(apiKey, config, transportSpy as never);
   });
 
   it('should instantiate an Autosuggest Client instance', () => {

test/client/available-languages.spec.ts renamed to __tests__/client/available-languages.spec.ts

@@ -28,7 +28,11 @@ describe('Available Languages Client', () => {
         body: {} as never,
       })
     );
-    client = AvailableLanguagesClient.init(apiKey, config, transportSpy);
+    client = AvailableLanguagesClient.init(
+      apiKey,
+      config,
+      transportSpy as never
+    );
   });
 
   it('should return instantiate an Available Languages Client instance', () => {

test/client/convert-to-3wa.spec.ts renamed to __tests__/client/convert-to-3wa.spec.ts

@@ -29,7 +29,7 @@ describe('Grid Section Client', () => {
         body: {} as never,
       })
     );
-    client = GridSectionClient.init(apiKey, config, transportSpy);
+    client = GridSectionClient.init(apiKey, config, transportSpy as never);
   });
 
   it('should return instantiate an Grid Section Client instance', () => {