@testrevolution/bugbug-cli 7.8.1 → 7.10.1

package/README.md

@@ -34,7 +34,7 @@ bugbug remote <option>
 
 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]
+* run [test|suite] <string:testId|suiteId> [--no-wait] [--no-progress] [--debug] [--with-details] [--profile] [--variable] [--reporter] [--output-path]
 * status [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug]
 * result [test|suite] <string:testRunId|suiteRunId> [--no-progress] [--debug] [--with-details]
 
@@ -43,8 +43,10 @@ optional flags:
 * --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"> - overrider variable during single run
+* --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
 ```
 
 Run test:

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@testrevolution/bugbug-cli",
   "description": "BugBug CLI",
-  "version": "7.8.1",
+  "version": "7.10.1",
   "keywords": [
     "automation",
     "cli",
@@ -22,13 +22,14 @@
     "axios": "^1.6.2",
     "console-table-printer": "^2.11.2",
     "dotenv": "^16.3.1",
+    "junit-xml": "^1.2.0",
     "minimist": "^1.2.8",
     "ora": "^5.4.1",
     "path": "^0.12.7",
     "validator": "^13.11.0"
   },
   "scripts": {
-    "start": "NODE_ENV=development node ./bin/bugbug",
+    "start": "cross-env NODE_ENV=development node ./bin/bugbug",
     "test": "jest --coverage",
     "lint": "eslint --report-unused-disable-directives ./src/**/*.js",
     "lint:fix": "eslint ./src/**/*.js --fix",
@@ -42,6 +43,7 @@
     "@babel/eslint-parser": "^7.23.3",
     "@babel/plugin-proposal-throw-expressions": "^7.23.3",
     "babel-plugin-rewire": "^1.2.0",
+    "cross-env": "^7.0.3",
     "eslint": "^8.53.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.29.0",

package/src/__tests__/commands.spec.js

@@ -179,6 +179,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -196,6 +198,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -213,6 +217,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -230,6 +236,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -247,6 +255,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -266,6 +276,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -284,6 +296,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -302,6 +316,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: true,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -320,6 +336,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: true,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -338,6 +356,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: true,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -355,6 +375,8 @@ describe('commands module', () => {
         noprogress: false,
         nowait: false,
         withDetails: true,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -372,6 +394,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -390,6 +414,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -408,6 +434,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: true,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -425,6 +453,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -442,6 +472,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -459,6 +491,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 
@@ -476,6 +510,8 @@ describe('commands module', () => {
         noprogress: true,
         nowait: false,
         withDetails: false,
+        reporter: 'inline',
+        outputPath: 'test-report.xml',
       });
     });
 

package/src/commands/remote.js

@@ -14,6 +14,9 @@ const {
   printTestRunInfo,
   printSuiteRunInfo,
 } = require('../utils/print');
+const {
+  generateJunitReport,
+} = require('../utils/testReports');
 const help = require('./help');
 
 const OBJECT_TYPES = [settings.TYPE_TEST, settings.TYPE_SUITE, settings.TYPE_PROFILE];
@@ -37,7 +40,10 @@ const getList = async (type, query, extraParams) => {
 };
 
 const getResult = async (type, id, extraParams) => {
-  const { noprogress, withDetails } = extraParams;
+  const {
+    noprogress, withDetails, reporter, outputPath,
+  } = extraParams;
+
   const spinner = getSpinner(noprogress);
   spinner.start('Waiting for result...');
   const route = settings.API_ROUTING[`${type}Result`];
@@ -45,10 +51,19 @@ const getResult = async (type, id, extraParams) => {
   try {
     const result = await apiCall(path, route.method, {}, {});
     if (result) {
-      if (type === settings.TYPE_TEST) {
-        printTestRunInfo(spinner, result.data, withDetails);
-      } else {
-        printSuiteRunInfo(spinner, result.data, withDetails);
+      switch (reporter) {
+        case settings.REPORTER_TYPE.junit: {
+          await generateJunitReport(type, result.data, outputPath);
+          break;
+        }
+        default: {
+          if (type === settings.TYPE_TEST) {
+            printTestRunInfo(spinner, result.data, withDetails);
+          } else {
+            printSuiteRunInfo(spinner, result.data, withDetails);
+          }
+          break;
+        }
       }
       return getExitCode(result.data.status);
     }
@@ -60,7 +75,9 @@ const getResult = async (type, id, extraParams) => {
 };
 
 const checkStatus = async (type, id, extraParams) => {
-  const { nowait, noprogress, withDetails } = extraParams;
+  const {
+    nowait, noprogress, withDetails, reporter,
+  } = extraParams;
   const spinner = getSpinner(noprogress);
   spinner.start('Waiting for result...');
   const route = settings.API_ROUTING[`${type}Status`];
@@ -73,7 +90,11 @@ const checkStatus = async (type, id, extraParams) => {
     } else {
       response = await apiCallPoll(path, route.method, {}, spinner, 0);
     }
-    if (withDetails || settings.FAILED_STATUS.includes(response.data.status)) {
+    if (
+      reporter !== settings.REPORTER_TYPE.inline
+      || withDetails
+      || settings.FAILED_STATUS.includes(response.data.status)
+    ) {
       await getResult(type, id, extraParams);
     } else {
       printStatus(spinner, response.data.status);
@@ -138,6 +159,8 @@ const parseArgs = async (args) => {
     nowait: args.wait === false || args.nowait || false,
     noprogress: args.progress === false || args.noprogress || false,
     withDetails: args['with-details'] || false,
+    reporter: args.reporter || settings.REPORTER_TYPE.inline,
+    outputPath: args['output-path'] || 'test-report.xml',
   };
 
   return {
@@ -152,7 +175,7 @@ const validateArgs = async (args) => {
     return false;
   }
 
-  const knownKeys = ['_', 'wait', 'nowait', 'noprogress', 'progress', 'with-details', 'debug', 'profile', 'variable', 'result-timeout'];
+  const knownKeys = ['_', 'wait', 'nowait', 'noprogress', 'progress', 'with-details', 'debug', 'profile', 'variable', 'result-timeout', 'reporter', 'output-path'];
   const unknownKeys = await getUnknownOptions(args, knownKeys);
   if (unknownKeys.length > 0) {
     console.error(`Unknown options: ${unknownKeys.join(', ')}`);

package/src/settings.js

@@ -11,6 +11,7 @@ const ENV_FILE_PATH = path.resolve(__dirname, '..', `.env.${NODE_ENV}`);
 const USER_AGENT = `BugBug CLI ${VERSION}`;
 dotenv.config({ path: ENV_FILE_PATH });
 
+// TODO: Fix this path due to Mac OS restrictions
 const CONFIG_DIR_PATH = path.join(os.homedir(), '.bugbug');
 const CONFIG_FILE_PATH = path.join(CONFIG_DIR_PATH, 'settings.json');
 
@@ -68,6 +69,11 @@ const API_ERROR_SUBSCRIPTION_EXCEPTION = 'subscriptionException';
 const API_ERROR_RUNNING_QUEUE_IS_FULL = 'runningQueueIsFullError';
 const API_ERROR_QUOTA_EXCEEDED = 'quotaExceeded';
 
+const REPORTER_TYPE = {
+  junit: 'junit',
+  inline: 'inline',
+};
+
 module.exports = {
   ACTION_HELP,
   ACTION_LIST,
@@ -95,4 +101,7 @@ module.exports = {
   TYPE_TEST,
   USER_AGENT,
   VERSION,
+  STATUS_ERROR,
+  STATUS_FAILED,
+  REPORTER_TYPE,
 };

package/src/utils/helper.js

@@ -43,10 +43,30 @@ const overrideSettings = async (args) => {
   }
 };
 
+const parseTimeFromDuration = (duration) => {
+  const [hours, minutes = '0', secondsWithMs = '0.0'] = (duration || '').split(':');
+  const [seconds, milliSeconds] = secondsWithMs.split('.');
+  return {
+    hours: hours || '00', minutes, secondsWithMs, seconds, milliSeconds,
+  };
+};
+
+const getMillisecondsFromDuration = (duration) => {
+  const {
+    hours, minutes, seconds, milliSeconds,
+  } = parseTimeFromDuration(duration);
+  return (
+    parseInt(hours, 10) * 3600
+    + parseInt(minutes, 10) * 60
+    + parseInt(seconds, 10)
+  ) * 1000 + parseInt(milliSeconds, 10);
+};
+
 module.exports = {
   getExitCode,
   getUnknownOptions,
   overrideSettings,
   parseVariables,
   printErrorResponse,
+  getMillisecondsFromDuration,
 };

package/src/utils/testReports.js

@@ -0,0 +1,57 @@
+const { getJunitXml } = require('junit-xml');
+const fs = require('node:fs');
+const path = require('node:path');
+
+const settings = require('../settings');
+const { getMillisecondsFromDuration } = require('./helper');
+
+const getTestInJunitFormat = (testRun) => {
+  const errorDetails = testRun.errorCode ? {
+    message: `Error ${testRun.errorCode} occurred in step: ${testRun.details[0].step.type} (${testRun.details[0].step.id})`,
+    stack: testRun.errorCode,
+  } : undefined;
+
+  return {
+    id: testRun.id,
+    name: testRun.name,
+    time: getMillisecondsFromDuration(testRun.duration),
+    classname: null,
+    errors: testRun.status === settings.STATUS_ERROR ? [errorDetails] : [],
+    failures: testRun.status === settings.STATUS_FAILED ? [errorDetails] : [],
+  };
+};
+
+const getSuiteInJunitFormat = (suiteRun) => ({
+  id: suiteRun.id,
+  name: suiteRun.name,
+  time: getMillisecondsFromDuration(suiteRun.duration),
+  testCases: suiteRun.details.map((testRun) => getTestInJunitFormat(testRun)),
+});
+
+const generateJunitReport = async (type, result, outputPath) => {
+  const testReport = {};
+  testReport.name = 'BugBug Report';
+  testReport.time = getMillisecondsFromDuration(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,
+};