@testim/testim-cli 3.193.0 → 3.197.0

package/README.md

@@ -1,6 +1,6 @@
 
 # TESTIM.IO
-## Web & Mobile Test Automation Solution. Built for agile teams. Testim is a cloud service that instantly enables Test Automation to make your Continuous Delivery ready.
+## Web Test Automation Solution. Built for agile teams. Testim is a cloud service that instantly enables Test Automation to make your Continuous Delivery ready.
 
 For more information please check out https://testim.io and https://help.testim.io/docs
 

package/cli/onExit.js

@@ -1,16 +1,22 @@
 'use strict';
 
 const constants = require('../commons/constants');
-const utils = require('../utils');
 const { requireWithFallback } = require('../commons/requireWithFallback');
 const { isCi } = require('./isCiRun');
 const { writeStackTrace } = require('./writeStackTrace');
 const logger = require('../commons/logger').getLogger('process-handler');
 
+let exitCodeIgnoreFailingTests = false;
+
 function getExitCode(result) {
     if (result instanceof Error) {
         return 1;
     }
+
+    if (exitCodeIgnoreFailingTests) {
+        return 0;
+    }
+
     result = result || {};
     const hasFailedTests = Object.values(result).some(
         ({ runnerStatus, success, testStatus, status }) => {
@@ -32,9 +38,13 @@ function closeChromeDriverIfRunning() {
     try {
         const chromedriver = requireWithFallback('chromedriver');
         chromedriver.stop();
+    // eslint-disable-next-line no-empty
     } catch (err) { }
 }
 
+module.exports.ignoreFailingTestsInExitCode = function () {
+    exitCodeIgnoreFailingTests = true;
+};
 
 
 module.exports.onExit = async function onExit(exitValue) {
@@ -42,6 +52,7 @@ module.exports.onExit = async function onExit(exitValue) {
         if (!isCi) {
             writeStackTrace(exitValue);
         } else {
+            // eslint-disable-next-line no-console
             console.error(exitValue, exitValue && exitValue.stack);
         }
     }

package/cli.js

@@ -7,7 +7,7 @@ require('./bluebirdConfig.js');
 const options = require('./runOptions');
 const EventEmitter = require('events');
 const logger = require('./commons/logger').getLogger('cli-entry');
-const { onExit } = require('./cli/onExit');
+const { onExit, ignoreFailingTestsInExitCode } = require('./cli/onExit');
 const testRunner = require('./runner');
 const prepareRunner = require('./commons/prepareRunner');
 const { CLI_MODE } = require('./commons/constants');
@@ -92,6 +92,10 @@ function main() {
                 options.localRCASaver = `http://localhost:${port}`;
             }
 
+            if (options.exitCodeIgnoreFailingTests) {
+                ignoreFailingTestsInExitCode();
+            }
+
             perf.log('right before testRunner.init/prepareRunner.prepare');
             return Promise.all([
                 testRunner.init(options),

package/codim/codim-npm-package/index.ts

@@ -119,6 +119,7 @@ type ApiCallOptions = {
     headers?: Headers;
     body?: string;
     sendViaWebApp?: boolean;
+    omitCookies?: boolean;
 }
 
 export enum GeneratedValueTypes {

package/commons/constants.js

@@ -33,29 +33,6 @@ module.exports = {
     test: {
         HIDDEN_PARAM: 'TST_HIDDEN_PARAM',
     },
-    deviceFarm: {
-        status: {
-            INITIALIZING: 'INITIALIZING',
-            PENDING: 'PENDING',
-            PENDING_CONCURRENCY: 'PENDING_CONCURRENCY',
-            PENDING_DEVICE: 'PENDING_DEVICE',
-            PROCESSING: 'PROCESSING',
-            SCHEDULING: 'SCHEDULING',
-            PREPARING: 'PREPARING',
-            RUNNING: 'RUNNING',
-            COMPLETED: 'COMPLETED',
-            STOPPING: 'STOPPING',
-        },
-        result: {
-            PENDING: 'PENDING',
-            PASSED: 'PASSED',
-            WARNED: 'WARNED',
-            FAILED: 'FAILED',
-            SKIPPED: 'SKIPPED',
-            ERRORED: 'ERRORED',
-            STOPPED: 'STOPPED',
-        },
-    },
     socketEventTypes: {
         TEST_RESULT_CREATED: 'test-result-created',
         TEST_RESULT_UPDATED: 'test-result-updated',
@@ -64,8 +41,6 @@ module.exports = {
     CLI_MODE: {
         EXTENSION: 'extension',
         SELENIUM: 'selenium',
-        APPIUM: 'appium',
-        DEVICE_FARM_APPIUM: 'device-farm-appium',
     },
     sessionType: {
         CODELESS: 'codeless',

package/commons/featureFlags.js

@@ -52,6 +52,8 @@ class FeatureFlagsService {
             autoSaveDownloadFileFireFox: new Rox.Flag(true),
             safariSelectOptionDispatchEventOnSelectElement: new Rox.Flag(true),
             experimentalPreCodeCompilation: new Rox.Flag(false),
+            /** Enables using top level await inside custom actions for non-IE browsers */
+            experimentalAsyncCustomCode: new Rox.Flag(),
             useSameBrowserForMultiTests: new LabFeatureFlag('labs'),
             highSpeedMode: new LabFeatureFlag(),
             usePortedHtml5DragDrop: new Rox.Flag(),

package/commons/socket/testResultService.js

@@ -2,11 +2,9 @@ const testResultServiceSocketIO = require('./testResultServiceSocketIO');
 const socketService = require('./socketService');
 
 const { EventEmitter } = require('events');
-
-const testimServicesApi = require('../testimServicesApi');
 const featureFlags = require('../featureFlags');
 
-const {socketEventTypes} = require('../constants');
+const { socketEventTypes } = require('../constants');
 const Promise = require('bluebird');
 
 class TestResultService extends EventEmitter {
@@ -22,9 +20,9 @@ class TestResultService extends EventEmitter {
     joinToTestResult(resultId, testId) {
         //TODO - Consider unifying the joinToTestResult and listenToTestResult flows
         if (featureFlags.flags.useNewWSCLI.isEnabled()) {
-            return socketService.addFilter(`${resultId}:testResult`, {resultId, testId}, [
+            return socketService.addFilter(`${resultId}:testResult`, { resultId, testId }, [
                 socketEventTypes.TEST_RESULT_UPDATED,
-                socketEventTypes.TEST_RESULT_CREATED
+                socketEventTypes.TEST_RESULT_CREATED,
             ]);
         }
         testResultServiceSocketIO.joinRoom(resultId, testId);
@@ -54,17 +52,9 @@ class TestResultService extends EventEmitter {
         testResultServiceSocketIO.listenToTestResult(resultId, testId, onTestResultStatus);
     }
 
-    clearTestResult(projectId, resultId, testId, testResult) {
-        return testimServicesApi.clearTestResult(projectId, resultId, testId, testResult);
-    }
-
-    updateTestResult(projectId, resultId, testId, testResult, remoteRunId) {
-        return testimServicesApi.updateTestResult(projectId, resultId, testId, testResult, remoteRunId);
-    }
-
     getSocket() {
         if (featureFlags.flags.useNewWSCLI.isEnabled()) {
-            return;
+            return undefined;
         }
         return testResultServiceSocketIO.getSocket();
     }

package/commons/testimAnalytics.js

@@ -5,7 +5,6 @@ const config = require('./config');
 const Analytics = require('analytics-node');
 
 const analytics = new Analytics('sJOSIGKa5x5rJEGsaOlCjrgozAf7FnVY', { flushAt: 1 });
-const testimCustomToken = require('./testimCustomToken');
 
 function identify(data) {
     if (config.IS_ON_PREM) {

package/commons/testimDesiredCapabilitiesBuilder.js

@@ -9,7 +9,6 @@ const featureFlags = require('./featureFlags');
 const { CLI_MODE, mobileWeb, gridTypes } = require('./constants');
 const config = require('./config');
 const utils = require('../utils');
-const { getAppCaps } = require('./apkUploader/apkUploaderFactory');
 const LambdatestService = require('../services/lambdatestService');
 const logger = require('./logger').getLogger('testim-desired-capabilities-builder');
 
@@ -193,7 +192,6 @@ function _buildChromiumOptions(opts, browserOptions, testRunConfig, customExtens
     }
 
     if (isDFGrid(gridInfo) && browserName === 'MicrosoftEdge') {
-        delete chromiumOptions.prefs['profile.content_settings.exceptions.clipboard']; // for some reason this breaks
         opts.desiredCapabilities['ms:edgeChromium'] = true;
     }
 
@@ -578,99 +576,6 @@ function buildSeleniumOptions(browserOptions, testName, testRunConfig, gridInfo,
     return opts;
 }
 
-function buildTestObject(browserOptions, testName, appCaps) {
-    if (!_.isEmpty(browserOptions.testobjectSauce)) {
-        return Object.assign({
-            idleTimeout: 30,
-            testobject_test_name: testName,
-            testobject_session_creation_timeout: String(browserOptions.browserTimeout),
-            deviceName: null,
-        }, appCaps, browserOptions.testobjectSauce);
-    }
-    return {};
-}
-
-function buildSaucelabsMobile(browserOptions, testName, appCaps) {
-    if (!_.isEmpty(browserOptions.saucelabs)) {
-        return Object.assign({
-            deviceName: null,
-            name: testName,
-            idleTimeout: 30,
-            browserName: '',
-        }, appCaps, browserOptions.saucelabs);
-    }
-    return {};
-}
-
-function buildAppiumOptions(browserOptions, gridInfo, nativeAppData, testName) {
-    const { getSessionTimeout, getSessionRetries, driverRequestTimeout, driverRequestRetries } = browserOptions;
-    const opts = {
-        host: gridInfo.host,
-        port: gridInfo.port || 4444,
-        path: gridInfo.path || '/wd/hub',
-        protocol: gridInfo.protocol || 'http',
-        logLevel: LOG_LEVEL,
-        connectionRetryTimeout: driverRequestTimeout,
-        connectionRetryCount: driverRequestRetries,
-        getSessionTimeout,
-        getSessionRetries,
-        desiredCapabilities: {
-            browserName: '',
-            noReset: false,
-            fullReset: false,
-        },
-    };
-
-    if (browserOptions.projectData.type === 'android') {
-        Object.assign(opts.desiredCapabilities, {
-            appPackage: nativeAppData.packageName,
-            appActivity: nativeAppData.activity,
-            platformName: 'Android',
-            automationName: 'uiautomator2',
-            autoLaunch: false,
-            ignoreUnimportantViews: false,
-            disableWindowAnimation: browserOptions.disableWindowAnimation,
-        });
-    } else if (browserOptions.projectData.type === 'ios') {
-        Object.assign(opts.desiredCapabilities, {
-            bundleId: nativeAppData.packageName,
-            platformName: 'iOS',
-            automationName: 'XCUITest',
-        });
-    }
-
-    if (browserOptions.deviceUdid) {
-        opts.desiredCapabilities.udid = browserOptions.deviceUdid;
-    }
-
-    if (browserOptions.deviceName) {
-        opts.desiredCapabilities.deviceName = browserOptions.deviceName;
-    }
-
-    if (gridInfo.user && gridInfo.key && gridInfo.type === 'saucelabs') {
-        browserOptions.saucelabs = browserOptions.saucelabs || {};
-        browserOptions.saucelabs.username = browserOptions.saucelabs.username || gridInfo.user;
-        browserOptions.saucelabs.accessKey = browserOptions.saucelabs.accessKey || gridInfo.key;
-    } else if (gridInfo.key && gridInfo.type === 'testobject') {
-        browserOptions.testobjectSauce = browserOptions.testobjectSauce || {};
-        browserOptions.testobjectSauce.testobjectApiKey = browserOptions.testobjectSauce.testobjectApiKey || gridInfo.key;
-    } else if (gridInfo.key && gridInfo.type === 'perfecto') {
-        browserOptions.perfecto = browserOptions.perfecto || {};
-        browserOptions.perfecto.securityToken = gridInfo.key;
-    }
-
-    const appCaps = getAppCaps(gridInfo);
-
-    Object.assign(
-        opts.desiredCapabilities,
-        buildTestObject(browserOptions, testName, appCaps),
-        buildSaucelabsMobile(browserOptions, testName, appCaps)
-    );
-
-    return opts;
-}
-
 module.exports = {
     buildSeleniumOptions,
-    buildAppiumOptions,
 };

package/commons/testimServicesApi.js

@@ -55,11 +55,6 @@ function putAuth(url, body) {
         .then(headers => httpRequest.put(`${config.SERVICES_HOST}${url || ''}`, body, headers));
 }
 
-function getTextWithAuth(url, query) {
-    return getTokenHeader()
-        .then(headers => httpRequest.getText(`${config.SERVICES_HOST}${url || ''}`, query, headers));
-}
-
 function getWithAuth(url, query, options, timeout) {
     return getTokenHeader()
         .then(headers => httpRequest.get(`${config.SERVICES_HOST}${url || ''}`, query, headers, timeout, options));
@@ -69,10 +64,6 @@ function getS3Artifact(url, timeout) {
     return utils.runWithRetries(() => getWithAuth(`/storage${url}`, null, { isBinary: true }, timeout));
 }
 
-function getS3ArtifactText(url) {
-    return utils.runWithRetries(() => getTextWithAuth(`/storage${url}`));
-}
-
 function getTestPlan(projectId, testPlanNames) {
     //TODO: need to be checked after 3 months to prevent users from using old version
     const parseProperty = (dataValue) => (dataValue == null ? [] : (typeof (dataValue) === 'string' && JSON.parse(dataValue)) || dataValue);
@@ -100,22 +91,16 @@ function saveTestPlanResult(projectId, testPlanId, result) {
     return utils.runWithRetries(() => postAuth({ url: '/testPlan/result', body: { projectId, testPlanId, result } }));
 }
 
-function updateTestStatus(status, executionId, testId, resultId, startTime, endTime, success, failureReason, config, projectId, remoteRunId, testRetryKey) {
+function updateTestStatus(projectId, executionId, testId, resultId, status, data, apiRetries = DEFAULT_REQUEST_RETRY) {
     return utils.runWithRetries(() => putAuth('/result/run/test', {
         runId: executionId,
         testId,
-        startTime,
-        endTime,
-        success,
-        failureReason,
         resultId,
         status,
-        config,
         projectId,
         runnerVersion,
-        remoteRunId,
-        testRetryKey,
-    }), DEFAULT_REQUEST_RETRY);
+        ...data,
+    }), apiRetries);
 }
 
 function updateExecutionTests(executionId, runnerStatuses, status, reason, success, startTime, endTime, projectId) {
@@ -182,14 +167,6 @@ function reportExecutionFinished(status, executionId, projectId, success, tmsOpt
     }), DEFAULT_REQUEST_RETRY);
 }
 
-function getBranchData(projectId, branchName) {
-    return utils.runWithRetries(() => getWithAuth(`/branch/branchData/${encodeURIComponent(branchName)}`, { projectId }));
-}
-
-function getUserDetails(userId) {
-    return utils.runWithRetries(() => getWithAuth(`/user/user/${userId}`));
-}
-
 function getTestPlanTestList(projectId, names, planIds, branch) {
     return utils.runWithRetries(() => postAuth({
         url: '/testPlan/list',
@@ -243,11 +220,11 @@ function keepAliveGrid(projectId, slots) {
     });
 }
 
-function releaseGridSlot(projectId, slotId, gridId, browser) {
+function releaseGridSlot(companyId, projectId, slotId, gridId, browser) {
     return postAuth({
         url: `/grid/release?reqId=${utils.guid()}`,
         body: {
-            projectId, slotId, gridId, browser,
+            companyId, projectId, slotId, gridId, browser,
         },
     });
 }
@@ -259,23 +236,16 @@ function getHybridGridProvider(body) {
     });
 }
 
-function getGridByProject(projectId, gridName, browser, executionId) {
+function getGridByName(companyId, projectId, gridName, browser, executionId) {
     return utils.runWithRetries(() => getWithAuth('/grid/name', {
-        projectId, name: gridName, browser, executionId, reqId: utils.guid(),
+        companyId, projectId, name: gridName, browser, executionId, reqId: utils.guid(),
     }));
 }
 
-function getGridById(projectId, gridId, browser, executionId) {
-    return utils.runWithRetries(() => getWithAuth(`/grid/${gridId}`, { projectId, browser, executionId, reqId: utils.guid() }));
-}
-
-function getCompanyByProjectId(projectId) {
-    return utils.runWithRetries(() => getWithAuth(`/company/company/${projectId}`));
+function getGridById(companyId, projectId, gridId, browser, executionId) {
+    return utils.runWithRetries(() => getWithAuth(`/grid/${gridId}`, { companyId, projectId, browser, executionId, reqId: utils.guid() }));
 }
 
-function getProject(projectId) {
-    return utils.runWithRetries(() => getWithAuth(`/v2/project/project?projectId=${projectId}`));
-}
 
 async function initializeUserWithAuth({ projectId, token, branchName, lightweightMode, localGrid }) {
     try {
@@ -325,38 +295,6 @@ const fetchLambdatestConfig = async () => utils.runWithRetries(() => getWithAuth
 
 const getLabFeaturesByProjectId = async (projectId) => utils.runWithRetries(() => getWithAuth(`/labFeature/v2/project/${projectId}`));
 
-function getAppUploadUrl(projectId, projectArn, appName) {
-    return utils.runWithRetries(() => postAuth({
-        url: '/deviceFarm/app',
-        body: {
-            projectId,
-            projectArn,
-            appName,
-        },
-    }));
-}
-
-function createDeviceFarmRun(companyId, projectId, projectArn, appArn, configuration, branch, executionId, env, remoteRunObject) {
-    return postAuth({
-        url: '/deviceFarm/run',
-        body: {
-            companyId,
-            projectId,
-            projectArn,
-            appArn,
-            configuration,
-            branch,
-            executionId,
-            env,
-            remoteRunObject,
-        },
-        timeout: 30000,
-    });
-}
-
-function getDeviceFarmRun(projectId, runArn) {
-    return getWithAuth(`/deviceFarm/run?projectId=${projectId}&runArn=${runArn}`);
-}
 
 function getRealData(projectId, channel, query) {
     return utils.runWithRetries(() => getWithAuth(`/real-data/${channel}?${query}&projectId=${projectId}`));
@@ -492,30 +430,22 @@ function addTestRetry({
 
 module.exports = {
     getS3Artifact,
-    getS3ArtifactText,
     getTestPlan,
     saveTestPlanResult,
     updateTestStatus,
     updateExecutionTests,
     reportExecutionStarted,
     reportExecutionFinished,
-    getBranchData,
-    getUserDetails,
     getTestPlanTestList,
     getSuiteTestList,
-    getCompanyByProjectId,
-    getProject,
     getUsageForCurrentBillingPeriod,
     getTestResults,
-    getGridByProject,
+    getGridByName,
     releaseGridSlot,
     keepAliveGrid,
     getGridById,
     getAllGrids,
     fetchLambdatestConfig,
-    getAppUploadUrl,
-    createDeviceFarmRun,
-    getDeviceFarmRun,
     getRealData,
     updateTestResult,
     clearTestResult,

package/executionQueue.js

@@ -1,12 +1,10 @@
-"use strict";
+'use strict';
 
 const TestRun = require('./testRunHandler.js');
 
 class ExecutionQueue {
     constructor(executionId, testList, options, branchToUse, testStatus) {
-        this._waitingTests = testList.map(testInfo => {
-            return new TestRun(executionId, testInfo, options, branchToUse, testStatus);
-        });
+        this._waitingTests = testList.map(testInfo => new TestRun(executionId, testInfo, options, branchToUse, testStatus));
     }
 
     getNext() {
@@ -14,6 +12,11 @@ class ExecutionQueue {
         if (nextTestRunHandler) {
             return nextTestRunHandler;
         }
+        return undefined;
+    }
+
+    hasMoreTests() {
+        return Boolean(this._waitingTests.length);
     }
 }