@testim/testim-cli 3.260.0 → 3.262.0

package/runOptions.js

@@ -112,6 +112,10 @@ const printUsage = () => {
         return line.includes('--high-speed'); // high speed mode was renamed to turbo mode
     }
 
+    function isUrls(line) {
+        return line.includes('--urls');
+    }
+
     function isTestStartTimeout(line) {
         return line.includes('--test-start-timeout');
     }
@@ -119,7 +123,7 @@ const printUsage = () => {
     program.help((txt) => {
         const lines = txt.split('\n');
         return lines
-            .filter(
+            .filter( // hide CLI options
                 (ln) =>
                     !isExtOnlyOption(ln) &&
                     !isParamsJsonOption(ln) &&
@@ -132,6 +136,7 @@ const printUsage = () => {
                     !isSaveRCALocally(ln) &&
                     !isExitCodeIgnoreFailingTests(ln) &&
                     !isDeprecatedHighSpeed(ln) &&
+                    !isUrls(ln) &&
                     !isTestStartTimeout(ln)
             )
             .join('\n');
@@ -172,6 +177,7 @@ program
     .option('-n, --name [test-name]', 'test name to run', collect, [])
     .option('--project [project-id]', 'project ID')
     .option('-r, --report-file [report junit xml path]', 'where to save junit xml results file')
+    .option('--urls', 'add step urls to the junit report')
     .option('--override-report-file-classname [override-report-file-classname]', 'custom junit class name for the junit reporter')
     .option('--reporters [names]', 'report types', list)
     .option('-h, --host [host-name]', 'host name or ip containing the selenium grid')
@@ -1108,6 +1114,7 @@ module.exports = {
             files: [program.files].flat(),
             webpackConfig: program.webpackConfig,
             reportFile: program.reportFile,
+            urls: program.urls,
             reportFileClassname: program.overrideReportFileClassname,
             reporters: program.reporters,
             project: program.project,

package/runners/TestPlanRunner.js

@@ -1,29 +1,30 @@
 'use strict';
 
 const _ = require('lodash');
-const constants = require('../commons/constants');
-
-const TESTIM_RUN_STATUS = constants.testRunStatus;
+const utils = require('../utils');
+const Logger = require('../commons/logger');
+const config = require('../commons/config');
 const reporter = require('../reports/reporter');
-const RealDataService = require('../commons/socket/realDataService');
-const testimServicesApi = require('../commons/testimServicesApi');
-const testimCustomToken = require('../commons/testimCustomToken');
+const constants = require('../commons/constants');
 const TestRunStatus = require('../testRunStatus');
-const analyticsService = require('../services/analyticsService');
+const perf = require('../commons/performance-logger');
 const gridService = require('../services/gridService');
 const branchService = require('../services/branchService');
-const config = require('../commons/config');
 const ParallelWorkerManager = require('./ParallelWorkerManager');
-const utils = require('../utils');
-const { getSuite, calcTestResultStatus, validateConfig } = require('./runnerUtils');
+const analyticsService = require('../services/analyticsService');
+const testimServicesApi = require('../commons/testimServicesApi');
+const testimCustomToken = require('../commons/testimCustomToken');
+const RealDataService = require('../commons/socket/realDataService');
 const { StopRunOnError, ArgError } = require('../errors');
-const Logger = require('../commons/logger');
-const perf = require('../commons/performance-logger');
+const { getSuite, calcTestResultStatus, validateConfig } = require('./runnerUtils');
 
 const guid = utils.guid;
+const TESTIM_RUN_STATUS = constants.testRunStatus;
 const logger = Logger.getLogger('test-plan-runner');
 const TDK_CHILD_RESULTS_TIMEOUT = 1000 * 60 * 5;
 
+/** @typedef {Awaited<ReturnType<typeof getSuite>>['tests'][number]} ExecutionList */
+
 class TestPlanRunner {
     /**
      * @param {string=} customExtensionLocalLocation
@@ -35,9 +36,9 @@ class TestPlanRunner {
 
     /**
      * @private
-     * @param {any[]} beforeTests
-     * @param {any[]} tests
-     * @param {any[]} afterTests
+     * @param {ExecutionList} beforeTests
+     * @param {ExecutionList} tests
+     * @param {ExecutionList} afterTests
      * @param {string} branchToUse
      * @param {import('../runOptions').RunnerOptions} tpOptions
      * @param {string} executionId
@@ -213,9 +214,9 @@ class TestPlanRunner {
 
     /**
      * @private
-     * @param {any[]} beforeTests
-     * @param {any[]} tests
-     * @param {any[]} afterTests
+     * @param {ExecutionList} beforeTests
+     * @param {ExecutionList} tests
+     * @param {ExecutionList} afterTests
      * @param {import('../runOptions').RunnerOptions} tpOptions
      * @param {string} testPlanName
      * @param {string | null} testPlanId
@@ -285,7 +286,7 @@ class TestPlanRunner {
         });
 
         function flattenTestListData(testPlansData) {
-            return _.flattenDeep(Object.keys(testPlansData).map(tpId => testPlansData[tpId])).reduce((all, testRun) => _.concat(all, testRun.beforeTests, testRun.tests, testRun.afterTests), []);
+            return _.flattenDeep(Object.values(testPlansData)).reduce((all, testRun) => all.concat(testRun.beforeTests, testRun.tests, testRun.afterTests), []);
         }
 
         const testPlansResults = {};

package/runners/runnerUtils.js

@@ -53,9 +53,8 @@ function calcTestResultStatus(tests) {
 
 
 /**
- * @template T
  * @param {import('../runOptions').RunnerOptions} options
- * @param {T[]} testList
+ * @param {import('./TestPlanRunner').ExecutionList} testList
  */
 async function validateConfig(options, testList) {
     const supportedBrowsers = options.mode === 'extension' ? [

package/testRunHandler.js

@@ -23,6 +23,14 @@ const MAX_LIGHTWEIGHT_MODE_RUN_DATA_SIZE = 20 * 1000; // max size, in characters
 const canSendRunDataOverUrl = (runData) => JSON.stringify(runData).length < MAX_LIGHTWEIGHT_MODE_RUN_DATA_SIZE;
 
 class TestRun {
+    /**
+     * @param {string} executionId
+     * @param {string} executionName
+     * @param {*} test
+     * @param {import('./runOptions').RunnerOptions} options
+     * @param {string} branchToUse
+     * @param {import('./testRunStatus')} testRunStatus
+     */
     constructor(executionId, executionName, test, options, branchToUse, testRunStatus) {
         this._executionId = executionId;
         this._executionName = executionName;
@@ -33,7 +41,7 @@ class TestRun {
         this._code = test.code;
         this._baseUrl = options.baseUrl || test.baseUrl || test.testConfig.baseUrl;
         this._nativeApp = test.nativeApp;
-        this._overrideTestConfigId = test.overrideTestConfig && test.overrideTestConfig.id;
+        this._overrideTestConfigId = test.overrideTestConfig?.id;
         this._options = options;
         this._branch = branchToUse;
         this._maxRetryCount = options.retries;
@@ -43,7 +51,7 @@ class TestRun {
         this._totalRetryCount = 1;
 
         this._testRunStatus = testRunStatus;
-        const shouldUpdateConfig = !(test.runConfig && test.runConfig.isMobileWeb) && options.browser;
+        const shouldUpdateConfig = !test.runConfig?.isMobileWeb && options.browser;
         this._runConfig = shouldUpdateConfig ? utils.getRunConfigByBrowserName(options.browser, options.saucelabs, options.browserstack) : test.runConfig;
         this.clearTestResultFinished = Promise.resolve();
 
@@ -181,20 +189,22 @@ class TestRun {
             runRequestParams.lightweightMode = this._options.lightweightMode;
         }
 
-        if (this._options.lightweightMode && this._options.lightweightMode.general) {
+        if (this._options.lightweightMode?.general) {
             runRequestParams.company = this._options.company;
             const runData = this.getRunData();
             runRequestParams.lightweightMode.isRunDataSentInUrl = canSendRunDataOverUrl(runData);
+            const stringifiedLength = JSON.stringify(runData).length;
+            const testId = this.getTestId();
             if (runRequestParams.lightweightMode.isRunDataSentInUrl) {
                 runRequestParams.runData = runData;
-                logger.info(`Run data sent as URL param, test id: ${this.getTestId()} run data length: ${JSON.stringify(runData).length}`);
+                logger.info(`Run data sent as URL param, test id: ${testId} run data length: ${stringifiedLength}`);
             } else {
-                logger.warn(`Run data is too big to be sent as a URL param. Test id: ${this.getTestId()}, run data size: ${JSON.stringify(runData).length} (limit: ${MAX_LIGHTWEIGHT_MODE_RUN_DATA_SIZE} characters)`);
+                logger.warn(`Run data is too big to be sent as a URL param. Test id: ${testId}, run data size: ${stringifiedLength} (limit: ${MAX_LIGHTWEIGHT_MODE_RUN_DATA_SIZE} characters)`);
             }
             runRequestParams.isLocalRun = Boolean(this._options.useLocalChromeDriver || this._options.useChromeLauncher);
         }
 
-        if (this._options.lightweightMode && this._options.lightweightMode.preloadTests && this._options.useChromeLauncher) {
+        if (this._options.lightweightMode?.preloadTests && this._options.useChromeLauncher) {
             const preloadedTests = await preloadTests(this._options);
             runRequestParams.preloadedTest = preloadedTests[runRequestParams.testId];
         }
@@ -259,8 +269,7 @@ class TestRun {
         }
         const mustClearPreviousStepResults = (this._timeoutRetryCount > 1 || this._retryCount > 1);
 
-        if (this._options.lightweightMode && this._options.lightweightMode.disableResults &&
-            !mustClearPreviousStepResults && canSendRunDataOverUrl(runData)) {
+        if (this._options.lightweightMode?.disableResults && !mustClearPreviousStepResults && canSendRunDataOverUrl(runData)) {
             return Promise.resolve();
         }
 
@@ -574,7 +583,7 @@ class TestRun {
         this._originalTestResultId = this._originalTestResultId || this._previousTestResultId;
         this._testResultId = utils.guid();
 
-        if (this._options.lightweightMode && this._options.lightweightMode.onlyTestIdsNoSuite) {
+        if (this._options.lightweightMode?.onlyTestIdsNoSuite) {
             return;
         }