@testim/testim-cli 3.251.0 → 3.253.0

package/agent/routers/index.js

@@ -20,7 +20,8 @@ module.exports = function(beforeMiddleware, standaloneBrowserInfo) {
      * set cors options
      */
 
-    const whitelist = ['http://localhost:3000', 'https://app.testim.io', 'https://staging.testim.io', 'https://playground.testim.io', 'https://app.staging.testim.cc', 'chrome-extension://pebeiooilphfmbohdbhbomomkkoghoia'];
+    const whitelist = ['http://localhost:3000', 'https://app.testim.io', 'https://staging.testim.io', 'https://playground.testim.io',
+        'https://app.staging.testim.cc', 'chrome-extension://pebeiooilphfmbohdbhbomomkkoghoia', 'https://tta-crm.tricentis.com'];
     const corsOptions = {
         methods: ['GET', 'PUT', 'POST', 'DELETE', 'OPTIONS'],
         allowedHeaders: ['Content-Type', 'Authorization'],

package/agent/routers/playground/router.js

@@ -7,7 +7,7 @@ const {ClientError, PlaygroundCodeError} = require('../../../errors');
 const {runPlaygroundTest, stopPlaygroundTest, CODE_TYPES} = require('./service');
 const {DISABLE_AGENT_ORIGIN_CHECK} = require('../../../commons/config');
 
-const VALID_HOSTS = ['localhost', 'app.testim.io', 'playground.testim.io', 'staging.testim.io', 'app.staging.testim.cc'];
+const VALID_HOSTS = ['localhost', 'app.testim.io', 'playground.testim.io', 'staging.testim.io', 'app.staging.testim.cc', 'tta-crm.tricentis.com'];
 
 const parseUrl = (url) => {
     if(!url) {

package/commons/chrome-launcher.js

@@ -1,15 +1,15 @@
-"use strict";
+'use strict';
 
-const { exec } = require("child_process");
+const { exec } = require('child_process');
 
-module.exports.launchChrome = function(url) {
+module.exports.launchChrome = function (url) {
     const { platform } = process;
 
-    if (platform === "win32") {
+    if (platform === 'win32') {
         exec(`start chrome ${url}`);
-    } else if (platform === "darwin") {
+    } else if (platform === 'darwin') {
         exec(`open -a "Google Chrome" ${url}`);
-    } else if (platform === "linux") {
+    } else if (platform === 'linux') {
         exec(`google-chrome ${url}`);
     }
 };

package/commons/constants.js

@@ -41,6 +41,7 @@ module.exports = {
     CLI_MODE: {
         EXTENSION: 'extension',
         SELENIUM: 'selenium',
+        APPIUM: 'appium',
     },
     sessionType: {
         CODELESS: 'codeless',
@@ -54,6 +55,7 @@ module.exports = {
         HYBRID: 'testimHybrid',
         BROWSERSTACK: 'browserstack',
         SAUCELABS: 'saucelabs',
+        TESTIM_HEADSPIN: 'testimHeadspin',
     },
     stepResult: {
         SETUP_TIMEOUT: 'setup-timeout',

package/commons/getSessionPlayerRequire.js

@@ -3,28 +3,10 @@
 const perf = require('./performance-logger');
 
 perf.log('getSessionPlayerRequire start');
-const getSessionPlayerFolder = require('./prepareRunnerAndTestimStartUtils').getSessionPlayerFolder;
+const { getSessionPlayerFolder } = require('./prepareRunnerAndTestimStartUtils');
 
 const testimAppDataFolder = getSessionPlayerFolder();
-/**
- * @type {{
-        sessionPlayer: typeof import('../../../clickim/src/background/session/sessionPlayer').SessionPlayer;
-        utils: typeof import('../../../clickim/src/lib/utils').utils;
-        commonConstants: typeof import('../../../clickim/src/common/commonConstantsStrong');
-        locatorBuilderUtils: import('../../../clickim/src/locators/locatorBuilderUtils')['locatorBuilderUtils'];
-        assetService: import('../../../clickim/src/background/assetService')['assetService'];
-        localAssetService: import('../../../clickim/src/background/localAssetService');
-        urlUtils: import('../../../clickim/src/background/portMatch/urlUtils');
-        positionUtils: import('../../../clickim/src/lib/positionUtils');
-        visibilityUtils: import('../../../clickim/src/background/visibilityUtils');
-        apiCall: import('../../../clickim/src/common/playback/apiCall')['apiCall'];
-        stepParamBuilder: typeof import('../../../clickim/src/common/stepParamsBuilder').StepParamsBuilder;
-        stepParamExpressionEvaluator: import('../../../clickim/src/common/stepParamExpressionEvaluator');
-        manifestVersion: string | undefined;
-        EyeSdkBuilder: typeof import('../../../clickim/src/background/eyeSdkBuilder').EyeSdkBuilder;
-        sfdc: typeof import('sfdc-engine');
-    }}
- */
+/** @type {import('clickim/src/background/sessionPlayerInit').SessionPlayerInit} */
 const sessionPlayer = require(require('path').join(testimAppDataFolder, 'sessionPlayer.js')); // eslint-disable-line import/no-dynamic-require
 
 module.exports = sessionPlayer;

package/commons/initializeUserWithAuth.js

@@ -3,7 +3,7 @@ const perf = require('./performance-logger');
 const localRunnerCache = require('./runnerFileCache');
 const servicesApi = require('./testimServicesApi.js');
 const testimCustomToken = require('./testimCustomToken');
-
+const { CLI_MODE } = require('./constants');
 
 const FIVE_MINUTES_MS = 1000 * 60 * 5;
 const TEN_HOURS_MS = 1000 * 60 * 60 * 10;
@@ -11,7 +11,7 @@ const TEN_HOURS_MS = 1000 * 60 * 60 * 10;
 function preloadSlowRequires(mode) {
     process.nextTick(() => {
         // heuristic to pay the cost of loading the sessionPlayer here while we are waiting for the backend
-        if (mode === 'selenium') {
+        if (mode === CLI_MODE.SELENIUM || mode === CLI_MODE.APPIUM) {
             try {
                 require('./getSessionPlayerRequire');
                 // jsdom for the same reason, we don't require workerSelenium here since it actually takes longer to load

package/commons/mockNetworkRuleFileSchema.json

@@ -13,7 +13,6 @@
                 }
             }
         },
-
         "header": {
             "type": "object",
             "required": [
@@ -88,48 +87,51 @@
                         "text": {
                             "type": "string"
                         }
+                    }
                 }
             }
-        }
-    },
-    "redirectResponse": {
-        "type": "object",
-        "required": ["redirectUrl"],
-        "additionalProperties": false,
-        "properties": {
-            "redirectUrl": { "type": "string" }
-        }
-    },
-    "passthroughResponse": {
-        "type": "object",
-        "required": ["passthrough"],
-        "additionalProperties": false,
-        "properties": {
-            "passthrough": { "type": "boolean", "enum": [ true ] }
-        }
-    },
-
-    "entry": {
-        "type": "object",
-        "required": ["request", "response"],
-        "additionalProperties": false,
-        "properties": {
-            "request": { "$ref": "#/definitions/request" },
-            "response": {
-                "oneOf": [
-                    { "$ref": "#/definitions/response" },
-                    { "$ref": "#/definitions/redirectResponse" },
-                    { "$ref": "#/definitions/passthroughResponse" }
-                ]
+        },
+        "redirectResponse": {
+            "type": "object",
+            "required": ["redirectUrl"],
+            "additionalProperties": false,
+            "properties": {
+                "redirectUrl": { "type": "string" }
+            }
+        },
+        "passthroughResponse": {
+            "type": "object",
+            "required": ["passthrough"],
+            "additionalProperties": false,
+            "properties": {
+                "passthrough": { "type": "boolean", "enum": [ true ] }
+            }
+        },
+        "entry": {
+            "type": "object",
+            "required": ["request", "response"],
+            "additionalProperties": false,
+            "properties": {
+                "request": { "$ref": "#/definitions/request" },
+                "response": {
+                    "oneOf": [
+                        { "$ref": "#/definitions/response" },
+                        { "$ref": "#/definitions/redirectResponse" },
+                        { "$ref": "#/definitions/passthroughResponse" }
+                    ]
+                },
+                "maxHits": {
+                    "type": "integer",
+                    "minimum": 1
+                }
             }
         }
-    }
-},
-"type": "object",
-"required": ["entries"],
+    },
+    "type": "object",
+    "required": ["entries"],
     "properties": {
-    "version": { "type": "string", "enum": ["1.2", "1.2.0"] },
-    "creator": { "type": "string" },
+        "version": { "type": "string", "enum": ["1.2", "1.2.0"] },
+        "creator": { "type": "string" },
         "entries": {
             "type": "array",
             "items": { "$ref": "#/definitions/entry" }

package/commons/testimDesiredCapabilitiesBuilder.js

@@ -602,6 +602,49 @@ function buildSeleniumOptions(browserOptions, testName, testRunConfig, gridInfo,
     return opts;
 }
 
+//testRunConfig not in used for now
+function buildAppiumOptions({ projectType, gridInfo, testRunConfig, nativeApp }) {
+    if (!nativeApp) {
+        throw Error('missing mobile app!');
+    }
+    if (gridInfo.type !== gridTypes.TESTIM_HEADSPIN) {
+        throw Error('unsupported grid was detected please make sure to select supported mobile grid');
+    }
+    const connection = {
+        protocol: gridInfo.protocol || 'https',
+        hostname: gridInfo.host,
+        port: gridInfo.port,
+        path: `/v0/${gridInfo.accessToken}/wd/hub`,
+    };
+
+    let appCaps = {};
+    switch (projectType) {
+        case 'ios':
+            appCaps = {
+                'appium:bundleId': nativeApp.id,
+                platformName: 'iOS',
+                'appium:automationName': 'XCUITest',
+            };
+            break;
+        case 'android':
+            appCaps = {
+                appPackage: nativeApp.packageName,
+                appActivity: nativeApp.activity,
+                'appium:automationName': 'UiAutomator2',
+            };
+            break;
+        default:
+            throw Error(`unsupported mobile project ${projectType}`);
+    }
+    return {
+        ...connection,
+        desiredCapabilities: appCaps,
+        capabilities: appCaps,
+    };
+}
+
 module.exports = {
     buildSeleniumOptions,
+    buildAppiumOptions,
+
 };

package/commons/testimServicesApi.js

@@ -21,7 +21,7 @@ function getTokenHeader() {
     return testimCustomToken.getCustomTokenV3()
         .then(brearToken => {
             if (!brearToken) {
-                return Promise.reject(new Error('Failed to get token from server'));
+                throw new Error('Failed to get token from server');
             }
             return { Authorization: `Bearer ${brearToken}` };
         });
@@ -43,6 +43,7 @@ function postAuth({
         });
 }
 
+// eslint-disable-next-line default-param-last
 function postAuthFormData(url, fields, files, headers = {}, timeout) {
     return getTokenHeader()
         .then(tokenHeaders => {
@@ -160,6 +161,7 @@ function reportExecutionStarted({
     });
 }
 
+// eslint-disable-next-line default-param-last
 function reportExecutionFinished(status, executionId, projectId, success, tmsOptions = {}, remoteRunId, resultExtraData) {
     const endTime = Date.now();
 
@@ -289,7 +291,14 @@ async function getEditorUrl() {
         return config.EDITOR_URL;
     }
     try {
-        return await pRetry(() => getWithAuth('/system-info/editor-url'), { reties: DEFAULT_REQUEST_RETRY });
+        return await pRetry(() => getWithAuth('/system-info/editor-url'), {
+            reties: DEFAULT_REQUEST_RETRY,
+            onFailedAttempt: error => {
+                if (error.attemptNumber >= DEFAULT_REQUEST_RETRY) {
+                    throw error;
+                }
+            },
+        });
     } catch (err) {
         logger.error('cannot retrieve editor-url from server');
         return 'https://app.testim.io';

package/credentialsManager.js

@@ -1,4 +1,4 @@
-"use strict";
+'use strict';
 
 const fse = require('fs-extra');
 const path = require('path');
@@ -26,10 +26,8 @@ async function getCredentialsFromChrome() {
         return timeout(new Promise(resolve => app.get('/loginInfo', (req, res) => {
             resolve(JSON.parse(Buffer.from(req.query.info, 'base64').toString()));
             res.status(200).end();
-        })), 60000).catch(() => {
-            return null;
-        });
-    })();
+        })), 60000).catch(() => null);
+    }());
     await new Promise((resolve, reject) => {
         const server = app.listen(42543, (err) => {
             if (err) {
@@ -45,6 +43,7 @@ async function getCredentialsFromChrome() {
         const url = await getEditorUrl();
         launchChrome(`${url}/#/new-test`);
     } catch (err) {
+        // eslint-disable-next-line no-console
         console.log('Unable to open Testim automatically - please manually go to https://app.testim.io');
     }
 
@@ -52,7 +51,7 @@ async function getCredentialsFromChrome() {
     return data;
 }
 
-async function doLogin({overwriteExisting = true, projects = null} = {}) {
+async function doLogin({ overwriteExisting = true, projects = null } = {}) {
     const homedir = os.homedir();
 
     const testimCredentialsFile = path.join(homedir, '.testim');
@@ -63,17 +62,15 @@ async function doLogin({overwriteExisting = true, projects = null} = {}) {
         return;
     }
 
-    let credentials = {};
+    const credentials = {};
 
     const prompts = require('prompts');
     const ora = require('ora');
 
-    let spinner = ora(`Getting credentials from Testim extension ...`).start();
+    const spinner = ora('Getting credentials from Testim extension ...').start();
 
     if (!projects) {
-        projects = await timeout(Promise.resolve(getCredentialsFromChrome()), 62000).catch(e => {
-            return null;
-        });
+        projects = await timeout(Promise.resolve(getCredentialsFromChrome()), 62000).catch(e => null);
     }
 
     if (projects && projects.token) { // V1(legacy) of the login extension API
@@ -83,19 +80,18 @@ async function doLogin({overwriteExisting = true, projects = null} = {}) {
 
         await writeCredentials(testimCredentialsFile, credentials);
         return;
-    } else if (projects && projects.length) { // V2(current) of the login extension API
-
+    } if (projects && projects.length) { // V2(current) of the login extension API
         spinner.succeed();
 
         const response = projects.length === 1 ?
-            { project: projects[0]} :
+            { project: projects[0] } :
             await prompts({
                 type: 'select',
                 name: 'project',
                 message: 'There are multiple projects associated with your user account. Please select the project you would like to connect to:',
-                choices: projects.map(p => ({title: p.name, value: p}))
+                choices: projects.map(p => ({ title: p.name, value: p })),
             }
-        );
+            );
 
         credentials.token = response.project.ci.token;
         credentials.projectId = response.project.id;
@@ -104,13 +100,14 @@ async function doLogin({overwriteExisting = true, projects = null} = {}) {
     }
 
     spinner.fail();
+    // eslint-disable-next-line no-console
     console.log('Error getting credentials - please pass `--token` and `--project` to the CLI or try again');
-
 }
 
 async function writeCredentials(testimCredentialsFile, credentials) {
     await fse.writeFile(testimCredentialsFile, YAML.stringify(credentials));
-    console.log(`Testim credentials saved in '${testimCredentialsFile}'`)
+    // eslint-disable-next-line no-console
+    console.log(`Testim credentials saved in '${testimCredentialsFile}'`);
 }
 
 async function getCredentialProperty(property) {
@@ -139,5 +136,5 @@ async function getCredentialProperty(property) {
 module.exports = {
     getProjectId,
     getToken,
-    doLogin
-}
+    doLogin,
+};