@testim/testim-cli 3.253.0 → 3.255.0

package/runOptions.js

@@ -2,22 +2,20 @@
 
 'use strict';
 
-const { CLI_MODE } = require('./commons/constants');
-const { EDGE_CHROMIUM_MIN_VERSION } = require('./player/constants');
-const program = require('commander');
 const fs = require('fs');
 const ms = require('ms');
-const Promise = require('bluebird');
-const NoArgsError = require('./errors.js').NoArgsError;
-const ArgError = require('./errors.js').ArgError;
 const url = require('url');
 const _ = require('lodash');
 const path = require('path');
+const chalk = require('chalk');
+const program = require('commander');
 const utils = require('./utils');
-const runOptionsAgentFlow = require('./runOptionsAgentFlow');
 const runOptionsUtils = require('./runOptionsUtils');
+const runOptionsAgentFlow = require('./runOptionsAgentFlow');
 const localRunnerCache = require('./commons/runnerFileCache');
-const chalk = require('chalk');
+const { CLI_MODE } = require('./commons/constants');
+const { NoArgsError, ArgError } = require('./errors');
+const { EDGE_CHROMIUM_MIN_VERSION } = require('./player/constants');
 
 const camelizeHyphenValues = (prop) => prop.replace(/-([a-z])/g, (m, w) => w.toUpperCase());
 
@@ -114,6 +112,10 @@ const printUsage = () => {
         return line.includes('--high-speed'); // high speed mode was renamed to turbo mode
     }
 
+    function isTestStartTimeout(line) {
+        return line.includes('--test-start-timeout');
+    }
+
     program.help((txt) => {
         const lines = txt.split('\n');
         return lines
@@ -129,7 +131,8 @@ const printUsage = () => {
                     !isWebdriverTimeout(ln) &&
                     !isSaveRCALocally(ln) &&
                     !isExitCodeIgnoreFailingTests(ln) &&
-                    !isDeprecatedHighSpeed(ln)
+                    !isDeprecatedHighSpeed(ln) &&
+                    !isTestStartTimeout(ln)
             )
             .join('\n');
     });
@@ -183,12 +186,12 @@ program
     .option('-h, --headless [headless]', 'run in headless mode')
     .option('-m, --mode [runner-mode]', 'use extension or selenium mode (extension/selenium/appium)')
     .option('--branch [branch]', 'branch name', null)
-    .option('--base-url [base-url]', 'change al test base-url to a specified url')
+    .option('--base-url [base-url]', 'change base-url to a specified url for all tests in current execution')
     .option('--token [token]', 'identification token to testim')
     .option('--is-regression-baseline-run', 'save doms and run results as regression baseline data')
-    .option('--parallel [number-of-tests]', 'number of tests to run on parallel')
-    .option('--before-parallel [number-of-tests]', 'number of tests to run on parallel in the before phase of a test plan')
-    .option('--after-parallel [number-of-tests]', 'number of tests to run on parallel in the after phase of a test plan')
+    .option('--parallel [number-of-tests]', 'number of tests to run in parallel')
+    .option('--before-parallel [number-of-tests]', 'number of tests to run in parallel during the before phase of a test plan')
+    .option('--after-parallel [number-of-tests]', 'number of tests to run in parallel during the after phase of a test plan')
     .option('--canary [canary-mode]', 'enable canary mode', false)
     .option('--test-plan [test-plan-name]', 'test plan to run', collect, [])
     .option('--test-plan-id [test-plan-id]', 'test plan to run', collect, [])
@@ -203,7 +206,7 @@ program
     .option('--proxy-for-grid [proxy-for-grid]', 'used together with --proxy to also router grid traffic through a proxy')
     .option('--result-label [result-label]', 'result label', collect, [])
     .option('-oen --override-execution-name [execution-name]', 'override the default execution name', '')
-    .option('--retries [max_num_of_retries]', 'number of retires failure test defaults to not retrying', 0)
+    .option('--retries [max_num_of_retries]', 'number of retries on test failure, defaults to 0 (no retries)', 0)
     .option('--set-retention [retention-in-days]', 'set the number of days for results retention')
     .option('--user [user-id]', 'user ID for local Testim-CLI')
     .option('--pass-zero-tests', 'don\'t fail the run if no tests were found')
@@ -217,17 +220,18 @@ program
     .option('--file-cache-location [directory]', ' internal CLI file caching location')
 
     // Timeout
-    .option('--timeout [test-timeout]', 'test run timeout in milliseconds')
-    .option('--browser-timeout [open-browser-timeout]', 'get browser from grid timeout in milliseconds')
-    .option('--new-browser-wait-timeout [max-wait-to-browser]', 'maximum get browser wait in minutes')
+    .option('--test-start-timeout [test-start-timeout]', 'The time to wait for a test to start after getting a browser session', Number, Number(process.env.TESTIM_TEST_START_TIMEOUT) || (2 * 60 * 1000))
+    .option('--timeout [test-timeout]', 'Test run timeout in milliseconds', Number)
+    .option('--browser-timeout [open-browser-timeout]', 'Get browser from grid timeout in milliseconds', Number)
+    .option('--new-browser-wait-timeout [max-wait-to-browser]', 'Maximum get browser wait in minutes', Number)
 
     // New Timeouts
-    .option('--get-browser-timeout [get-browser-timeout]', 'Timeout for a single attempt to get browser from the grid configured in the project\'s plan') // getBrowserTimeout
-    .option('--get-browser-retries [get-browser-retries]', 'Number of attempts to get browser from the grid configured in the project\'s plan') // getBrowserRetries
-    .option('--get-session-timeout [get-session-timeout]', 'Timeout for "/session" request to the selenium server', ms('90s')) // getSessionTimeout
-    .option('--get-session-retries [get-session-retries]', 'Retries for "/session" request to the selenium server', 3) // getSessionRetries
-    .option('--driver-request-timeout [driver-request-timeout]', 'Timeout for any WebDriver request to the grid server', ms('90s')) // driverRequestTimeout
-    .option('--driver-request-retries [driver-request-retries]', 'Retries for any WebDriver request to the grid server', 3) // driverRequestRetries
+    .option('--get-browser-timeout [get-browser-timeout]', 'Timeout for a single attempt to get browser from the grid configured in the project\'s plan', Number) // getBrowserTimeout
+    .option('--get-browser-retries [get-browser-retries]', 'Number of attempts to get browser from the grid configured in the project\'s plan', Number) // getBrowserRetries
+    .option('--get-session-timeout [get-session-timeout]', 'Timeout for "/session" request to the selenium server', Number, ms('90s')) // getSessionTimeout
+    .option('--get-session-retries [get-session-retries]', 'Retries for "/session" request to the selenium server', Number, 3) // getSessionRetries
+    .option('--driver-request-timeout [driver-request-timeout]', 'Timeout for any WebDriver request to the grid server', Number, ms('90s')) // driverRequestTimeout
+    .option('--driver-request-retries [driver-request-retries]', 'Retries for any WebDriver request to the grid server', Number, 3) // driverRequestRetries
 
     // Run chrome ext mode locally
     .option('--use-local-chrome-driver [use-local-chrome-driver]', 'use a local ChromeDriver instance instead of a selenium grid')
@@ -347,7 +351,7 @@ program
     .option('--use-prefeched-data [location]', 'use prefetched data from local cache file, and force using only cached data')
     .option('--save-rca-locally [path]', 'save root cause analysis assets locally')
 
-    .option('--exit-code-ignore-failing-tests', 'dont return non zero exit code when tests fail. non zero exit code will mean a real error occurred')
+    .option('--exit-code-ignore-failing-tests', 'return exit code of zero when tests fail. non zero exit code will mean a real error occurred')
 
     .option('--intersect-with-label [label]', 'Out of the execution\'s test list, run only those tests that have the specified label', collect, [])
     .option('--intersect-with-suite [suiteName]', 'Out of the execution\'s test list, run only those tests that are included in the specified suite (by suite name)', collect, [])
@@ -510,8 +514,10 @@ module.exports = {
         try {
             let options = {};
             if (program.configFile) {
+                // eslint-disable-next-line import/no-dynamic-require
                 options = require(path.join(process.cwd(), program.configFile)).config;
             } else if (program.optionsFile) {
+                // eslint-disable-next-line import/no-dynamic-require
                 options = require(path.join(process.cwd(), program.optionsFile));
             }
 
@@ -546,19 +552,20 @@ module.exports = {
         }
 
 
-        const isTestConfigSpecified = (program.testConfig && program.testConfig.length) || (program.testConfigId && program.testConfigId.length);
-        const isTestPlanSpecified = (program.testPlan && program.testPlan.length) || (program.testPlanId && program.testPlanId.length);
-        const isSuiteSpecified = (program.suite && program.suite.length) || (program.suiteId && program.suiteId.length);
+        const isTestConfigSpecified = program.testConfig?.length || program.testConfigId?.length;
+        const isTestPlanSpecified = program.testPlan?.length || program.testPlanId?.length;
+        const isSuiteSpecified = program.suite?.length || program.suiteId?.length;
 
         if (program.seleniumCapsFile) {
             try {
+                // eslint-disable-next-line import/no-dynamic-require
                 seleniumCapsFileContent = require(path.join(process.cwd(), program.seleniumCapsFile));
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to parse selenium caps file file error: ${err.message}`));
+                throw new ArgError(`Failed to parse selenium caps file file error: ${err.message}`);
             }
         }
 
-        if (program.reporters && program.reporters.includes('junit') && !program.reportFile) {
+        if (program.reporters?.includes('junit') && !program.reportFile) {
             console.log('Warning: please define --report-file option for JUnit reporter');
         }
 
@@ -575,9 +582,10 @@ module.exports = {
         }
         if (program.chromeExtraPrefs) {
             try {
+                // eslint-disable-next-line import/no-dynamic-require
                 chromeExtraPrefs = require(path.join(process.cwd(), program.chromeExtraPrefs));
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to read/open chrome extra prefs file error: ${err.message}`));
+                throw new ArgError(`Failed to read/open chrome extra prefs file error: ${err.message}`);
             }
         }
 
@@ -598,9 +606,10 @@ module.exports = {
 
         if (program.paramsFile) {
             try {
+                // eslint-disable-next-line import/no-dynamic-require
                 userParamsData = Object.assign({}, userParamsData, require(path.join(process.cwd(), program.paramsFile)));
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to read/open params file error: ${err.message}`));
+                throw new ArgError(`Failed to read/open params file error: ${err.message}`);
             }
         }
 
@@ -608,7 +617,7 @@ module.exports = {
             try {
                 userParamsData = Object.assign({}, userParamsData, JSON.parse(program.params));
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to parse params string error: ${err.message}`));
+                throw new ArgError(`Failed to parse params string error: ${err.message}`);
             }
         }
 
@@ -627,6 +636,7 @@ module.exports = {
 
         if (program.sauceOptions) {
             try {
+                // eslint-disable-next-line import/no-dynamic-require
                 const sOptions = require(path.join(process.cwd(), program.sauceOptions));
                 const isMobile = sOptions.platformName && ['ios', 'android'].includes(sOptions.platformName.toLowerCase());
                 if (sOptions.browserName) {
@@ -649,12 +659,12 @@ module.exports = {
 
                 const isBadVersion = parseFloat(sOptions.version) < 50 && !['dev', 'beta'].includes(sOptions.version);
                 if (!isMobile && program.browser === 'chrome' && isBadVersion) {
-                    return Promise.reject(new ArgError('The minimum chrome supported version is 50.0'));
+                    throw new ArgError('The minimum chrome supported version is 50.0');
                 }
 
                 program.saucelabs = Object.assign({}, program.saucelabs, sOptions);
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to parse saucelabs options file error: ${err.message}`));
+                throw new ArgError(`Failed to parse saucelabs options file error: ${err.message}`);
             }
         }
 
@@ -672,6 +682,7 @@ module.exports = {
 
         if (program.browserstackOptions) {
             try {
+                // eslint-disable-next-line import/no-dynamic-require
                 const bsOptions = require(path.join(process.cwd(), program.browserstackOptions));
                 const isMobile = bsOptions.platform && ['mac', 'android'].includes(bsOptions.platform.toLowerCase());
                 if (bsOptions.browserName) {
@@ -683,12 +694,12 @@ module.exports = {
                 }
 
                 if (!isMobile && parseFloat(bsOptions.browser_version) < 50 && program.browser === 'chrome') {
-                    return Promise.reject(new ArgError('The minimum chrome supported version is 50.0'));
+                    throw new ArgError('The minimum chrome supported version is 50.0');
                 }
 
                 program.browserstack = Object.assign({}, program.browserstack, bsOptions);
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to parse browserstack options file error: ${err.message}`));
+                throw new ArgError(`Failed to parse browserstack options file error: ${err.message}`);
             }
         }
 
@@ -700,11 +711,12 @@ module.exports = {
 
         if (program.perfectoOptions) {
             try {
+                // eslint-disable-next-line import/no-dynamic-require
                 const perfectoOptions = require(path.join(process.cwd(), program.perfectoOptions));
                 const DEFAULTS = { location: 'US East', securityToken: program.perfectoToken };
                 program.perfecto = Object.assign({}, DEFAULTS, perfectoOptions);
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to parse perfecto options file error: ${err.message}`));
+                throw new ArgError(`Failed to parse perfecto options file error: ${err.message}`);
             }
         }
 
@@ -716,11 +728,12 @@ module.exports = {
 
         if (program.testobjectOptions) {
             try {
+                // eslint-disable-next-line import/no-dynamic-require
                 const testobjectOptions = require(path.join(process.cwd(), program.testobjectOptions));
                 const DEFAULTS = { testobjectApiKey: program.testobjectKey };
                 program.testobjectSauce = Object.assign({}, DEFAULTS, testobjectOptions);
             } catch (err) {
-                return Promise.reject(new ArgError(`Failed to parse test object options file error: ${err.message}`));
+                throw new ArgError(`Failed to parse test object options file error: ${err.message}`);
             }
         }
 
@@ -751,8 +764,8 @@ module.exports = {
         }
 
         program.retries = !program.retries || typeof program.retries === 'boolean' ? 1 : Number(program.retries) + 1;
-        program.browserTimeout = !program.browserTimeout || typeof program.browserTimeout === 'boolean' ? 60 * 1000 : Number(program.browserTimeout);
-        program.newBrowserWaitTimeout = !program.newBrowserWaitTimeout || typeof program.newBrowserWaitTimeout === 'boolean' ? 10 * 60 * 1000 : Number(program.newBrowserWaitTimeout * 60 * 1000);
+        program.browserTimeout = !program.browserTimeout || typeof program.browserTimeout === 'boolean' ? 60 * 1000 : program.browserTimeout;
+        program.newBrowserWaitTimeout = !program.newBrowserWaitTimeout || typeof program.newBrowserWaitTimeout === 'boolean' ? 10 * 60 * 1000 : program.newBrowserWaitTimeout * 60 * 1000;
 
         if (!program.getBrowserTimeout) {
             program.getBrowserTimeout = program.browserTimeout;
@@ -764,7 +777,7 @@ module.exports = {
         program.driverRequestTimeout = program.browserTimeout < program.driverRequestTimeout ? program.driverRequestTimeout : program.browserTimeout;
 
         const timeoutWasGiven = Boolean(program.timeout);
-        program.timeout = !program.timeout || typeof program.timeout === 'boolean' ? 10 * 60 * 1000 : Number(program.timeout);
+        program.timeout = !program.timeout || typeof program.timeout === 'boolean' ? 10 * 60 * 1000 : program.timeout;
         program.beforeParallel = !program.beforeParallel || typeof program.beforeParallel === 'boolean' ? 1 : Number(program.beforeParallel);
         program.parallel = !program.parallel || typeof program.parallel === 'boolean' ? 1 : Number(program.parallel);
         program.afterParallel = !program.afterParallel || typeof program.afterParallel === 'boolean' ? 1 : Number(program.afterParallel);
@@ -901,7 +914,7 @@ module.exports = {
             throw new ArgError('please define exactly one of --grid or --grid-id or --host');
         }
 
-        if (program.host && program.host.includes('/')) {
+        if (program.host?.includes('/')) {
             if (!/^(f|ht)tps?:\/\//i.test(program.host)) {
                 program.host = `http://${program.host}`;
             }
@@ -1009,7 +1022,7 @@ module.exports = {
                 const fileContent = fs.readFileSync(program.tmsFieldFile);
                 program.tmsCustomFields = JSON.parse(fileContent);
             } catch (err) {
-                return Promise.reject(new ArgError(`failed to parse field file error: ${err.message}`));
+                throw new ArgError(`failed to parse field file error: ${err.message}`);
             }
         }
 
@@ -1046,7 +1059,7 @@ module.exports = {
                 const lightweightModeOptions = typeof program.lightweightMode === 'string' ? JSON.parse(program.lightweightMode) : {};
                 program.lightweightMode = Object.assign({}, DEFAULTS, lightweightModeOptions);
             } catch (err) {
-                return Promise.reject(new ArgError(`failed to parse lightweightMode settings error: ${err.message}`));
+                throw new ArgError(`failed to parse lightweightMode settings error: ${err.message}`);
             }
         } else if (program.turboMode && program.mode === CLI_MODE.EXTENSION) {
             program.lightweightMode = {
@@ -1179,6 +1192,8 @@ module.exports = {
             driverRequestTimeout: program.driverRequestTimeout,
             driverRequestRetries: program.driverRequestRetries,
 
+            testStartTimeout: program.testStartTimeout,
+
             testConfigNames: program.testConfig,
             testConfigIds: program.testConfigId,
 

package/runner.js

@@ -118,6 +118,14 @@ function setBranch(options, branchInfoFromServer) {
     }
 }
 
+async function setSfdcCredential(options) {
+    const { projectData: { projectId } } = options;
+    const branch = branchService.getCurrentBranch();
+    if (_.get(options, 'company.activePlan.premiumFeatures.ttaForSalesforce')) {
+        options.sfdcCredential = await servicesApi.loadSfdcCredential({ projectId, branch });
+    }
+}
+
 function setCompany(options, company) {
     const { onprem, id, storageBaseUrl, storageType, name, activePlan = {} } = company;
     if (onprem) {
@@ -172,6 +180,7 @@ function setAuthData(options, authData) {
 function setProject(options, project) {
     const { id, name, type, defaults } = project;
     featureFlags.setProjectId(id);
+    featureFlags.setProjectType(type);
     options.projectData = {
         projectId: id,
         type,
@@ -194,6 +203,10 @@ async function setMockNetworkRules(options) {
     }
 }
 
+/**
+ * @param {import('./runOptions').RunnerOptions} options
+ * @param {string=} customExtensionLocalLocation
+ */
 async function runRunner(options, customExtensionLocalLocation) {
     perf.log('in runner.js runRunner');
 
@@ -265,6 +278,7 @@ async function init(options) {
     setBranch(options, branchName);
     setAllGrids(options, allGrids);
     setAuthData(options, authData);
+    await setSfdcCredential(options);
 
     if (!(options.lightweightMode && options.lightweightMode.disableLabs)) {
         await labFeaturesService.loadLabFeatures(projectById.id, companyByProjectId.activePlan);

package/runners/ParallelWorkerManager.js

@@ -61,13 +61,13 @@ class ParallelWorkerManager {
             const combinedTestResults = {};
             const testCount = testList.length;
 
-            const companyId = options.company && options.company.companyId;
-            const companyName = options.company && options.company.name;
+            const companyId = options.company?.companyId;
+            const companyName = options.company?.name;
             const source = options.source || 'cli';
             const user = options.user;
-            const companyPlan = options.company && options.company.planType;
-            const isStartUp = options.company && options.company.isStartUp;
-            const projectName = options.projectData && options.projectData.name;
+            const companyPlan = options.company?.planType;
+            const isStartUp = options.company?.isStartUp;
+            const projectName = options.projectData?.name;
             const lightweightMode = options.lightweightMode;
             const sessionType = utils.getSessionType(options);
 
@@ -95,7 +95,7 @@ class ParallelWorkerManager {
             const onTestCompleted = async (wid, testId, testResult, sessionId, isRerun) => {
                 runningTests--;
                 const update = {};
-                if (lightweightMode && lightweightMode.onlyTestIdsNoSuite) {
+                if (lightweightMode?.onlyTestIdsNoSuite) {
                     update.show = true;
                 }
                 if (testResult.seleniumStats) {
@@ -115,9 +115,9 @@ class ParallelWorkerManager {
                     update.gridHost = options.host;
                 }
                 if (options.grid || options.gridId) {
-                    update.gridName = options.grid || (options.gridData && options.gridData.name);
-                    update.gridType = options.gridData && options.gridData.type;
-                    update.gridProvider = options.gridData && options.gridData.provider;
+                    update.gridName = options.grid || options.gridData?.name;
+                    update.gridType = options.gridData?.type;
+                    update.gridProvider = options.gridData?.provider;
                 } else if (options.useLocalChromeDriver) {
                     update.gridName = 'local-chrome-driver-from-options';
                     update.gridType = 'local-chrome';
@@ -214,7 +214,6 @@ class ParallelWorkerManager {
     }
 }
 
-
 function schedule(fn, index) {
     if (index === 0) {
         fn();