@mablhq/mabl-cli 2.29.7 → 2.31.2

package/commands/tests/tests_cmds/import_cmds/import_playwright.js

@@ -0,0 +1,439 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.processTracesPath = exports.processSingleTraceFile = void 0;
+const env_1 = require("../../../../env/env");
+const pluralize_1 = __importDefault(require("pluralize"));
+const inquirer = __importStar(require("inquirer"));
+const mablApiClientFactory_1 = require("../../../../api/mablApiClientFactory");
+const util_1 = require("../../../commandUtil/util");
+const mablApi_1 = require("../../../../mablApi");
+const pureUtil_1 = require("../../../../util/pureUtil");
+const constants_1 = require("../../../constants");
+const loggingProvider_1 = require("../../../../providers/logging/loggingProvider");
+const chromiumBrowserEngine_1 = require("../../../../browserEngines/chromiumBrowserEngine");
+const RichPromise_1 = __importDefault(require("../../../../util/RichPromise"));
+const { spawn } = require('child_process');
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const adm_zip_1 = __importDefault(require("adm-zip"));
+const execution_1 = require("../../../../execution");
+const projectInfoTestFile = `
+import { test } from "@playwright/test";
+test("mablImportInfo", async ({baseURL, trace}) => {
+  console.log('@mabl project info',
+    JSON.stringify({
+      baseURL: baseURL,
+    })
+  );
+});
+`;
+var PostImportActions;
+(function (PostImportActions) {
+    PostImportActions["Discard"] = "Discard the test";
+    PostImportActions["Run"] = "Run the test locally";
+    PostImportActions["Save"] = "Save the test";
+    PostImportActions["View"] = "View the test description";
+})(PostImportActions || (PostImportActions = {}));
+exports.command = 'playwright';
+exports.describe =
+    '[LABS]: Import an existing Playwright test.\nThis functionality is in an experimental stage.';
+exports.builder = (yargs) => {
+    yargs
+        .option(constants_1.CommandArgAuto, {
+        default: false,
+        describe: 'Automatically save imported test when complete',
+        requiresArg: false,
+        type: 'boolean',
+    })
+        .option(constants_1.CommandArgWorkspaceId, {
+        alias: constants_1.CommandArgAliases.WorkspaceId,
+        describe: 'Workspace into which tests should be imported',
+        nargs: 1,
+        requiresArg: true,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgPath, {
+        describe: 'Project location. Current directory is default',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgProject, {
+        describe: 'Playwright project to run. This project must have tracing enabled.',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgGrep, {
+        describe: 'Grep argument to pass to Playwright to filter tests',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgExtraArguments, {
+        describe: 'Extra arguments to pass to playwright',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgTestPath, {
+        describe: 'Path where the tests are located',
+        type: 'string',
+        default: 'tests',
+    })
+        .option(constants_1.CommandArgTraceFile, {
+        describe: 'Path of a single playwright trace file to import',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgTracesPath, {
+        describe: 'Path of the directory containing playwright trace files to import',
+        type: 'string',
+    })
+        .check((argv) => {
+        if (!argv[constants_1.CommandArgTraceFile] &&
+            !argv[constants_1.CommandArgTracesPath] &&
+            !argv[constants_1.CommandArgPath]) {
+            throw new Error(`Please pass in one of --${constants_1.CommandArgTraceFile}, --${constants_1.CommandArgTracesPath}, or ${constants_1.CommandArgPath}`);
+        }
+        if (argv[constants_1.CommandArgTraceFile] && argv[constants_1.CommandArgTracesPath]) {
+            throw new Error(`Only one of --${constants_1.CommandArgTraceFile} or --${constants_1.CommandArgTracesPath} can be provided`);
+        }
+        return true;
+    });
+};
+exports.handler = (0, util_1.failWrapper)(processCommand);
+async function processCommand(parsed) {
+    const workspaceId = await (0, util_1.getWorkspaceId)(parsed);
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const importedTests = await importTests(parsed);
+    if (!importedTests.length) {
+        return Promise.reject(new Error(`No tests were imported.`));
+    }
+    if (importedTests.length > 1) {
+        loggingProvider_1.logger.info(`Imported ${importedTests.length} tests.\n`);
+    }
+    else {
+        loggingProvider_1.logger.info(`Imported ${(0, pluralize_1.default)('step', importedTests[0].steps.length, true)}.\n`);
+    }
+    return handlePostImportActions(workspaceId, apiClient, importedTests, parsed[constants_1.CommandArgAuto]);
+}
+async function importTests(args) {
+    var _a, _b;
+    const cwd = (_a = args[constants_1.CommandArgPath]) !== null && _a !== void 0 ? _a : process.cwd();
+    const tracesPath = (_b = args[constants_1.CommandArgTracesPath]) !== null && _b !== void 0 ? _b : path_1.default.join(cwd, 'test-results');
+    const playwrightProject = args[constants_1.CommandArgProject]
+        ? await getProjectInfo(args)
+        : { baseUrl: '' };
+    if (!args[constants_1.CommandArgTraceFile] && !args[constants_1.CommandArgTracesPath]) {
+        await runPlaywrightProject(args, tracesPath, cwd);
+    }
+    let importedTests = [];
+    const converter = new execution_1.PlaywrightToMablStepConverter();
+    if (args[constants_1.CommandArgTraceFile]) {
+        importedTests = processSingleTraceFile(args[constants_1.CommandArgTraceFile], playwrightProject, converter);
+    }
+    else {
+        importedTests = processTracesPath(tracesPath, playwrightProject, converter);
+    }
+    converter.printMissingApis(loggingProvider_1.logger);
+    return importedTests;
+}
+async function handlePostImportActions(workspaceId, apiClient, importedTests, autoSave) {
+    let nextAction;
+    do {
+        nextAction = await getNextAction(autoSave);
+        loggingProvider_1.logger.logNewLine();
+        switch (nextAction) {
+            case PostImportActions.Save:
+                return saveTests(workspaceId, apiClient, importedTests).then(() => {
+                    loggingProvider_1.logger.info('Import complete.');
+                });
+            case PostImportActions.View:
+                displayTestDescriptions(importedTests);
+                break;
+            case PostImportActions.Run:
+                await runTests(workspaceId, apiClient, importedTests);
+                break;
+            case PostImportActions.Discard:
+                loggingProvider_1.logger.info('Exiting without saving.');
+                return;
+        }
+        loggingProvider_1.logger.logNewLine();
+    } while ([PostImportActions.View, PostImportActions.Run].includes(nextAction));
+}
+async function getNextAction(autoSave) {
+    if (autoSave) {
+        return PostImportActions.Save;
+    }
+    const answer = await inquirer.prompt([
+        {
+            type: 'list',
+            name: 'action',
+            hint: false,
+            message: 'What do you want to do next?',
+            choices: Object.values(PostImportActions),
+        },
+    ]);
+    return answer.action;
+}
+function saveTests(workspaceId, apiClient, importedTests) {
+    loggingProvider_1.logger.info(`Saving ${(0, pluralize_1.default)('test', importedTests.length, true)}...`);
+    const savePromises = importedTests.map((test) => apiClient
+        .createFlow(stepsToFlow(workspaceId, test.steps))
+        .then((flow) => apiClient.createJourney(flowToJourney(test.testName, flow)))
+        .then((journey) => {
+        loggingProvider_1.logger.info(`Saved test ${journey.invariant_id} : ${env_1.BASE_APP_URL}/workspaces/${journey.organization_id}/train/tests/${journey.invariant_id}/current`);
+        return journey;
+    }));
+    return Promise.all(savePromises);
+}
+function displayTestDescriptions(importedTests) {
+    importedTests.forEach((test, index) => {
+        if (importedTests.length > 1) {
+            loggingProvider_1.logger.info(`Test ${index + 1} of ${importedTests.length}: '${test.testName}'`);
+        }
+        loggingProvider_1.logger.info(test.steps.map((step) => step.description).join('\n'));
+        loggingProvider_1.logger.logNewLine();
+    });
+}
+async function runTests(workspaceId, apiClient, importedTests) {
+    var _a, _b, _c;
+    const tests = importedTests.map((test) => ({
+        test,
+        flow: stepsToFlow(workspaceId, test.steps),
+    }));
+    const firstUrl = (_b = (_a = tests.find((test) => test.flow.url)) === null || _a === void 0 ? void 0 : _a.flow) === null || _b === void 0 ? void 0 : _b.url;
+    const browserPath = await new chromiumBrowserEngine_1.ChromiumBrowserEngine().findBrowserExecutable();
+    for (let testIndex = 0; testIndex < tests.length; testIndex++) {
+        const testToRun = tests[testIndex];
+        loggingProvider_1.logger.info(`Running test '${testToRun.test.testName}' ${testIndex + 1} of ${tests.length}.`);
+        const journey = {
+            organization_id: workspaceId,
+            name: testToRun.test.testName,
+            flows: [],
+            url: (_c = testToRun.flow.url) !== null && _c !== void 0 ? _c : firstUrl,
+        };
+        const testRunner = await createTestRunner(apiClient, journey, testToRun.flow, journey.url, workspaceId, browserPath);
+        const results = await testRunner.run();
+        loggingProvider_1.logger.info(`Test result: ${results.status}`);
+    }
+}
+function stepsToFlow(workspaceId, steps) {
+    const prototype = {
+        import_source_id: mablApi_1.Flow.ImportSourceIdEnum.SeleniumNodeProxy,
+        import_source_version: (0, pureUtil_1.getCliVersion)(),
+        flow_type: mablApi_1.Flow.FlowTypeEnum.Mablscript,
+        organization_id: workspaceId,
+        reusable: false,
+        selectors: steps
+            .map((step) => step.selector)
+            .map((selector) => selector === null || selector === void 0 ? void 0 : selector.toMablscriptSelector())
+            .filter((selector) => selector)
+            .map((selector) => selector),
+        script: steps.map((step) => step.mablscript).join('\n'),
+        script_description: steps.map((step) => step.description).join('\n'),
+        url: steps.map((step) => step.url).find((url) => url),
+    };
+    return prototype;
+}
+function flowToJourney(name, flow) {
+    const prototype = {
+        organization_id: flow.organization_id,
+        name,
+        flows: [flow.id],
+        url: flow.url,
+    };
+    return prototype;
+}
+async function createTestRunner(apiClient, test, flow, url, workspaceId, browserPath) {
+    const runner = new execution_1.BrowserTestRunner({
+        testRunConfig: {
+            _cliCreated: true,
+            imported: true,
+            filterHttpRequests: false,
+            url,
+            workspaceId,
+        },
+        mablApiClient: apiClient,
+    });
+    await runner.initializeTestRunner(test, [flow], 'master', apiClient, false, browserPath, { url });
+    return runner;
+}
+function processSingleTraceFile(traceFile, playwrightProject, converter) {
+    const importedTests = [];
+    if (!fs_1.default.existsSync(traceFile)) {
+        throw new Error(`Trace file not found: ${traceFile}`);
+    }
+    const importedTest = processTestResult(traceFile, playwrightProject, converter);
+    if (importedTest) {
+        importedTests.push(importedTest);
+    }
+    return importedTests;
+}
+exports.processSingleTraceFile = processSingleTraceFile;
+function processTracesPath(tracesPath, playwrightProject, converter) {
+    const importedTests = [];
+    const testResults = fs_1.default.readdirSync(tracesPath);
+    console.log(`Found ${testResults.length} test results`);
+    for (const testResult of testResults) {
+        const testResultPath = path_1.default.join(tracesPath, testResult);
+        const tracePath = path_1.default.join(testResultPath, 'trace.zip');
+        const importedTest = processTestResult(tracePath, playwrightProject, converter);
+        if (importedTest) {
+            importedTests.push(importedTest);
+        }
+    }
+    return importedTests;
+}
+exports.processTracesPath = processTracesPath;
+function processTestResult(traceZip, playwrightProject, converter) {
+    const testResultPath = path_1.default.dirname(traceZip);
+    if (!fs_1.default.existsSync(traceZip)) {
+        return;
+    }
+    const zip = new adm_zip_1.default(traceZip);
+    const zipEntries = zip.getEntries();
+    const lines = [];
+    const traceInfoFiles = zipEntries.filter((entry) => entry.entryName.endsWith('-trace.trace'));
+    traceInfoFiles.sort((a, b) => {
+        const aNum = parseInt(a.entryName.split('-')[0]);
+        const bNum = parseInt(b.entryName.split('-')[0]);
+        return aNum - bNum;
+    });
+    for (const entry of traceInfoFiles) {
+        const entryContent = entry.getData().toString('utf8');
+        fs_1.default.writeFileSync(path_1.default.join(testResultPath, entry.entryName), entryContent);
+        lines.push(...entryContent.split('\n'));
+    }
+    const traceLines = lines
+        .filter((line) => line.trim() !== '')
+        .map((line) => {
+        try {
+            return JSON.parse(line);
+        }
+        catch (e) {
+            return;
+        }
+    })
+        .filter((line) => line !== undefined);
+    const testName = getTestNameFromTraceInfo(traceLines);
+    const steps = converter.getStepsFromTraceInfo(traceLines, playwrightProject.baseUrl);
+    return { testName, steps };
+}
+function getTestNameFromTraceInfo(traceLines) {
+    var _a;
+    const contextOptionsLine = traceLines.find((trace) => trace.type === 'context-options');
+    return (_a = contextOptionsLine === null || contextOptionsLine === void 0 ? void 0 : contextOptionsLine.title) !== null && _a !== void 0 ? _a : '';
+}
+async function getProjectInfo(args) {
+    var _a, _b, _c;
+    const consoleLines = [];
+    const commandArgs = [
+        'playwright',
+        'test',
+        '--project',
+        args[constants_1.CommandArgProject],
+        '--grep',
+        'mablImportInfo',
+    ];
+    const testFile = path_1.default.join((_a = args[constants_1.CommandArgPath]) !== null && _a !== void 0 ? _a : process.cwd(), (_b = args[constants_1.CommandArgTestPath]) !== null && _b !== void 0 ? _b : 'tests', 'mablImportInfo.spec.ts');
+    fs_1.default.writeFileSync(testFile, projectInfoTestFile);
+    const options = {
+        cwd: (_c = args[constants_1.CommandArgPath]) !== null && _c !== void 0 ? _c : process.cwd(),
+        env: {
+            ...process.env,
+        },
+    };
+    const processClosedPromise = new RichPromise_1.default();
+    const playwrightProcess = spawn('npx', commandArgs, options);
+    playwrightProcess.stdout.on('data', (data) => {
+        consoleLines.push(data.toString());
+        if (data.toString().includes('@mabl project info') &&
+            processClosedPromise.isPending()) {
+            try {
+                const info = JSON.parse(data.toString().split('@mabl project info')[1]);
+                processClosedPromise.resolve(info);
+            }
+            catch {
+            }
+        }
+    });
+    playwrightProcess.on('close', (code) => {
+        if (code !== 0) {
+            processClosedPromise.reject(new Error(`Playwright process exited with code ${code}`));
+            console.log(consoleLines.join('\n'));
+        }
+        else {
+            processClosedPromise.resolve();
+        }
+    });
+    const projectInfo = await processClosedPromise;
+    fs_1.default.unlinkSync(testFile);
+    return projectInfo !== null && projectInfo !== void 0 ? projectInfo : { baseUrl: '' };
+}
+async function runPlaywrightProject(args, tracesPath, cwd) {
+    const processClosedPromise = new RichPromise_1.default();
+    const commandArgs = ['playwright', 'test', '--trace', 'on'];
+    if (args[constants_1.CommandArgProject]) {
+        commandArgs.push('--project', args[constants_1.CommandArgProject]);
+    }
+    if (args.grep) {
+        commandArgs.push('--grep', args.grep);
+    }
+    if (args[constants_1.CommandArgExtraArguments]) {
+        commandArgs.push(args[constants_1.CommandArgExtraArguments]);
+    }
+    const options = {
+        cwd,
+        env: {
+            ...process.env,
+        },
+    };
+    loggingProvider_1.logger.info('Checking playwright project...');
+    const playwrightProjectFile = path_1.default.join(options.cwd, 'playwright.config.ts');
+    if (!fs_1.default.existsSync(playwrightProjectFile)) {
+        throw new Error('No playwright project found. Please ensure you are in the root directory of a playwright project.');
+    }
+    loggingProvider_1.logger.info('Deleting existing traces...');
+    if (fs_1.default.existsSync(tracesPath)) {
+        fs_1.default.rmSync(tracesPath, { recursive: true });
+    }
+    loggingProvider_1.logger.info('Importing tests from Playwright...');
+    loggingProvider_1.logger.info('This may take a few minutes.');
+    const playwrightProcess = spawn('npx', commandArgs, options);
+    playwrightProcess.stdout.on('data', (data) => {
+        loggingProvider_1.logger.info(data.toString());
+    });
+    playwrightProcess.on('close', (code) => {
+        if (code !== 0) {
+            processClosedPromise.reject(new Error(`Playwright process exited with code ${code}`));
+        }
+        else {
+            processClosedPromise.resolve();
+        }
+    });
+    await processClosedPromise;
+    loggingProvider_1.logger.info('Test import complete. Processing output');
+}