@mablhq/mabl-cli 1.25.19 → 1.29.0

package/commands/tests/testsUtil.js

@@ -27,25 +27,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toBasicHttpAuthenticationCredentials = exports.generateChromiumPreferencesFile = exports.logTestInfoIfPresent = exports.milliSecondsToSeconds = exports.calculateTotalTimeSeconds = exports.extractTestRunConfig = exports.pullDownTestRunConfig = exports.validateRunCommandWithLabels = exports.validateRunEditCommand = exports.downloadUploadFile = exports.sleep = exports.editTheTest = exports.runTheTest = exports.prepareTrainerForSplitPlayback = exports.createTrainingSession = exports.cleanUpInitialPages = exports.getExtensionBackgroundPageWithCliTool = exports.createBrowserForExecutionEngine = exports.addExecutionEngineLaunchArgs = exports.createBrowser = exports.prepareChromePreferencesDirectory = exports.findChrome = exports.searchForChrome = exports.getFinalUrl = exports.getTempChromePrefDirectory = void 0;
-const os = __importStar(require("os"));
+const async_retry_1 = __importDefault(require("async-retry"));
+const axios_1 = __importDefault(require("axios"));
+const cli_table3_1 = __importDefault(require("cli-table3"));
 const fs = __importStar(require("fs-extra"));
+const os = __importStar(require("os"));
 const path = __importStar(require("path"));
-const constants_1 = require("../constants");
-const messaging_1 = require("../../core/messaging/messaging");
-const cliConfigProvider_1 = require("../../providers/cliConfigProvider");
-const configKeys_1 = require("../config/config_cmds/configKeys");
+const stream_1 = require("stream");
+const browserLauncher_1 = require("../../browserLauncher/browserLauncher");
 const trainingSessionActions_1 = require("../../core/messaging/actions/trainingSessionActions");
-const async_retry_1 = __importDefault(require("async-retry"));
+const logLineMessaging_1 = require("../../core/messaging/logLineMessaging");
+const messaging_1 = require("../../core/messaging/messaging");
 const env_1 = require("../../env/env");
-const axios_1 = __importDefault(require("axios"));
-const httpUtil_1 = require("../../util/httpUtil");
+const cliConfigProvider_1 = require("../../providers/cliConfigProvider");
 const loggingProvider_1 = require("../../providers/logging/loggingProvider");
-const cli_table3_1 = __importDefault(require("cli-table3"));
-const logLineMessaging_1 = require("../../core/messaging/logLineMessaging");
+const httpUtil_1 = require("../../util/httpUtil");
 const resourceUtil_1 = require("../../util/resourceUtil");
+const configKeys_1 = require("../config/config_cmds/configKeys");
+const constants_1 = require("../constants");
 const mobileEmulationUtil_1 = require("./mobileEmulationUtil");
-const browserLauncher_1 = require("../../browserLauncher/browserLauncher");
-const stream_1 = require("stream");
 const trainerUtil_1 = require("./tests_cmds/trainerUtil");
 const chalk = require('chalk');
 const chromeFinder = require('chrome-launcher/dist/chrome-finder');
@@ -106,42 +106,23 @@ async function findChrome() {
     return chromePath;
 }
 exports.findChrome = findChrome;
-async function launchBrowserInstance(chromePath, launchArgs, userDataDir, headless, credentials, options) {
-    var _a;
-    const { bypassContentSecurityPolicy, defaultDeviceDescriptor, disableFocusEmulation, extraHttpHeaders, ignoreDefaultArgs, runnerType, loggerFunc, userAgent, } = options || {};
-    let browser;
-    const proxyServer = (_a = (await cliConfigProvider_1.CliConfigProvider.getCliConfig()).http.test
-        .proxyHost) === null || _a === void 0 ? void 0 : _a.href;
-    let proxy;
-    if (proxyServer) {
-        proxy = {
-            server: proxyServer,
+async function launchBrowserInstance(launchArgs, userDataDir, headless, credentials, options) {
+    const optionsProxy = await maybeGetProxyOptions(options);
+    if (optionsProxy) {
+        options = {
+            ...options,
+            proxy: optionsProxy,
         };
     }
+    let browser;
     try {
-        browser = await maybeLaunchBrowser(chromePath, launchArgs, userDataDir, headless, credentials, {
-            bypassContentSecurityPolicy,
-            defaultDeviceDescriptor,
-            disableFocusEmulation,
-            extraHttpHeaders,
-            ignoreDefaultArgs,
-            runnerType,
-            loggerFunc,
-            proxy,
-            userAgent,
-        });
+        browser = await maybeLaunchBrowser(launchArgs, userDataDir, headless, credentials, options);
     }
     catch (error) {
         if (error.message.includes('Running as root without --no-sandbox is not supported')) {
             launchArgs.push('--no-sandbox');
             messaging_1.mablEventEmitter.log('Unable to initialize browser with standard settings, attempting to run with --no-sandbox setting', Date.now(), logLineMessaging_1.LogLineColor.yellow);
-            return maybeLaunchBrowser(chromePath, launchArgs, userDataDir, headless, credentials, {
-                bypassContentSecurityPolicy,
-                defaultDeviceDescriptor,
-                ignoreDefaultArgs,
-                proxy,
-                runnerType,
-            }).catch((error) => {
+            return maybeLaunchBrowser(launchArgs, userDataDir, headless, credentials, options).catch((error) => {
                 messaging_1.mablEventEmitter.log('Browser launch failed', Date.now(), logLineMessaging_1.LogLineColor.red);
                 messaging_1.mablEventEmitter.log(error.message);
             });
@@ -151,22 +132,34 @@ async function launchBrowserInstance(chromePath, launchArgs, userDataDir, headle
     }
     return browser;
 }
-function maybeLaunchBrowser(chromePath, launchArgs, userDataDir, headless, credentials, options) {
-    const { bypassContentSecurityPolicy, defaultDeviceDescriptor, disableFocusEmulation, extraHttpHeaders, ignoreDefaultArgs, runnerType, loggerFunc, proxy, userAgent, } = options || {};
-    return browserLauncher_1.BrowserLauncherFactory.createRunner(runnerType, loggerFunc).launch({
-        bypassContentSecurityPolicy,
-        defaultDeviceDescriptor,
-        disableFocusEmulation,
-        executablePath: chromePath,
-        extraHttpHeaders,
+async function maybeGetProxyOptions(options) {
+    const proxyServer = (await cliConfigProvider_1.CliConfigProvider.getCliConfig()).http.test
+        .proxyHost;
+    let optionsProxy;
+    if (options === null || options === void 0 ? void 0 : options.proxy) {
+        optionsProxy = {
+            server: options.proxy.server,
+            username: options.proxy.username,
+            password: options.proxy.password,
+        };
+    }
+    else if (proxyServer) {
+        optionsProxy = {
+            server: proxyServer.href,
+            username: proxyServer.username,
+            password: proxyServer.password,
+        };
+    }
+    return optionsProxy;
+}
+function maybeLaunchBrowser(launchArgs, userDataDir, headless, credentials, options) {
+    return browserLauncher_1.BrowserLauncherFactory.createRunner(options === null || options === void 0 ? void 0 : options.runnerType, options === null || options === void 0 ? void 0 : options.loggerFunc).launch({
+        ...options,
         headless,
         args: launchArgs,
-        ignoreDefaultArgs,
         userDataDir,
         downloadPath: createDownloadDirectory(),
         credentials,
-        proxy,
-        userAgent,
     });
 }
 async function prepareChromePreferencesDirectory(browserPreferences) {
@@ -191,12 +184,8 @@ function removeTempBrowserPreferencesDirectory(tempDirPath) {
     }
 }
 async function createBrowser(browserWidth, browserHeight, headless, containerTesting, tempBrowserPreferencesDirectory, options) {
-    const { bypassContentSecurityPolicy, credentials, browserPath, disableFocusEmulation, disableIsolation, extraHttpHeaders, ignoreCertificateErrors, emulationConfig, enableExtensions, runnerType, loggerFunc, resourcesDirectoryOverride, proxy, userAgent, } = options || {};
-    const chromePath = browserPath !== null && browserPath !== void 0 ? browserPath : (await findChrome());
-    if (!chromePath.length) {
-        messaging_1.mablEventEmitter.log(chalk.yellow('Could not find a local install of Chrome to use, please ensure you have it installed and try again'));
-        throw new Error('Chrome not found error');
-    }
+    var _a;
+    const { credentials, disableIsolation, ignoreCertificateErrors, emulationConfig, enableExtensions, resourcesDirectoryOverride, } = options || {};
     const disableFeaturesFlags = [];
     const launchArgs = [];
     if (containerTesting) {
@@ -217,16 +206,12 @@ async function createBrowser(browserWidth, browserHeight, headless, containerTes
     if (enableExtensions) {
         ignoreDefaultArgs = ['--disable-extensions'];
     }
-    const maybeBrowser = await launchBrowserInstance(chromePath, launchArgs, tempBrowserPreferencesDirectory, headless, credentials, {
-        bypassContentSecurityPolicy,
+    const maybeBrowser = await launchBrowserInstance(launchArgs, tempBrowserPreferencesDirectory, headless, credentials, {
+        ...options,
         defaultDeviceDescriptor,
-        disableFocusEmulation,
-        extraHttpHeaders,
         ignoreDefaultArgs,
-        runnerType,
-        loggerFunc,
-        proxy,
-        userAgent: userAgent !== null && userAgent !== void 0 ? userAgent : emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent,
+        userAgent: (_a = options === null || options === void 0 ? void 0 : options.userAgent) !== null && _a !== void 0 ? _a : emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent,
+        defaultUserAgent: options === null || options === void 0 ? void 0 : options.defaultUserAgent,
     });
     if (!maybeBrowser) {
         throw new Error('Unable to start Chrome session');
@@ -266,15 +251,18 @@ function addExecutionEngineLaunchArgs(browserWidth, browserHeight, proxyInfo, em
 }
 exports.addExecutionEngineLaunchArgs = addExecutionEngineLaunchArgs;
 async function createBrowserForExecutionEngine(browserWidth, browserHeight, headless, tempBrowserPreferencesDirectory, proxyInfo, options) {
-    const { credentials, browserPath, emulationConfig, runnerType, loggerFunc } = options || {};
-    const chromePath = browserPath !== null && browserPath !== void 0 ? browserPath : (await findChrome());
-    const { launchArgs, defaultDeviceDescriptor } = addExecutionEngineLaunchArgs(browserWidth, browserHeight, proxyInfo, emulationConfig);
-    const maybeBrowser = await maybeLaunchBrowser(chromePath, launchArgs, tempBrowserPreferencesDirectory, headless, credentials, {
-        defaultDeviceDescriptor,
-        runnerType,
-        loggerFunc,
-        userAgent: emulationConfig === null || emulationConfig === void 0 ? void 0 : emulationConfig.device_config.user_agent,
-    });
+    const { credentials, deviceEmulationConfig, userAgent } = options;
+    if (deviceEmulationConfig && !userAgent) {
+        options = {
+            ...options,
+            userAgent: deviceEmulationConfig.device_config.user_agent,
+        };
+    }
+    const { launchArgs, defaultDeviceDescriptor } = addExecutionEngineLaunchArgs(browserWidth, browserHeight, proxyInfo, deviceEmulationConfig);
+    if (defaultDeviceDescriptor) {
+        options = { ...options, defaultDeviceDescriptor };
+    }
+    const maybeBrowser = await maybeLaunchBrowser(launchArgs, tempBrowserPreferencesDirectory, headless, credentials, options);
     if (!maybeBrowser) {
         throw new Error('Unable to start Chrome session');
     }
@@ -594,7 +582,7 @@ function validateRunCommandWithLabels(testId, suppliedLabelsInclude, suppliedLab
 }
 exports.validateRunCommandWithLabels = validateRunCommandWithLabels;
 async function pullDownTestRunConfig(testRunId, apiClient) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     const journeyRun = await apiClient.getTestRun(testRunId);
     const planRun = await apiClient.getPlanRun(journeyRun.parent_execution);
     return {
@@ -609,16 +597,15 @@ async function pullDownTestRunConfig(testRunId, apiClient) {
         deviceEmulation: (_g = journeyRun.journey_parameters) === null || _g === void 0 ? void 0 : _g.device_emulation,
         environmentId: (_j = (_h = journeyRun.journey_parameters) === null || _h === void 0 ? void 0 : _h.deployment) === null || _j === void 0 ? void 0 : _j.environment_id,
         filterHttpRequests: false,
-        journeyUserDefinedVariables: (_l = (_k = journeyRun.journey) === null || _k === void 0 ? void 0 : _k.variables) === null || _l === void 0 ? void 0 : _l.inputs,
-        importedVariables: (_m = journeyRun.journey_parameters) === null || _m === void 0 ? void 0 : _m.imported_variables,
-        pageLoadWait: (_o = journeyRun.journey_parameters) === null || _o === void 0 ? void 0 : _o.page_load_wait,
-        testId: (_p = journeyRun.journey) === null || _p === void 0 ? void 0 : _p.invariant_id,
-        url: (_r = (_q = journeyRun.journey_parameters) === null || _q === void 0 ? void 0 : _q.deployment) === null || _r === void 0 ? void 0 : _r.uri,
+        importedVariables: (_k = journeyRun.journey_parameters) === null || _k === void 0 ? void 0 : _k.imported_variables,
+        pageLoadWait: (_l = journeyRun.journey_parameters) === null || _l === void 0 ? void 0 : _l.page_load_wait,
+        testId: (_m = journeyRun.journey) === null || _m === void 0 ? void 0 : _m.invariant_id,
+        url: (_p = (_o = journeyRun.journey_parameters) === null || _o === void 0 ? void 0 : _o.deployment) === null || _p === void 0 ? void 0 : _p.uri,
     };
 }
 exports.pullDownTestRunConfig = pullDownTestRunConfig;
 async function extractTestRunConfig(executionMessage, apiClient) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
     const journeyRun = (_a = executionMessage.journey_run) !== null && _a !== void 0 ? _a : (await apiClient.getTestRun(executionMessage.journey_run_id));
     const planRun = executionMessage.plan_run;
     const maybeRunnerType = ((_b = planRun === null || planRun === void 0 ? void 0 : planRun.run_policy) === null || _b === void 0 ? void 0 : _b.nodejs_runtime_variant)
@@ -635,11 +622,10 @@ async function extractTestRunConfig(executionMessage, apiClient) {
         environmentId: (_k = (_j = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _j === void 0 ? void 0 : _j.deployment) === null || _k === void 0 ? void 0 : _k.environment_id,
         filterHttpRequests: true,
         importedVariables: (_l = journeyRun.journey_parameters) === null || _l === void 0 ? void 0 : _l.imported_variables,
-        journeyUserDefinedVariables: (_o = (_m = journeyRun.journey) === null || _m === void 0 ? void 0 : _m.variables) === null || _o === void 0 ? void 0 : _o.inputs,
-        pageLoadWait: (_p = journeyRun.journey_parameters) === null || _p === void 0 ? void 0 : _p.page_load_wait,
+        pageLoadWait: (_m = journeyRun.journey_parameters) === null || _m === void 0 ? void 0 : _m.page_load_wait,
         runnerType: maybeRunnerType,
-        testId: (_q = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey) === null || _q === void 0 ? void 0 : _q.invariant_id,
-        url: (_s = (_r = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _r === void 0 ? void 0 : _r.deployment) === null || _s === void 0 ? void 0 : _s.uri,
+        testId: (_o = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey) === null || _o === void 0 ? void 0 : _o.invariant_id,
+        url: (_q = (_p = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _p === void 0 ? void 0 : _p.deployment) === null || _q === void 0 ? void 0 : _q.uri,
     };
 }
 exports.extractTestRunConfig = extractTestRunConfig;

package/commands/tests/tests_cmds/run-cloud.js

@@ -56,9 +56,9 @@ exports.builder = (yargs) => {
     })
         .option(constants_1.CommandArgBrowsers, {
         alias: constants_1.CommandArgAliases.Browsers,
-        describe: 'Space delimited browsers to test against (e.g. "chrome firefox")',
+        describe: 'Space delimited browsers to test against (e.g. "chrome edge firefox")',
         type: 'array',
-        default: constants_1.DefaultBrowserType.toString(),
+        default: constants_1.DefaultBrowserType,
         choices: constants_1.BrowserTypeSelections,
         demand: 'Choose at least one browser to run on',
     })

package/commands/tests/tests_cmds/run.js

@@ -7,6 +7,7 @@ const constants_1 = require("../../constants");
 const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
 const mablApi_1 = require("../../../mablApi");
 const reporter_1 = require("../../../reporters/reporter");
+const browserTypes_1 = require("../../browserTypes");
 const chalk = require('chalk');
 const execution = require('../../../execution/index');
 exports.command = `run`;
@@ -141,7 +142,7 @@ exports.builder = (yargs) => {
         type: 'boolean',
     })
         .option(constants_1.CommandArgBrowserEnableExtensions, {
-        describe: 'Enable browser extensions on [Chrome]',
+        describe: 'Enable browser extensions on [Chrome] and [Edge]',
         default: false,
         type: 'boolean',
     })
@@ -157,14 +158,27 @@ exports.builder = (yargs) => {
         describe: 'Set the speed that mabl interacts with webpages. Overrides test run settings if specified.',
         type: 'string',
         choices: Object.keys(mablApi_1.JourneyParameters.PageLoadWaitEnum).map((pageLoadWait) => pageLoadWait.toLowerCase()),
+    })
+        .option(constants_1.CommandArgBrowser, {
+        describe: 'Target browser to execute the test against [chrome,edge]',
+        type: 'string',
+        nargs: 1,
+        choices: [browserTypes_1.BrowserType.Chrome, browserTypes_1.BrowserType.Edge],
+        hidden: true,
     })
         .check((argv) => {
         (0, testsUtil_1.validateRunCommandWithLabels)(argv[constants_1.CommandArgId], argv[constants_1.CommandArgLabelsInclude], argv[constants_1.CommandArgLabelsExclude], argv[constants_1.CommandArgTestRunId], argv[constants_1.CommandArgFromPlanId], true, argv[constants_1.CommandArgTestFile]);
+        validateBrowserInput(argv[constants_1.CommandArgBrowser]);
         const httpHeaders = argv[constants_1.CommandArgHttpHeaders];
         (0, util_1.validateArrayInputs)(httpHeaders, 'HTTP headers must be SPACE delimited, e.g. "--http-headers "foo:bar" "baz:qux"');
         argv[constants_1.CommandArgHttpHeaders] = (0, util_1.validateValuePairInputs)('HTTP header', httpHeaders);
         return true;
     });
+    function validateBrowserInput(browser) {
+        if (browser && !['chrome', 'edge'].includes(browser)) {
+            throw new Error('invalid browser type, valid browser types are [chrome,edge]');
+        }
+    }
 };
 const exitCodeOnError = 1;
 exports.handler = (0, util_1.failWrapper)(run, exitCodeOnError);
@@ -184,10 +198,19 @@ async function run(parsed) {
             extraHttpHeaders[headerParts[0].toLowerCase()] = headerParts[1];
         }
     });
+    let browserType;
+    switch (parsed[constants_1.CommandArgBrowser]) {
+        case 'edge':
+            browserType = browserTypes_1.BrowserType.Edge;
+            break;
+        default:
+            browserType = browserTypes_1.BrowserType.Chrome;
+    }
     const testRunnerConfig = {
         _cliCreated: true,
         basicAuthCredentialsId: parsed[constants_1.CommandArgBasicAuthCredentials],
         branchName: parsed['mabl-branch'],
+        browserType,
         credentialsId: parsed['credentials-id'],
         disableIsolation: parsed[constants_1.CommandArgBrowserDisableIsolation],
         enableExtensions: parsed[constants_1.CommandArgBrowserEnableExtensions],

package/commands/users/users.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = 'users <command>';
+exports.describe = 'mabl users related commands';
+exports.builder = (yargs) => yargs.commandDir('users_cmds').demandCommand();

package/commands/users/users_cmds/list.js

@@ -0,0 +1,58 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const js_yaml_1 = require("js-yaml");
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const cli_table3_1 = __importDefault(require("cli-table3"));
+const moment = require("moment");
+const util_1 = require("../../commandUtil/util");
+const constants_1 = require("../../constants");
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+const list_1 = require("../../commandUtil/list");
+exports.command = 'list';
+exports.describe = 'List users from a workspace';
+exports.builder = (0, list_1.getListBuilderOptions)('users');
+exports.handler = (0, util_1.failWrapper)(listUsers);
+async function listUsers(parsed) {
+    const output = parsed.output;
+    const workspaceId = await (0, util_1.getWorkspaceId)(parsed);
+    const limit = parsed.limit;
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const users = await apiClient.getUsers(workspaceId, limit);
+    printUsers(users, output, workspaceId);
+    return users.length;
+}
+function printUsers(users, outputFormat, workspaceId) {
+    switch (outputFormat) {
+        case 'json':
+            loggingProvider_1.logger.info(JSON.stringify(users, null, 2));
+            break;
+        case 'yaml':
+            loggingProvider_1.logger.info((0, js_yaml_1.dump)(users));
+            break;
+        default:
+            const table = new cli_table3_1.default({
+                head: ['ID', 'Name', 'Role', 'Email', 'Created time'],
+                wordWrap: true,
+            });
+            users.forEach((user) => {
+                var _a, _b, _c;
+                const userRole = (_c = (_b = (_a = user.roles) === null || _a === void 0 ? void 0 : _a.find((role) => role.organization_id === workspaceId)) === null || _b === void 0 ? void 0 : _b.role) !== null && _c !== void 0 ? _c : 'unknown';
+                table.push([
+                    { rowSpan: 1, content: user.id, vAlign: 'center' },
+                    { rowSpan: 1, content: user.name, vAlign: 'center' },
+                    { rowSpan: 1, content: userRole, vAlign: 'center' },
+                    { rowSpan: 1, content: user.email, vAlign: 'center' },
+                    {
+                        rowSpan: 1,
+                        content: moment.utc(user.created_time).format(constants_1.ListTimeFormat),
+                        vAlign: 'center',
+                    },
+                ]);
+            });
+            loggingProvider_1.logger.info(table.toString());
+            break;
+    }
+}