specmatic 0.70.0 → 0.70.2

package/CONTRIBUTING.MD

@@ -1,6 +1,8 @@
 # Contributing
 
-Thanks for being willing to contribute!
+Thanks for your willingness to contribute!
+
+Please check [open issues](https://github.com/znsio/specmatic-node/issues?q=is%3Aopen+is%3Aissue). Please respond to questions/bug reports/feature requests!
 
 ## Project setup
 
@@ -29,53 +31,27 @@ Please make sure to run the tests before you commit your changes by using the co
 
 `npm test`
 
-Build the dist files using
+Build the dist files locally once to make sure build works
 
 `npm run build`
 
-
-### Update Typings
-
-If your PR introduced some changes in the API, you are more than welcome to
-modify the Typescript type definition to reflect those changes. Just modify the
-`/types/index.d.ts` file accordingly. If you have never seen Typescript
-definitions before, you can read more about it in its
-[documentation pages](https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html).
-Though this library itself is not written in Typescript we use
-[dtslint](https://github.com/microsoft/dtslint) to lint our typings.
-
+Finally commit
 
 ## Publishing a new version to npm
 
 ### Prerequisites
-* Access to push to master. 
-* Node version > 14 is needed.
-
-### Step 1: Make the changes
-If there is a new version available in [specmatic downloads](https://specmatic.in/download/), download it in the project root, replacing the older version. Commit the new version.
-
-### Step 2: Update node module's version
-`npm version` displays the existing version of the npm module.
-
-Use the suitable command to auto increment the npm version:
-
-`npm version major`
-
-`npm version minor`
-
-`npm version patch`
-
-OR
-
-Update the version to a specific semver by using command `npm version x.y.z`
-
-### Step 3: Publish to npm
-If the version updated in step 2 is different from the one available in npm global repository, push to remote master on github will automatically build, run the tests and publish the new version to npm. You can check the status of the publish in [github actions](https://github.com/znsio/specmatic-node/actions). Though, it might take some time to reflect in the [specmatic npm page](https://www.npmjs.com/package/specmatic) because of the npm caching.
-
+* Push access to master branch 
+* Node version 14 or higher
 
-## Help needed
+### Step 1: Update specmatic core jar
+If there is a new version available in [latest github release](https://github.com/znsio/specmatic/releases/latest), download it in the project root, replacing the older version. Commit the new version.
 
-Please checkout the [the open issues][issues]
+### Step 2: Make a release via github releases
+* Goto [github releases](https://github.com/znsio/specmatic-node/releases) and draft a new release
+* Click `choose a tag` and enter the required version. If the tag exists then you might be releasing a wrong version. Reverify the tag and version number. Ideally the tag should not exist as this is a new version and thus you should be presented with option to `+ Create new tag: <version> on publish` option. Click it.
+* Give a release title of format `v<version>`. 
+* Describe the changes in this release briefly
+* You can either save this draft and come back later to publish it or publish it now.
+* On publish, a github action is triggered that updates the release on npm repository.
 
-Also, please watch the repo and respond to questions/bug reports/feature
-requests! Thanks!
+You can check the publish status in [github actions](https://github.com/znsio/specmatic-node/actions). Though, it might take some time to reflect in the [specmatic npm page](https://www.npmjs.com/package/specmatic) because of the npm caching.

package/README.md

@@ -58,14 +58,14 @@ import {
 } from 'specmatic';
 ```
 
-`startStub(host?: string, port?: string, stubDir?: string) : Promise<ChildProcess>` <br />
-Start the stub server
+`startStub(host?: string, port?: number, args?: (string | number)[]): Promise<Stub>` <br />
+Start the stub server. Argument `args` values are passed directly to specmatic jar executable.
 
-`stopStub(process: ChildProcess)` <br />
+`stopStub(stub: Stub)` <br />
 Stop the stub server
 
-`test(host?: string, port?: string, specs?: string): Promise<boolean>` <br />
-Run tests
+`test(host?: string, port?: string, contractPath?: string, args?: (string | number)[]): Promise<{ [k: string]: number } | undefined>` <br />
+Run tests. Argument `args` values are passed directly to specmatic jar executable.
 
 `setExpectations(stubPath: string, stubServerBaseUrl?: string): Promise<boolean>` <br />
 Set stub expectiona. Stub should be running before invoking this method.

package/dist/lib/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.test = exports.stopStub = exports.startStub = exports.showTestResults = exports.setExpectations = exports.printJarVersion = void 0;
+exports.test = exports.stopStub = exports.startStub = exports.showTestResults = exports.setExpectations = exports.printJarVersion = exports.Stub = void 0;
 var _nodeFetch = _interopRequireDefault(require("node-fetch"));
 var _path = _interopRequireDefault(require("path"));
 var _fastXmlParser = require("fast-xml-parser");
@@ -11,12 +11,27 @@ var _fs = _interopRequireDefault(require("fs"));
 var _logger = _interopRequireDefault(require("../common/logger"));
 var _runner = _interopRequireDefault(require("../common/runner"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-var startStub = (host, port, stubDir) => {
-  var stubs = _path.default.resolve(stubDir + '');
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+class Stub {
+  constructor(host, port, url, process) {
+    _defineProperty(this, "host", void 0);
+    _defineProperty(this, "port", void 0);
+    _defineProperty(this, "url", void 0);
+    _defineProperty(this, "process", void 0);
+    this.host = host;
+    this.port = port;
+    this.url = url;
+    this.process = process;
+  }
+}
+exports.Stub = Stub;
+var startStub = (host, port, args) => {
   var cmd = "stub";
-  if (stubDir) cmd += " --data=".concat(stubs);
   if (host) cmd += " --host=".concat(host);
   if (port) cmd += " --port=".concat(port);
+  if (args) cmd += ' ' + args.join(' ');
   _logger.default.info('Stub: Starting server');
   _logger.default.debug("Stub: Executing \"".concat(cmd, "\""));
   return new Promise((resolve, reject) => {
@@ -28,7 +43,13 @@ var startStub = (host, port, stubDir) => {
       if (!error) {
         if (message.indexOf('Stub server is running') > -1) {
           _logger.default.info("Stub: ".concat(message));
-          resolve(javaProcess);
+          var stubInfo = message.split('on');
+          if (stubInfo.length < 2) reject();else {
+            var _urlInfo$length;
+            var url = stubInfo[1].trim();
+            var urlInfo = /(.*?):\/\/(.*?):([0-9]+)/.exec(url);
+            if (((_urlInfo$length = urlInfo === null || urlInfo === void 0 ? void 0 : urlInfo.length) !== null && _urlInfo$length !== void 0 ? _urlInfo$length : 0) < 4) reject();else resolve(new Stub(urlInfo[2], parseInt(urlInfo[3]), urlInfo[0], javaProcess));
+          }
         } else if (message.indexOf('Address already in use') > -1) {
           _logger.default.error("Stub: ".concat(message));
           reject();
@@ -42,23 +63,25 @@ var startStub = (host, port, stubDir) => {
   });
 };
 exports.startStub = startStub;
-var stopStub = javaProcess => {
+var stopStub = stub => {
   var _javaProcess$stdout, _javaProcess$stderr;
-  _logger.default.debug('Stopping stub server');
+  _logger.default.debug("Stopping stub server at ".concat(stub.url));
+  var javaProcess = stub.process;
   (_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();
-  _logger.default.info('Stopped stub server');
+  _logger.default.info("Stopped stub server at ".concat(stub.url));
 };
 exports.stopStub = stopStub;
-var test = (host, port, specs) => {
-  var specsPath = _path.default.resolve(specs + '');
+var test = (host, port, contractPath, args) => {
+  var specsPath = _path.default.resolve(contractPath + '');
   var cmd = "test";
-  if (specs) cmd += " ".concat(specsPath);
+  if (contractPath) cmd += " ".concat(specsPath);
   cmd += ' --junitReportDir=dist/test-report';
   if (host) cmd += " --host=".concat(host);
   if (port) cmd += " --port=".concat(port);
+  if (args) cmd += ' ' + args.join(' ');
   _logger.default.info('Test: Running');
   _logger.default.debug("Test: Executing \"".concat(cmd, "\""));
   var reportDir = _path.default.resolve('dist/test-report');
@@ -101,9 +124,10 @@ var showTestResults = testFn => {
 exports.showTestResults = showTestResults;
 var setExpectations = (stubPath, stubServerBaseUrl) => {
   var stubResponse = require(_path.default.resolve(stubPath));
-  _logger.default.info('Set Expectations: Running');
+  stubServerBaseUrl = stubServerBaseUrl || 'http://localhost:9000';
+  _logger.default.info("Set Expectations: Stub url is ".concat(stubServerBaseUrl));
   return new Promise((resolve, reject) => {
-    (0, _nodeFetch.default)("".concat(stubServerBaseUrl ? stubServerBaseUrl : "http://localhost:9000/", "_specmatic/expectations"), {
+    (0, _nodeFetch.default)("".concat(stubServerBaseUrl, "/_specmatic/expectations"), {
       method: 'POST',
       body: JSON.stringify(stubResponse)
     }).then(response => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "specmatic",
-  "version": "0.70.0",
+  "version": "0.70.2",
   "description": "Node wrapper for Specmatic",
   "main": "dist/index.js",
   "scripts": {
@@ -31,6 +31,9 @@
       "jest-extended/all"
     ]
   },
+  "specmatic": {
+    "logLevel": "trace"
+  },
   "dependencies": {
     "@babel/cli": "^7.21.5",
     "@babel/core": "^7.21.8",
@@ -47,9 +50,9 @@
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.1",
+    "@types/jest": "^29.5.2",
     "jest": "^29.5.0",
-    "jest-extended": "^3.2.4",
+    "jest-extended": "^4.0.0",
     "jest-mock-extended": "^3.0.4"
   }
 }

package/src/lib/__tests__/index.ts

@@ -10,6 +10,7 @@ import fs from 'fs';
 import * as specmatic from '../../';
 import { specmaticJarName } from '../../config';
 import mockStub from '../../../test-resources/sample-mock-stub.json';
+import { Stub } from '..';
 
 jest.mock('exec-sh');
 jest.mock('node-fetch');
@@ -18,16 +19,18 @@ const fetchMock = fetch as unknown as jest.Mock;
 
 const SPECMATIC_JAR_PATH = path.resolve(__dirname, '..', '..', '..', specmaticJarName);
 const STUB_PATH = 'test-resources/sample-mock-stub.json';
-const CONTRACT_YAML_FILE_PATH = './contracts';
-const STUB_DIR_PATH = './data';
+const CONTRACT_FILE_PATH = './contracts';
 const HOST = 'localhost';
-const PORT = '8000';
+const PORT = 8000;
 
 const javaProcessMock = jestMock<ChildProcess>();
 const readableMock = jestMock<Readable>();
 javaProcessMock.stdout = readableMock;
 javaProcessMock.stderr = readableMock;
 
+const stubUrl = `http://${HOST}:${PORT}`;
+const stub = new Stub(HOST, PORT, stubUrl, javaProcessMock);
+
 beforeEach(() => {
     execSh.mockReset();
     fetchMock.mockReset();
@@ -37,33 +40,67 @@ beforeEach(() => {
 
 test('startStub method starts the specmatic stub server', async () => {
     execSh.mockReturnValue(javaProcessMock);
-    setTimeout(() => readableMock.on.mock.calls[0][1]('Stub server is running'), 0);
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running on ${stubUrl}`), 0);
 
-    await expect(specmatic.startStub(HOST, PORT, STUB_DIR_PATH)).resolves.toBe(javaProcessMock);
+    await expect(specmatic.startStub(HOST, PORT)).resolves.toStrictEqual(stub);
 
     expect(execSh).toHaveBeenCalledTimes(1);
-    expect(execSh.mock.calls[0][0]).toBe(
-        `java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --data=${path.resolve(STUB_DIR_PATH)} --host=${HOST} --port=${PORT}`
-    );
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`);
 });
 
 test('startStub method notifies when start fails due to port not available', async () => {
     execSh.mockReturnValue(javaProcessMock);
     setTimeout(() => readableMock.on.mock.calls[0][1]('Address already in use'), 0);
 
-    await expect(specmatic.startStub(HOST, PORT, STUB_DIR_PATH)).toReject();
+    await expect(specmatic.startStub(HOST, PORT)).toReject();
 
     expect(execSh).toHaveBeenCalledTimes(1);
-    expect(execSh.mock.calls[0][0]).toBe(
-        `java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --data=${path.resolve(STUB_DIR_PATH)} --host=${HOST} --port=${PORT}`
-    );
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`);
+});
+
+test('startStub method returns host, port and stub url', async () => {
+    execSh.mockReturnValue(javaProcessMock);
+    const randomPort = 62269;
+    const stubUrl = `http://${HOST}:${randomPort}`;
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running on ${stubUrl}. Ctrl + C to stop.`), 0);
+
+    const stub = new Stub(HOST, randomPort, stubUrl, javaProcessMock);
+
+    await expect(specmatic.startStub(HOST, PORT)).resolves.toStrictEqual(stub);
+
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`);
+});
+
+test('startStub method fails if stub url is not available in start up message', async () => {
+    execSh.mockReturnValue(javaProcessMock);
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running`), 0);
+
+    await expect(specmatic.startStub(HOST, PORT)).toReject();
+
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`);
 });
 
-test('startStub method stubDir is optional', async () => {
+test('startStub method fails if host info is not available in start up message', async () => {
     execSh.mockReturnValue(javaProcessMock);
-    setTimeout(() => readableMock.on.mock.calls[0][1]('Stub server is running'), 0);
+    const randomPort = 62269;
+    const stubUrl = `http://`;
+    const stub = new Stub(HOST, randomPort, stubUrl, javaProcessMock);
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running on ${stubUrl}`), 0);
 
-    await expect(specmatic.startStub(HOST, PORT)).resolves.toBe(javaProcessMock);
+    await expect(specmatic.startStub(HOST, PORT)).toReject();
+
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`);
+});
+
+test('startStub method fails if port info is not available in start up message', async () => {
+    execSh.mockReturnValue(javaProcessMock);
+    const stubUrl = `http://${HOST}`;
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running on ${stubUrl}`), 0);
+
+    await expect(specmatic.startStub(HOST, PORT)).toReject();
 
     expect(execSh).toHaveBeenCalledTimes(1);
     expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`);
@@ -71,16 +108,36 @@ test('startStub method stubDir is optional', async () => {
 
 test('startStub method host and port are optional', async () => {
     execSh.mockReturnValue(javaProcessMock);
-    setTimeout(() => readableMock.on.mock.calls[0][1]('Stub server is running'), 0);
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running on ${stubUrl}`), 0);
 
-    await expect(specmatic.startStub()).resolves.toBe(javaProcessMock);
+    await expect(specmatic.startStub()).resolves.toStrictEqual(stub);
 
     expect(execSh).toHaveBeenCalledTimes(1);
     expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub`);
 });
 
+test('startStub method takes additional pass through arguments', async () => {
+    execSh.mockReturnValue(javaProcessMock);
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running on ${stubUrl}`), 0);
+
+    await expect(specmatic.startStub(HOST, PORT, ['p1', 'p2'])).resolves.toStrictEqual(stub);
+
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT} p1 p2`);
+});
+
+test('startStub method takes additional pass through arguments can be string or number', async () => {
+    execSh.mockReturnValue(javaProcessMock);
+    setTimeout(() => readableMock.on.mock.calls[0][1](`Stub server is running on ${stubUrl}`), 0);
+
+    await expect(specmatic.startStub(HOST, PORT, ['p1', 123])).resolves.toStrictEqual(stub);
+
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT} p1 123`);
+});
+
 test('stopStub method stops any running stub server', () => {
-    specmatic.stopStub(javaProcessMock);
+    specmatic.stopStub(stub);
 
     expect(readableMock.removeAllListeners).toHaveBeenCalledTimes(2);
     expect(javaProcessMock.removeAllListeners).toHaveBeenCalledTimes(1);
@@ -94,16 +151,50 @@ test('test runs the contract tests', async function () {
         execSh.mock.calls[0][2]();
     }, 0);
 
-    await expect(specmatic.test(HOST, PORT, CONTRACT_YAML_FILE_PATH)).resolves.toBeTruthy();
+    await expect(specmatic.test(HOST, PORT, CONTRACT_FILE_PATH)).resolves.toBeTruthy();
 
     expect(execSh).toHaveBeenCalledTimes(1);
     expect(execSh.mock.calls[0][0]).toBe(
         `java -jar ${path.resolve(SPECMATIC_JAR_PATH)} test ${path.resolve(
-            CONTRACT_YAML_FILE_PATH
+            CONTRACT_FILE_PATH
         )} --junitReportDir=dist/test-report --host=${HOST} --port=${PORT}`
     );
 });
 
+test('test takes additional pass through arguments', async () => {
+    execSh.mockReturnValue(javaProcessMock);
+    setTimeout(() => {
+        copyReportFile();
+        execSh.mock.calls[0][2]();
+    }, 0);
+
+    await expect(specmatic.test(HOST, PORT, CONTRACT_FILE_PATH, ['P1', 'P2'])).resolves.toBeTruthy();
+
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(
+        `java -jar ${path.resolve(SPECMATIC_JAR_PATH)} test ${path.resolve(
+            CONTRACT_FILE_PATH
+        )} --junitReportDir=dist/test-report --host=${HOST} --port=${PORT} P1 P2`
+    );
+});
+
+test('test takes additional pass through arguments can be string or number', async () => {
+    execSh.mockReturnValue(javaProcessMock);
+    setTimeout(() => {
+        copyReportFile();
+        execSh.mock.calls[0][2]();
+    }, 0);
+
+    await expect(specmatic.test(HOST, PORT, CONTRACT_FILE_PATH, ['P1', 123])).resolves.toBeTruthy();
+
+    expect(execSh).toHaveBeenCalledTimes(1);
+    expect(execSh.mock.calls[0][0]).toBe(
+        `java -jar ${path.resolve(SPECMATIC_JAR_PATH)} test ${path.resolve(
+            CONTRACT_FILE_PATH
+        )} --junitReportDir=dist/test-report --host=${HOST} --port=${PORT} P1 123`
+    );
+});
+
 test('test runs the contract tests with host and port optional', async function () {
     execSh.mockReturnValue(javaProcessMock);
     setTimeout(() => {
@@ -198,7 +289,7 @@ test('printJarVersion', () => {
 });
 
 test('setExpectations with default baseUrl', async () => {
-    fetchMock.mockReturnValue(Promise.resolve({status: 200}));
+    fetchMock.mockReturnValue(Promise.resolve({ status: 200 }));
     await expect(specmatic.setExpectations(path.resolve(STUB_PATH))).toResolve();
 
     expect(fetchMock).toHaveBeenCalledTimes(1);
@@ -210,13 +301,13 @@ test('setExpectations with default baseUrl', async () => {
 });
 
 test('setExpectations with a different baseUrl for the stub server', async () => {
-    fetchMock.mockReturnValue(Promise.resolve({status: 200}));
-    const stubServerBaseUrl = 'http://localhost:8000/';
+    fetchMock.mockReturnValue(Promise.resolve({ status: 200 }));
+    const stubServerBaseUrl = 'http://localhost:8000';
 
     await expect(specmatic.setExpectations(path.resolve(STUB_PATH), stubServerBaseUrl)).toResolve();
 
     expect(fetchMock).toHaveBeenCalledTimes(1);
-    expect(fetchMock.mock.calls[0][0]).toBe(`${stubServerBaseUrl}_specmatic/expectations`);
+    expect(fetchMock.mock.calls[0][0]).toBe(`${stubServerBaseUrl}/_specmatic/expectations`);
     expect(fetchMock.mock.calls[0][1]).toMatchObject({
         method: 'POST',
         body: JSON.stringify(mockStub),
@@ -237,13 +328,13 @@ test('setExpectations notifies when it fails', async () => {
 });
 
 test('setExpectations notifies as failure when status code is not 200', async () => {
-    fetchMock.mockReturnValue(Promise.resolve({status: 400}));
-    const stubServerBaseUrl = 'http://localhost:8000/';
+    fetchMock.mockReturnValue(Promise.resolve({ status: 400 }));
+    const stubServerBaseUrl = 'http://localhost:8000';
 
     await expect(specmatic.setExpectations(path.resolve(STUB_PATH), stubServerBaseUrl)).toReject();
 
     expect(fetchMock).toHaveBeenCalledTimes(1);
-    expect(fetchMock.mock.calls[0][0]).toBe(`${stubServerBaseUrl}_specmatic/expectations`);
+    expect(fetchMock.mock.calls[0][0]).toBe(`${stubServerBaseUrl}/_specmatic/expectations`);
     expect(fetchMock.mock.calls[0][1]).toMatchObject({
         method: 'POST',
         body: JSON.stringify(mockStub),

package/src/lib/index.ts

@@ -6,13 +6,24 @@ import fs from 'fs';
 import logger from '../common/logger';
 import callSpecmatic from '../common/runner';
 
-const startStub = (host?: string, port?: string, stubDir?: string): Promise<ChildProcess> => {
-    const stubs = path.resolve(stubDir + '');
-
+export class Stub {
+    host: string;
+    port: number;
+    url: string;
+    process: ChildProcess;
+    constructor(host: string, port: number, url: string, process: ChildProcess) {
+        this.host = host;
+        this.port = port;
+        this.url = url;
+        this.process = process;
+    }
+}
+
+const startStub = (host?: string, port?: number, args?: (string | number)[]): Promise<Stub> => {
     var cmd = `stub`;
-    if (stubDir) cmd += ` --data=${stubs}`;
     if (host) cmd += ` --host=${host}`;
     if (port) cmd += ` --port=${port}`;
+    if (args) cmd += ' ' + args.join(' ');
 
     logger.info('Stub: Starting server');
     logger.debug(`Stub: Executing "${cmd}"`);
@@ -29,7 +40,14 @@ const startStub = (host?: string, port?: string, stubDir?: string): Promise<Chil
                 if (!error) {
                     if (message.indexOf('Stub server is running') > -1) {
                         logger.info(`Stub: ${message}`);
-                        resolve(javaProcess);
+                        const stubInfo = message.split('on');
+                        if (stubInfo.length < 2) reject();
+                        else {
+                            const url = stubInfo[1].trim();
+                            const urlInfo = /(.*?):\/\/(.*?):([0-9]+)/.exec(url);
+                            if ((urlInfo?.length ?? 0) < 4) reject();
+                            else resolve(new Stub(urlInfo![2], parseInt(urlInfo![3]), urlInfo![0], javaProcess));
+                        }
                     } else if (message.indexOf('Address already in use') > -1) {
                         logger.error(`Stub: ${message}`);
                         reject();
@@ -44,23 +62,25 @@ const startStub = (host?: string, port?: string, stubDir?: string): Promise<Chil
     });
 };
 
-const stopStub = (javaProcess: ChildProcess) => {
-    logger.debug('Stopping stub server');
+const stopStub = (stub: Stub) => {
+    logger.debug(`Stopping stub server at ${stub.url}`);
+    const javaProcess = stub.process;
     javaProcess.stdout?.removeAllListeners();
     javaProcess.stderr?.removeAllListeners();
     javaProcess.removeAllListeners('close');
     javaProcess.kill();
-    logger.info('Stopped stub server');
+    logger.info(`Stopped stub server at ${stub.url}`);
 };
 
-const test = (host?: string, port?: string, specs?: string): Promise<{ [k: string]: number } | undefined> => {
-    const specsPath = path.resolve(specs + '');
+const test = (host?: string, port?: number, contractPath?: string, args?: (string | number)[]): Promise<{ [k: string]: number } | undefined> => {
+    const specsPath = path.resolve(contractPath + '');
 
     var cmd = `test`;
-    if (specs) cmd += ` ${specsPath}`;
+    if (contractPath) cmd += ` ${specsPath}`;
     cmd += ' --junitReportDir=dist/test-report';
     if (host) cmd += ` --host=${host}`;
     if (port) cmd += ` --port=${port}`;
+    if (args) cmd += ' ' + args.join(' ');
 
     logger.info('Test: Running');
     logger.debug(`Test: Executing "${cmd}"`);
@@ -106,11 +126,12 @@ const showTestResults = (testFn: (name: string, cb: () => void) => void) => {
 
 const setExpectations = (stubPath: string, stubServerBaseUrl?: string): Promise<void> => {
     const stubResponse = require(path.resolve(stubPath));
+    stubServerBaseUrl = stubServerBaseUrl || 'http://localhost:9000';
 
-    logger.info('Set Expectations: Running');
+    logger.info(`Set Expectations: Stub url is ${stubServerBaseUrl}`);
 
     return new Promise((resolve, reject) => {
-        fetch(`${stubServerBaseUrl ? stubServerBaseUrl : `http://localhost:9000/`}_specmatic/expectations`, {
+        fetch(`${stubServerBaseUrl}/_specmatic/expectations`, {
             method: 'POST',
             body: JSON.stringify(stubResponse),
         })

package/.vscode/settings.json

@@ -1,7 +0,0 @@
-{
-    "cSpell.words": [
-        "qontract",
-        "qontracts",
-        "specmatic"
-    ]
-}