@testrevolution/bugbug-cli 12.34.1 → 13.5.3

package/.env

@@ -1 +1 @@
-SENTRY_DSN=https://33fb182a5d1a45f783ee5362a20f219a@o346063.ingest.sentry.io/6360873
+SENTRY_DSN=https://c850ce209b19d8558600d0ecbb5a160f@sentry.bugbug.io/52

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@testrevolution/bugbug-cli",
   "description": "BugBug CLI",
-  "version": "12.34.1",
+  "version": "13.5.3",
   "keywords": [
     "automation",
     "cli",
@@ -19,16 +19,17 @@
   },
   "dependencies": {
     "@sentry/node": "^10.5.0",
-    "axios": "^1.10.0",
-    "console-table-printer": "^2.12.1",
-    "dotenv": "^16.4.7",
+    "axios": "^1.13.4",
+    "chalk": "^4.1.2",
+    "console-table-printer": "^2.15.0",
+    "dotenv": "^17.2.3",
     "jest-junit": "^16.0.0",
     "junit-xml": "^1.2.0",
     "minimist": "^1.2.8",
-    "nanoid": "^3.3.4",
+    "nanoid": "^3.3.11",
     "ora": "^5.4.1",
     "path": "^0.12.7",
-    "validator": "^13.15.0"
+    "validator": "^13.15.26"
   },
   "scripts": {
     "start": "cross-env NODE_ENV=development node ./bin/bugbug",
@@ -49,9 +50,9 @@
     "eslint": "^8.57.1",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jest": "^29.0.1",
+    "eslint-plugin-jest": "^29.12.2",
     "eslint-plugin-node": "^11.1.0",
-    "jest": "^30.0.3"
+    "jest": "^30.2.0"
   },
   "author": "TestRevolution sp. z o.o."
 }

package/src/__tests__/commands.spec.js

@@ -1,5 +1,10 @@
 const axios = require('axios');
+const fs = require('fs');
+const chalk = require('chalk');
 
+chalk.level = 0;
+
+const { join } = require('path');
 const {
   config: configCommand,
   help: helpCommand,
@@ -36,7 +41,7 @@ describe('commands module', () => {
       const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
       await helpCommand(args);
       expect(consoleLogSpy).toHaveBeenCalled();
-      expect(consoleLogSpy).toHaveBeenCalledWith(expect.stringContaining('bugbug [command] <options>'));
+      expect(consoleLogSpy).toHaveBeenCalledWith(expect.stringContaining('bugbug <command> [options]'));
     });
 
     it('should console log config help menu', async () => {
@@ -46,7 +51,7 @@ describe('commands module', () => {
       const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
       await helpCommand(args);
       expect(consoleLogSpy).toHaveBeenCalled();
-      expect(consoleLogSpy).toHaveBeenCalledWith(expect.stringContaining('bugbug config <options>'));
+      expect(consoleLogSpy).toHaveBeenCalledWith(expect.stringContaining('config <command>'));
     });
 
     it('should console log remote help menu', async () => {
@@ -56,7 +61,7 @@ describe('commands module', () => {
       const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
       await helpCommand(args);
       expect(consoleLogSpy).toHaveBeenCalled();
-      expect(consoleLogSpy).toHaveBeenCalledWith(expect.stringContaining('bugbug remote <options>'));
+      expect(consoleLogSpy).toHaveBeenCalledWith(expect.stringContaining('remote <command> [options]'));
     });
   });
 
@@ -297,7 +302,10 @@ describe('commands module', () => {
         variable: ['var=val', 'var2=val2'],
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [{ key: 'var', value: 'val' }, { key: 'var2', value: 'val2' }], {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [{ key: 'var', value: 'val' }, {
+        key: 'var2',
+        value: 'val2',
+      }], {
         noprogress: true,
         nowait: false,
         withDetails: false,
@@ -421,7 +429,10 @@ describe('commands module', () => {
         variable: ['var=val', 'var2=val2'],
       };
       await remoteCommand(args);
-      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [{ key: 'var', value: 'val' }, { key: 'var2', value: 'val2' }], {
+      expect(runFunMock).toHaveBeenCalledWith(id, undefined, [{ key: 'var', value: 'val' }, {
+        key: 'var2',
+        value: 'val2',
+      }], {
         noprogress: true,
         nowait: false,
         withDetails: false,
@@ -581,6 +592,31 @@ describe('commands module', () => {
       });
     });
 
+    it.each(['test', 'suite'])('result %s command should call API and generate JUnit report', async (type) => {
+      // Arrange
+      const reportFile = 'report data';
+      jest.spyOn(fs, 'writeFileSync').mockImplementation();
+      const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
+      axios
+        .mockResolvedValueOnce(apiMocks.getResultTestRunSuccess)
+        .mockResolvedValueOnce({ data: reportFile });
+      const id = '95a37d6a-a7a5-42ae-8fe3-336a120b807b';
+      const args = {
+        _: ['remote', 'result', type, id],
+        noprogress: true,
+        'with-details': true,
+        reporter: settings.REPORTER_TYPE.junit,
+        'output-path': 'test-report.xml',
+      };
+
+      // Act
+      await remoteCommand(args);
+
+      // Assert
+      expect(fs.writeFileSync).toHaveBeenCalledWith(join(process.cwd(), 'test-report.xml'), reportFile, expect.any(Object));
+      expect(consoleLogSpy).toHaveBeenCalledWith(`JUnit report generated at ${join(process.cwd(), 'test-report.xml')}`);
+    });
+
     it('result test command should call API and print errorCode when failed', async () => {
       const consoleLogSpy = jest.spyOn(console, 'log').mockImplementation();
       const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation();
@@ -789,7 +825,7 @@ describe('commands module', () => {
           test_id: id, profile_name: undefined, variables: [], triggeredBy: 'cli',
 
         },
-        params: { },
+        params: {},
         headers: { Authorization: `Token ${configValue.token}`, 'User-Agent': settings.USER_AGENT },
       });
       expect(axios).toHaveBeenNthCalledWith(2, {

package/src/commands/config.js

@@ -27,7 +27,7 @@ const validateArgs = async (args) => {
     help({ _: ['config'] });
     return false;
   }
-  const knownKeys = ['_'];
+  const knownKeys = ['_', 'color', 'no-color'];
   const unknownKeys = await getUnknownOptions(args, knownKeys);
   if (unknownKeys.length > 0) {
     console.error(`Unknown options: ${unknownKeys.join(', ')}`);
@@ -43,6 +43,10 @@ module.exports = async (args) => {
   }
   const { subCmd, token } = await parseArgs(args);
   switch (subCmd) {
+    case settings.ACTION_HELP:
+      help({ _: ['config'] });
+      exitCode = await getExitCode(true);
+      break;
     case settings.ACTION_SET_TOKEN:
       exitCode = await setToken(token);
       break;

package/src/commands/help.js

@@ -1,40 +1,58 @@
+const chalk = require('chalk');
 const settings = require('../settings');
 
 const help = {
   main: `
-    bugbug [command] <options>
+${chalk.bold('Usage:')}
+  ${chalk.green('bugbug')} <command> [options]
 
-    config ................
-    remote ................
-    version ...............
-    help <config|remote>... show help menu for a command`,
+${chalk.bold('Commands:')}
+  ${chalk.cyan('config')}           Configure CLI settings
+  ${chalk.cyan('remote')}           Run and manage tests on remote
+  ${chalk.cyan('version')}          Show version information
+  ${chalk.cyan('help <command>')}   Show help menu for a command
+
+${chalk.bold('Global flags:')}
+  ${chalk.yellow('--debug')}           Show raw API responses
+  ${chalk.yellow('--no-color')}       Disable colored output`,
 
   config: `
-    bugbug config <options>
+${chalk.bold('Usage:')}
+  ${chalk.green('bugbug config')} <command>
 
-    options:
-    * set-token <token>`,
+${chalk.bold('Commands:')}
+  ${chalk.cyan('set-token <token>')}    Set BugBug API token`,
 
   remote: `
-    bugbug remote <options>
-
-    options:
-    * list [test|suite|profile] [--no-wait] [--no-progress] [--debug]
-    * run [test|suite] <string:testId|suiteId> [--no-wait] [--no-progress] [--debug] [--with-details] [--profile] [--variable] [--result-timeout <int>]  [--reporter] [--output-path]
-    * status [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug]
-    * result [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug] [--with-details] [--result-timeout <int>]
-    * stop [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug] [--result-timeout <int>]
-
-    optional flags:
-    * --debug - show more data (like raw API response)
-    * --no-progress - don't show progress spinner
-    * --no-wait - exit immediately, don't wait for result
-    * --profile <string:"profile name"> - run with specific profile
-    * --variable <string:"varName=varValue"> - override variable during single run
-    * --with-details - show result with details
-    * --reporter <"inline"|"junit"> - the name of the reporter to use (default: "inline")
-    * --output-path - the path to save the test report; relative to the current working directory
-    * --result-timeout - modify the default result waiting time (minutes, default: 60)
+${chalk.bold('Usage:')}
+  ${chalk.green('bugbug remote')} <command> [options]
+
+${chalk.bold('Commands:')}
+  ${chalk.cyan('list')}   <test|suite|profile>      List tests, suites or profiles
+  ${chalk.cyan('run')}    <test|suite> <id>         Run a test or suite
+  ${chalk.cyan('status')} <test|suite> <id>         Check run status
+  ${chalk.cyan('result')} <test|suite> <id>         Get run result
+  ${chalk.cyan('stop')}   <test|suite> <id>         Stop a running test or suite
+
+
+${chalk.bold('Global flags:')}
+  ${chalk.yellow('--debug')}                          Show raw API responses
+  ${chalk.yellow('--no-progress')}                    Hide progress spinner
+  ${chalk.yellow('--no-color')}                       Disable colored output
+
+${chalk.bold('Command-specific flags:')}
+  ${chalk.white.underline('run, status')}
+    ${chalk.yellow('--no-wait')}                      Exit immediately, don't wait for result
+    ${chalk.yellow('--result-timeout <min>')}         Max waiting time (default: 60)
+
+  ${chalk.white.underline('run')}
+    ${chalk.yellow('--profile <name>')}               Run with specific profile
+    ${chalk.yellow('--variable <key=val>')}           Override variable (can be used multiple times)
+
+  ${chalk.white.underline('run, status, result')}
+    ${chalk.yellow('--with-details')}                 Include detailed step information
+    ${chalk.yellow('--reporter <type>')}              "inline" or "junit" (default: "inline")
+    ${chalk.yellow('--output-path <path>')}           Path for JUnit report (default: test-report.xml)
 `,
 };
 

package/src/commands/remote.js

@@ -1,3 +1,5 @@
+const fs = require('node:fs');
+const { join } = require('node:path');
 const { format } = require('util');
 const validator = require('validator');
 
@@ -14,9 +16,6 @@ const {
   printTestRunInfo,
   printSuiteRunInfo,
 } = require('../utils/print');
-const {
-  generateJunitReport,
-} = require('../utils/testReports');
 const help = require('./help');
 const { sentry } = require('../utils/sentry');
 
@@ -54,8 +53,16 @@ const getResult = async (type, id, extraParams) => {
     if (result) {
       switch (reporter) {
         case settings.REPORTER_TYPE.junit: {
-          console.log('Generating JUnit report...');
-          await generateJunitReport(type, result.data, outputPath);
+          spinner.info('Generating JUnit report...');
+          const report = await apiCall(
+            format(settings.API_ROUTING[`${type}RunReport`].path, id),
+            settings.API_ROUTING[`${type}RunReport`].method,
+            {},
+            {},
+            extraParams.triggeredBy,
+          );
+          fs.writeFileSync(join(process.cwd(), outputPath), report.data, { flag: 'w+' });
+          spinner.info(`JUnit report generated at ${join(process.cwd(), outputPath)}`);
           break;
         }
         default: {
@@ -185,8 +192,8 @@ const checkTokenConfig = async () => {
 };
 
 const parseArgs = async (args) => {
-  const subCmd = args._[1].toLowerCase();
-  const objectType = args._[2].toLowerCase();
+  const subCmd = (args._[1] || '').toLowerCase();
+  const objectType = (args._[2] || '').toLowerCase();
   const id = args._[3];
   const variables = await parseVariables(args.variable);
 
@@ -208,19 +215,24 @@ const parseArgs = async (args) => {
 };
 
 const validateArgs = async (args) => {
+  const subCmd = (args._[1] || '').toLowerCase();
+  if (subCmd === settings.ACTION_HELP) {
+    return true;
+  }
+
   if (args._.length < 3) {
     console.error('Missing parameters!');
     help({ _: ['remote'] });
     return false;
   }
 
-  const knownKeys = ['_', 'wait', 'nowait', 'noprogress', 'progress', 'with-details', 'debug', 'profile', 'variable', 'result-timeout', 'reporter', 'output-path', 'triggered-by'];
+  const knownKeys = ['_', 'wait', 'nowait', 'noprogress', 'progress', 'with-details', 'debug', 'profile', 'variable', 'result-timeout', 'reporter', 'output-path', 'triggered-by', 'color', 'no-color'];
   const unknownKeys = await getUnknownOptions(args, knownKeys);
   if (unknownKeys.length > 0) {
     console.error(`Unknown options: ${unknownKeys.join(', ')}`);
     return false;
   }
-  const { subCmd, objectType, id } = await parseArgs(args);
+  const { objectType, id } = await parseArgs(args);
 
   if (!OBJECT_TYPES.includes(objectType)) {
     console.error(`Incorrect object type ${objectType}. Available types: ${OBJECT_TYPES}.`);
@@ -260,6 +272,10 @@ module.exports = async (args) => {
   let exitCode;
   await checkTokenConfig();
   switch (subCmd) {
+    case settings.ACTION_HELP:
+      help({ _: ['remote'] });
+      exitCode = await getExitCode(true);
+      break;
     case settings.ACTION_LIST:
       exitCode = await getList(objectType, id, extraParams);
       break;

package/src/index.js

@@ -3,9 +3,10 @@ const minimist = require('minimist');
 const { nanoid } = require('nanoid');
 const { sentry, init: initSentry } = require('./utils/sentry');
 const settings = require('./settings');
-require('dotenv').config();
+require('dotenv').config({ quiet: true });
 require('dotenv').config({
   path: path.resolve(process.cwd(), `.env.${settings.NODE_ENV}`),
+  quiet: true,
 });
 // Initialize Sentry first
 initSentry();

package/src/settings.js

@@ -9,7 +9,7 @@ util.inspect.styles.string = 'white';
 const NODE_ENV = process.env.NODE_ENV || 'production';
 const ENV_FILE_PATH = path.resolve(__dirname, '..', `.env.${NODE_ENV}`);
 const USER_AGENT = `BugBug CLI ${VERSION}`;
-dotenv.config({ path: ENV_FILE_PATH });
+dotenv.config({ path: ENV_FILE_PATH, quiet: true });
 
 // TODO: Fix this path due to Mac OS restrictions
 const CONFIG_DIR_PATH = path.join(os.homedir(), '.bugbug');
@@ -42,6 +42,8 @@ const API_ROUTING = {
   testRun: { method: 'POST', path: `${API_VERSION}/testruns/` },
   testStatus: { method: 'GET', path: `${API_VERSION}/testruns/%s/status/` },
   testStop: { method: 'POST', path: `${API_VERSION}/testruns/%s/stop/` },
+  testRunReport: { method: 'GET', path: `${API_VERSION}/testruns/%s/report/junit/` },
+  suiteRunReport: { method: 'GET', path: `${API_VERSION}/suiteruns/%s/report/junit/` },
 };
 
 const API_POLLING_MODIFIED_INTERVAL = 120000; // 120 seconds

package/test-report.xml

@@ -0,0 +1,37 @@
+<?xml version='1.0' encoding='utf-8'?>
+<testsuites>
+  <testsuite errors="0" failures="0" id="08deed80-07d1-4987-aaa3-e14a1f906a29" name="Test_Tic Tac Toe simple [OK]" skipped="0" tests="1" time="7.00" sequence="#3" timestamp="2025-10-28T13:08:49.533959+00:00">
+    <properties>
+      <property name="report_id" value="ca971f23-d2e1-4401-bf12-5cd2e968ce3a" />
+      <property name="generated_at" value="2025-10-28T13:08:57.329443+00:00" />
+      <property name="generated_by" value="admin@testrevolution.io" />
+      <property name="auto_retry_attempt" value="0" />
+      <property name="browser_height" value="786" />
+      <property name="browser_name" value="Chrome" />
+      <property name="browser_version" value="136.0.0.0" />
+      <property name="browser_width" value="1366" />
+      <property name="extension_version" value="12.33.2" />
+      <property name="finished" value="2025-10-28T13:08:56.534381+00:00" />
+      <property name="os_name" value="Linux" />
+      <property name="profile_name" value="Default" />
+      <property name="run_mode" value="cloud" />
+      <property name="sequence" value="#3" />
+      <property name="screen_size_type" value="desktop" />
+      <property name="test_id" value="d998ade4-93bc-4d94-bab8-a73a290f8490" />
+      <property name="triggered_by" value="cli" />
+      <property name="report_format_version" value="1.0" />
+    </properties>
+    <testcase name="Tic Tac Toe simple [OK]" classname="TestSuite_Single" time="7.00" test_run_id="08deed80-07d1-4987-aaa3-e14a1f906a29" sequence="#3">
+      <system-out>=== Test Steps Execution (summary) ===
+Total steps: 9
+Passed: 9
+Failed: 0
+
+First 3 steps:
+1. OK goto (2.36s)
+2. OK click (1.22s)
+3. OK click (0.27s)
+</system-out>
+    </testcase>
+  </testsuite>
+</testsuites>

package/src/utils/testReports.js

@@ -1,65 +0,0 @@
-const { getJunitXml } = require('junit-xml');
-const fs = require('node:fs');
-const path = require('node:path');
-
-const settings = require('../settings');
-const { getSecondsFromDuration } = require('./helper');
-
-const getTestInJunitFormat = (testRun) => {
-  const errorCode = testRun.errorCode ?? 'MISSING_ERROR_CODE';
-  const stepInfo = testRun.details?.[0]?.step;
-  const errorDetails = stepInfo
-    ? {
-      message: `Error ${errorCode} occurred in step: ${stepInfo.type} (${stepInfo.id})`,
-      stack: errorCode,
-    }
-    : {
-      message: `Error ${errorCode} occurred`,
-      stack: errorCode,
-    };
-  const errorsList = errorDetails ? [errorDetails] : [];
-
-  return {
-    id: testRun.id,
-    name: testRun.name,
-    time: getSecondsFromDuration(testRun.duration),
-    classname: null,
-    errors: testRun.status === settings.STATUS_ERROR ? errorsList : [],
-    failures: testRun.status === settings.STATUS_FAILED ? errorsList : [],
-  };
-};
-
-const getSuiteInJunitFormat = (suiteRun) => ({
-  id: suiteRun.id,
-  name: suiteRun.name,
-  time: getSecondsFromDuration(suiteRun.duration),
-  testCases: suiteRun.details.map((testRun) => getTestInJunitFormat(testRun)),
-});
-
-const generateJunitReport = async (type, result, outputPath) => {
-  const testReport = {};
-  testReport.name = 'BugBug Report';
-  testReport.time = getSecondsFromDuration(result.duration);
-  testReport.suites = [];
-
-  if (type === settings.TYPE_TEST) {
-    testReport.suites.push(
-      getSuiteInJunitFormat({
-        name: 'Single Test Run',
-        duration: result.duration,
-        details: [result],
-      }),
-    );
-  }
-
-  if (type === settings.TYPE_SUITE) {
-    testReport.suites.push(getSuiteInJunitFormat(result));
-  }
-
-  const junitReport = getJunitXml(testReport);
-  fs.writeFileSync(path.join(process.cwd(), outputPath), junitReport, { flag: 'w+' });
-};
-
-module.exports = {
-  generateJunitReport,
-};