@pact-foundation/pact 10.0.0-beta.9 → 10.0.0

package/src/httpPact/index.spec.js

@@ -0,0 +1,238 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// @ts-nocheck
+var chai_1 = __importDefault(require("chai"));
+var chai_as_promised_1 = __importDefault(require("chai-as-promised"));
+var sinon_1 = __importDefault(require("sinon"));
+var sinon_chai_1 = __importDefault(require("sinon-chai"));
+var _1 = require(".");
+chai_1.default.use(sinon_chai_1.default);
+chai_1.default.use(chai_as_promised_1.default);
+var expect = chai_1.default.expect;
+describe('Pact', function () {
+    var fullOpts = {
+        consumer: 'A',
+        provider: 'B',
+        port: 1234,
+        host: '127.0.0.1',
+        ssl: false,
+        logLevel: 'info',
+        spec: 2,
+        cors: false,
+        pactfileWriteMode: 'merge',
+    };
+    afterEach(function () {
+        sinon_1.default.restore();
+    });
+    describe('#constructor', function () {
+        it('throws Error when consumer not provided', function () {
+            expect(function () {
+                new _1.Pact({ consumer: '', provider: 'provider' });
+            }).to.throw(Error, 'You must specify a Consumer for this pact.');
+        });
+        it('throws Error when provider not provided', function () {
+            expect(function () {
+                new _1.Pact({ consumer: 'someconsumer', provider: '' });
+            }).to.throw(Error, 'You must specify a Provider for this pact.');
+        });
+    });
+    describe('#createOptionsWithDefault', function () {
+        var constructorOpts = {
+            consumer: 'A',
+            provider: 'B',
+        };
+        it('merges options with sensible defaults', function () {
+            var opts = _1.Pact.createOptionsWithDefaults(constructorOpts);
+            expect(opts.consumer).to.eq('A');
+            expect(opts.provider).to.eq('B');
+            expect(opts.cors).to.eq(false);
+            expect(opts.host).to.eq('127.0.0.1');
+            expect(opts.logLevel).to.eq('info');
+            expect(opts.spec).to.eq(2);
+            expect(opts.dir).not.to.be.empty;
+            expect(opts.log).not.to.be.empty;
+            expect(opts.pactfileWriteMode).to.eq('merge');
+            expect(opts.ssl).to.eq(false);
+            expect(opts.sslcert).to.eq(undefined);
+            expect(opts.sslkey).to.eq(undefined);
+        });
+    });
+    describe('#setup', function () {
+        describe('when server is properly configured', function () {
+            it('updates the mock service configuration', function () { return __awaiter(void 0, void 0, void 0, function () {
+                var p;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            p = new _1.Pact(fullOpts);
+                            return [4 /*yield*/, p.setup()];
+                        case 1:
+                            _a.sent();
+                            expect(p.mockService).to.deep.equal({
+                                baseUrl: 'http://127.0.0.1:1234',
+                                pactDetails: {
+                                    pactfile_write_mode: 'merge',
+                                    consumer: {
+                                        name: 'A',
+                                    },
+                                    provider: { name: 'B' },
+                                },
+                            });
+                            return [2 /*return*/];
+                    }
+                });
+            }); });
+            it('returns the current configuration', function () {
+                var p = new _1.Pact(fullOpts);
+                return expect(p.setup()).to.eventually.include({
+                    consumer: 'A',
+                    provider: 'B',
+                    port: 1234,
+                    host: '127.0.0.1',
+                    ssl: false,
+                    logLevel: 'info',
+                    spec: 2,
+                    cors: false,
+                    pactfileWriteMode: 'merge',
+                });
+            });
+        });
+        describe('when a port is given', function () {
+            it('checks if the port is available', function () {
+                var p = new _1.Pact(fullOpts);
+                return expect(p.setup())
+                    .to.eventually.have.property('port')
+                    .eq(fullOpts.port);
+            });
+        });
+        describe('when no port is given', function () {
+            it('finds a free port', function () {
+                var opts = __assign(__assign({}, fullOpts), { port: undefined });
+                var p = new _1.Pact(opts);
+                return expect(p.setup()).to.eventually.have.property('port').not
+                    .undefined;
+            });
+        });
+    });
+    describe('#addInteraction', function () {
+        // This is more of an integration test, as the function has taken on a lot more
+        // responsibility previously covered by other functions during the upgrade to
+        // the rust core, to ensure the API remains backwards compatible
+        it('sets the correct request and response details on the FFI and starts the mock server', function () {
+            var p = new _1.Pact(fullOpts);
+            var uponReceiving = sinon_1.default.stub().returns(true);
+            var given = sinon_1.default.stub().returns(true);
+            var withRequest = sinon_1.default.stub().returns(true);
+            var withRequestBody = sinon_1.default.stub().returns(true);
+            var withRequestHeader = sinon_1.default.stub().returns(true);
+            var withQuery = sinon_1.default.stub().returns(true);
+            var withResponseBody = sinon_1.default.stub().returns(true);
+            var withResponseHeader = sinon_1.default.stub().returns(true);
+            var withStatus = sinon_1.default.stub().returns(true);
+            var createMockServer = sinon_1.default.stub().returns(1234);
+            var pactMock = {
+                createMockServer: createMockServer,
+            };
+            var interactionMock = {
+                uponReceiving: uponReceiving,
+                given: given,
+                withRequest: withRequest,
+                withRequestBody: withRequestBody,
+                withRequestHeader: withRequestHeader,
+                withQuery: withQuery,
+                withResponseBody: withResponseBody,
+                withResponseHeader: withResponseHeader,
+                withStatus: withStatus,
+            };
+            p.pact = pactMock;
+            p.interaction = interactionMock;
+            p.mockService = {};
+            p.addInteraction({
+                state: 'some state',
+                uponReceiving: 'some description',
+                withRequest: {
+                    method: 'GET',
+                    path: '/',
+                    body: { foo: 'bar' },
+                    headers: {
+                        'content-type': 'application/json',
+                        foo: 'bar',
+                    },
+                    query: {
+                        query: 'string',
+                        foo: 'bar',
+                    },
+                },
+                willRespondWith: {
+                    status: 200,
+                    body: { baz: 'bat' },
+                    headers: {
+                        'content-type': 'application/hal+json',
+                        foo: 'bar',
+                    },
+                },
+            });
+            expect(uponReceiving.calledOnce).to.be.true;
+            expect(given.calledOnce).to.be.true;
+            expect(withRequest.calledOnce).to.be.true;
+            expect(withQuery.calledTwice).to.be.true;
+            expect(withRequestHeader.calledTwice).to.be.true;
+            expect(withRequestBody.calledOnce).to.be.true;
+            expect(withResponseBody.calledOnce).to.be.true;
+            expect(withResponseHeader.calledTwice).to.be.true;
+            // Pact mock server started
+            expect(createMockServer.called).to.be.true;
+        });
+    });
+});
+//# sourceMappingURL=index.spec.js.map

package/src/httpPact/index.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.spec.js","sourceRoot":"","sources":["../../../src/httpPact/index.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,8CAAwB;AACxB,sEAA8C;AAC9C,gDAA0B;AAC1B,0DAAmC;AAEnC,sBAAyB;AAGzB,cAAI,CAAC,GAAG,CAAC,oBAAS,CAAC,CAAC;AACpB,cAAI,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AAEjB,IAAA,MAAM,GAAK,cAAI,OAAT,CAAU;AAExB,QAAQ,CAAC,MAAM,EAAE;IACf,IAAM,QAAQ,GAAG;QACf,QAAQ,EAAE,GAAG;QACb,QAAQ,EAAE,GAAG;QACb,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,WAAW;QACjB,GAAG,EAAE,KAAK;QACV,QAAQ,EAAE,MAAM;QAChB,IAAI,EAAE,CAAC;QACP,IAAI,EAAE,KAAK;QACX,iBAAiB,EAAE,OAAO;KACJ,CAAC;IAEzB,SAAS,CAAC;QACR,eAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE;QACvB,EAAE,CAAC,yCAAyC,EAAE;YAC5C,MAAM,CAAC;gBACL,IAAI,OAAI,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,4CAA4C,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE;YAC5C,MAAM,CAAC;gBACL,IAAI,OAAI,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;YACvD,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,4CAA4C,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE;QACpC,IAAM,eAAe,GAAgB;YACnC,QAAQ,EAAE,GAAG;YACb,QAAQ,EAAE,GAAG;SACd,CAAC;QAEF,EAAE,CAAC,uCAAuC,EAAE;YAC1C,IAAM,IAAI,GAAG,OAAI,CAAC,yBAAyB,CAAC,eAAe,CAAC,CAAC;YAC7D,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC;YACrC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;YACpC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YACjC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;YAC9C,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE;QACjB,QAAQ,CAAC,oCAAoC,EAAE;YAC7C,EAAE,CAAC,wCAAwC,EAAE;;;;;4BACrC,CAAC,GAAS,IAAI,OAAI,CAAC,QAAQ,CAAC,CAAC;4BAEnC,qBAAM,CAAC,CAAC,KAAK,EAAE,EAAA;;4BAAf,SAAe,CAAC;4BAChB,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;gCAClC,OAAO,EAAE,uBAAuB;gCAChC,WAAW,EAAE;oCACX,mBAAmB,EAAE,OAAO;oCAC5B,QAAQ,EAAE;wCACR,IAAI,EAAE,GAAG;qCACV;oCACD,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE;iCACxB;6BACF,CAAC,CAAC;;;;iBACJ,CAAC,CAAC;YAEH,EAAE,CAAC,mCAAmC,EAAE;gBACtC,IAAM,CAAC,GAAQ,IAAI,OAAI,CAAC,QAAQ,CAAC,CAAC;gBAElC,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;oBAC7C,QAAQ,EAAE,GAAG;oBACb,QAAQ,EAAE,GAAG;oBACb,IAAI,EAAE,IAAI;oBACV,IAAI,EAAE,WAAW;oBACjB,GAAG,EAAE,KAAK;oBACV,QAAQ,EAAE,MAAM;oBAChB,IAAI,EAAE,CAAC;oBACP,IAAI,EAAE,KAAK;oBACX,iBAAiB,EAAE,OAAO;iBAC3B,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,sBAAsB,EAAE;YAC/B,EAAE,CAAC,iCAAiC,EAAE;gBACpC,IAAM,CAAC,GAAQ,IAAI,OAAI,CAAC,QAAQ,CAAC,CAAC;gBAElC,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;qBACrB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;qBACnC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,uBAAuB,EAAE;YAChC,EAAE,CAAC,mBAAmB,EAAE;gBACtB,IAAM,IAAI,yBACL,QAAQ,KACX,IAAI,EAAE,SAAS,GAChB,CAAC;gBACF,IAAM,CAAC,GAAQ,IAAI,OAAI,CAAC,IAAI,CAAC,CAAC;gBAE9B,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG;qBAC7D,SAAS,CAAC;YACf,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,iBAAiB,EAAE;QAC1B,+EAA+E;QAC/E,6EAA6E;QAC7E,gEAAgE;QAChE,EAAE,CAAC,qFAAqF,EAAE;YACxF,IAAM,CAAC,GAAS,IAAI,OAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,IAAM,aAAa,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACjD,IAAM,KAAK,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACzC,IAAM,WAAW,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC/C,IAAM,eAAe,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACnD,IAAM,iBAAiB,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACrD,IAAM,SAAS,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7C,IAAM,gBAAgB,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpD,IAAM,kBAAkB,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACtD,IAAM,UAAU,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAM,gBAAgB,GAAG,eAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACpD,IAAM,QAAQ,GAAiB;gBAC7B,gBAAgB,kBAAA;aACjB,CAAC;YACF,IAAM,eAAe,GAAwB;gBAC3C,aAAa,eAAA;gBACb,KAAK,OAAA;gBACL,WAAW,aAAA;gBACX,eAAe,iBAAA;gBACf,iBAAiB,mBAAA;gBACjB,SAAS,WAAA;gBACT,gBAAgB,kBAAA;gBAChB,kBAAkB,oBAAA;gBAClB,UAAU,YAAA;aACX,CAAC;YACF,CAAC,CAAC,IAAI,GAAG,QAAQ,CAAC;YAClB,CAAC,CAAC,WAAW,GAAG,eAAe,CAAC;YAChC,CAAC,CAAC,WAAW,GAAG,EAAE,CAAC;YAEnB,CAAC,CAAC,cAAc,CAAC;gBACf,KAAK,EAAE,YAAY;gBACnB,aAAa,EAAE,kBAAkB;gBACjC,WAAW,EAAE;oBACX,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,GAAG;oBACT,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;oBACpB,OAAO,EAAE;wBACP,cAAc,EAAE,kBAAkB;wBAClC,GAAG,EAAE,KAAK;qBACX;oBACD,KAAK,EAAE;wBACL,KAAK,EAAE,QAAQ;wBACf,GAAG,EAAE,KAAK;qBACX;iBACF;gBACD,eAAe,EAAE;oBACf,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE;oBACpB,OAAO,EAAE;wBACP,cAAc,EAAE,sBAAsB;wBACtC,GAAG,EAAE,KAAK;qBACX;iBACF;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACpC,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC1C,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACzC,MAAM,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YACjD,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC9C,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAC/C,MAAM,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;YAElD,2BAA2B;YAC3B,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/src/httpPact/tracing.d.ts

@@ -0,0 +1 @@
+export declare const traceHttpInteractions: () => void;

package/src/httpPact/tracing.js

@@ -0,0 +1,53 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.traceHttpInteractions = void 0;
+var http_1 = __importDefault(require("http"));
+var logger_1 = __importDefault(require("../common/logger"));
+var traceHttpInteractions = function () {
+    var originalRequest = http_1.default.request;
+    http_1.default.request = function (options, cb) {
+        var requestBodyChunks = [];
+        var responseBodyChunks = [];
+        var hijackedCallback = function (res) {
+            logger_1.default.trace("outgoing request: ".concat(JSON.stringify(__assign(__assign({}, options), { body: Buffer.concat(requestBodyChunks).toString('utf8') }))));
+            if (cb) {
+                cb(res);
+            }
+        };
+        var clientRequest = originalRequest(options, hijackedCallback);
+        var oldWrite = clientRequest.end.bind(clientRequest);
+        clientRequest.end = function (chunk) {
+            requestBodyChunks.push(Buffer.from(chunk));
+            return oldWrite(chunk);
+        };
+        clientRequest.on('response', function (incoming) {
+            incoming.on('readable', function () {
+                responseBodyChunks.push(Buffer.from(incoming.read()));
+            });
+            incoming.on('end', function () {
+                logger_1.default.trace("response: ".concat(JSON.stringify({
+                    body: Buffer.concat(responseBodyChunks).toString('utf8'),
+                    headers: incoming.headers,
+                    statusCode: incoming.statusCode,
+                })));
+            });
+        });
+        return clientRequest;
+    };
+};
+exports.traceHttpInteractions = traceHttpInteractions;
+//# sourceMappingURL=tracing.js.map

package/src/httpPact/tracing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../../../src/httpPact/tracing.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA4E;AAE5E,4DAAsC;AAE/B,IAAM,qBAAqB,GAAG;IACnC,IAAM,eAAe,GAAG,cAAI,CAAC,OAAO,CAAC;IACrC,cAAI,CAAC,OAAO,GAAG,UACb,OAAuB,EACvB,EAAkC;QAElC,IAAM,iBAAiB,GAAa,EAAE,CAAC;QACvC,IAAM,kBAAkB,GAAa,EAAE,CAAC;QACxC,IAAM,gBAAgB,GAAG,UAAC,GAAoB;YAC5C,gBAAM,CAAC,KAAK,CACV,4BAAqB,IAAI,CAAC,SAAS,uBAC9B,OAAO,KACV,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IACvD,CAAE,CACL,CAAC;YACF,IAAI,EAAE,EAAE;gBACN,EAAE,CAAC,GAAG,CAAC,CAAC;aACT;QACH,CAAC,CAAC;QACF,IAAM,aAAa,GAAkB,eAAe,CAClD,OAAO,EACP,gBAAgB,CACjB,CAAC;QACF,IAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACvD,aAAa,CAAC,GAAG,GAAG,UAAC,KAAgD;YACnE,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3C,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC;QAEF,aAAa,CAAC,EAAE,CAAC,UAAU,EAAE,UAAC,QAAyB;YACrD,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE;gBACtB,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACxD,CAAC,CAAC,CAAC;YACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE;gBACjB,gBAAM,CAAC,KAAK,CACV,oBAAa,IAAI,CAAC,SAAS,CAAC;oBAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC;oBACxD,OAAO,EAAE,QAAQ,CAAC,OAAO;oBACzB,UAAU,EAAE,QAAQ,CAAC,UAAU;iBAChC,CAAC,CAAE,CACL,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC,CAAC;AA7CW,QAAA,qBAAqB,yBA6ChC"}

package/{pact.d.ts → src/index.d.ts}

@@ -7,68 +7,69 @@
  * @memberof Pact
  * @static
  */
-export * from "./httpPact";
+/**
+ * Exposes {@link Matchers}
+ * To avoid polluting the root module's namespace, re-export
+ * Matchers as its own module
+ * @memberof Pact
+ * @static
+ */
+import * as MatchersStar from './dsl/matchers';
+export declare const Matchers: typeof MatchersStar;
+export { InterfaceToTemplate } from './dsl/matchers';
+export { Pact } from './httpPact';
 /**
  * Exposes {@link MessageConsumerPact}
  * @memberof Pact
  * @static
  */
-export * from "./messageConsumerPact";
+export * from './messageConsumerPact';
 /**
  * Exposes {@link MessageProviderPact}
  * @memberof Pact
  * @static
  */
-export * from "./messageProviderPact";
+export { MessageProviderPact, providerWithMetadata, } from './messageProviderPact';
 /**
  * Exposes {@link Message}
  * @memberof Pact
  * @static
  */
-export * from "./dsl/message";
+export * from './dsl/message';
 /**
  * Exposes {@link Verifier}
  * @memberof Pact
  * @static
  */
-export * from "./dsl/verifier";
+export * from './dsl/verifier/verifier';
 /**
  * Exposes {@link GraphQL}
  * @memberof Pact
  * @static
  */
-export * from "./dsl/graphql";
+export * from './dsl/graphql';
 /**
  * Exposes {@link ApolloGraphQL}
  * @memberof Pact
  * @static
  */
-export * from "./dsl/apolloGraphql";
-/**
- * Exposes {@link Matchers}
- * To avoid polluting the root module's namespace, re-export
- * Matchers as its owns module
- * @memberof Pact
- * @static
- */
-import * as Matchers from "./dsl/matchers";
-export import Matchers = Matchers;
+export * from './dsl/apolloGraphql';
 /**
  * Exposes {@link Interaction}
  * @memberof Pact
  * @static
  */
-export * from "./dsl/interaction";
+export * from './dsl/interaction';
 /**
  * Exposes {@link MockService}
  * @memberof Pact
  * @static
  */
-export * from "./dsl/mockService";
-export * from "./v3";
+export * from './dsl/mockService';
+export * from './v3';
 /**
- * Exposes {@link Publisher}
+ * Exposes {@link PactOptions}
  * @memberof Pact
  * @static
  */
-export * from "./dsl/publisher";
+export * from './dsl/options';

package/src/index.js

@@ -0,0 +1,107 @@
+"use strict";
+/**
+ * Pact module meta package.
+ * @module Pact
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.providerWithMetadata = exports.MessageProviderPact = exports.Pact = exports.Matchers = void 0;
+/**
+ * Exposes {@link Pact}
+ * @memberof Pact
+ * @static
+ */
+/**
+ * Exposes {@link Matchers}
+ * To avoid polluting the root module's namespace, re-export
+ * Matchers as its own module
+ * @memberof Pact
+ * @static
+ */
+var MatchersStar = __importStar(require("./dsl/matchers"));
+exports.Matchers = MatchersStar;
+var httpPact_1 = require("./httpPact");
+Object.defineProperty(exports, "Pact", { enumerable: true, get: function () { return httpPact_1.Pact; } });
+/**
+ * Exposes {@link MessageConsumerPact}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./messageConsumerPact"), exports);
+/**
+ * Exposes {@link MessageProviderPact}
+ * @memberof Pact
+ * @static
+ */
+var messageProviderPact_1 = require("./messageProviderPact");
+Object.defineProperty(exports, "MessageProviderPact", { enumerable: true, get: function () { return messageProviderPact_1.MessageProviderPact; } });
+Object.defineProperty(exports, "providerWithMetadata", { enumerable: true, get: function () { return messageProviderPact_1.providerWithMetadata; } });
+/**
+ * Exposes {@link Message}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./dsl/message"), exports);
+/**
+ * Exposes {@link Verifier}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./dsl/verifier/verifier"), exports);
+/**
+ * Exposes {@link GraphQL}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./dsl/graphql"), exports);
+/**
+ * Exposes {@link ApolloGraphQL}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./dsl/apolloGraphql"), exports);
+/**
+ * Exposes {@link Interaction}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./dsl/interaction"), exports);
+/**
+ * Exposes {@link MockService}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./dsl/mockService"), exports);
+__exportStar(require("./v3"), exports);
+/**
+ * Exposes {@link PactOptions}
+ * @memberof Pact
+ * @static
+ */
+__exportStar(require("./dsl/options"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH;;;;GAIG;AAEH;;;;;;GAMG;AACH,2DAA+C;AAElC,QAAA,QAAQ,GAAG,YAAY,CAAC;AAIrC,uCAAkC;AAAzB,gGAAA,IAAI,OAAA;AAEb;;;;GAIG;AACH,wDAAsC;AAEtC;;;;GAIG;AACH,6DAG+B;AAF7B,0HAAA,mBAAmB,OAAA;AACnB,2HAAA,oBAAoB,OAAA;AAGtB;;;;GAIG;AACH,gDAA8B;AAE9B;;;;GAIG;AACH,0DAAwC;AAExC;;;;GAIG;AACH,gDAA8B;AAC9B;;;;GAIG;AACH,sDAAoC;AAEpC;;;;GAIG;AACH,oDAAkC;AAElC;;;;GAIG;AACH,oDAAkC;AAElC,uCAAqB;AAErB;;;;GAIG;AACH,gDAA8B"}

package/src/messageConsumerPact.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @module Message
+ */
+/// <reference types="node" />
+import { AnyJson } from './common/jsonTypes';
+import { AnyTemplate } from './dsl/matchers';
+import { Metadata, Message, MessageConsumer, ProviderState } from './dsl/message';
+import { MessageConsumerOptions } from './dsl/options';
+/**
+ * A Message Consumer is analagous to a Provider in the HTTP Interaction model.
+ * It is the receiver of an interaction, and needs to be able to handle whatever
+ * request was provided.
+ */
+export declare class MessageConsumerPact {
+    private config;
+    private state;
+    private pact;
+    private message;
+    constructor(config: MessageConsumerOptions);
+    /**
+     * Gives a state the provider should be in for this Message.
+     *
+     * @param {string} state - The state of the provider.
+     * @returns {Message} MessageConsumer
+     */
+    given(state: string | ProviderState): MessageConsumerPact;
+    /**
+     * A free style description of the Message.
+     *
+     * @param {string} description - A description of the Message to be received
+     * @returns {Message} MessageConsumer
+     */
+    expectsToReceive(description: string): MessageConsumerPact;
+    /**
+     * The JSON object to be received by the message consumer.
+     *
+     * May be a JSON object or JSON primitive. The contents must be able to be properly
+     * strigified and parse (i.e. via JSON.stringify and JSON.parse).
+     *
+     * @param {string} content - A description of the Message to be received
+     * @returns {Message} MessageConsumer
+     */
+    withContent(content: AnyTemplate): MessageConsumerPact;
+    /**
+     * The text content to be received by the message consumer.
+     *
+     * May be any text
+     *
+     * @param {string} content - A description of the Message to be received
+     * @returns {Message} MessageConsumer
+     */
+    withTextContent(content: string, contentType: string): MessageConsumerPact;
+    /**
+     * The binary content to be received by the message consumer.
+     *
+     * Content will be stored in base64 in the resulting pact file.
+     *
+     * @param {Buffer} content - A buffer containing the binary content
+     * @param {String} contenttype - The mime type of the content to expect
+     * @returns {Message} MessageConsumer
+     */
+    withBinaryContent(content: Buffer, contentType: string): MessageConsumerPact;
+    /**
+     * Message metadata.
+     *
+     * @param {string} metadata -
+     * @returns {Message} MessageConsumer
+     */
+    withMetadata(metadata: Metadata): MessageConsumerPact;
+    /**
+     * Creates a new Pact _message_ interaction to build a testable interaction.
+     *
+     * @param handler A message handler, that must be able to consume the given Message
+     * @returns {Promise}
+     */
+    verify(handler: MessageConsumer): Promise<unknown>;
+    private reifiedContent;
+    /**
+     * Returns the Message object created.
+     *
+     * @returns {Message}
+     */
+    json(): Message;
+}
+export declare function synchronousBodyHandler<R>(handler: (body: AnyJson | Buffer) => R): MessageConsumer;
+export declare function asynchronousBodyHandler<R>(handler: (body: AnyJson | Buffer) => Promise<R>): MessageConsumer;