@mablhq/playwright-tools 2.49.1

package/commands/tests/tests_cmds/edit.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../commandUtil/util");
+const testsUtil_1 = require("../testsUtil");
+const constants_1 = require("../../constants");
+const trainingSessions_1 = require("../../../core/trainer/trainingSessions");
+exports.command = 'edit';
+exports.describe = 'Edit a test locally';
+exports.builder = (yargs) => {
+    yargs
+        .example('$0 tests edit --id <id>', 'edit test locally by id')
+        .example('$0 tests edit --run-id <test-run-id>', 'edit a test locally in the context of a test configuration from a cloud run')
+        .option(constants_1.CommandArgId, {
+        describe: 'the id of the test to edit',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgTestRunId, {
+        describe: 'The id of the test run to pull config from',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgMablBranch, {
+        describe: 'Branch to edit the mabl test against',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgMablAutoBranch, {
+        describe: 'Create a mabl branch when a mabl-branch target is specified that does not exist',
+        type: 'boolean',
+        default: false,
+    })
+        .option(constants_1.CommandArgEnvironmentId, {
+        alias: constants_1.CommandArgAliases.EnvironmentId,
+        describe: 'Mabl environment to edit the test under. Specify to edit the test with environment variables and the latest find information.',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgApplicationId, {
+        alias: constants_1.CommandArgAliases.ApplicationId,
+        describe: 'Mabl application to edit the test under',
+        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 edit the mabl test against',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgCredentials, {
+        alias: constants_1.CommandArgAliases.Credentials,
+        describe: 'Credentials ID to edit the test with',
+        nargs: 1,
+        type: 'string',
+    })
+        .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',
+    })
+        .check((argv) => (0, testsUtil_1.validateRunEditCommand)(argv[constants_1.CommandArgId], argv[constants_1.CommandArgTestRunId]));
+};
+exports.handler = (0, util_1.failWrapper)(launchEditTrainingSession);
+async function launchEditTrainingSession(parsed) {
+    const testRunId = parsed['run-id'];
+    const testId = parsed.id;
+    const url = parsed.url;
+    const credentialsId = parsed['credentials-id'];
+    const branchName = parsed['mabl-branch'];
+    const width = parsed.width;
+    const height = parsed.height;
+    const autoBranch = parsed['auto-branch'];
+    const environmentId = parsed[constants_1.CommandArgEnvironmentId];
+    const applicationId = parsed[constants_1.CommandArgApplicationId];
+    const disableIsolation = parsed[constants_1.CommandArgBrowserDisableIsolation];
+    const ignoreCertificateErrors = parsed[constants_1.CommandArgBrowserIgnoreCertificateErrors];
+    const editTrainingSessionOptions = {
+        applicationId,
+        autoBranch,
+        branchName,
+        credentialsId,
+        disableIsolation,
+        environmentId,
+        height,
+        ignoreCertificateErrors,
+        testId,
+        testRunId,
+        url,
+        width,
+    };
+    await (0, trainingSessions_1.editTest)(editTrainingSessionOptions);
+    return 'done';
+}

package/commands/tests/tests_cmds/export.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mablApi_1 = require("../../../mablApi");
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const util_1 = require("../../commandUtil/util");
+const js_yaml_1 = require("js-yaml");
+const constants_1 = require("../../constants");
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+const fileUtil_1 = require("../../commandUtil/fileUtil");
+const execution_1 = require("../../../execution");
+const chalk = require('chalk');
+const os = require('os');
+const JSON_REPLACER = null;
+exports.command = `export <${constants_1.CommandArgId}>`;
+exports.describe = 'Export a mabl test in a specified file format';
+exports.builder = (yargs) => {
+    yargs
+        .positional(constants_1.CommandArgId, {
+        describe: 'test id to export',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgFormat, {
+        alias: 'fmt',
+        default: 'yaml',
+        describe: `Specify a format for the test export`,
+        choices: [
+            constants_1.OutputFormats.Json,
+            constants_1.OutputFormats.Yaml,
+            constants_1.OutputFormats.Csv,
+            constants_1.OutputFormats.Playwright,
+            constants_1.OutputFormats.SeleniumIde,
+        ],
+    })
+        .option(constants_1.CommandArgDetailLevel, {
+        default: 'simple',
+        hidden: true,
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgMablBranch, {
+        describe: 'Which branch of the test to export',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgEnvironmentId, {
+        alias: 'e',
+        describe: 'Generate selectors based on the find information learned in this environment (Playwright only)',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgOutputFilePath, {
+        describe: 'Export to specific file, default: local path/export name',
+        nargs: 1,
+        type: 'string',
+    });
+};
+exports.handler = (0, util_1.failWrapper)(exportTest);
+async function exportTest(parsed) {
+    var _a;
+    const testId = parsed.id;
+    const format = parsed.format;
+    const environmentId = parsed[constants_1.CommandArgEnvironmentId];
+    const detailLevel = parsed[constants_1.CommandArgDetailLevel];
+    const fileName = parsed[constants_1.CommandArgOutputFilePath];
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const branchName = (_a = parsed['mabl-branch']) !== null && _a !== void 0 ? _a : constants_1.DefaultBranchName;
+    const journey = await apiClient.getJourney(testId, branchName, format);
+    if (journey.test_type === mablApi_1.TestTypeEnum.Performance) {
+        throw new Error('Export functionality is not yet available for performance tests.');
+    }
+    const flowArray = await (0, util_1.getJourneyFlowArray)(journey, apiClient, branchName);
+    if (flowArray
+        .map((flow) => flow.flow_type === mablApi_1.Flow.FlowTypeEnum.Mablscript ||
+        flow.flow_type === mablApi_1.Flow.FlowTypeEnum.Api ||
+        flow.flow_type === mablApi_1.Flow.FlowTypeEnum.Mobile)
+        .includes(false)) {
+        loggingProvider_1.logger.info(chalk.red(`Default mabl tests can not be exported`));
+        return;
+    }
+    switch (format) {
+        case constants_1.OutputFormats.Csv:
+            return dumpToCsv(journey, flowArray, fileName);
+        case constants_1.OutputFormats.SeleniumIde:
+            if (journey.test_type !== mablApi_1.TestTypeEnum.Browser) {
+                throw new Error('Selenium IDE tests can only be exported for browser tests.');
+            }
+            return dumpToSeleniumIde(journey, flowArray, fileName);
+        case constants_1.OutputFormats.Playwright:
+            if (journey.test_type !== mablApi_1.TestTypeEnum.Browser) {
+                throw new Error('Playwright tests can only be exported for browser tests.');
+            }
+            return dumpToPlaywrightTest(journey, flowArray, apiClient, fileName, environmentId);
+        case constants_1.OutputFormats.Json:
+        case constants_1.OutputFormats.Yaml:
+        default:
+            return dumpYamlOrJsonToFile(format, journey, flowArray, detailLevel, fileName);
+    }
+}
+function dumpToSeleniumIde(journey, flows, fileName) {
+    const selIdeConfig = new execution_1.SelIdeConfigGenerator(journey, flows);
+    const configGenerated = selIdeConfig.generateConfigFile();
+    const jsonified = JSON.stringify(configGenerated, JSON_REPLACER, 2);
+    return (0, fileUtil_1.writeExportedEntityToFile)(jsonified, 'side', journey.id, fileName);
+}
+async function dumpToPlaywrightTest(journey, flows, apiClient, fileName, environmentId) {
+    let findModel = [];
+    let findOverrides = [];
+    if (journey.test_type !== mablApi_1.TestTypeEnum.Browser) {
+        throw new Error('Playwright tests can only be generated for browser tests.');
+    }
+    if (!environmentId) {
+        loggingProvider_1.logger.warn(chalk.yellow('Warning: No', chalk.underline(constants_1.CommandArgEnvironmentId), `specified. XPath selectors will be generated.
+        You can take advantage of the find information learned in a specific environment by specifying the environment id with the --${constants_1.CommandArgEnvironmentId} flag.`));
+    }
+    else {
+        findModel = await apiClient.getTestFindModels(journey.invariant_id, environmentId);
+        if (!findModel.length) {
+            loggingProvider_1.logger.warn(chalk.yellow('Warning: No find information was found on the environment', chalk.underline(environmentId), `XPath selectors will be generated.`));
+        }
+        findOverrides = await apiClient.getTestOverrides(journey.invariant_id, environmentId);
+    }
+    const generator = new execution_1.PlaywrightTestGenerator(journey, flows, findModel, findOverrides);
+    const test = generator.generateTest();
+    return (0, fileUtil_1.writeExportedEntityToFile)(test, 'spec.ts', journey.id, fileName);
+}
+function dumpYamlOrJsonToFile(type, journey, flows, detailLevel, fileName) {
+    const journeyConfig = new execution_1.JourneyConfig(journey, flows, false);
+    const configGenerated = detailLevel === constants_1.DetailLevelFormats.Full
+        ? journeyConfig.generateConfigFile()
+        : journeyConfig.generateSimpleFormat();
+    switch (type) {
+        case constants_1.OutputFormats.Yaml:
+            const yaml = (0, js_yaml_1.dump)(configGenerated, { skipInvalid: false });
+            return (0, fileUtil_1.writeExportedEntityToFile)(yaml, 'yml', journey.id, fileName);
+        case constants_1.OutputFormats.Json:
+            return (0, fileUtil_1.writeExportedEntityToFile)(JSON.stringify(configGenerated, JSON_REPLACER, 2), 'json', journey.id, fileName);
+        default:
+            throw new Error(`Invalid Type supplied for exporting: ${type}`);
+    }
+}
+function dumpToCsv(journey, flows, fileName) {
+    const journeyConfig = new execution_1.JourneyConfig(journey, flows, false);
+    const output = journeyConfig.generateSimpleCsv();
+    return (0, fileUtil_1.writeExportedEntityToFile)(output.join(os.EOL), 'csv', journey.id, fileName);
+}

package/commands/tests/tests_cmds/import.js

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