specmatic 0.65.2 → 0.67.0

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,9 @@
 # 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)](https://www.npmjs.com/package/specmatic)
+[![GitHub release badge](https://badgen.net/github/release/znsio/specmatic-node/master)](https://github.com/znsio/specmatic-node/releases/latest)
+
 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 +25,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-bff-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.
@@ -41,10 +48,10 @@ method to start the stub server.
 `stopStub(process: ChildProcess)` <br />
 method to stop the stub server.
 
-`test(specs?: string, host?: string, port?: string): Promise<boolean>` <br />
+`test(host?: string, port?: string, specs?: string): Promise<boolean>` <br />
 method to run tests.
 
-`setExpectations(stubPath: string, stubServerBaseUrl?: string)` <br />
+`setExpectations(stubPath: string, stubServerBaseUrl?: string): Promise<boolean>` <br />
 method to dynamically set stub expectiona. Stub should be running before invoking this method.
 
 `printSpecmaticJarVersion()` <br />

package/dist/bin/index.js

@@ -1,8 +1,6 @@
 #!/usr/bin/env node
 "use strict";
 
-var _core = _interopRequireDefault(require("./core"));
-
+var _core = _interopRequireDefault(require("../lib/core"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 (0, _core.default)();

package/dist/config.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.specmatic = exports.specmaticJarPathRemote = exports.specmaticJarPathLocal = void 0;
+exports.specmaticJarPathRemote = exports.specmaticJarPathLocal = exports.specmatic = void 0;
 var specmaticJarPathLocal = './node_modules/specmatic/specmatic.jar';
 exports.specmaticJarPathLocal = specmaticJarPathLocal;
 var specmaticJarPathRemote = 'https://github.com/znsio/specmatic/releases/download/0.24.2/specmatic.jar';

package/dist/index.js

@@ -3,35 +3,40 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "startStub", {
+Object.defineProperty(exports, "printJarVersion", {
   enumerable: true,
   get: function get() {
-    return _lib.startStub;
+    return _lib.printJarVersion;
   }
 });
-Object.defineProperty(exports, "stopStub", {
+Object.defineProperty(exports, "setExpectations", {
   enumerable: true,
   get: function get() {
-    return _lib.stopStub;
+    return _lib.setExpectations;
   }
 });
-Object.defineProperty(exports, "test", {
+Object.defineProperty(exports, "showTestResults", {
   enumerable: true,
   get: function get() {
-    return _lib.test;
+    return _lib.showTestResults;
   }
 });
-Object.defineProperty(exports, "setExpectations", {
+Object.defineProperty(exports, "startStub", {
   enumerable: true,
   get: function get() {
-    return _lib.setExpectations;
+    return _lib.startStub;
   }
 });
-Object.defineProperty(exports, "printJarVersion", {
+Object.defineProperty(exports, "stopStub", {
   enumerable: true,
   get: function get() {
-    return _lib.printJarVersion;
+    return _lib.stopStub;
+  }
+});
+Object.defineProperty(exports, "test", {
+  enumerable: true,
+  get: function get() {
+    return _lib.test;
   }
 });
-
 var _lib = require("./lib");

package/dist/{bin → lib}/core.js

@@ -4,18 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _execSh = _interopRequireDefault(require("exec-sh"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _config = require("../config");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var callSpecmaticCli = args => {
   var specmaticJarPath = _path.default.resolve(_config.specmaticJarPathLocal);
-
   var cliArgs = (args || process.argv).slice(2).join(' ');
   console.log('starting specmatic server', cliArgs);
   (0, _execSh.default)("java -jar ".concat(specmaticJarPath, " ").concat(cliArgs), {}, err => {
@@ -25,6 +19,5 @@ var callSpecmaticCli = args => {
     }
   });
 };
-
 var _default = callSpecmaticCli;
 exports.default = _default;

package/dist/lib/index.js

@@ -3,28 +3,23 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.printJarVersion = exports.setExpectations = exports.test = exports.stopStub = exports.startStub = void 0;
-
+exports.test = exports.stopStub = exports.startStub = exports.showTestResults = exports.setExpectations = exports.printJarVersion = void 0;
 var _nodeFetch = _interopRequireDefault(require("node-fetch"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _execSh = _interopRequireDefault(require("exec-sh"));
-
 var _config = require("../config");
-
+var _fastXmlParser = require("fast-xml-parser");
+var _fs = _interopRequireDefault(require("fs"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 var specmaticJarPath = _path.default.resolve(_config.specmaticJarPathLocal);
-
 var startStub = (host, port, stubDir) => {
   var stubs = _path.default.resolve(stubDir + '');
-
   var cmd = "java -jar ".concat(specmaticJarPath, " stub");
   if (stubDir) cmd += " --data=".concat(stubs);
   if (host) cmd += " --host=".concat(host);
   if (port) cmd += " --port=".concat(port);
-  console.log(cmd);
+  // console.log(cmd);
+
   console.log('Starting specmatic stub server');
   return new Promise((resolve, _reject) => {
     var javaProcess = (0, _execSh.default)(cmd, {
@@ -36,9 +31,9 @@ var startStub = (host, port, stubDir) => {
       }
     });
     javaProcess.stdout.on('data', function (data) {
-      console.log('STDOUT: ' + data);
-
+      // console.log('STDOUT: ' + data);
       if (data.indexOf('Stub server is running') > -1) {
+        console.log('STDOUT: ' + data);
         resolve(javaProcess);
       }
     });
@@ -47,55 +42,71 @@ var startStub = (host, port, stubDir) => {
     });
   });
 };
-
 exports.startStub = startStub;
-
 var stopStub = javaProcess => {
   var _javaProcess$stdout, _javaProcess$stderr;
-
-  console.log("Stopping specmatic server");
+  console.log("Stopping specmatic stub server");
   (_javaProcess$stdout = javaProcess.stdout) === null || _javaProcess$stdout === void 0 ? void 0 : _javaProcess$stdout.removeAllListeners();
   (_javaProcess$stderr = javaProcess.stderr) === null || _javaProcess$stderr === void 0 ? void 0 : _javaProcess$stderr.removeAllListeners();
   javaProcess.removeAllListeners('close');
   javaProcess.kill();
 };
-
 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");
   if (specs) cmd += " ".concat(specsPath);
+  cmd += ' --junitReportDir=dist/test-report';
   if (host) cmd += " --host=".concat(host);
   if (port) cmd += " --port=".concat(port);
-  console.log(cmd);
+  // console.log(cmd);
+
   console.log('Running specmatic tests');
+  var reportDir = _path.default.resolve('dist/test-report');
+  _fs.default.rmSync(reportDir, {
+    recursive: true,
+    force: true
+  });
   return new Promise((resolve, _reject) => {
-    (0, _execSh.default)(cmd, {}, err => {
-      if (err) {
-        console.error('Specmatic test run failed with error', err);
-      }
-
-      resolve(err == null);
+    (0, _execSh.default)(cmd, {
+      stdio: 'pipe',
+      stderr: 'pipe'
+    }, err => {
+      // if (err) {
+      //     console.error('Specmatic test run failed with error', err);
+      // }
+      var testCases = parseJunitXML();
+      var total = testCases.length;
+      var success = testCases.filter(testcase => testcase['system-out'] && !testcase['failure']).length;
+      var failure = testCases.filter(testcase => testcase['failure']).length;
+      var result = new TestResult(total, success, failure);
+      resolve(result);
     });
   });
 };
-
 exports.test = test;
-
+var showTestResults = cb => {
+  var testCases = parseJunitXML();
+  testCases.map(function (testcase) {
+    var name = testcase['system-out'].trim().replaceAll('\n', '').split('display-name:  Scenario: ')[1].trim();
+    cb(name, !testcase.failure);
+  });
+};
+exports.showTestResults = showTestResults;
 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('Setting expectations complete');
+      resolve(true);
+    });
+  });
 };
-
 exports.setExpectations = setExpectations;
-
 var printJarVersion = () => {
   (0, _execSh.default)("java -jar ".concat(specmaticJarPath, " --version"), {}, err => {
     if (err) {
@@ -103,5 +114,19 @@ var printJarVersion = () => {
     }
   });
 };
-
-exports.printJarVersion = printJarVersion;
+exports.printJarVersion = printJarVersion;
+var parseJunitXML = () => {
+  var reportPath = _path.default.resolve('dist/test-report/TEST-junit-jupiter.xml');
+  var data = _fs.default.readFileSync(reportPath);
+  var parser = new _fastXmlParser.XMLParser();
+  var resultXml = parser.parse(data);
+  resultXml.testsuite.testcase = Array.isArray(resultXml.testsuite.testcase) ? resultXml.testsuite.testcase : [resultXml.testsuite.testcase];
+  return resultXml.testsuite.testcase;
+};
+class TestResult {
+  constructor(count, success, failure) {
+    this.count = count;
+    this.success = success;
+    this.failure = failure;
+  }
+}

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "specmatic",
-  "version": "0.65.2",
+  "version": "0.67.0",
   "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",
@@ -35,16 +32,18 @@
     "@babel/core": "^7.11.4",
     "@babel/preset-env": "^7.11.0",
     "@babel/preset-typescript": "^7.10.4",
+    "@types/node": "^20.2.3",
     "@types/node-fetch": "^2.5.7",
     "@types/yargs": "^15.0.5",
     "exec-sh": "^0.3.4",
+    "fast-xml-parser": "^4.2.2",
     "node-fetch": "^2.6.0",
     "rimraf": "^3.0.2",
     "yargs": "^15.4.1"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.14",
-    "jest": "^26.4.2",
+    "@types/jest": "^26.0.24",
+    "jest": "^29.5.0",
     "jest-mock-extended": "^3.0.4"
   }
 }

package/src/app.d.ts

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

package/src/bin/__tests__/core.ts

@@ -1,13 +1,13 @@
 import execSh from 'exec-sh';
 import path from 'path';
-import startSpecmaticServer from '../core';
+import startSpecmaticServer from '../../lib/core';
 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/index.ts

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
-import callSpecmaticCli from './core';
+import callSpecmaticCli from '../lib/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, showTestResults } from './lib';