specmatic 0.65.2 → 0.65.3

package/.babelrc

@@ -1,13 +1,13 @@
 {
-    "presets": [
-        "@babel/typescript",
-        [
-            "@babel/preset-env",
-            {
-              "targets": {
-                "esmodules": true
-              }
-            }
-        ],
-    ]
-}
+  "presets": [
+    "@babel/typescript",
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "esmodules": true
+        }
+      }
+    ],
+  ]
+}

package/.github/workflows/npm-publish.yml

@@ -1,15 +1,17 @@
 # This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
 # For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
 
-name: Node.js Package
+name: publish
 
 on:
-  push:
-    branches:
-      - master
+  workflow_run:
+    workflows: ["test"]
+    types:
+      - completed
 
 jobs:
   build-and-publish:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -17,8 +19,15 @@ jobs:
         with:
           node-version: 14
       - run: npm install
-      - run: npm test
       - run: npm run build
+      - run: echo "previous_tag=$(git describe --tags --abbrev=0 2>/dev/null || echo '')" >> $GITHUB_ENV
+      - name: Create Tag
+        id: create_tag
+        uses: jaywcjlove/create-tag-action@main
+        if: env.previous_tag
+        with:
+          package-path: ./package.json
+          release: true
       - uses: JS-DevTools/npm-publish@v1
         with:
           check-version: true

package/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v2
+          - uses: actions/setup-node@v2
+            with:
+              node-version: 14
+          - run: npm install
+          - run: npm test

package/README.md

@@ -1,5 +1,8 @@
 # Specmatic Framework Node Module
 
+![tests](https://github.com/znsio/specmatic-node/actions/workflows/test.yml/badge.svg)
+![publish](https://github.com/znsio/specmatic-node/actions/workflows/npm-publish.yml/badge.svg)
+
 This node module is a thin wrapper over the [standalone executable jar](https://specmatic.in/getting_started.html#setup). All core capabilities are in the main [Specmatic project](https://github.com/znsio/specmatic). The purpose of this wrapper module is to act as a convenience to help with below aspects.
 * Easy installation and upgrade of the jar file in node projects through npm
 * JS helper library which provides to do various setup steps like start, stop the specmatic stub server, installing specs etc. These helpers methods can be used inside a setup file inside a javascript project programmatically instead of using cli scripts.
@@ -21,6 +24,9 @@ Tests for Free – Specmatic parses your API Specification files and based on th
 
 Check [Documentation](https://specmatic.in/documentation.html) for more information on cli commands and arguments.
 
+## Sample Repo
+https://github.com/znsio/specmatic-order-backend-nodejs
+
 ## Programmatic Access
 
 Specmatic JS library exposes some of the commands as methods that can be run programmatically from any javascript testing framework, during setup or test phases.

package/dist/lib/index.js

@@ -62,7 +62,7 @@ var stopStub = javaProcess => {
 
 exports.stopStub = stopStub;
 
-var test = (specs, host, port) => {
+var test = (host, port, specs) => {
   var specsPath = _path.default.resolve(specs + '');
 
   var cmd = "java -jar ".concat(specmaticJarPath, " test");
@@ -88,10 +88,15 @@ var setExpectations = (stubPath, stubServerBaseUrl) => {
   var stubResponse = require(_path.default.resolve(stubPath));
 
   console.log('Setting expectations');
-  (0, _nodeFetch.default)("".concat(stubServerBaseUrl ? stubServerBaseUrl : "http://localhost:9000/", "_specmatic/expectations"), {
-    method: 'POST',
-    body: JSON.stringify(stubResponse)
-  }).then(json => console.log(json));
+  return new Promise((resolve, _reject) => {
+    (0, _nodeFetch.default)("".concat(stubServerBaseUrl ? stubServerBaseUrl : "http://localhost:9000/", "_specmatic/expectations"), {
+      method: 'POST',
+      body: JSON.stringify(stubResponse)
+    }).then(json => {
+      console.log(json);
+      resolve(true);
+    });
+  });
 };
 
 exports.setExpectations = setExpectations;

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "specmatic",
-  "version": "0.65.2",
+  "version": "0.65.3",
   "description": "Node wrapper for Specmatic",
   "main": "dist/index.js",
   "scripts": {
     "test": "jest",
-    "build": "npm test && rimraf dist && ./node_modules/.bin/babel src --extensions '.ts,.js' --ignore '**/__tests__/*.ts' -d dist",
-    "build-and-publish-patch": "npm run build && npm version patch && npm publish",
-    "build-and-publish-minor": "npm run build && npm version minor && npm publish",
-    "build-and-publish-major": "npm run build && npm version major && npm publish"
+    "build": "npm test && rimraf dist && ./node_modules/.bin/babel src --extensions '.ts,.js' --ignore '**/__tests__/*.ts' -d dist"
   },
   "repository": {
     "type": "git",

package/src/app.d.ts

@@ -1 +1 @@
-declare module 'exec-sh';
+declare module 'exec-sh';

package/src/bin/__tests__/core.ts

@@ -6,8 +6,8 @@ import { specmaticJarPathLocal } from '../../config';
 jest.mock('exec-sh');
 
 test('arguments to be passed correctly to Specmatic lib', () => {
-  const testArgs = ['node', 'index.js', 'stub', '*.specmatic', '--data', 'src/mocks', '--host', 'localhost', '--port', '8000'];
-  startSpecmaticServer(testArgs);
-  expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} ${testArgs.slice(2).join(' ')}`);
-  expect(execSh).toHaveBeenCalledTimes(1);
+    const testArgs = ['node', 'index.js', 'stub', '*.specmatic', '--data', 'src/mocks', '--host', 'localhost', '--port', '8000'];
+    startSpecmaticServer(testArgs);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} ${testArgs.slice(2).join(' ')}`);
+    expect(execSh).toHaveBeenCalledTimes(1);
 });

package/src/bin/core.ts

@@ -3,20 +3,16 @@ import path from 'path';
 import { specmaticJarPathLocal } from '../config';
 
 const callSpecmaticCli = (args?: string[]) => {
-  const specmaticJarPath = path.resolve(specmaticJarPathLocal);
-  const cliArgs = (args || process.argv).slice(2).join(' ');
+    const specmaticJarPath = path.resolve(specmaticJarPathLocal);
+    const cliArgs = (args || process.argv).slice(2).join(' ');
 
-  console.log('starting specmatic server', cliArgs)
-  execSh(
-    `java -jar ${specmaticJarPath} ${cliArgs}`,
-    {},
-    (err: any) => {
-      if (err) {
-        console.log('Exit code: ', err.code);
-        process.exit(err.code);
-      }
-    }
-  );
+    console.log('starting specmatic server', cliArgs);
+    execSh(`java -jar ${specmaticJarPath} ${cliArgs}`, {}, (err: any) => {
+        if (err) {
+            console.log('Exit code: ', err.code);
+            process.exit(err.code);
+        }
+    });
 };
 
-export default callSpecmaticCli;
+export default callSpecmaticCli;

package/src/bin/index.ts

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
 import callSpecmaticCli from './core';
 
-callSpecmaticCli();
+callSpecmaticCli();

package/src/config.ts

@@ -1,3 +1,3 @@
 export const specmaticJarPathLocal = './node_modules/specmatic/specmatic.jar';
 export const specmaticJarPathRemote = 'https://github.com/znsio/specmatic/releases/download/0.24.2/specmatic.jar';
-export const specmatic = 'specmatic.json'
+export const specmatic = 'specmatic.json'

package/src/index.ts

@@ -1,7 +1 @@
-export {
-    startStub,
-    stopStub,
-    test,
-    setExpectations,
-    printJarVersion
-} from './lib';
+export { startStub, stopStub, test, setExpectations, printJarVersion } from './lib';

package/src/lib/__tests__/index.ts

@@ -3,120 +3,146 @@ import fetch from 'node-fetch';
 import path from 'path';
 import { ChildProcess } from 'child_process';
 import { mock as jestMock } from 'jest-mock-extended';
-import { Readable } from "stream";
+import { Readable } from 'stream';
 
 import * as specmatic from '../';
 import { startStub, stopStub, printJarVersion, setExpectations } from '../';
 import { specmaticJarPathLocal } from '../../config';
-import mockStub from '../../../mockStub.json';
+import mockStub from '../../../sample-mock-stub.json';
 
 jest.mock('exec-sh');
 jest.mock('node-fetch');
 
-const contractsPath = './contracts';
-const stubDataPath = './data';
-const host = 'localhost';
-const port = '8000';
+const CONTRACT_YAML_FILE_PATH = './contracts';
+const STUB_DIR_PATH = './data';
+const HOST = 'localhost';
+const PORT = '8000';
+
 const javaProcessMock = jestMock<ChildProcess>();
 const readableMock = jestMock<Readable>();
 javaProcessMock.stdout = readableMock;
 javaProcessMock.stderr = readableMock;
 
 beforeEach(() => {
-  execSh.mockReset();
-  fetch.mockReset();
+    execSh.mockReset();
+    fetch.mockReset();
 });
 
 test('startStub method starts the specmatic stub server', async () => {
-  execSh.mockReturnValue(javaProcessMock);
+    execSh.mockReturnValue(javaProcessMock);
 
-  startStub(host, port, stubDataPath).then(javaProcess => {
-    expect(javaProcess).toBe(javaProcessMock);
-  })
+    startStub(HOST, PORT, STUB_DIR_PATH).then(javaProcess => {
+        expect(javaProcess).toBe(javaProcessMock);
+    });
 
-  readableMock.on.mock.calls[0][1]("Stub server is running");
+    readableMock.on.mock.calls[0][1]('Stub server is running');
 
-  expect(execSh).toHaveBeenCalledTimes(1);
-  expect(execSh.mock.calls[0][0])
-  .toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} stub --data=${path.resolve(stubDataPath)} --host=${host} --port=${port}`);
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(
+        `java -jar ${path.resolve(specmaticJarPathLocal)} stub --data=${path.resolve(STUB_DIR_PATH)} --host=${HOST} --port=${PORT}`
+    );
 });
 
 test('startStub method stubDir is optional', async () => {
-  execSh.mockReturnValue(javaProcessMock);
+    execSh.mockReturnValue(javaProcessMock);
 
-  startStub(host, port).then(javaProcess => {
-    expect(javaProcess).toBe(javaProcessMock);
-  })
+    startStub(HOST, PORT).then(javaProcess => {
+        expect(javaProcess).toBe(javaProcessMock);
+    });
 
-  readableMock.on.mock.calls[0][1]("Stub server is running");
+    readableMock.on.mock.calls[0][1]('Stub server is running');
 
-  expect(execSh).toHaveBeenCalledTimes(1);
-  expect(execSh.mock.calls[0][0])
-    .toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} stub --host=${host} --port=${port}`);
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} stub --host=${HOST} --port=${PORT}`);
 });
 
 test('startStub method host and port are optional', async () => {
-  execSh.mockReturnValue(javaProcessMock);
+    execSh.mockReturnValue(javaProcessMock);
 
-  startStub().then(javaProcess => {
-    expect(javaProcess).toBe(javaProcessMock);
-  })
+    startStub().then(javaProcess => {
+        expect(javaProcess).toBe(javaProcessMock);
+    });
 
-  readableMock.on.mock.calls[0][1]("Stub server is running");
+    readableMock.on.mock.calls[0][1]('Stub server is running');
 
-  expect(execSh).toHaveBeenCalledTimes(1);
-  expect(execSh.mock.calls[0][0])
-    .toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} stub`);
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} stub`);
 });
 
 test('stopStub method stops any running stub server', () => {
-  stopStub(javaProcessMock);
+    stopStub(javaProcessMock);
 
-  expect(readableMock.removeAllListeners).toHaveBeenCalledTimes(2);
-  expect(javaProcessMock.removeAllListeners).toHaveBeenCalledTimes(1);
-  expect(javaProcessMock.kill).toHaveBeenCalledTimes(1);
+    expect(readableMock.removeAllListeners).toHaveBeenCalledTimes(2);
+    expect(javaProcessMock.removeAllListeners).toHaveBeenCalledTimes(1);
+    expect(javaProcessMock.kill).toHaveBeenCalledTimes(1);
 });
 
 test('test runs the contract tests', function (done) {
-    specmatic.test(contractsPath, host, port).then(result => {
-      expect(result).toBeTruthy();
-      done();
+    specmatic.test(HOST, PORT, CONTRACT_YAML_FILE_PATH).then(result => {
+        expect(result).toBeTruthy();
+        done();
+    });
+    execSh.mock.calls[0][2](); //Execute the callback
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(
+        `java -jar ${path.resolve(specmaticJarPathLocal)} test ${path.resolve(CONTRACT_YAML_FILE_PATH)} --host=${HOST} --port=${PORT}`
+    );
+});
+
+test('test runs the contract tests with host and port optional', function (done) {
+    specmatic.test().then(result => {
+        expect(result).toBeTruthy();
+        done();
     });
     execSh.mock.calls[0][2](); //Execute the callback
     expect(execSh).toHaveBeenCalledTimes(1);
-    expect(execSh.mock.calls[0][0])
-      .toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} test ${path.resolve(contractsPath)} --host=${host} --port=${port}`);
-  });
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} test`);
+});
+
+test('test runs the contract tests with contracts path optional', function (done) {
+    specmatic.test(HOST, PORT).then(result => {
+        expect(result).toBeTruthy();
+        done();
+    });
+    execSh.mock.calls[0][2](); //Execute the callback
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} test --host=${HOST} --port=${PORT}`);
+});
 
 test('printJarVersion', () => {
-  printJarVersion();
+    printJarVersion();
 
-  expect(execSh).toHaveBeenCalledTimes(1);
-  expect(execSh.mock.calls[0][0])
-    .toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} --version`);
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} --version`);
 });
 
-test('setExpectations with default baseUrl', () => {
-  fetch.mockReturnValue(Promise.resolve("{}"));
-  setExpectations(path.resolve('./mockStub.json'));
+test('setExpectations with default baseUrl', done => {
+    fetch.mockReturnValue(Promise.resolve('{}'));
+    setExpectations(path.resolve('./sample-mock-stub.json')).then(result => {
+        expect(result).toBeTruthy();
+        done();
+    });
 
-  expect(fetch).toHaveBeenCalledTimes(1);
-  expect(fetch.mock.calls[0][0]).toBe('http://localhost:9000/_specmatic/expectations');
-  expect(fetch.mock.calls[0][1]).toMatchObject({
-    method: 'POST',
-    body: JSON.stringify(mockStub)
-  });
+    expect(fetch).toHaveBeenCalledTimes(1);
+    expect(fetch.mock.calls[0][0]).toBe('http://localhost:9000/_specmatic/expectations');
+    expect(fetch.mock.calls[0][1]).toMatchObject({
+        method: 'POST',
+        body: JSON.stringify(mockStub),
+    });
 });
 
-test('setExpectations with a different baseUrl for the stub server', () => {
-  fetch.mockReturnValue(Promise.resolve("{}"));
-  const stubServerBaseUrl = 'http://localhost:8000/'
-  setExpectations(path.resolve('./mockStub.json'), stubServerBaseUrl);
-
-  expect(fetch).toHaveBeenCalledTimes(1);
-  expect(fetch.mock.calls[0][0]).toBe(`${stubServerBaseUrl}_specmatic/expectations`);
-  expect(fetch.mock.calls[0][1]).toMatchObject({
-    method: 'POST',
-    body: JSON.stringify(mockStub)
-  });
+test('setExpectations with a different baseUrl for the stub server', done => {
+    fetch.mockReturnValue(Promise.resolve('{}'));
+    const stubServerBaseUrl = 'http://localhost:8000/';
+    setExpectations(path.resolve('./sample-mock-stub.json'), stubServerBaseUrl).then(result => {
+        expect(result).toBeTruthy();
+        done();
+    });
+
+    expect(fetch).toHaveBeenCalledTimes(1);
+    expect(fetch.mock.calls[0][0]).toBe(`${stubServerBaseUrl}_specmatic/expectations`);
+    expect(fetch.mock.calls[0][1]).toMatchObject({
+        method: 'POST',
+        body: JSON.stringify(mockStub),
+    });
 });

package/src/lib/index.ts

@@ -6,7 +6,7 @@ import { ChildProcess } from 'child_process';
 
 const specmaticJarPath = path.resolve(specmaticJarPathLocal);
 
-const startStub = (host?: string, port?: string, stubDir?: string) : Promise<ChildProcess> => {
+const startStub = (host?: string, port?: string, stubDir?: string): Promise<ChildProcess> => {
     const stubs = path.resolve(stubDir + '');
 
     var cmd = `java -jar ${specmaticJarPath} stub`;
@@ -25,7 +25,7 @@ const startStub = (host?: string, port?: string, stubDir?: string) : Promise<Chi
         javaProcess.stdout.on('data', function (data: String) {
             console.log('STDOUT: ' + data);
             if (data.indexOf('Stub server is running') > -1) {
-              resolve(javaProcess);
+                resolve(javaProcess);
             }
         });
         javaProcess.stderr.on('data', function (data: String) {
@@ -42,7 +42,7 @@ const stopStub = (javaProcess: ChildProcess) => {
     javaProcess.kill();
 };
 
-const test = (specs?: string, host?: string, port?: string): Promise<boolean> => {
+const test = (host?: string, port?: string, specs?: string): Promise<boolean> => {
     const specsPath = path.resolve(specs + '');
 
     var cmd = `java -jar ${specmaticJarPath} test`;
@@ -63,14 +63,20 @@ const test = (specs?: string, host?: string, port?: string): Promise<boolean> =>
     });
 };
 
-const setExpectations = (stubPath: string, stubServerBaseUrl?: string) => {
+const setExpectations = (stubPath: string, stubServerBaseUrl?: string): Promise<boolean> => {
     const stubResponse = require(path.resolve(stubPath));
 
     console.log('Setting expectations');
-    fetch(`${stubServerBaseUrl ? stubServerBaseUrl : `http://localhost:9000/`}_specmatic/expectations`, {
-        method: 'POST',
-        body: JSON.stringify(stubResponse),
-    }).then(json => console.log(json));
+
+    return new Promise((resolve, _reject) => {
+        fetch(`${stubServerBaseUrl ? stubServerBaseUrl : `http://localhost:9000/`}_specmatic/expectations`, {
+            method: 'POST',
+            body: JSON.stringify(stubResponse),
+        }).then(json => {
+            console.log(json);
+            resolve(true);
+        });
+    });
 };
 
 const printJarVersion = () => {