specmatic 0.67.6 → 0.68.1

package/.github/workflows/{npm-publish.yml → publish.yml}

@@ -1,4 +1,4 @@
-name: NPM Publish
+name: publish
 
 on:
   release:
@@ -8,8 +8,8 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: 14
       - run: npm install
@@ -17,7 +17,6 @@ jobs:
       - uses: reedyuk/npm-version@1.1.1
         with:
           version: ${{ github.event.release.tag_name }}
-      - uses: JS-DevTools/npm-publish@v1
+      - uses: JS-DevTools/npm-publish@v2
         with:
-          check-version: true
           token: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Run Tests
+name: test
 
 on:
   push:
@@ -7,11 +7,14 @@ on:
 
 jobs:
     test:
+        strategy:
+          matrix:
+            node-version: [14.x, 16.x, 18.x, 20.x]
         runs-on: ubuntu-latest
         steps:
-          - uses: actions/checkout@v2
-          - uses: actions/setup-node@v2
+          - uses: actions/checkout@v3
+          - uses: actions/setup-node@v3
             with:
-              node-version: 14
+              node-version: ${{ matrix.node-version }}
           - run: npm install
           - run: npm test

package/README.md

@@ -1,8 +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)](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)
+![test](https://github.com/znsio/specmatic-node/actions/workflows/test.yml/badge.svg)
+[![publish](https://github.com/znsio/specmatic-node/actions/workflows/publish.yml/badge.svg)](https://www.npmjs.com/package/specmatic)
+[![release](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.
 
@@ -35,7 +35,7 @@ https://github.com/znsio/specmatic-order-bff-nodejs
 
 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.
 
-```
+```javascript
 import {
     startStub,
     stopStub,
@@ -75,3 +75,9 @@ By default only warning and error messages are displayed. You can configure the
 ```
 
 logLevel accepts all values supported by winston logger (https://github.com/winstonjs/winston#logging-levels)
+
+## Known Issues
+
+### Node 17/18 - Connection Refused error when connecting to stub
+
+Node 18 apparently shifted to IPv6 as first choice for resolving hostname when both IPv4 and IPv6 addresses are available. This means `localhost` most likely resolves to `::1` rather than `127.0.0.1` or `0.0.0.0`. Now specmatic node wrapper does not start the stub server but the java program under the hood does it and java still resolves to IPv4 address by default. Thus localhost on node v18 and java might resolve to a different address and any connection from node to the running stub will fail. To resolve this, until we have a permanent solution, we request to disable any IPv6 address mapping to a named host in your DNS resolver or `/etc/hosts`.

package/dist/bin/core.js

@@ -6,11 +6,15 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _execSh = _interopRequireDefault(require("exec-sh"));
 var _path = _interopRequireDefault(require("path"));
+var _child_process = require("child_process");
+var _fs = _interopRequireDefault(require("fs"));
 var _config = require("../config");
-var _logger = _interopRequireDefault(require("../logger"));
+var _logger = _interopRequireDefault(require("../common/logger"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 var callSpecmaticCli = args => {
-  var specmaticJarPath = _path.default.resolve(_config.specmaticJarPathLocal);
+  var rootPath = _path.default.resolve(__dirname, '..', '..');
+  var specmaticJarPath = _path.default.resolve(rootPath, _config.specmaticJarName);
+  _logger.default.debug("CLI: Specmatic jar path: ".concat(specmaticJarPath));
   var cliArgs = (args || process.argv).slice(2).join(' ');
   _logger.default.info("CLI: Running with args \"".concat(cliArgs, "\""));
   (0, _execSh.default)("java -jar ".concat(specmaticJarPath, " ").concat(cliArgs), {}, err => {
@@ -23,5 +27,32 @@ var callSpecmaticCli = args => {
     }
   });
 };
+function getSpecmaticJarPath() {
+  return new Promise((resolve, _reject) => {
+    var specmaticJarPath = _path.default.resolve(_config.specmaticJarPathLocal);
+    resolve(specmaticJarPath);
+  }).then(specmaticJarPath => {
+    //Get current directory
+    console.log("Script basename: ".concat(__dirname));
+    var rootPath = _path.default.resolve(__dirname, '..', '..');
+    var specmaticJarPath2 = _path.default.resolve(rootPath, _config.specmaticJarName);
+    console.log("Script jar path: ".concat(specmaticJarPath2));
+    console.log("Script jar path exists? ".concat(_fs.default.existsSync(specmaticJarPath2)));
+    if (!_fs.default.existsSync(specmaticJarPath)) {
+      return getGlobalSpecmaticJarPath();
+    } else {
+      return specmaticJarPath;
+    }
+  });
+}
+function getGlobalSpecmaticJarPath() {
+  return new Promise((resolve, _reject) => {
+    (0, _child_process.exec)('npm root -g', (_err, stdout) => {
+      var npmGlobalModuleInstallPath = stdout.replace(/\n/g, '');
+      var jarPath = _path.default.join(npmGlobalModuleInstallPath, 'specmatic', _config.specmaticJarName);
+      resolve(jarPath);
+    });
+  });
+}
 var _default = callSpecmaticCli;
 exports.default = _default;

package/dist/common/logger.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.initLogger = initLogger;
+var _winston = require("winston");
+var _fs = _interopRequireDefault(require("fs"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var logFormat = _winston.format.printf(_ref => {
+  var {
+    level,
+    message,
+    label,
+    timestamp
+  } = _ref;
+  return "[".concat(label, "] ").concat(timestamp, " ").concat(level, ": ").concat(message);
+});
+function getSpecmaticConfig() {
+  var packageJsonPath = './package.json';
+  var specmaticConfig;
+  if (_fs.default.existsSync(packageJsonPath)) {
+    var packageJsonContent;
+    try {
+      packageJsonContent = _fs.default.readFileSync(packageJsonPath);
+    } catch (error) {
+      packageJsonContent = "{}";
+    }
+    var packageConfig = JSON.parse(packageJsonContent);
+    specmaticConfig = packageConfig.specmatic;
+  }
+  return specmaticConfig || {};
+}
+function initLogger() {
+  var specmaticConfig = getSpecmaticConfig();
+  var logger = (0, _winston.createLogger)({
+    level: specmaticConfig.logLevel || 'warn',
+    format: _winston.format.combine(_winston.format.label({
+      label: 'specmatic'
+    }), _winston.format.timestamp({
+      format: 'DD-MM-YYYY HH:mm:ss'
+    }), logFormat),
+    transports: [new _winston.transports.Console()]
+  });
+  return logger;
+}
+var _default = initLogger();
+exports.default = _default;

package/dist/config.js

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

package/dist/lib/index.js

@@ -10,7 +10,7 @@ var _execSh = _interopRequireDefault(require("exec-sh"));
 var _config = require("../config");
 var _fastXmlParser = require("fast-xml-parser");
 var _fs = _interopRequireDefault(require("fs"));
-var _logger = _interopRequireDefault(require("../logger"));
+var _logger = _interopRequireDefault(require("../common/logger"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 var specmaticJarPath = _path.default.resolve(_config.specmaticJarPathLocal);
 var startStub = (host, port, stubDir) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "specmatic",
-  "version": "0.67.6",
+  "version": "0.68.1",
   "description": "Node wrapper for Specmatic",
   "main": "dist/index.js",
   "scripts": {
@@ -31,9 +31,6 @@
       "jest-extended/all"
     ]
   },
-  "specmatic": {
-    "logLevel": "debug"
-  },
   "dependencies": {
     "@babel/cli": "^7.21.5",
     "@babel/core": "^7.21.8",

package/src/bin/__tests__/core.ts

@@ -1,13 +1,35 @@
 import execSh from 'exec-sh';
 import path from 'path';
 import callSpecmaticCli from '../core';
-import { specmaticJarPathLocal } from '../../config';
+import { specmaticJarName, specmaticJarPathLocal } from '../../config';
+import fs from 'fs';
+import { exec } from 'child_process';
 
 jest.mock('exec-sh');
+jest.mock('child_process');
+const execMock = exec as unknown as jest.Mock;
 
-test('arguments to be passed correctly to Specmatic lib', () => {
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+
+test('pass all wrapper arguments to the jar', async () => {
+    jest.spyOn(fs, 'existsSync').mockReturnValue(true);
     const testArgs = ['node', 'index.js', 'stub', '*.specmatic', '--data', 'src/mocks', '--host', 'localhost', '--port', '8000'];
     callSpecmaticCli(testArgs);
-    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPathLocal)} ${testArgs.slice(2).join(' ')}`);
+    const specmaticJarPath = path.resolve(__dirname, '..', '..', '..', specmaticJarName);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(specmaticJarPath)} ${testArgs.slice(2).join(' ')}`);
     expect(execSh).toHaveBeenCalledTimes(1);
 });
+
+// test('look for jar in specmatic globally installled directory when run from global install', async () => {
+//     jest.spyOn(fs, 'existsSync').mockReturnValue(false);
+//     const testArgs = ['node', 'index.js', 'stub', '*.specmatic', '--data', 'src/mocks', '--host', 'localhost', '--port', '8000'];
+//     const NPM_GLOBAL_PATH = '/npm/global/path';
+//     setTimeout(() => {
+//         execMock.mock.calls[0][1](0, NPM_GLOBAL_PATH);
+//     }, 0);
+//     await callSpecmaticCli(testArgs);
+//     expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(NPM_GLOBAL_PATH, 'specmatic', specmaticJarName)} ${testArgs.slice(2).join(' ')}`);
+//     expect(execSh).toHaveBeenCalledTimes(1);
+// });

package/src/bin/core.ts

@@ -1,10 +1,14 @@
 import execSh from 'exec-sh';
 import path from 'path';
-import { specmaticJarPathLocal } from '../config';
-import logger from '../logger';
+import { exec } from 'child_process';
+import fs from 'fs';
+import { specmaticJarPathLocal, specmaticJarName } from '../config';
+import logger from '../common/logger';
 
 const callSpecmaticCli = (args?: string[]) => {
-    const specmaticJarPath = path.resolve(specmaticJarPathLocal);
+    const rootPath = path.resolve(__dirname, '..', '..');
+    const specmaticJarPath = path.resolve(rootPath, specmaticJarName);
+    logger.debug(`CLI: Specmatic jar path: ${specmaticJarPath}`);
     const cliArgs = (args || process.argv).slice(2).join(' ');
     logger.info(`CLI: Running with args "${cliArgs}"`);
     execSh(`java -jar ${specmaticJarPath} ${cliArgs}`, {}, (err: any) => {
@@ -18,4 +22,33 @@ const callSpecmaticCli = (args?: string[]) => {
     });
 };
 
+function getSpecmaticJarPath() {
+    return new Promise<string>((resolve, _reject) => {
+        let specmaticJarPath = path.resolve(specmaticJarPathLocal);
+        resolve(specmaticJarPath);
+    }).then(specmaticJarPath => {
+        //Get current directory
+        console.log(`Script basename: ${__dirname}`);
+        const rootPath = path.resolve(__dirname, '..', '..');
+        const specmaticJarPath2 = path.resolve(rootPath, specmaticJarName);
+        console.log(`Script jar path: ${specmaticJarPath2}`);
+        console.log(`Script jar path exists? ${fs.existsSync(specmaticJarPath2)}`);
+        if (!fs.existsSync(specmaticJarPath)) {
+            return getGlobalSpecmaticJarPath();
+        } else {
+            return specmaticJarPath;
+        }
+    });
+}
+
+function getGlobalSpecmaticJarPath() {
+    return new Promise((resolve, _reject) => {
+        exec('npm root -g', (_err, stdout) => {
+            const npmGlobalModuleInstallPath = stdout.replace(/\n/g, '');
+            const jarPath = path.join(npmGlobalModuleInstallPath, 'specmatic', specmaticJarName);
+            resolve(jarPath);
+        });
+    });
+}
+
 export default callSpecmaticCli;

package/src/common/__tests__/logger.ts

@@ -0,0 +1,64 @@
+import { initLogger } from '../logger';
+
+import fs from 'fs';
+
+beforeEach(() => {
+    jest.resetAllMocks();
+});
+
+test('Logging level is debug as configured in package.json', () => {
+    const packageJsonFileReadSpy = jest.spyOn(fs, 'readFileSync').mockReturnValue(
+        '{\
+            "specmatic": {\
+                "logLevel": "debug"\
+            }\
+        }'
+    );
+    const logger = initLogger();
+    expect(packageJsonFileReadSpy).toHaveBeenCalledTimes(1);
+    expect(logger.level).toBe('debug');
+});
+
+test('Logging level is info as configured in package.json', () => {
+    const packageJsonFileReadSpy = jest.spyOn(fs, 'readFileSync').mockReturnValue(
+        '{\
+            "specmatic": {\
+                "logLevel": "info"\
+            }\
+        }'
+    );
+    const logger = initLogger();
+    expect(packageJsonFileReadSpy).toHaveBeenCalledTimes(1);
+    expect(logger.level).toBe('info');
+});
+
+test('Defaults logging level to warn when logLevel setting does not exist with specmatic configuration', () => {
+    const packageJsonFileReadSpy = jest.spyOn(fs, 'readFileSync').mockReturnValue(
+        '{\
+            "specmatic": {\
+            }\
+        }'
+    );
+    const logger = initLogger();
+    expect(packageJsonFileReadSpy).toHaveBeenCalledTimes(1);
+    expect(logger.level).toBe('warn');
+})
+
+test('Defaults logging level to warn when specmatic configuration does not exist', () => {
+    const packageJsonFileReadSpy = jest.spyOn(fs, 'readFileSync').mockReturnValue(
+        '{\
+        }'
+    );
+    const logger = initLogger();
+    expect(packageJsonFileReadSpy).toHaveBeenCalledTimes(1);
+    expect(logger.level).toBe('warn');
+})
+
+test('Defaults logging level to warn when package.json does not exist', () => {
+    const packageJsonFileReadSpy = jest.spyOn(fs, 'readFileSync').mockImplementation(() => {
+        throw new Error();
+    });
+    const logger = initLogger();
+    expect(packageJsonFileReadSpy).toHaveBeenCalledTimes(1);
+    expect(logger.level).toBe('warn');
+});

package/src/common/logger.ts

@@ -0,0 +1,34 @@
+import { createLogger, format, transports } from 'winston';
+import fs from 'fs';
+
+const logFormat = format.printf(({ level, message, label, timestamp }) => {
+    return `[${label}] ${timestamp} ${level}: ${message}`;
+});
+
+function getSpecmaticConfig() {
+    const packageJsonPath = './package.json';
+    var specmaticConfig;
+    if (fs.existsSync(packageJsonPath)) {
+        let packageJsonContent;
+        try {
+            packageJsonContent = fs.readFileSync(packageJsonPath);
+        } catch (error) {
+            packageJsonContent = "{}";
+        }
+        const packageConfig = JSON.parse(packageJsonContent as unknown as string);
+        specmaticConfig = packageConfig.specmatic;
+    }
+    return specmaticConfig || {};
+}
+
+export function initLogger() {
+    const specmaticConfig = getSpecmaticConfig();
+    const logger = createLogger({
+        level: specmaticConfig.logLevel || 'warn',
+        format: format.combine(format.label({ label: 'specmatic' }), format.timestamp({ format: 'DD-MM-YYYY HH:mm:ss' }), logFormat),
+        transports: [new transports.Console()],
+    });
+    return logger;
+}
+
+export default initLogger();

package/src/config.ts

@@ -1,3 +1,4 @@
-export const specmaticJarPathLocal = './node_modules/specmatic/specmatic.jar';
+export const specmaticJarName = 'specmatic.jar';
+export const specmaticJarPathLocal = `./node_modules/specmatic/${specmaticJarName}`;
 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/lib/index.ts

@@ -5,7 +5,7 @@ import { specmaticJarPathLocal, specmatic } from '../config';
 import { ChildProcess } from 'child_process';
 import { XMLParser } from 'fast-xml-parser';
 import fs from 'fs';
-import logger from '../logger';
+import logger from '../common/logger';
 
 const specmaticJarPath = path.resolve(specmaticJarPathLocal);
 

package/dist/logger.js

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _winston = require("winston");
-var _fs = _interopRequireDefault(require("fs"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-var data = _fs.default.readFileSync('./package.json');
-var packageConfig = JSON.parse(data);
-var specmaticConfig = packageConfig.specmatic || {};
-var logFormat = _winston.format.printf(_ref => {
-  var {
-    level,
-    message,
-    label,
-    timestamp
-  } = _ref;
-  return "[".concat(label, "] ").concat(timestamp, " ").concat(level, ": ").concat(message);
-});
-var _default = (0, _winston.createLogger)({
-  level: specmaticConfig.logLevel || 'warn',
-  format: _winston.format.combine(_winston.format.label({
-    label: 'specmatic'
-  }), _winston.format.timestamp({
-    format: 'DD-MM-YYYY HH:mm:ss'
-  }), logFormat),
-  transports: [new _winston.transports.Console()]
-});
-exports.default = _default;

package/src/logger.ts

@@ -1,16 +0,0 @@
-import { createLogger, format, transports } from 'winston';
-import fs from 'fs';
-
-const data = fs.readFileSync('./package.json');
-const packageConfig = JSON.parse(data as unknown as string);
-const specmaticConfig = packageConfig.specmatic || {};
-
-const logFormat = format.printf(({ level, message, label, timestamp }) => {
-    return `[${label}] ${timestamp} ${level}: ${message}`;
-});
-
-export default createLogger({
-    level: specmaticConfig.logLevel || 'warn',
-    format: format.combine(format.label({ label: 'specmatic' }), format.timestamp({ format: 'DD-MM-YYYY HH:mm:ss' }), logFormat),
-    transports: [new transports.Console()],
-});