specmatic 0.70.0 → 0.70.1

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?: string, args?: (string | number)[]) : Promise<ChildProcess>` <br />
+Start the stub server. Argument `args` values are passed directly to specmatic jar executable.
 
 `stopStub(process: ChildProcess)` <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<boolean>` <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

@@ -11,12 +11,11 @@ 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 + '');
+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) => {
@@ -52,13 +51,14 @@ var stopStub = javaProcess => {
   _logger.default.info('Stopped stub server');
 };
 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');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "specmatic",
-  "version": "0.70.0",
+  "version": "0.70.1",
   "description": "Node wrapper for Specmatic",
   "main": "dist/index.js",
   "scripts": {

package/src/lib/__tests__/index.ts

@@ -18,7 +18,7 @@ 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 CONTRACT_FILE_PATH = './contracts';
 const STUB_DIR_PATH = './data';
 const HOST = 'localhost';
 const PORT = '8000';
@@ -39,11 +39,11 @@ test('startStub method starts the specmatic stub server', async () => {
     execSh.mockReturnValue(javaProcessMock);
     setTimeout(() => readableMock.on.mock.calls[0][1]('Stub server is running'), 0);
 
-    await expect(specmatic.startStub(HOST, PORT, STUB_DIR_PATH)).resolves.toBe(javaProcessMock);
+    await expect(specmatic.startStub(HOST, PORT)).resolves.toBe(javaProcessMock);
 
     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}`
+        `java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`
     );
 });
 
@@ -51,32 +51,42 @@ test('startStub method notifies when start fails due to port not available', asy
     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}`
+        `java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`
     );
 });
 
-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);
 
-    await expect(specmatic.startStub(HOST, PORT)).resolves.toBe(javaProcessMock);
+    await expect(specmatic.startStub()).resolves.toBe(javaProcessMock);
 
     expect(execSh).toHaveBeenCalledTimes(1);
-    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub --host=${HOST} --port=${PORT}`);
+    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub`);
 });
 
-test('startStub method host and port are optional', async () => {
+test('startStub method takes additional pass through arguments', async () => {
     execSh.mockReturnValue(javaProcessMock);
     setTimeout(() => readableMock.on.mock.calls[0][1]('Stub server is running'), 0);
 
-    await expect(specmatic.startStub()).resolves.toBe(javaProcessMock);
+    await expect(specmatic.startStub(HOST, PORT, ['p1', 'p2'])).resolves.toBe(javaProcessMock);
 
     expect(execSh).toHaveBeenCalledTimes(1);
-    expect(execSh.mock.calls[0][0]).toBe(`java -jar ${path.resolve(SPECMATIC_JAR_PATH)} stub`);
+    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'), 0);
+
+    await expect(specmatic.startStub(HOST, PORT, ['p1', 123])).resolves.toBe(javaProcessMock);
+
+    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', () => {
@@ -94,16 +104,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(() => {

package/src/lib/index.ts

@@ -6,13 +6,11 @@ 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 + '');
-
+const startStub = (host?: string, port?: string, args?: (string | number)[]): Promise<ChildProcess> => {
     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}"`);
@@ -53,14 +51,15 @@ const stopStub = (javaProcess: ChildProcess) => {
     logger.info('Stopped stub server');
 };
 
-const test = (host?: string, port?: string, specs?: string): Promise<{ [k: string]: number } | undefined> => {
-    const specsPath = path.resolve(specs + '');
+const test = (host?: string, port?: string, 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}"`);