@mablhq/playwright-tools 2.49.1

package/commands/tests/tests_cmds/run.js

@@ -0,0 +1,314 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+const util_1 = require("../../commandUtil/util");
+const testsUtil_1 = require("../testsUtil");
+const constants_1 = require("../../constants");
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+const mablApi_1 = require("../../../mablApi");
+const execution_1 = require("../../../execution");
+const defaultEnv_1 = require("../../../env/defaultEnv");
+const runUtils_1 = require("./runUtils");
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const execution = require('../../../execution/index');
+exports.command = `run`;
+exports.describe =
+    "Run a test locally with headless support\nPre v1.0.0 'run' command behavior moved to 'run-legacy'";
+exports.builder = (yargs) => {
+    yargs
+        .example('$0 tests run --id <id> --headless', 'run test locally by id in headless mode')
+        .example('$0 tests run --run-id <test-run-id>', 'run a test locally using the test configuration from a cloud run')
+        .option(constants_1.CommandArgId, {
+        describe: 'The id of the test to run',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgTestFile, {
+        describe: 'the source file of the test to run',
+        type: 'string',
+        hidden: true,
+    })
+        .option(constants_1.CommandArgTestRunId, {
+        describe: 'The id of the test run to pull config from',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgFromPlanId, {
+        describe: `The plan id to get a list of tests from.
+Note: running tests with the --from-plan-id option is not a plan run. Advanced plan configurations, such as stages, browser settings or shared variables, are not applied.`,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgMablBranch, {
+        describe: 'Mabl branch to run test against',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgMablBranchChangesOnly, {
+        describe: 'Only execute tests changed on specified mabl branch',
+        type: 'boolean',
+        default: false,
+    })
+        .implies(constants_1.CommandArgMablBranchChangesOnly, constants_1.CommandArgMablBranch)
+        .option(constants_1.CommandArgLabelsInclude, {
+        describe: 'Space delimited test labels. Run tests that match any label.',
+        type: 'array',
+        conflicts: [constants_1.CommandArgId],
+    })
+        .option(constants_1.CommandArgLabelsExclude, {
+        describe: 'Space delimited test labels. Exclude tests that match any label.',
+        type: 'array',
+        conflicts: [constants_1.CommandArgId],
+    })
+        .option(constants_1.CommandArgWorkspaceId, {
+        alias: constants_1.CommandArgAliases.WorkspaceId,
+        describe: 'Workspace to run against',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgEnvironmentId, {
+        alias: constants_1.CommandArgAliases.EnvironmentId,
+        describe: `Mabl environment to run under. Specify to ensure the test runs with environment variables and the latest find information.
+Note: Setting the environment does not override the default URL. Please use the (—url) command to override the URL.`,
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgLocale, {
+        describe: 'Locale to run the test in, e.g. en-US',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgTimezoneID, {
+        describe: 'Identifier of the timezone to run the test in, e.g. America/Buenos_Aires',
+        nargs: 1,
+        type: 'string',
+    })
+        .option('width', {
+        describe: 'Set the browser width in pixels',
+        default: 1366,
+        nargs: 1,
+        type: 'number',
+    })
+        .option('height', {
+        describe: 'Set the browser height in pixels',
+        default: 768,
+        nargs: 1,
+        type: 'number',
+    })
+        .option(constants_1.CommandArgUrl, {
+        alias: constants_1.CommandArgAliases.Url,
+        describe: 'URL to run the mabl test against',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgCredentials, {
+        alias: constants_1.CommandArgAliases.Credentials,
+        describe: 'Credentials ID to run the test with',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgDataTableId, {
+        describe: 'Run test using all the scenarios from the Data table ID',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgScenarioId, {
+        describe: 'Run test using an specific scenario',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgBasicAuthCredentials, {
+        alias: constants_1.CommandArgAliases.BasicAuthCredentials,
+        describe: 'Basic Authentication credentials to run the test with',
+        nargs: 1,
+        type: 'string',
+    })
+        .option('headless', {
+        describe: 'Should the test run headless or not',
+        default: false,
+        type: 'boolean',
+    })
+        .option('highlights', {
+        describe: 'Highlight elements before interacting with them. Highlighting introduces a small delay for each step.',
+        default: false,
+        type: 'boolean',
+    })
+        .option('keep-browser-open', {
+        describe: 'Prevent the browser from closing at the end of a test.',
+        default: false,
+        type: 'boolean',
+    })
+        .option(constants_1.CommandArgReporter, {
+        describe: 'Output test run information for specified reporter',
+        hidden: true,
+        type: 'string',
+        choices: [constants_1.ReporterOptions.Mochawesome],
+    })
+        .option(constants_1.CommandArgReporterOptions, {
+        describe: 'Reporter options as comma separated key/values pairs. e.g. "reportDir=path/to,json=true"',
+        hidden: true,
+        type: 'string',
+    })
+        .implies(constants_1.CommandArgReporterOptions, constants_1.CommandArgReporter)
+        .option(constants_1.CommandArgBrowserDisableIsolation, {
+        hidden: true,
+        describe: 'Disable cross origin isolation',
+        default: false,
+        type: 'boolean',
+    })
+        .option(constants_1.CommandArgBrowserIgnoreCertificateErrors, {
+        hidden: true,
+        describe: 'Ignore certificate errors',
+        default: false,
+        type: 'boolean',
+    })
+        .option(constants_1.CommandArgBrowserEnableExtensions, {
+        describe: 'Enable browser extensions on [Chrome] and [Edge]',
+        default: false,
+        type: 'boolean',
+    })
+        .option(constants_1.CommandArgHttpHeaders, {
+        describe: 'Space delimited HTTP headers added to browser requests (e.g. "x-header:foo")',
+        type: 'array',
+    })
+        .option(constants_1.CommandArgUserAgent, {
+        describe: 'Emulates a custom user-agent (e.g. "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4651.0 Safari/537.36")',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgTestInteractionSpeed, {
+        describe: 'Set the speed that mabl interacts with webpages. Overrides test run settings if specified.',
+        type: 'string',
+        choices: Object.keys(mablApi_1.TestParameters.PageLoadWaitEnum).map((pageLoadWait) => pageLoadWait.toLowerCase()),
+    })
+        .option(constants_1.CommandArgBrowser, {
+        describe: `Target browser to execute the test against, must be one of ${constants_1.ValidBrowserTypesForLocalRuns}, defaults to ${constants_1.DefaultBrowserType}`,
+        type: 'string',
+        nargs: 1,
+        choices: constants_1.ValidBrowserTypesForLocalRuns,
+        hidden: true,
+    })
+        .option(constants_1.CommandArgUseTestExecutionProxy, {
+        describe: 'Route test HTTP traffic through a local proxy',
+        type: 'boolean',
+        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]);
+        if (argv[constants_1.CommandArgDataTableId] &&
+            !argv[constants_1.CommandArgId] &&
+            !argv[constants_1.CommandArgFromPlanId]) {
+            throw new Error(`The ${constants_1.CommandArgDataTableId} option can only be used with the ${constants_1.CommandArgId} or the ${constants_1.CommandArgFromPlanId} option`);
+        }
+        if (argv[constants_1.CommandArgDataTableId] && argv[constants_1.CommandArgScenarioId]) {
+            throw new Error(`The ${constants_1.CommandArgScenarioId} option cannot be used with the ${constants_1.CommandArgDataTableId} option`);
+        }
+        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;
+    });
+};
+const exitCodeOnError = 1;
+exports.handler = (0, util_1.failWrapper)(run, exitCodeOnError);
+async function run(parsed) {
+    var _a;
+    const commandStartTime = Date.now();
+    let workspaceId;
+    try {
+        workspaceId = await (0, util_1.getWorkspaceId)(parsed);
+    }
+    catch {
+    }
+    const extraHttpHeaders = {};
+    ((_a = parsed['http-headers']) !== null && _a !== void 0 ? _a : []).forEach((header) => {
+        const headerParts = header.split(':');
+        if (headerParts.length === 2 && headerParts[0] && headerParts[1]) {
+            extraHttpHeaders[headerParts[0].toLowerCase()] = headerParts[1];
+        }
+    });
+    const browserType = (0, testsUtil_1.parseBrowserType)(parsed[constants_1.CommandArgBrowser]);
+    let scenario;
+    if (parsed[constants_1.CommandArgScenarioId]) {
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+        scenario = await apiClient.getScenario(parsed[constants_1.CommandArgScenarioId]);
+        if (!scenario) {
+            throw new Error(`Scenario with ID ${parsed[constants_1.CommandArgScenarioId]} not found`);
+        }
+    }
+    const parsedLocale = parsed[constants_1.CommandArgLocale];
+    const parsedTimezone = parsed[constants_1.CommandArgTimezoneID];
+    const localizationOptions = parsedLocale || parsedTimezone
+        ? {
+            locale: parsedLocale,
+            timezone_identifier: parsedTimezone,
+        }
+        : undefined;
+    const testRunnerConfig = {
+        _cliCreated: true,
+        basicAuthCredentialsId: parsed[constants_1.CommandArgBasicAuthCredentials],
+        branchName: parsed['mabl-branch'],
+        browserType,
+        credentialsId: parsed['credentials-id'],
+        dataTableVariables: scenario,
+        disableIsolation: parsed[constants_1.CommandArgBrowserDisableIsolation],
+        enableExtensions: parsed[constants_1.CommandArgBrowserEnableExtensions],
+        enableLink: false,
+        environmentId: parsed[constants_1.CommandArgEnvironmentId],
+        extraHttpHeaders,
+        filterHttpRequests: false,
+        fromPlanId: parsed['from-plan-id'],
+        headless: parsed.headless,
+        height: parsed.height,
+        highlights: parsed.highlights,
+        ignoreCertificateErrors: parsed[constants_1.CommandArgBrowserIgnoreCertificateErrors],
+        interactionSpeed: parsed[constants_1.CommandArgTestInteractionSpeed],
+        keepBrowserOpen: parsed['keep-browser-open'],
+        labelsExclude: parsed['exclude-labels'],
+        labelsInclude: parsed.labels,
+        localizationOptions,
+        runId: parsed['run-id'],
+        testFile: parsed[constants_1.CommandArgTestFile],
+        testId: parsed.id,
+        url: parsed.url,
+        useTestExecutionProxy: parsed[constants_1.CommandArgUseTestExecutionProxy],
+        userAgent: parsed[constants_1.CommandArgUserAgent],
+        usingDataTableId: parsed[constants_1.CommandArgDataTableId],
+        width: parsed.width,
+        workspaceId,
+    };
+    loggingProvider_1.logger.info('Warming up test runner...');
+    const mablTestsRunner = await execution.createBrowserTestsRunner(testRunnerConfig);
+    const results = await mablTestsRunner.run();
+    if ((mablTestsRunner === null || mablTestsRunner === void 0 ? void 0 : mablTestsRunner.mablTestRunners) !== undefined) {
+        mablTestsRunner.mablTestRunners
+            .filter((tr) => tr instanceof execution_1.MablTestRunner)
+            .forEach((tr) => {
+            const testContext = tr.testContext;
+            (0, testsUtil_1.cleanupTestResources)(testContext);
+        });
+    }
+    await (0, runUtils_1.logTestResults)(results, parsed, commandStartTime, generateRunCommandTemplate(parsed, results));
+    if (!testRunnerConfig.keepBrowserOpen) {
+        if (!results.success) {
+            process.exit(1);
+        }
+    }
+}
+exports.run = run;
+function generateRunCommandTemplate(parsed, testResults) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const testResult = testResults.testResults[0];
+    let templateCommand = `${defaultEnv_1.SCRIPT_NAME} ${parsed._.join(' ')} \\\n`;
+    if ((_a = testResult === null || testResult === void 0 ? void 0 : testResult.rerunConfig) === null || _a === void 0 ? void 0 : _a.environmentId) {
+        templateCommand = `${templateCommand} --${constants_1.CommandArgEnvironmentId} ${(_b = testResult === null || testResult === void 0 ? void 0 : testResult.rerunConfig) === null || _b === void 0 ? void 0 : _b.environmentId} \\\n`;
+    }
+    if ((_c = testResult === null || testResult === void 0 ? void 0 : testResult.rerunConfig) === null || _c === void 0 ? void 0 : _c.credentialsId) {
+        templateCommand = `${templateCommand} --${constants_1.CommandArgCredentials} ${(_d = testResult === null || testResult === void 0 ? void 0 : testResult.rerunConfig) === null || _d === void 0 ? void 0 : _d.credentialsId} \\\n`;
+    }
+    if ((_e = testResult === null || testResult === void 0 ? void 0 : testResult.rerunConfig) === null || _e === void 0 ? void 0 : _e.url) {
+        templateCommand = `${templateCommand} --${constants_1.CommandArgUrl} ${(_f = testResult === null || testResult === void 0 ? void 0 : testResult.rerunConfig) === null || _f === void 0 ? void 0 : _f.url} \\\n`;
+    }
+    if ((_g = testResult === null || testResult === void 0 ? void 0 : testResult.rerunConfig) === null || _g === void 0 ? void 0 : _g.branch) {
+        templateCommand = `${templateCommand} --${constants_1.CommandArgMablBranch} ${testResult.rerunConfig.branch} \\\n`;
+    }
+    const testIdVal = parsed.id ? parsed.id : '<TEST-ID>';
+    templateCommand = `${templateCommand} --${constants_1.CommandArgId} ${testIdVal}`;
+    return templateCommand;
+}

package/commands/tests/tests_cmds/runUtils.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPlatformFromTestRun = exports.logTestResults = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+const reporter_1 = require("../../../reporters/reporter");
+const testsUtil_1 = require("../testsUtil");
+const execution_1 = require("../../../execution");
+async function logTestResults(results, parsed, commandStartTime, rerunCommandTemplate) {
+    loggingProvider_1.logger.logNewLine();
+    loggingProvider_1.logger.info(`Test count: ${results.numTotalTests}`);
+    loggingProvider_1.logger.info(`Passed: ${results.numPassedTests}`);
+    if (results.numPassedTests) {
+        results.testResults.forEach((result) => {
+            if (result.status === 'passed') {
+                loggingProvider_1.logger.info(` - ${getTestResultDescription(result)} (${(0, testsUtil_1.calculateTotalTimeSeconds)(result.startTime, result.endTime)}s)`);
+            }
+        });
+    }
+    loggingProvider_1.logger.info(`Skipped: ${results.numSkippedTests}`);
+    if (results.numSkippedTests) {
+        results.testResults.forEach((result) => {
+            if (result.status === 'skipped') {
+                loggingProvider_1.logger.info(chalk_1.default.yellow(` - ${getTestResultDescription(result)}`));
+            }
+        });
+    }
+    loggingProvider_1.logger.info(`Failed: ${results.numFailedTests}`);
+    if (results.numFailedTests) {
+        results.testResults.forEach((result) => {
+            if (result.status === 'failed') {
+                loggingProvider_1.logger.info(chalk_1.default.red(` - ${getTestResultDescription(result)} (${(0, testsUtil_1.calculateTotalTimeSeconds)(result.startTime, result.endTime)}s)`));
+            }
+        });
+        if (parsed.labels || parsed['from-plan-id'] || process.env.CI) {
+            loggingProvider_1.logger.info(`Rerun any failed test with the following command template:`);
+            loggingProvider_1.logger.info(`${chalk_1.default.magenta(rerunCommandTemplate)}`);
+        }
+    }
+    loggingProvider_1.logger.info(`Total time: ${(0, testsUtil_1.calculateTotalTimeSeconds)(commandStartTime, Date.now())} seconds`);
+    if (parsed.reporter) {
+        await (0, reporter_1.handleReportingForTestsRun)(parsed.reporter, results, parsed['reporter-options']);
+    }
+}
+exports.logTestResults = logTestResults;
+function getTestResultDescription(result) {
+    return `${result.testName}${result.scenarioName ? ` - Scenario: ${result.scenarioName}` : ''}`;
+}
+function getPlatformFromTestRun(testRun) {
+    var _a, _b;
+    const platform = (_b = (_a = testRun.journey_parameters) === null || _a === void 0 ? void 0 : _a.mobile_device) === null || _b === void 0 ? void 0 : _b.platform;
+    if (!platform) {
+        throw new Error(`Unable to determine mobile platform from test run: ${testRun.id}`);
+    }
+    return (0, execution_1.parsePlatformName)(platform);
+}
+exports.getPlatformFromTestRun = getPlatformFromTestRun;

package/commands/tests/tests_cmds/trainerUtil.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTrainerId = exports.LOCAL_TRAINER_ID = void 0;
+const env_1 = require("../../../env/env");
+exports.LOCAL_TRAINER_ID = 'jmeffipchlcmnkllcolcbmneknjckcpp';
+function getTrainerId() {
+    if (env_1.LOCAL_TRAINER_PATH) {
+        return env_1.EXTENSION_ID;
+    }
+    return exports.LOCAL_TRAINER_ID;
+}
+exports.getTrainerId = getTrainerId;

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;
+    }
+}

package/commands/workspaces/workspace_cmds/copy.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const util_1 = require("../../commandUtil/util");
+const constants_1 = require("../../constants");
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+const chalk_1 = __importDefault(require("chalk"));
+const moment_1 = __importDefault(require("moment"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const mablApi_1 = require("../../../mablApi");
+const ora = require("ora");
+exports.command = 'copy';
+exports.describe = 'copy data from one workspace to another';
+exports.builder = (yargs) => {
+    yargs
+        .option(constants_1.CommandArgFrom, {
+        describe: 'The workspace from which to copy',
+        required: true,
+        nargs: 1,
+    })
+        .option(constants_1.CommandArgTo, {
+        describe: 'The workspace the data will be copied into',
+        required: true,
+        nargs: 1,
+    })
+        .option(constants_1.CommandArgIncludeDefaults, {
+        describe: 'Include default tests when copying',
+        default: false,
+        type: 'boolean',
+    })
+        .option(constants_1.CommandArgIncludedTests, {
+        describe: 'List of test ids to include with the copy. If empty, all tests will be copied.',
+        default: [],
+        type: 'array',
+    })
+        .option(constants_1.CommandArgExcludedTests, {
+        describe: 'List of test ids to exclude from the copy. If a test is in both the include and exclude list, it will be excluded.',
+        default: [],
+        type: 'array',
+    });
+};
+exports.handler = (0, util_1.failWrapper)(copyWorkspace);
+function getTimestamp() {
+    return (0, moment_1.default)().format('HH:mm:ss');
+}
+function hasOwnerRoleInWorkspace(user, workspaceId) {
+    var _a;
+    const hasOwnerRole = (_a = user.roles) === null || _a === void 0 ? void 0 : _a.some((role) => role.organization_id === workspaceId && role.role === mablApi_1.UserRoleEnum.Owner);
+    if (!hasOwnerRole) {
+        loggingProvider_1.logger.warn(chalk_1.default.yellow(`You must be an owner in both workspaces to copy. You do not have owner permissions in workspace: ${workspaceId}`));
+    }
+    return !!hasOwnerRole;
+}
+async function copyWorkspace(parsed) {
+    const spinner = ora({
+        prefixText: ' ',
+        text: 'Copying workspace assets...',
+    });
+    try {
+        const sourceWorkspaceId = parsed.from;
+        const destinationWorkspaceId = parsed.to;
+        const includeDefaults = parsed.includeDefaults;
+        const includedTests = parsed.includedTests;
+        const excludedTests = parsed.excludedTests;
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+        const [sourceWorkspace, destinationWorkspace] = await Promise.all([
+            apiClient.getWorkspace(sourceWorkspaceId),
+            apiClient.getWorkspace(destinationWorkspaceId),
+        ]);
+        const user = await apiClient.getSelf();
+        if (!hasOwnerRoleInWorkspace(user, sourceWorkspaceId) ||
+            !hasOwnerRoleInWorkspace(user, destinationWorkspaceId)) {
+            return Promise.reject(new Error('You must be owner of both the source and destination workspace to copy a workspace.'));
+        }
+        loggingProvider_1.logger.info(chalk_1.default.yellow(`[${getTimestamp()}] In case of failure, please DO NOT re-run this command, as it would create duplicate items in the destination. The operation may take several minutes, or longer for especially large workspaces. Please contact mabl support if you encounter any issues.`));
+        loggingProvider_1.logger.info(chalk_1.default.yellow(`[${getTimestamp()}] Note: currently the copy includes tests, flows, datatables, file uploads, javascript snippets. Unsupported items include: plans, applications, environments, coverage, and run history.`));
+        const excludedTestsConfirmationDetail = !includeDefaults || (excludedTests === null || excludedTests === void 0 ? void 0 : excludedTests.length)
+            ? ' excluding default tests and all tests specified with --exclude-tests '
+            : '';
+        const response = await inquirer_1.default.prompt([
+            {
+                type: 'confirm',
+                name: 'do_continue',
+                message: `Are you sure you want to copy ALL tests${excludedTestsConfirmationDetail} from Workspace [${sourceWorkspaceId}](${sourceWorkspace.name}) to Workspace [${destinationWorkspaceId}](${destinationWorkspace.name})? Once the copy begins, it cannot be cancelled.`,
+                default: false,
+            },
+        ]);
+        if (!response.do_continue) {
+            return 'Skipped';
+        }
+        loggingProvider_1.logger.info(chalk_1.default.yellow(`[${getTimestamp()}] The copy process will complete even if this command is interrupted.`));
+        spinner.start();
+        await apiClient.copyWorkspace(sourceWorkspaceId, destinationWorkspaceId, includeDefaults, includedTests, excludedTests);
+        spinner.succeed('Done copying assets');
+        loggingProvider_1.logger.info(chalk_1.default.green(`[${getTimestamp()}] Workspace copy successful`));
+        return 'Success';
+    }
+    catch (error) {
+        if (spinner.isSpinning) {
+            spinner.fail('Error copying workspace assets');
+            loggingProvider_1.logger.info(chalk_1.default.red(`[${getTimestamp()}] Workspace copy failed`));
+        }
+        throw error;
+    }
+}

package/commands/workspaces/workspace_cmds/describe.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const describe_1 = require("../../commandUtil/describe");
+const util_1 = require("../../commandUtil/util");
+exports.command = 'describe <id>';
+exports.describe = (0, util_1.getDescribeDescriptions)('workspace');
+exports.builder = (0, describe_1.getDescribeBuilderOptions)();
+exports.handler = (0, util_1.failWrapper)(getWorkspace);
+async function getWorkspace(parsed) {
+    try {
+        const workspaceId = parsed.id;
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+        const workspace = await apiClient.getWorkspace(workspaceId);
+        (0, describe_1.outputEntity)(workspace, parsed.output);
+        return workspace.id;
+    }
+    catch (error) {
+        throw new Error(`Error getting workspace: ${error}`);
+    }
+}

package/commands/workspaces/workspace_cmds/list.js

@@ -0,0 +1,67 @@
+"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 interfaces_1 = require("../../commandUtil/interfaces");
+const constants_1 = require("../../constants");
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+exports.command = 'list';
+exports.describe = 'List your workspaces';
+exports.builder = (yargs) => {
+    yargs
+        .option(constants_1.CommandArgLimitOutput, {
+        alias: constants_1.CommandArgAliases.LimitOutput,
+        describe: 'The number of workspaces to return',
+        default: interfaces_1.DEFAULT_LISTING_RESULT_LIMIT,
+        nargs: 1,
+    })
+        .option(constants_1.CommandArgOutput, {
+        alias: constants_1.CommandArgAliases.OutputType,
+        choices: constants_1.DefaultOutputFormatChoices,
+        describe: 'Specify result output format',
+        nargs: 1,
+    });
+};
+exports.handler = (0, util_1.failWrapper)(listWorkspaces);
+async function listWorkspaces(parsed) {
+    const output = parsed.output;
+    const limit = parsed.limit;
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const workspaces = await apiClient.getWorkspaces(limit);
+    printWorkspaces(workspaces, output);
+    return workspaces.length;
+}
+function printWorkspaces(workspaces, output) {
+    switch (output) {
+        case 'json':
+            loggingProvider_1.logger.info(JSON.stringify(workspaces, null, 2));
+            break;
+        case 'yaml':
+            loggingProvider_1.logger.info((0, js_yaml_1.dump)(workspaces));
+            break;
+        default:
+            const table = new cli_table3_1.default({
+                head: ['ID', 'Name', 'Created time'],
+                wordWrap: true,
+            });
+            workspaces.forEach((workspace) => {
+                table.push([
+                    { rowSpan: 1, content: workspace.id, vAlign: 'center' },
+                    { rowSpan: 1, content: workspace.name, vAlign: 'center' },
+                    {
+                        rowSpan: 1,
+                        content: moment.utc(workspace.created_time).format(constants_1.ListTimeFormat),
+                        vAlign: 'center',
+                    },
+                ]);
+            });
+            loggingProvider_1.logger.info(table.toString());
+            break;
+    }
+}

package/commands/workspaces/workspaces.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = 'workspaces <command>';
+exports.describe = 'Manage your workspaces';
+exports.builder = (yargs) => yargs.commandDir('workspace_cmds').demandCommand();

package/core/entityValidation/environmentsValidation.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidEnvironmentVariableName = void 0;
+function isValidEnvironmentVariableName(name) {
+    return /^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name);
+}
+exports.isValidEnvironmentVariableName = isValidEnvironmentVariableName;