feat: remove supertest, add random ports

.npmignore

@@ -20,3 +20,4 @@ tslint.json
 RELEASING.md
 CONTRIBUTING.md
 commitlint.config.js
+jestpact.tar.gz

README.md

@@ -11,19 +11,16 @@
 ### Features
 
 - [x] Jest Adaptor For Pact
-  - [ ] Assign random ports but pass port back to user for thier http agent
-- [x] Jest Adaptor For Pact with SuperTest
-  - [x] With added Supertest types
-  - [ ] Assign random ports
+  - [X] Assign random ports and pass port back to user for thier http agent
 - [x] use postman-pact to generate postman collections for pact contracts
 - [x] example publish / tagging to pact-broker
 - [x] example verification
 - [x] example pact stub service docker templates
 - [x] Now ships with pact and jest as dependencies
+- [X] BREAKING CHANGE - Removed supertest and types in v1.0.0
 
 ## `Jest-Pact` Roadmap
 
-- [ ] Remove supertest and types
 - [ ] user configurable paths for log/pact output dirs
 - [ ] integration with Jest's API to make setup and teardown of pact tests very simple
 - [ ] Ensure that jest-pact plays well with jest's default of watch-mode
@@ -47,14 +44,6 @@ pactWith({ consumer: 'MyConsumer', provider: 'MyProvider' }, provider => {
 }
 ```
 
-with supertest
-
-```ts
-pactWith({ consumer: 'MyConsumer', provider: 'MyProvider' }, (provider, client) => {
-    // regular pact tests go here
-}
-```
-
 ## Configuration
 
 ```ts
@@ -115,40 +104,6 @@ pactWith(
 );
 ```
 
-## Example with SuperTest
-
-You can use superagent as your http agent, it has a great assertion engine and as we instantiate the pact mock and http agent at the same time, we can assign random ports and take advantage of jests parallel execution.
-
-```ts
-pactWithSuperTest(
-  { consumer: "MyConsumer", provider: "pactWithSuperTest" },
-  async (provider: any, client: any) => {
-    test("should accept a valid get request to get a pet", async () => {
-      const postValidRequest: InteractionObject = {
-        state: "A pet 1 exists",
-        uponReceiving: "A get request to get a pet",
-        willRespondWith: {
-          status: 200
-        },
-        withRequest: {
-          method: "GET",
-          path: "/v2/pet/1",
-          headers: { api_key: "[]" }
-        }
-      };
-
-      await provider.addInteraction(postValidRequest);
-      await client
-        .get("/v2/pet/1")
-        .set("api_key", "[]")
-        .expect(200);
-
-      await provider.verify();
-    });
-  }
-);
-```
-
 ### Examples of usage of `jest-pact`
 
 See [Jest-Pact-Typescript](https://github.com/YOU54F/jest-pact-typescript) which showcases a full consumer workflow written in Typescript with Jest, using this adaptor

package.json

@@ -48,7 +48,7 @@
     "lint-staged": "8.1.7",
     "prettier": "1.17.1",
     "rimraf": "2.6.3",
-    "standard-version": "^6.0.1",
+    "standard-version": "^6.0.1",    
     "supertest": "4.0.2",
     "ts-jest": "24.0.2",
     "ts-node": "8.2.0",

src/index.ts

@@ -1,6 +1,5 @@
 import * as pact from "@pact-foundation/pact";
 import * as path from "path";
-import * as supertest from "supertest";
 
 export interface PactOptions {
   provider: string;
@@ -21,7 +20,7 @@ export declare type LogLevel =
 export declare type PactFileWriteMode = "overwrite" | "update" | "merge";
 
 const applyDefaults = (options: PactOptions) => ({
-  port: options.port || 8282,
+  port: options.port,
   log: path.resolve(
     process.cwd(),
     "pact/logs",
@@ -54,8 +53,3 @@ export const pactWith = (options: PactOptions, tests: any) =>
   describe(`Pact between ${options.consumer} and ${options.provider}`, () => {
     tests(setupProvider(applyDefaults(options)));
   });
-
-export const pactWithSuperTest = (options: PactOptions, tests: any) =>
-  pactWith(options, (provider: pact.Pact) => {
-    tests(provider, supertest(getProviderBaseUrl(provider)));
-  });

src/test/pactwith.test.ts

@@ -53,8 +53,8 @@ pactWith({ consumer: "MyConsumer", provider: "pactWith2" }, (provider: any) => {
   });
 
   describe("provider object", () => {
-    test("should show the default port in the URL", () => {
-      expect(provider.mockService.baseUrl).toMatch(new RegExp(`8282$`));
+    test("should show the randomly assigned port in the URL", () => {
+      expect(provider.mockService.baseUrl).toMatch(new RegExp(`\\d{4,5}$`));
     });
   });
 });