specmatic 0.67.1 → 0.67.4

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

@@ -1,17 +1,11 @@
-# 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: publish
+name: NPM Publish
 
 on:
-  workflow_run:
-    workflows: ["test"]
-    types:
-      - completed
+  release:
+    types: [published]
 
 jobs:
-  build-and-publish:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+  publish:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -20,14 +14,9 @@ jobs:
           node-version: 14
       - run: npm install
       - 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
+      - uses: reedyuk/npm-version@1.1.1
         with:
-          package-path: ./package.json
-          release: true
+          version: ${{ github.event.release.tag_name }}
       - uses: JS-DevTools/npm-publish@v1
         with:
           check-version: true

package/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: test
+name: Run Tests
 
 on:
   push:

package/README.md

@@ -38,6 +38,7 @@ import {
     stopStub,
     test, 
     setExpecations,
+    showTestResults,
     printJarVersion
 } from 'specmatic';
 ```
@@ -54,8 +55,8 @@ method to run tests.
 `setExpectations(stubPath: string, stubServerBaseUrl?: string): Promise<boolean>` <br />
 method to dynamically set stub expectiona. Stub should be running before invoking this method.
 
-`showTestResults = (testFn: (name: string, cb: () => void) => void)` <br />
+`showTestResults(testFn: (name: string, cb: () => void) => void)` <br />
 method to report test results in any framework so that it shows up in IDE test results interface.
 
-`printSpecmaticJarVersion()` <br />
+`printJarVersion()` <br />
 method to print the version of specmatic.jar

package/dist/bin/core.js

@@ -11,11 +11,14 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 var callSpecmaticCli = args => {
   var specmaticJarPath = _path.default.resolve(_config.specmaticJarPathLocal);
   var cliArgs = (args || process.argv).slice(2).join(' ');
-  console.log('starting specmatic server', cliArgs);
+  console.log('Running specmatic ', cliArgs);
   (0, _execSh.default)("java -jar ".concat(specmaticJarPath, " ").concat(cliArgs), {}, err => {
     if (err) {
-      console.log('Exit code: ', err.code);
-      process.exit(err.code);
+      console.log('Specmatic finished with non zero exit code: ', err.code);
+      process.exitCode = err.code;
+    } else {
+      console.log('Specmatic finished');
+      process.exitCode = 0;
     }
   });
 };

package/dist/lib/index.js

@@ -92,7 +92,7 @@ exports.test = test;
 var showTestResults = testFn => {
   var testCases = parseJunitXML();
   testCases.map(function (testcase) {
-    var name = testcase['system-out'].trim().replaceAll('\n', '').split('display-name:  Scenario: ')[1].trim();
+    var name = testcase['system-out'].trim().replace(/\n/g, '').split('display-name:  Scenario: ')[1].trim();
     testFn(name, () => {
       if (testcase.failure) throw new Error('Did not pass');
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "specmatic",
-  "version": "0.67.1",
+  "version": "0.67.4",
   "description": "Node wrapper for Specmatic",
   "main": "dist/index.js",
   "scripts": {
@@ -24,25 +24,24 @@
   },
   "homepage": "https://github.com/znsio/specmatic-node#readme",
   "bin": {
-    "specmatic": "dist/bin/index.js",
-    "qontract": "dist/bin/index.js"
+    "specmatic": "dist/bin/index.js"
   },
   "dependencies": {
-    "@babel/cli": "^7.10.5",
-    "@babel/core": "^7.11.4",
-    "@babel/preset-env": "^7.11.0",
-    "@babel/preset-typescript": "^7.10.4",
+    "@babel/cli": "^7.21.5",
+    "@babel/core": "^7.21.8",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.21.5",
     "@types/node": "^20.2.3",
-    "@types/node-fetch": "^2.5.7",
-    "@types/yargs": "^15.0.5",
-    "exec-sh": "^0.3.4",
+    "@types/node-fetch": "^2.6.4",
+    "@types/yargs": "^17.0.24",
+    "exec-sh": "^0.4.0",
     "fast-xml-parser": "^4.2.2",
-    "node-fetch": "^2.6.0",
-    "rimraf": "^3.0.2",
-    "yargs": "^15.4.1"
+    "node-fetch": "^2.6.11",
+    "rimraf": "^5.0.1",
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.24",
+    "@types/jest": "^29.5.1",
     "jest": "^29.5.0",
     "jest-mock-extended": "^3.0.4"
   }

package/src/bin/__tests__/core.ts

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

@@ -6,11 +6,14 @@ const callSpecmaticCli = (args?: string[]) => {
     const specmaticJarPath = path.resolve(specmaticJarPathLocal);
     const cliArgs = (args || process.argv).slice(2).join(' ');
 
-    console.log('starting specmatic server', cliArgs);
+    console.log('Running specmatic ', cliArgs);
     execSh(`java -jar ${specmaticJarPath} ${cliArgs}`, {}, (err: any) => {
         if (err) {
-            console.log('Exit code: ', err.code);
-            process.exit(err.code);
+            console.log('Specmatic finished with non zero exit code: ', err.code);
+            process.exitCode = err.code;
+        } else {
+            console.log('Specmatic finished');
+            process.exitCode = 0;
         }
     });
 };

package/src/lib/__tests__/index.ts

@@ -13,6 +13,8 @@ import mockStub from '../../../test-resources/sample-mock-stub.json';
 jest.mock('exec-sh');
 jest.mock('node-fetch');
 
+const fetchMock = (fetch as unknown as jest.Mock)
+
 const STUB_PATH = 'test-resources/sample-mock-stub.json';
 const CONTRACT_YAML_FILE_PATH = './contracts';
 const STUB_DIR_PATH = './data';
@@ -26,7 +28,7 @@ javaProcessMock.stderr = readableMock;
 
 beforeEach(() => {
     execSh.mockReset();
-    fetch.mockReset();
+    fetchMock.mockReset();
 });
 
 test('startStub method starts the specmatic stub server', async () => {
@@ -164,36 +166,43 @@ test('printJarVersion', () => {
 });
 
 test('setExpectations with default baseUrl', done => {
-    fetch.mockReturnValue(Promise.resolve('{}'));
+    fetchMock.mockReturnValue(Promise.resolve('{}'));
     specmatic.setExpectations(path.resolve(STUB_PATH)).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({
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    expect(fetchMock.mock.calls[0][0]).toBe('http://localhost:9000/_specmatic/expectations');
+    expect(fetchMock.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('{}'));
+    fetchMock.mockReturnValue(Promise.resolve('{}'));
     const stubServerBaseUrl = 'http://localhost:8000/';
     specmatic.setExpectations(path.resolve(STUB_PATH), 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({
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    expect(fetchMock.mock.calls[0][0]).toBe(`${stubServerBaseUrl}_specmatic/expectations`);
+    expect(fetchMock.mock.calls[0][1]).toMatchObject({
         method: 'POST',
         body: JSON.stringify(mockStub),
     });
 });
 
+test('setTestResults invokes the test function', () => {
+    const cb = jest.fn();
+    copyReportFile();
+    specmatic.showTestResults(cb);
+    expect(cb).toHaveBeenCalledTimes(5);
+});
+
 function copyReportFile() {
     copyReportFileWithName('sample-junit-result-multiple.xml');
 }

package/src/lib/index.ts

@@ -78,7 +78,7 @@ const test = (host?: string, port?: string, specs?: string): Promise<{ [k: strin
 const showTestResults = (testFn: (name: string, cb: () => void) => void) => {
     var testCases = parseJunitXML();
     testCases.map(function (testcase: { [id: string]: any }) {
-        var name = testcase['system-out'].trim().replaceAll('\n', '').split('display-name:  Scenario: ')[1].trim();
+        var name = testcase['system-out'].trim().replace(/\n/g, '').split('display-name:  Scenario: ')[1].trim();
         testFn(name, () => {
             if (testcase.failure) throw new Error('Did not pass');
         });