@testim/testim-cli 3.253.0 → 3.255.0

package/{utils.js → utils/index.js}

@@ -1,16 +1,17 @@
+// @ts-check
+
 'use strict';
 
-const moment = require('moment');
-const pRetry = require('p-retry');
+const os = require('os');
 const _ = require('lodash');
-const Promise = require('bluebird');
-const fs = Promise.promisifyAll(require('fs'));
-const { W3C_ELEMENT_ID } = require('./player/constants');
-const { sessionType, testStatus: testStatusConst } = require('./commons/constants');
 const path = require('path');
-const httpRequest = require('./commons/httpRequest');
-const decompress = require('decompress');
-const os = require('os');
+const fsUtils = require('./fsUtils');
+const argsUtils = require('./argsUtils');
+const timeUtils = require('./timeUtils');
+const stringUtils = require('./stringUtils');
+const promiseUtils = require('./promiseUtils');
+const httpRequest = require('../commons/httpRequest');
+const { W3C_ELEMENT_ID } = require('../player/constants');
 
 const HOMEDIR = os.homedir();
 const TESTIM_BROWSER_DIR = path.join(HOMEDIR, '.testim-browser-profile');
@@ -43,6 +44,7 @@ const BROWSERS = [
     { browserName: 'Firefox', bs: { browser: 'Firefox', browser_version: '89' }, sl: { browserName: 'firefox', version: '89.0' }, browserValue: 'firefox' },
     { browserName: 'Safari', bs: { browser: 'Safari' }, sl: { browserName: 'safari' }, browserValue: 'safari' },
     { browserName: 'Edge', bs: { browser: 'Edge', browser_version: '18' }, sl: { browserName: 'MicrosoftEdge', version: '18.17763' }, browserValue: 'edge' },
+    // eslint-disable-next-line max-len
     { browserName: 'Edge Chromium', bs: { browser: 'Edge', browser_version: '94' }, sl: { browserName: 'MicrosoftEdge', version: '94' }, synonyms: ['edge-chromium'], browserValue: 'edge-chromium', seleniumName: 'MicrosoftEdge' },
     { browserName: 'Internet Explorer 11', bs: { browser: 'IE', browser_version: '11' }, sl: { browserName: 'internet explorer', version: '11.0' }, synonyms: ['ie11'], browserValue: 'ie11' },
     { browserName: 'Browser', bs: {}, sl: { browserName: 'Browser' }, browserValue: 'browser' },
@@ -53,7 +55,7 @@ const BROWSERS = [
 
 function getRunConfigByBrowserName(browser, saucelabs, browserstack) {
     browser = browser.toLowerCase();
-    const selectedBrowser = BROWSERS.find(b => b.browserName.toLowerCase() === browser || browser.indexOf(b.synonyms) > -1) || BROWSERS[0];
+    const selectedBrowser = BROWSERS.find(b => b.browserName.toLowerCase() === browser || browser.includes(b.synonyms)) || BROWSERS[0];
 
     // BS and SL do not support Linux for newer browser, so use Windows instead.
     let selectedOS = OSS.find(x => x.osName === 'Windows 10');
@@ -75,82 +77,10 @@ function getRunConfigByBrowserName(browser, saucelabs, browserstack) {
     return _.merge(selectedBrowser, selectedOS);
 }
 
-function getTestUrl(editorUrl, projectId, testId, resultId, branch) {
-    let testUrl = '';
-    branch = branch ? encodeURIComponent(branch) : 'master';
-    if (projectId && testId) {
-        testUrl = `${editorUrl}/#/project/${projectId}/branch/${branch}/test/${testId}`;
-        if (resultId) {
-            testUrl += `?result-id=${resultId}`;
-        }
-    }
-    return testUrl;
-}
-
-function isPromise(obj) {
-    return !!obj && (typeof obj === 'object' || typeof obj === 'function') && typeof obj.then === 'function' && typeof obj.catch === 'function';
-}
-
-function getDuration(ms) {
-    const duration = moment.duration(ms);
-    return `${duration.hours()}:${duration.minutes()}:${duration.seconds()}.${duration.milliseconds()}`;
-}
-
-function getDurationSec(ms) {
-    return moment.duration(ms).asSeconds();
-}
-
-function getRunnerVersion() {
-    try {
-        const pack = require(`${__dirname}/package.json`);
-        return pack.version;
-    } catch (err) {
-        return '';
-    }
-}
-
-function getEnginesVersion() {
-    try {
-        const pack = require(`${__dirname}/package.json`);
-        return pack.engines.node;
-    } catch (err) {
-        return '';
-    }
-}
-
-async function getEnginesVersionAsync() {
-    try {
-        const pack = JSON.parse(await fs.readFileAsync(`${__dirname}/package.json`));
-        return pack.engines.node;
-    } catch (err) {
-        return '';
-    }
-}
-
 function getEnvironmentGitBranch() {
     return process.env.GIT_BRANCH || process.env.CIRCLE_BRANCH || process.env.TRAVIS_BRANCH || process.env.CI_BRANCH;
 }
 
-function getUniqBrowsers(options, testList) {
-    if ((options.testConfigNames.length || options.testConfigIds.length || options.testPlan.length || options.testPlanIds.length) && !options.browser) {
-        return _.uniq(testList.map(t => t.runConfig.browserValue));
-    }
-    return [options.browser.toLowerCase()];
-}
-
-function randomString(length) {
-    const a = 'qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM1234567890';
-    const index = (Math.random() * (a.length - 1)).toFixed(0);
-    return length > 0 ? a[index] + randomString(length - 1) : '';
-}
-
-function blueBirdify(fn) {
-    return new Promise((resolve, reject) =>
-        fn()
-            .then(x => resolve(x))
-            .catch(y => reject(y)));
-}
-
 function removePropertyFromObject(obj, propName, cmpFunction) {
     for (const prop in obj) {
         if (obj.hasOwnProperty(prop)) {
@@ -163,133 +93,10 @@ function removePropertyFromObject(obj, propName, cmpFunction) {
     }
 }
 
-function getCliLocation() {
-    let cliLocation;
-    if (!require.main) { // we're in a REPL
-        return process.cwd(); // fall back on the current working directory
-    }
-    if (require.main.filename.includes('/src') || require.main.filename.includes('\\src') || process.env.IS_UNIT_TEST) {
-        cliLocation = path.resolve(__dirname, '../');
-    } else {
-        cliLocation = __dirname;
-    }
-
-    return cliLocation;
-}
-
-function buildBasicHeader(userName, password) {
-    const userAndPasswordBase64 = Buffer.from(`${userName}:${password}`).toString('base64');
-    return `Basic ${userAndPasswordBase64}`;
-}
-
 function extractElementId(element) {
     return element.ELEMENT || element[W3C_ELEMENT_ID];
 }
 
-function isURL(path) {
-    const legacyPattern = /^(https?:\/\/)/i;
-
-    // https://gist.github.com/dperini/729294 (validator.js based on).
-    const pattern = new RegExp(
-        '^' +
-        // protocol identifier (optional)
-        // short syntax // still required
-        '(?:(?:(?:https?|ftp):)?\\/\\/)' +
-        // user:pass BasicAuth (optional)
-        '(?:\\S+(?::\\S*)?@)?' +
-        '(?:' +
-        // IP address exclusion
-        // private & local networks
-        '(?!(?:10|127)(?:\\.\\d{1,3}){3})' +
-        '(?!(?:169\\.254|192\\.168)(?:\\.\\d{1,3}){2})' +
-        '(?!172\\.(?:1[6-9]|2\\d|3[0-1])(?:\\.\\d{1,3}){2})' +
-        // IP address dotted notation octets
-        // excludes loopback network 0.0.0.0
-        // excludes reserved space >= 224.0.0.0
-        // excludes network & broadcast addresses
-        // (first & last IP address of each class)
-        '(?:[1-9]\\d?|1\\d\\d|2[01]\\d|22[0-3])' +
-        '(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}' +
-        '(?:\\.(?:[1-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))' +
-        '|' +
-        // host & domain names, may end with dot
-        // can be replaced by a shortest alternative
-        // (?![-_])(?:[-\\w\\u00a1-\\uffff]{0,63}[^-_]\\.)+
-        '(?:' +
-        '(?:' +
-        '[a-z0-9\\u00a1-\\uffff]' +
-        '[a-z0-9\\u00a1-\\uffff_-]{0,62}' +
-        ')?' +
-        '[a-z0-9\\u00a1-\\uffff]\\.' +
-        ')+' +
-        // TLD identifier name, may end with dot
-        '(?:[a-z\\u00a1-\\uffff]{2,}\\.?)' +
-        ')' +
-        // port number (optional)
-        '(?::\\d{2,5})?' +
-        // resource path (optional)
-        '(?:[/?#]\\S*)?' +
-        '$', 'i'
-    );
-
-    return legacyPattern.test(path) || pattern.test(path);
-}
-
-const DOWNLOAD_RETRY = 3;
-const download = async (url) => pRetry(() => httpRequest.download(url), { retries: DOWNLOAD_RETRY });
-
-const downloadAndSave = async (url, saveToLocation) => {
-    const res = await download(url);
-    return fs.writeFileAsync(saveToLocation, res.body);
-};
-
-const copy = async (readFile, destFile) => new Promise((resolve, reject) => {
-    try {
-        const file = fs.createWriteStream(destFile);
-        fs.createReadStream(readFile).pipe(file);
-        file.on('finish', () => {
-            file.close(resolve);
-        });
-    } catch (err) {
-        reject(err);
-    }
-});
-function getSourcePath(location, fileName) {
-    if (isURL(location)) {
-        return fileName || path.join(process.cwd(), location.replace(/^.*[\\\/]/, ''));
-    }
-
-    return fileName || path.basename(location);
-}
-
-const getSource = async (location, fileName) => {
-    const destFile = getSourcePath(location, fileName);
-    if (isURL(location)) {
-        return downloadAndSave(location, destFile);
-    }
-
-    return copy(location, destFile);
-};
-
-const getSourceAsBuffer = async (location) => {
-    if (isURL(location)) {
-        return download(location);
-    }
-    return fs.readFileAsync(location);
-};
-
-const unzipFile = async (srcZipFile, destZipPath) => await decompress(srcZipFile, destZipPath);
-
-const getLocalFileSizeInMB = (fileLocation) => {
-    const stats = fs.statSync(fileLocation);
-    const fileSizeInBytes = stats.size;
-    return fileSizeInBytes / 1000000;
-};
-
-function getSessionType(options) {
-    return options.files.length > 0 ? sessionType.CODEFUL : sessionType.CODELESS;
-}
-
 function getPlanType(plan) {
     plan = plan || {};
     const now = Date.now();
@@ -304,16 +111,6 @@ function getPlanType(plan) {
     return 'free';
 }
 
-/**
- * @param time {number} in ms
- * @returns {Promise}
- */
-function delay(time) {
-    return new Promise(((resolve) => {
-        setTimeout(resolve, time);
-    }));
-}
-
 const calcPercentile = (arr, percentile) => {
     if (arr.length === 0) return 0;
     if (typeof percentile !== 'number') throw new TypeError('p must be a number');
@@ -327,17 +124,11 @@ const calcPercentile = (arr, percentile) => {
     return arr[index];
 };
 
-const hasTestPlanFlag = (options) => (options.testPlan && options.testPlan.length) || (options.testPlanIds && options.testPlanIds.length);
-
-const isRemoteRun = (options) => options.resultId && options.source === 'remote-run';
-
-const isQuarantineAndNotRemoteRun = (test, options) => test.testStatus === testStatusConst.QUARANTINE && !isRemoteRun(options) && !options.runQuarantinedTests;
-
 function groupTestsByRetries(testResults = []) { // NOTE: This duplicates a function in services (stream-data/result/resultService.js) since we can't share code between packages.
     return _.chain(testResults)
         .groupBy((tr) => tr.originalTestResultId || tr.resultId)
         .values()
-        .reduce((all, current) => {
+        .reduce((/** @type {any[]} */ all, current) => {
             if (!current) {
                 return all;
             }
@@ -356,7 +147,7 @@ function groupTestsByRetries(testResults = []) { // NOTE: This duplicates a func
             all.push(last);
             return all;
         }, [])
-        .filter(Boolean)
+        .compact()
         .value();
 }
 
@@ -380,54 +171,20 @@ async function getCdpAddressForHost(browserInstanceHost, timeout) {
     }
 }
 
-function getArgsOnRemoteRunFailure() {
-    const { argv: args } = process;
-    if (!args.includes('--remoteRunId')) {
-        return undefined;
-    }
-    return {
-        remoteRunId: args[args.indexOf('--remoteRunId') + 1],
-        projectId: args[args.indexOf('--project') + 1],
-        token: args[args.indexOf('--token') + 1],
-    };
-}
-
 
 module.exports = {
     TESTIM_BROWSER_DIR,
     removePropertyFromObject,
-    getTestUrl,
-    getDuration,
-    getDurationSec,
-    getRunnerVersion,
-    getEnginesVersion,
-    getEnginesVersionAsync,
-    isPromise,
     getEnvironmentGitBranch,
-    getUniqBrowsers,
-    guid: (n = 16) => randomString(n),
     getRunConfigByBrowserName,
-    blueBirdify,
-    buildBasicHeader,
     extractElementId,
-    getCliLocation,
-    isURL,
-    download,
-    downloadAndSave,
-    copy,
-    unzipFile,
-    getLocalFileSizeInMB,
-    getSource,
-    getSourceAsBuffer,
-    getSessionType,
-    getSourcePath,
     calcPercentile,
-    hasTestPlanFlag,
-    isRemoteRun,
-    isQuarantineAndNotRemoteRun,
     groupTestsByRetries,
     getPlanType,
-    delay,
     getCdpAddressForHost,
-    getArgsOnRemoteRunFailure,
+    ...fsUtils,
+    ...argsUtils,
+    ...timeUtils,
+    ...promiseUtils,
+    ...stringUtils,
 };

package/utils/promiseUtils.js

@@ -0,0 +1,89 @@
+// @ts-check
+
+'use strict';
+
+const Bluebird = require('bluebird');
+const { TimeoutError } = require('../errors');
+
+function isPromise(obj) {
+    return !!obj && (typeof obj === 'object' || typeof obj === 'function') && typeof obj.then === 'function' && typeof obj.catch === 'function';
+}
+
+/**
+ * @deprecated This is horrifying. Please stop what you are doing and think about what you just considered!
+ * @template T
+ * @param {() => Promise<T>} fn
+ * @returns {Bluebird<T>}
+ */
+function blueBirdify(fn) {
+    return new Bluebird((resolve, reject) =>
+        fn()
+            .then(x => resolve(x))
+            .catch(y => reject(y)));
+}
+
+/**
+ * @param time {number} in ms
+ * @returns {Promise}
+ */
+function delay(time) {
+    return new Promise(((resolve) => {
+        setTimeout(resolve, time);
+    }));
+}
+
+/**
+ * @template T
+ * @param {Promise<T> | undefined} promise
+ * @param {number} timeout
+ * @param {string=} errMsg
+ */
+function promiseTimeout(promise, timeout, errMsg = 'Timeout Error') {
+    return Promise.race([
+        promise,
+        delay(timeout).then(() => { throw new TimeoutError(errMsg); }),
+    ]);
+}
+
+/** @type {import('p-limit').default} */
+let pLimit;
+
+/**
+ * @template T, U
+ * @param {ArrayLike<T> | Iterable<T>} arr
+ * @param {(item: T, index: number) => PromiseLike<U>} handler
+ * @param {{ concurrency?: number }} options
+ */
+async function promiseMap(arr, handler, { concurrency } = {}) {
+    pLimit = pLimit || (await import('p-limit')).default;
+    if (concurrency) {
+        const limit = pLimit(concurrency);
+        return await Promise.all(Array.from(arr, (item, index) => limit(() => handler(item, index))));
+    }
+    return await Promise.all(Array.from(arr, handler));
+}
+
+/**
+ * @template ErrT, T
+ * @param {(callback: (err: ErrT, result: T) => void) => void} resolver
+ * @returns {Promise<T>}
+ */
+function promiseFromCallback(resolver) {
+    return new Promise((resolve, reject) => {
+        resolver((err, result) => {
+            if (err) {
+                return reject(err);
+            }
+            return resolve(result);
+        });
+    });
+}
+
+module.exports = {
+    isPromise,
+    blueBirdify,
+    delay,
+    promiseTimeout,
+    promiseMap,
+    promiseFromCallback,
+};

package/utils/stringUtils.js

@@ -0,0 +1,98 @@
+// @ts-check
+
+'use strict';
+
+/**
+ * @param {number} length
+ * @returns {string}
+ */
+function randomString(length) {
+    const a = 'qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM1234567890';
+    const index = (Math.random() * (a.length - 1)).toFixed(0);
+    return length > 0 ? a[index] + randomString(length - 1) : '';
+}
+
+/**
+ * @param {string} editorUrl
+ * @param {string} projectId
+ * @param {string} testId
+ * @param {string=} resultId
+ * @param {string=} branch
+ */
+function getTestUrl(editorUrl, projectId, testId, resultId, branch) {
+    let testUrl = '';
+    branch = branch ? encodeURIComponent(branch) : 'master';
+    if (projectId && testId) {
+        testUrl = `${editorUrl}/#/project/${projectId}/branch/${branch}/test/${testId}`;
+        if (resultId) {
+            testUrl += `?result-id=${resultId}`;
+        }
+    }
+    return testUrl;
+}
+
+/**
+ * @param {string} userName
+ * @param {string} password
+ */
+function buildBasicHeader(userName, password) {
+    const userAndPasswordBase64 = Buffer.from(`${userName}:${password}`).toString('base64');
+    return `Basic ${userAndPasswordBase64}`;
+}
+
+/** @param {string} path */
+function isURL(path) {
+    const legacyPattern = /^(https?:\/\/)/i;
+
+    // https://gist.github.com/dperini/729294 (validator.js based on).
+    const pattern = new RegExp(
+        '^' +
+        // protocol identifier (optional)
+        // short syntax // still required
+        '(?:(?:(?:https?|ftp):)?\\/\\/)' +
+        // user:pass BasicAuth (optional)
+        '(?:\\S+(?::\\S*)?@)?' +
+        '(?:' +
+        // IP address exclusion
+        // private & local networks
+        '(?!(?:10|127)(?:\\.\\d{1,3}){3})' +
+        '(?!(?:169\\.254|192\\.168)(?:\\.\\d{1,3}){2})' +
+        '(?!172\\.(?:1[6-9]|2\\d|3[0-1])(?:\\.\\d{1,3}){2})' +
+        // IP address dotted notation octets
+        // excludes loopback network 0.0.0.0
+        // excludes reserved space >= 224.0.0.0
+        // excludes network & broadcast addresses
+        // (first & last IP address of each class)
+        '(?:[1-9]\\d?|1\\d\\d|2[01]\\d|22[0-3])' +
+        '(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}' +
+        '(?:\\.(?:[1-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))' +
+        '|' +
+        // host & domain names, may end with dot
+        // can be replaced by a shortest alternative
+        // (?![-_])(?:[-\\w\\u00a1-\\uffff]{0,63}[^-_]\\.)+
+        '(?:' +
+        '(?:' +
+        '[a-z0-9\\u00a1-\\uffff]' +
+        '[a-z0-9\\u00a1-\\uffff_-]{0,62}' +
+        ')?' +
+        '[a-z0-9\\u00a1-\\uffff]\\.' +
+        ')+' +
+        // TLD identifier name, may end with dot
+        '(?:[a-z\\u00a1-\\uffff]{2,}\\.?)' +
+        ')' +
+        // port number (optional)
+        '(?::\\d{2,5})?' +
+        // resource path (optional)
+        '(?:[/?#]\\S*)?' +
+        '$', 'i'
+    );
+
+    return legacyPattern.test(path) || pattern.test(path);
+}
+
+module.exports = {
+    isURL,
+    getTestUrl,
+    buildBasicHeader,
+    guid: (n = 16) => randomString(n),
+};

package/utils/stringUtils.test.js

@@ -0,0 +1,22 @@
+const chai = require('chai'); // eslint-disable-line import/no-extraneous-dependencies
+const stringUtils = require('./stringUtils');
+
+const expect = chai.expect;
+
+describe('stringUtils', () => {
+    describe('getTestUrl', () => {
+        it('should create properly escaped test URL', () => {
+            expect(stringUtils.getTestUrl('http://localhost:8080', 'project', 'test')).to.equal('http://localhost:8080/#/project/project/branch/master/test/test');
+            expect(stringUtils.getTestUrl('http://localhost:8080', 'project', 'test', 'result')).to.equal('http://localhost:8080/#/project/project/branch/master/test/test?result-id=result');
+            expect(stringUtils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', null)).to.equal('http://localhost:8080/#/project/project/branch/master/test/test?result-id=result');
+            expect(stringUtils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'normal-branch-name'))
+                .to.equal('http://localhost:8080/#/project/project/branch/normal-branch-name/test/test?result-id=result');
+            expect(stringUtils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'branch/with/slashes'))
+                .to.equal('http://localhost:8080/#/project/project/branch/branch%2Fwith%2Fslashes/test/test?result-id=result');
+            expect(stringUtils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'branch with spaces'))
+                .to.equal('http://localhost:8080/#/project/project/branch/branch%20with%20spaces/test/test?result-id=result');
+            expect(stringUtils.getTestUrl('http://localhost:8080', 'project', 'test', 'result', 'encoded%20branch'))
+                .to.equal('http://localhost:8080/#/project/project/branch/encoded%2520branch/test/test?result-id=result');
+        });
+    });
+});

package/utils/timeUtils.js

@@ -0,0 +1,25 @@
+//@ts-check
+
+'use strict';
+
+const moment = require('moment');
+
+/**
+ * @param {moment.DurationInputArg1} ms
+ */
+function getDuration(ms) {
+    const duration = moment.duration(ms);
+    return `${duration.hours()}:${duration.minutes()}:${duration.seconds()}.${duration.milliseconds()}`;
+}
+
+/**
+ * @param {moment.DurationInputArg1} ms
+ */
+function getDurationSec(ms) {
+    return moment.duration(ms).asSeconds();
+}
+
+module.exports = {
+    getDuration,
+    getDurationSec,
+};

package/utils/utils.test.js

@@ -0,0 +1,27 @@
+const chai = require('chai'); // eslint-disable-line import/no-extraneous-dependencies
+const utils = require('./index');
+
+const expect = chai.expect;
+
+describe('utils', () => {
+    describe('calcPercentile', () => {
+        it('should calc some precentiles', () => {
+            // Arrange:
+            const arr = [4, 5, 1, 2, 7, 8, 3, 6, 9, 10];
+
+            // Act:
+            const p0 = utils.calcPercentile(arr, 0);
+            const p50 = utils.calcPercentile(arr, 50);
+            const p90 = utils.calcPercentile(arr, 90);
+            const p95 = utils.calcPercentile(arr, 95);
+            const p100 = utils.calcPercentile(arr, 100);
+
+            // Assert:
+            expect(p0).to.eql(1);
+            expect(p50).to.eql(5);
+            expect(p90).to.eql(9);
+            expect(p95).to.eql(10);
+            expect(p100).to.eql(10);
+        });
+    });
+});