@mablhq/mabl-cli 1.48.47 → 1.50.4

package/commands/datatables/utils.js

@@ -0,0 +1,138 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.variableRowAsScenario = exports.scenarioAsVariableRow = exports.dataTableAsVariableTable = exports.isScenarioArray = exports.inferFileFormat = exports.jsonToScenarios = exports.parseJsonScenarios = exports.csvScenarioFormatToScenarios = exports.parseCsvScenarios = exports.sanitizeCsvCellInput = void 0;
+const constants_1 = require("../constants");
+const path_1 = require("path");
+const fs_1 = __importDefault(require("fs"));
+const csv_parser_1 = __importDefault(require("csv-parser"));
+const MALICIOUS_LINE_PREFIX_MATCHER = /^([+\-@=])/;
+const SANITIZED_LINE_PREFIX_MATCHER = /^(`[+\-@=])/;
+function sanitizeCsvCellInput(input) {
+    return MALICIOUS_LINE_PREFIX_MATCHER.test(input)
+        ? `\`${input}`.trim()
+        : input.trim();
+}
+exports.sanitizeCsvCellInput = sanitizeCsvCellInput;
+function desanitizeCsvCellOutput(input) {
+    return SANITIZED_LINE_PREFIX_MATCHER.test(input)
+        ? input.slice(1).trim()
+        : input.trim();
+}
+var AllowedInputExtensions;
+(function (AllowedInputExtensions) {
+    AllowedInputExtensions["Csv"] = ".csv";
+    AllowedInputExtensions["Json"] = ".json";
+})(AllowedInputExtensions || (AllowedInputExtensions = {}));
+async function parseCsvScenarios(fileName) {
+    const readCsv = await fileToCsvScenarioFormat(fileName);
+    return csvScenarioFormatToScenarios(readCsv);
+}
+exports.parseCsvScenarios = parseCsvScenarios;
+async function fileToCsvScenarioFormat(fileName) {
+    const csvInput = [];
+    await new Promise((resolve) => {
+        fs_1.default.createReadStream(fileName)
+            .pipe((0, csv_parser_1.default)())
+            .on('data', (data) => csvInput.push(data))
+            .on('end', () => resolve());
+    });
+    return csvInput;
+}
+function csvScenarioFormatToScenarios(input) {
+    if (input.length === 0) {
+        return [];
+    }
+    return input.map((rowItem) => ({
+        id: rowItem[constants_1.SCENARIO_ID_HEADER] || undefined,
+        name: desanitizeCsvCellOutput(rowItem[constants_1.SCENARIO_NAME_HEADER]),
+        variables: Object.entries(rowItem)
+            .filter(([key, _]) => key !== constants_1.SCENARIO_NAME_HEADER && key !== constants_1.SCENARIO_ID_HEADER)
+            .map(([key, value]) => ({
+            name: desanitizeCsvCellOutput(key),
+            value: desanitizeCsvCellOutput(value),
+        })),
+    }));
+}
+exports.csvScenarioFormatToScenarios = csvScenarioFormatToScenarios;
+function parseJsonScenarios(fileName) {
+    const readJson = fs_1.default.readFileSync(fileName, 'utf-8');
+    return jsonToScenarios(readJson);
+}
+exports.parseJsonScenarios = parseJsonScenarios;
+function jsonToScenarios(input) {
+    const parsedJson = JSON.parse(input);
+    if (isScenarioArray(parsedJson)) {
+        return parsedJson;
+    }
+    throw Error('Json input was not formatted correctly');
+}
+exports.jsonToScenarios = jsonToScenarios;
+function inferFileFormat(fileName) {
+    const extension = (0, path_1.extname)(fileName);
+    switch (extension) {
+        case AllowedInputExtensions.Csv:
+            return constants_1.OutputFormats.Csv;
+        case AllowedInputExtensions.Json:
+            return constants_1.OutputFormats.Json;
+        default:
+            throw new Error('The file format could be inferred from the extension, please specify a format for your input data.');
+    }
+}
+exports.inferFileFormat = inferFileFormat;
+function isScenario(arg) {
+    return ((typeof arg.id === 'string' || arg.id === undefined) &&
+        typeof arg.name === 'string' &&
+        Array.isArray(arg.variables) &&
+        arg.variables.every((col) => typeof col.name === 'string' && typeof col.value === 'string'));
+}
+function isScenarioArray(arg) {
+    return Array.isArray(arg) && arg.every((scenario) => isScenario(scenario));
+}
+exports.isScenarioArray = isScenarioArray;
+function dataTableAsVariableTable(dataTable) {
+    return {
+        id: dataTable.id,
+        organization_id: dataTable.workspace_id,
+        name: dataTable.name,
+        created_time: dataTable.created_time,
+        created_by_id: dataTable.created_by_id,
+        last_updated_time: dataTable.last_updated_time,
+        last_updated_by_id: dataTable.last_updated_by_id,
+        row_ids: dataTable.scenario_ids,
+    };
+}
+exports.dataTableAsVariableTable = dataTableAsVariableTable;
+function scenarioAsVariableRow(scenario) {
+    return {
+        id: scenario === null || scenario === void 0 ? void 0 : scenario.id,
+        table_id: scenario === null || scenario === void 0 ? void 0 : scenario.table_id,
+        created_time: scenario === null || scenario === void 0 ? void 0 : scenario.created_time,
+        created_by_id: scenario === null || scenario === void 0 ? void 0 : scenario.created_by_id,
+        last_updated_time: scenario === null || scenario === void 0 ? void 0 : scenario.last_updated_time,
+        last_updated_by_id: scenario === null || scenario === void 0 ? void 0 : scenario.last_updated_by_id,
+        organization_id: scenario === null || scenario === void 0 ? void 0 : scenario.workspace_id,
+        scenario_id: scenario === null || scenario === void 0 ? void 0 : scenario.name,
+        row: scenario === null || scenario === void 0 ? void 0 : scenario.variables,
+    };
+}
+exports.scenarioAsVariableRow = scenarioAsVariableRow;
+function variableRowAsScenario(variableRow) {
+    if (isScenario(variableRow)) {
+        return variableRow;
+    }
+    return {
+        id: variableRow.id,
+        table_id: variableRow.table_id,
+        created_time: variableRow.created_time,
+        created_by_id: variableRow.created_by_id,
+        last_updated_time: variableRow.last_updated_time,
+        last_updated_by_id: variableRow.last_updated_by_id,
+        workspace_id: variableRow.organization_id,
+        name: variableRow.scenario_id,
+        variables: variableRow.row,
+    };
+}
+exports.variableRowAsScenario = variableRowAsScenario;

package/commands/flows/flows_cmds/export.js

@@ -4,7 +4,7 @@ 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 flowConfigGenerator_1 = require("../../../codeGenerators/seleniumConfigGenerators/flowConfigGenerator");
+const flowConfigGenerator_1 = require("../../../execution/codeGenerators/seleniumConfigGenerators/flowConfigGenerator");
 const fileUtil_1 = require("../../commandUtil/fileUtil");
 const os = require('os');
 const JSON_REPLACER = null;

package/commands/tests/testsUtil.js

@@ -42,6 +42,7 @@ const logUtils_1 = require("../../util/logUtils");
 const browserTypes_1 = require("../browserTypes");
 const constants_1 = require("../constants");
 const trainerUtil_1 = require("./tests_cmds/trainerUtil");
+const utils_1 = require("../datatables/utils");
 const chalk = require('chalk');
 let RUNNING_TEST = false;
 function getFinalUrl(test, parsedUrl) {
@@ -394,31 +395,33 @@ 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;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
     const journeyRun = await apiClient.getTestRun(testRunId);
     const planRun = await apiClient.getPlanRun(journeyRun.parent_execution);
+    const testDatatablevariables = ((_a = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _a === void 0 ? void 0 : _a.user_variables) &&
+        (0, utils_1.variableRowAsScenario)((_b = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _b === void 0 ? void 0 : _b.user_variables);
     return {
-        basicAuthCredentialsId: ((_a = planRun === null || planRun === void 0 ? void 0 : planRun.run_policy) === null || _a === void 0 ? void 0 : _a.http_auth_credentials_required)
-            ? (_b = planRun === null || planRun === void 0 ? void 0 : planRun.run_policy) === null || _b === void 0 ? void 0 : _b.http_auth_credentials_id
+        basicAuthCredentialsId: ((_c = planRun === null || planRun === void 0 ? void 0 : planRun.run_policy) === null || _c === void 0 ? void 0 : _c.http_auth_credentials_required)
+            ? (_d = planRun === null || planRun === void 0 ? void 0 : planRun.run_policy) === null || _d === void 0 ? void 0 : _d.http_auth_credentials_id
             : undefined,
-        branchName: (_c = journeyRun.journey_parameters) === null || _c === void 0 ? void 0 : _c.source_control_tag,
-        credentialsId: ((_d = planRun.run_policy) === null || _d === void 0 ? void 0 : _d.credentials_required)
-            ? (_e = planRun.run_policy) === null || _e === void 0 ? void 0 : _e.credentials_id
+        branchName: (_e = journeyRun.journey_parameters) === null || _e === void 0 ? void 0 : _e.source_control_tag,
+        credentialsId: ((_f = planRun.run_policy) === null || _f === void 0 ? void 0 : _f.credentials_required)
+            ? (_g = planRun.run_policy) === null || _g === void 0 ? void 0 : _g.credentials_id
             : undefined,
-        dataTableVariables: (_f = journeyRun.journey_parameters) === null || _f === void 0 ? void 0 : _f.user_variables,
-        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,
+        dataTableVariables: testDatatablevariables,
+        deviceEmulation: (_h = journeyRun.journey_parameters) === null || _h === void 0 ? void 0 : _h.device_emulation,
+        environmentId: (_k = (_j = journeyRun.journey_parameters) === null || _j === void 0 ? void 0 : _j.deployment) === null || _k === void 0 ? void 0 : _k.environment_id,
         filterHttpRequests: false,
-        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,
+        importedVariables: (_l = journeyRun.journey_parameters) === null || _l === void 0 ? void 0 : _l.imported_variables,
+        pageLoadWait: (_m = journeyRun.journey_parameters) === null || _m === void 0 ? void 0 : _m.page_load_wait,
         runId: journeyRun.id,
-        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,
+        testId: (_o = journeyRun.journey) === null || _o === void 0 ? void 0 : _o.invariant_id,
+        url: (_q = (_p = journeyRun.journey_parameters) === null || _p === void 0 ? void 0 : _p.deployment) === null || _q === void 0 ? void 0 : _q.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;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
     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)
@@ -430,16 +433,17 @@ async function extractTestRunConfig(executionMessage, apiClient) {
         credentialsId: ((_e = planRun === null || planRun === void 0 ? void 0 : planRun.run_policy) === null || _e === void 0 ? void 0 : _e.credentials_required)
             ? (_f = planRun === null || planRun === void 0 ? void 0 : planRun.run_policy) === null || _f === void 0 ? void 0 : _f.credentials_id
             : undefined,
-        dataTableVariables: (_g = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _g === void 0 ? void 0 : _g.user_variables,
-        deviceEmulation: (_h = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _h === void 0 ? void 0 : _h.device_emulation,
-        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,
+        dataTableVariables: ((_g = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _g === void 0 ? void 0 : _g.user_variables) &&
+            (0, utils_1.variableRowAsScenario)((_h = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _h === void 0 ? void 0 : _h.user_variables),
+        deviceEmulation: (_j = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _j === void 0 ? void 0 : _j.device_emulation,
+        environmentId: (_l = (_k = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _k === void 0 ? void 0 : _k.deployment) === null || _l === void 0 ? void 0 : _l.environment_id,
         filterHttpRequests: true,
-        importedVariables: (_l = journeyRun.journey_parameters) === null || _l === void 0 ? void 0 : _l.imported_variables,
-        pageLoadWait: (_m = journeyRun.journey_parameters) === null || _m === void 0 ? void 0 : _m.page_load_wait,
+        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,
         runId: journeyRun.id,
         runnerType: maybeRunnerType,
-        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,
+        testId: (_p = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey) === null || _p === void 0 ? void 0 : _p.invariant_id,
+        url: (_r = (_q = journeyRun === null || journeyRun === void 0 ? void 0 : journeyRun.journey_parameters) === null || _q === void 0 ? void 0 : _q.deployment) === null || _r === void 0 ? void 0 : _r.uri,
     };
 }
 exports.extractTestRunConfig = extractTestRunConfig;

package/commands/tests/tests_cmds/export.js

@@ -2,13 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const mablApi_1 = require("../../../mablApi");
 const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
-const selIdeGenerator_1 = require("../../../codeGenerators/seleniumConfigGenerators/selIdeGenerator");
 const util_1 = require("../../commandUtil/util");
-const testConfigGenerator_1 = require("../../../codeGenerators/seleniumConfigGenerators/testConfigGenerator");
 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;
@@ -28,6 +27,7 @@ exports.builder = (yargs) => {
             constants_1.OutputFormats.Json,
             constants_1.OutputFormats.Yaml,
             constants_1.OutputFormats.Csv,
+            constants_1.OutputFormats.Playwright,
             constants_1.OutputFormats.SeleniumIde,
         ],
     })
@@ -41,14 +41,27 @@ exports.builder = (yargs) => {
         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)(pullJourney);
-async function pullJourney(parsed) {
+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);
@@ -62,43 +75,61 @@ async function pullJourney(parsed) {
     }
     switch (format) {
         case constants_1.OutputFormats.Csv:
-            dumpToCsv(journey, flowArray);
-            break;
+            return dumpToCsv(journey, flowArray, fileName);
         case constants_1.OutputFormats.SeleniumIde:
-            dumpToSeleniumIde(journey, flowArray);
-            break;
+            return dumpToSeleniumIde(journey, flowArray, fileName);
+        case constants_1.OutputFormats.Playwright:
+            return dumpToPlaywrightTest(journey, flowArray, apiClient, fileName, environmentId);
         case constants_1.OutputFormats.Json:
         case constants_1.OutputFormats.Yaml:
         default:
-            dumpYamlOrJsonToFile(format, journey, flowArray, detailLevel);
-            break;
+            return dumpYamlOrJsonToFile(format, journey, flowArray, detailLevel, fileName);
     }
 }
-function dumpToSeleniumIde(journey, flows) {
-    const selIdeConfig = new selIdeGenerator_1.SelIdeConfig(journey, flows);
+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);
-    (0, fileUtil_1.writeExportedEntityToFile)(jsonified, 'side', journey.id);
+    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) {
-    const journeyConfig = new testConfigGenerator_1.JourneyConfig(journey, flows, false);
+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 });
-            (0, fileUtil_1.writeExportedEntityToFile)(yaml, 'yml', journey.id);
-            break;
+            return (0, fileUtil_1.writeExportedEntityToFile)(yaml, 'yml', journey.id, fileName);
         case constants_1.OutputFormats.Json:
-            (0, fileUtil_1.writeExportedEntityToFile)(JSON.stringify(configGenerated, JSON_REPLACER, 2), 'json', journey.id);
-            break;
+            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) {
-    const journeyConfig = new testConfigGenerator_1.JourneyConfig(journey, flows, false);
+function dumpToCsv(journey, flows, fileName) {
+    const journeyConfig = new execution_1.JourneyConfig(journey, flows, false);
     const output = journeyConfig.generateSimpleCsv();
-    (0, fileUtil_1.writeExportedEntityToFile)(output.join(os.EOL), 'csv', journey.id);
+    return (0, fileUtil_1.writeExportedEntityToFile)(output.join(os.EOL), 'csv', journey.id, fileName);
 }

package/core/trainer/trainingSessions.js

@@ -109,7 +109,7 @@ async function editTest(trainingSessionOptions) {
         planId: testRunIdConfig.fromPlanId,
         sender: exports.SENDER,
         testId,
-        testType: (_j = test.test_type) !== null && _j !== void 0 ? _j : mablApi_1.Journey.TestTypeEnum.Browser,
+        testType: (_j = test.test_type) !== null && _j !== void 0 ? _j : mablApi_1.TestTypeEnum.Browser,
         url: finalUrl,
         width: (_k = trainingSessionOptions.width) !== null && _k !== void 0 ? _k : exports.DEFAULT_WIDTH,
         workspaceId,