feat: create pact from nock also

Author: mefellows

Makefile

@@ -20,6 +20,7 @@ all: test
 ## ====================
 
 ci: test publish_pacts can_i_deploy $(DEPLOY_TARGET)
+ci_nock: test_nock publish_pacts can_i_deploy $(DEPLOY_TARGET)
 
 # Run the ci target from a developer machine with the environment variables
 # set as if it was on Travis CI.
@@ -31,6 +32,13 @@ fake_ci: .env
 	REACT_APP_API_BASE_URL=http://localhost:8080 \
 	make ci
 
+fake_ci_nock: .env
+	@CI=true \
+	TRAVIS_COMMIT=`git rev-parse --short HEAD`+`date +%s` \
+	TRAVIS_BRANCH=`git rev-parse --abbrev-ref HEAD` \
+	REACT_APP_API_BASE_URL=http://localhost:8080 \
+	make ci_nock
+
 publish_pacts: .env
 	@echo "\n========== STAGE: publish pacts ==========\n"
 	@"${PACT_CLI}" publish ${PWD}/pacts --consumer-app-version ${TRAVIS_COMMIT} --tag ${TRAVIS_BRANCH}
@@ -40,9 +48,13 @@ publish_pacts: .env
 ## =====================
 
 test: .env
-	@echo "\n========== STAGE: test ==========\n"
+	@echo "\n========== STAGE: test (pact) ==========\n"
 	npm run test:pact
 
+test_nock: .env
+	@echo "\n========== STAGE: test (nock) ==========\n"
+	npm run test:nock
+
 ## =====================
 ## Deploy tasks
 ## =====================

fixtures/nock.json

@@ -0,0 +1,80 @@
+[
+    {
+        "scope": "http://localhost:3000",
+        "method": "GET",
+        "path": "/products",
+        "body": "",
+        "status": 200,
+        "response": [
+            {
+                "id": "09",
+                "type": "CREDIT_CARD",
+                "name": "Gem Visa",
+                "version": "v1",
+                "price": 99.99
+            },
+            {
+                "id": "10",
+                "type": "CREDIT_CARD",
+                "name": "28 Degrees",
+                "version": "v1",
+                "price": 49.49
+            },
+            {
+                "id": "11",
+                "type": "PERSONAL_LOAN",
+                "name": "MyFlexiPay",
+                "version": "v2",
+                "price": 16.5
+            }
+        ],
+        "rawHeaders": [
+            "X-Powered-By",
+            "Express",
+            "Access-Control-Allow-Origin",
+            "*",
+            "Content-Type",
+            "application/json; charset=utf-8",
+            "Content-Length",
+            "246",
+            "ETag",
+            "W/\"f6-w3kK4moDvOGs6FOpA/LePl4PlXg\"",
+            "Date",
+            "Wed, 17 Feb 2021 13:20:37 GMT",
+            "Connection",
+            "close"
+        ],
+        "responseIsBinary": false
+    },
+    {
+        "scope": "http://localhost:3000",
+        "method": "GET",
+        "path": "/product/10",
+        "body": "",
+        "status": 200,
+        "response": {
+            "id": "10",
+            "type": "CREDIT_CARD",
+            "name": "28 Degrees",
+            "version": "v1",
+            "price": 49.49
+        },
+        "rawHeaders": [
+            "X-Powered-By",
+            "Express",
+            "Access-Control-Allow-Origin",
+            "*",
+            "Content-Type",
+            "application/json; charset=utf-8",
+            "Content-Length",
+            "81",
+            "ETag",
+            "W/\"51-/fCT2fY74qwFWk1CnZqdJTmzvZg\"",
+            "Date",
+            "Wed, 17 Feb 2021 13:20:37 GMT",
+            "Connection",
+            "close"
+        ],
+        "responseIsBinary": false
+    }
+]

package-lock.json

@@ -10,14 +10,17 @@
     "react-router": "latest",
     "react-router-dom": "^5.2.0",
     "react-scripts": "^3.4.3",
-    "spectre.css": "^0.5.9"
+    "spectre.css": "^0.5.9",
+    "swagger-mock-validator": "^10.0.0"
   },
   "scripts": {
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "cross-env CI=true react-scripts test",
     "eject": "react-scripts eject",
-    "test:pact": "cross-env CI=true react-scripts test --testTimeout 30000 pact.spec.js"
+    "test:pact": "cross-env CI=true react-scripts test --testTimeout 30000 pact.spec.js",
+    "test:nock": "cross-env CI=true react-scripts test --testTimeout 30000 nock.spec.js",
+    "test:record": "cross-env CI=true react-scripts test --testTimeout 30000 record.spec.js"
   },
   "eslintConfig": {
     "extends": "react-app"

package.json

@@ -0,0 +1,33 @@
+import { API } from "./api";
+import { convertToPact } from "./api.record.spec";
+
+const nockBack = require("nock").back;
+nockBack.fixtures = "fixtures";
+
+describe("API Nock Tests", () => {
+  test("nock recordings", (done) => {
+    // reuse the nock fixture
+    nockBack(
+      "nock.json",
+      { afterRecord: convertToPact },
+      async function(nockDone ) {
+        const api = new API("http://localhost:3000");
+
+        // Test 1
+        const products = await api.getAllProducts();
+        expect(products.length).toBeGreaterThan(0);
+
+        // Test 2
+        const product = await api.getProduct("10");
+        expect(product.id).toBe("10");
+
+        // This will fail if not all mocks were tested
+        // meaning we won't serialise unused items into the contract
+        this.assertScopesFinished();
+
+        nockDone();
+        done()
+      }
+    );
+  });
+});

src/api.nock.spec.js

@@ -16,7 +16,10 @@ describe('API Pact test', () => {
   describe('retrieving a product', () => {
     test('ID 10 exists', async () => {
       // Arrange
-      const expectedProduct = { id: '10', type: 'CREDIT_CARD', name: '28 Degrees' }
+      // const expectedProduct = { id: '10', type: 'CREDIT_CARD', name: '28 Degrees'}
+
+      // Uncomment to see this fail
+      const expectedProduct = { id: '10', type: 'CREDIT_CARD', name: '28 Degrees', price: 30.0, newField: 22}
 
       await mockProvider.addInteraction({
         state: 'a product with ID 10 exists',