@testrevolution/bugbug-cli 3.1.0 → 2022.3.2-9.0

package/README.md

@@ -10,20 +10,20 @@ https://bugbug.io
 
 ### CLI Installation
 
-```
+```bash
 npm install -g @testrevolution/bugbug-cli
 ```
 
 ### Configuration
 
-```
+```bash
 bugbug config set-token API_TOKEN_FROM_WEBAPP_PROJECT_SETTINGS
 ```
 
 
 ### Available commands
 
-```
+```bash
 bugbug help
 
 bugbug config <option>
@@ -32,22 +32,25 @@ bugbug config <option>
 
 bugbug remote <option>
 
-* list [test|suite] [--nowait] [--noprogress] [--debug]
-* run [test|suite] <string:testId|suiteId> [--nowait] [--noprogress] [--debug] [--with-details]
+options:
+* list [test|suite|profile] [--nowait] [--noprogress] [--debug]
+* run [test|suite] <string:testId|suiteId> [--nowait] [--noprogress] [--debug] [--with-details] [--profile] [--variable]
 * status [test|suite] <string:testRunId|suiteRunId> [--noprogress] [--debug]
 * result [test|suite] <string:testRunId|suiteRunId> [--noprogress] [--debug] [--with-details]
 
 optional flags:
-* --nowait - exit immediately, don't wait for result
+* --debug - show more data (like raw API response)
 * --noprogress - don't show progress spinner
+* --nowait - exit immediately, don't wait for result
+* --profile <string:"profile name"> - run with specific profile
+* --variable <string:"varName=varValue"> - overrider variable during single run
 * --with-details - show result with details
-* --debug - show more data (like raw API response)
 ```
 
 Run test:
 
 ```bash
-$ bugbug remote run test ubzwl45t
-ℹ Queued (testRunId: sbglfg05)
+bugbug remote run test f95f9f55-f1bf-4e2d-ab27-9ef4752ebbfb
+ℹ Queued (testRunId: 2d6401a7-de84-4785-8fa2-4227b3330a8e)
 ✔ Status: passed
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@testrevolution/bugbug-cli",
   "description": "BugBug CLI",
-  "version": "3.1.0",
+  "version": "2022.3.29.0",
   "keywords": [
     "automation",
     "cli",
@@ -32,7 +32,7 @@
     "pub": "NODE_ENV=production npm publish --access public --loglevel verbose"
   },
   "engines": {
-    "node": ">= 11.14"
+    "node": ">= 14.10"
   },
   "devDependencies": {
     "@babel/plugin-proposal-throw-expressions": "^7.14.5",
@@ -46,4 +46,4 @@
     "jest": "^27.5.1"
   },
   "author": "TestRevolution sp. z o.o."
-}
+}

package/src/__tests__/commands.spec.js

@@ -222,7 +222,7 @@ describe('commands module', () => {
         noprogress: true,
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [], {
         noprogress: true,
         nowait: false,
         withDetails: false,
@@ -241,7 +241,25 @@ describe('commands module', () => {
         profile: profileName,
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, profileName, {
+      expect(runFunMock).toHaveBeenCalledWith(id, profileName, [], {
+        noprogress: true,
+        nowait: false,
+        withDetails: false,
+      });
+    });
+
+    it('run test action with variable override flags should call runTest function', async () => {
+      const runFunMock = jest.fn();
+      remoteCommand.__RewireAPI__.__Rewire__('runTest', runFunMock);
+
+      const id = '999';
+      const args = {
+        _: ['remote', 'run', 'test', id],
+        noprogress: true,
+        variable: ['var=val', 'var2=val2'],
+      };
+      await remoteCommand(args);
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [{ key: 'var', value: 'val' }, { key: 'var2', value: 'val2' }], {
         noprogress: true,
         nowait: false,
         withDetails: false,
@@ -259,7 +277,7 @@ describe('commands module', () => {
         noprogress: true,
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [], {
         noprogress: true,
         nowait: true,
         withDetails: false,
@@ -277,7 +295,7 @@ describe('commands module', () => {
         noprogress: true,
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [], {
         noprogress: true,
         nowait: true,
         withDetails: false,
@@ -294,7 +312,7 @@ describe('commands module', () => {
         'with-details': true,
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [], {
         noprogress: false,
         nowait: false,
         withDetails: true,
@@ -311,7 +329,25 @@ describe('commands module', () => {
         noprogress: true,
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [], {
+        noprogress: true,
+        nowait: false,
+        withDetails: false,
+      });
+    });
+
+    it('run suite action with variable override flags should call runSuite function', async () => {
+      const runFunMock = jest.fn();
+      remoteCommand.__RewireAPI__.__Rewire__('runSuite', runFunMock);
+
+      const id = '999';
+      const args = {
+        _: ['remote', 'run', 'suite', id],
+        noprogress: true,
+        variable: ['var=val', 'var2=val2'],
+      };
+      await remoteCommand(args);
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [{ key: 'var', value: 'val' }, { key: 'var2', value: 'val2' }], {
         noprogress: true,
         nowait: false,
         withDetails: false,
@@ -330,7 +366,7 @@ describe('commands module', () => {
         undefined,
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [], {
         noprogress: true,
         nowait: true,
         withDetails: false,
@@ -491,6 +527,7 @@ describe('commands module', () => {
         data: {
           suite_id: id,
           profile_name: undefined,
+          variables: [],
         },
         params: {},
         headers: { Authorization: `Token ${configValue.token}` },
@@ -516,6 +553,7 @@ describe('commands module', () => {
         data: {
           suite_id: id,
           profile_name: profileName,
+          variables: [],
         },
         params: {},
         headers: { Authorization: `Token ${configValue.token}` },
@@ -569,7 +607,7 @@ describe('commands module', () => {
         method: 'POST',
         url: 'https://bugbug.io/test-api/v1/testruns/',
         data: {
-          test_id: id, profile_name: undefined,
+          test_id: id, profile_name: undefined, variables: [],
         },
         params: {},
         headers: { Authorization: `Token ${configValue.token}` },
@@ -594,7 +632,7 @@ describe('commands module', () => {
         method: 'POST',
         url: 'https://bugbug.io/test-api/v1/testruns/',
         data: {
-          test_id: id, profile_name: profileName,
+          test_id: id, profile_name: profileName, variables: [],
         },
         params: {},
         headers: { Authorization: `Token ${configValue.token}` },
@@ -620,7 +658,7 @@ describe('commands module', () => {
         method: 'POST',
         url: 'https://bugbug.io/test-api/v1/testruns/',
         data: {
-          test_id: id, profile_name: undefined,
+          test_id: id, profile_name: undefined, variables: [],
         },
         params: {},
         headers: { Authorization: `Token ${configValue.token}` },

package/src/__tests__/utils.spec.js

@@ -50,45 +50,39 @@ describe('utils module', () => {
     it('printStatus should console.log when success', async () => {
       const consoleLogSpyOn = jest.spyOn(console, 'log').mockImplementation();
       const spinner = getSpinner(true);
-      print.printStatus(spinner, 'success', 'https://bugbug.io/tests');
+      print.printStatus(spinner, 'success');
 
       expect(consoleLogSpyOn).toHaveBeenCalledWith('Status: success');
     });
 
     it('printStatus should console.warn when failed', async () => {
       const consoleErrorSpyOn = jest.spyOn(console, 'error').mockImplementation();
-      const consoleLogSpyOn = jest.spyOn(console, 'log').mockImplementation();
       const spinner = getSpinner(true);
-      print.printStatus(spinner, 'failed', 'https://bugbug.io/tests');
+      print.printStatus(spinner, 'failed');
 
-      expect(consoleLogSpyOn).toHaveBeenCalledWith('https://bugbug.io/tests');
       expect(consoleErrorSpyOn).toHaveBeenCalledWith('Status: failed');
     });
 
     it('printStatus should console.warn when error', async () => {
       const consoleErrorSpyOn = jest.spyOn(console, 'error').mockImplementation();
-      const consoleLogSpyOn = jest.spyOn(console, 'log').mockImplementation();
       const spinner = getSpinner(true);
-      print.printStatus(spinner, 'error', 'https://bugbug.io/tests');
+      print.printStatus(spinner, 'error');
 
-      expect(consoleLogSpyOn).toHaveBeenCalledWith('https://bugbug.io/tests');
       expect(consoleErrorSpyOn).toHaveBeenCalledWith('Status: error');
     });
 
     it('printStatus should console.warn when stopped', async () => {
       const consoleErrorSpyOn = jest.spyOn(console, 'error').mockImplementation();
-      const consoleLogSpyOn = jest.spyOn(console, 'log').mockImplementation();
       const spinner = getSpinner(true);
-      print.printStatus(spinner, 'stopped', 'https://bugbug.io/tests');
+      print.printStatus(spinner, 'stopped');
 
-      expect(consoleLogSpyOn).toHaveBeenCalledWith('https://bugbug.io/tests');
       expect(consoleErrorSpyOn).toHaveBeenCalledWith('Status: stopped');
     });
 
     it('printStatus should console.log when other status', async () => {
       const consoleLogSpyOn = jest.spyOn(console, 'log').mockImplementation();
       const spinner = getSpinner(true);
-      print.printStatus(spinner, '21', 'https://bugbug.io/tests');
+      print.printStatus(spinner, '21');
 
       expect(consoleLogSpyOn).toHaveBeenCalledWith('Status: 21');
     });
@@ -114,6 +108,33 @@ describe('utils module', () => {
     it('testing getExitCode function: 3 stopped exit code', async () => {
       expect(await helper.getExitCode('stopped')).toBe(3);
     });
+
+    it('testing parseVariables function: empty data', async () => {
+      expect(await helper.parseVariables(undefined)).toStrictEqual([]);
+      expect(await helper.parseVariables('')).toStrictEqual([]);
+      expect(await helper.parseVariables([])).toStrictEqual([]);
+    });
+
+    it('testing parseVariables function: single variable', async () => {
+      expect(await helper.parseVariables('var=val')).toStrictEqual([
+        { key: 'var', value: 'val' },
+      ]);
+    });
+
+    it('testing parseVariables function: = in variable value', async () => {
+      expect(await helper.parseVariables('var=val=ue')).toStrictEqual([
+        { key: 'var', value: 'val=ue' },
+      ]);
+      expect(await helper.parseVariables(['var=val=ue', 'var2=val=ue2'])).toStrictEqual([
+        { key: 'var', value: 'val=ue' }, { key: 'var2', value: 'val=ue2' },
+      ]);
+    });
+
+    it('testing parseVariables function: multiple variable', async () => {
+      expect(await helper.parseVariables(['var=val', 'var2=val2'])).toStrictEqual([
+        { key: 'var', value: 'val' }, { key: 'var2', value: 'val2' },
+      ]);
+    });
   });
 
   describe('config', () => {

package/src/commands/help.js

@@ -19,16 +19,17 @@ const help = {
 
     options:
     * list [test|suite|profile] [--nowait] [--noprogress] [--debug]
-    * run [test|suite] <string:testId|suiteId> [--nowait] [--noprogress] [--debug] [--with-details] [--profile]
+    * run [test|suite] <string:testId|suiteId> [--nowait] [--noprogress] [--debug] [--with-details] [--profile] [--variable]
     * status [test|suite] <string:testRunId|suiteRunId> [--noprogress] [--debug]
     * result [test|suite] <string:testRunId|suiteRunId> [--noprogress] [--debug] [--with-details]
 
     optional flags:
-    * --profile=<string:"profile name"> - run with specific profile
-    * --nowait - exit immediately, don't wait for result
+    * --debug - show more data (like raw API response)
     * --noprogress - don't show progress spinner
+    * --nowait - exit immediately, don't wait for result
+    * --profile <string:"profile name"> - run with specific profile
+    * --variable <string:"varName=varValue"> - overrider variable during single run
     * --with-details - show result with details
-    * --debug - show more data (like raw API response)
 `,
 };
 

package/src/commands/remote.js

@@ -3,7 +3,7 @@ const { format } = require('util');
 const settings = require('../settings');
 const { getSpinner } = require('../utils/spinner');
 const { getConfigValue } = require('../utils/config');
-const { getExitCode } = require('../utils/helper');
+const { getExitCode, parseVariables, printErrorResponse } = require('../utils/helper');
 const { apiCall, apiCallPoll } = require('../utils/api');
 const {
   printList,
@@ -28,7 +28,7 @@ const getList = async (type, query, extraParams) => {
       return getExitCode(true);
     }
   } catch (error) {
-    spinner.fail(error.toString());
+    await printErrorResponse(spinner, error);
   }
   return getExitCode(false);
 };
@@ -50,7 +50,7 @@ const getResult = async (type, id, extraParams) => {
       return getExitCode(result.data.status);
     }
   } catch (error) {
-    spinner.fail(error.toString());
+    await printErrorResponse(spinner, error);
   }
 
   return getExitCode(false);
@@ -70,14 +70,14 @@ const checkStatus = async (type, id, extraParams) => {
     } else {
       response = await apiCallPoll(path, route.method, {}, spinner, 0);
     }
-    if (withDetails) {
+    if (withDetails || settings.FAILED_STATUS.includes(response.data.status)) {
       await getResult(type, id, extraParams);
     } else {
-      printStatus(spinner, response.data.status, response.data.webappUrl);
+      printStatus(spinner, response.data.status);
     }
     exitCode = getExitCode(response.data.status);
   } catch (error) {
-    spinner.fail(error.toString());
+    await printErrorResponse(spinner, error);
     await getResult(type, id, extraParams);
     exitCode = getExitCode(false);
   }
@@ -99,17 +99,17 @@ const run = async (type, data, extraParams) => {
       return getExitCode(true);
     }
   } catch (error) {
-    spinner.fail(error.toString());
+    await printErrorResponse(spinner, error);
   }
   return getExitCode(false);
 };
 
-const runTest = async (testId, profileName, extraParams) => run(
-  settings.TYPE_TEST, { test_id: testId, profile_name: profileName }, extraParams,
+const runTest = async (testId, profileName, variables, extraParams) => run(
+  settings.TYPE_TEST, { test_id: testId, profile_name: profileName, variables }, extraParams,
 );
 
-const runSuite = async (suiteId, profileName, extraParams) => run(
-  settings.TYPE_SUITE, { suite_id: suiteId, profile_name: profileName }, extraParams,
+const runSuite = async (suiteId, profileName, variables, extraParams) => run(
+  settings.TYPE_SUITE, { suite_id: suiteId, profile_name: profileName, variables }, extraParams,
 );
 
 const checkTokenConfig = async () => {
@@ -131,6 +131,7 @@ module.exports = async (args) => {
   const subCmd = args._[1].toLowerCase();
   const objectType = args._[2].toLowerCase();
   const id = args._[3];
+  const parsedVariables = await parseVariables(args.variable);
   const extraParams = {
     nowait: args.nowait || false,
     noprogress: args.noprogress || false,
@@ -152,9 +153,9 @@ module.exports = async (args) => {
       break;
     case settings.ACTION_RUN:
       if (objectType === settings.TYPE_TEST) {
-        exitCode = await runTest(id, args.profile, extraParams);
+        exitCode = await runTest(id, args.profile, parsedVariables, extraParams);
       } else if (objectType === settings.TYPE_SUITE) {
-        exitCode = await runSuite(id, args.profile, extraParams);
+        exitCode = await runSuite(id, args.profile, parsedVariables, extraParams);
       }
       break;
     case settings.ACTION_STATUS:

package/src/utils/helper.js

@@ -5,6 +5,32 @@ const getExitCode = async (status) => {
   return exitCode === undefined ? 1 : exitCode;
 };
 
+const parseVariables = async (variablesData) => {
+  if (!variablesData) {
+    return [];
+  }
+  let variablesArray = variablesData;
+  if (typeof (variablesData) === 'string') {
+    variablesArray = [variablesData];
+  }
+  return variablesArray.map((variable) => {
+    const [variableKey, ...variableValue] = variable.split('=');
+    return { key: variableKey, value: variableValue.join('=') };
+  });
+};
+
+const printErrorResponse = async (spinner, error) => {
+  if (
+    error?.response.status === 400
+    && error.response?.data[0]?.message) {
+    spinner.fail(error.response.data[0].message);
+  } else {
+    spinner.fail(error.toString());
+  }
+};
+
 module.exports = {
   getExitCode,
+  parseVariables,
+  printErrorResponse,
 };

package/src/utils/print.js

@@ -2,11 +2,8 @@ const util = require('util');
 const { Table, printTable } = require('console-table-printer');
 const settings = require('../settings');
 
-const printStatus = (spinner, status, webappUrl) => {
+const printStatus = (spinner, status) => {
   if (settings.FAILED_STATUS.includes(status)) {
-    if (webappUrl) {
-      spinner.info(webappUrl);
-    }
     spinner.fail(`Status: ${status}`);
   } else {
     spinner.succeed(`Status: ${status}`);
@@ -33,6 +30,8 @@ const printTestRunInfo = (spinner, result, withDetails = false) => {
     spinner.info(`Sequence: ${result.sequence}`);
     spinner.info(`Created: ${result.queued}`);
     spinner.info(`Duration: ${result.duration}`);
+  } else if (settings.FAILED_STATUS.includes(result.status)) {
+    spinner.info(result.webappUrl);
   }
   printStatus(spinner, result.status);
 
@@ -59,6 +58,8 @@ const printSuiteRunInfo = (spinner, result, withDetails = false) => {
     spinner.info(`Sequence: ${result.sequence}`);
     spinner.info(`Created: ${result.queued}`);
     spinner.info(`Duration: ${result.duration}`);
+  } else if (settings.FAILED_STATUS.includes(result.status)) {
+    spinner.info(result.webappUrl);
   }
   printStatus(spinner, result.status);