@mablhq/playwright-tools 2.49.1

package/commands/mobile-build-files/mobile-build-files_cmds/upload.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const promises_1 = require("node:fs/promises");
+const path_1 = require("path");
+const chalk_1 = __importDefault(require("chalk"));
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+const mablApi_1 = require("../../../mablApi");
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const util_1 = require("../../commandUtil/util");
+const constants_1 = require("../../constants");
+const upload_1 = require("../../../upload");
+const env_1 = require("../../../env/env");
+const authenticationProvider_1 = require("../../../providers/authenticationProvider");
+const types_1 = require("../../../api/types");
+exports.command = [
+    `upload <${constants_1.CommandArgMobileBuildFilePath}>`,
+    `create <${constants_1.CommandArgMobileBuildFilePath}>`,
+];
+exports.describe = 'Upload a new mobile build file';
+exports.builder = (yargs) => {
+    yargs
+        .positional(constants_1.CommandArgMobileBuildFilePath, {
+        describe: 'Relative path to mobile build file file',
+    })
+        .option(constants_1.CommandArgBranch, {
+        describe: 'Branch from which this mobile build file was built',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgLabels, {
+        describe: 'Space delimited labels to save the file with',
+        type: 'array',
+    })
+        .option(constants_1.CommandArgMobilePlatform, {
+        describe: 'The mobile platform',
+        defaultDescription: 'inferred from app binary extension',
+        type: 'string',
+        choices: [
+            mablApi_1.MobilePlatformEnum.Android.toString().toLowerCase(),
+            mablApi_1.MobilePlatformEnum.Ios.toString().toLowerCase(),
+        ],
+    })
+        .version(false)
+        .option(constants_1.CommandArgVersion, {
+        describe: 'Version of this mobile build file',
+        type: 'string',
+    })
+        .option(constants_1.CommandArgWorkspaceId, {
+        alias: constants_1.CommandArgAliases.WorkspaceId,
+        describe: `Workspace to create mobile build file in`,
+        type: 'string',
+    });
+};
+exports.handler = (0, util_1.failWrapper)(createMobileAppFile);
+async function createMobileAppFile(parsed) {
+    const { branch, labels, platform, version } = parsed;
+    const file = parsed[constants_1.CommandArgMobileBuildFilePath];
+    const workspaceId = await (0, util_1.getWorkspaceId)(parsed);
+    const mobileAppFilePrototype = {
+        branch,
+        labels,
+        platform,
+        version,
+        workspace_id: workspaceId,
+    };
+    const { httpClient } = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const uploadClient = new upload_1.UploadClient({
+        authorizationProvider: createAuthorizationProvider(),
+        httpClient,
+        uploadServiceUrl: new URL(env_1.BASE_API_URL),
+    });
+    loggingProvider_1.logger.info(`Beginning upload of mobile app file ${(0, path_1.basename)((0, path_1.resolve)(file))} to ${workspaceId}`);
+    const mobileAppFile = await uploadClient.uploadMobileAppFile(file, mobileAppFilePrototype, await createUploadProgressListener(file));
+    loggingProvider_1.logger.info(chalk_1.default.green(`Created mobile app file ${chalk_1.default.bold(mobileAppFile.id)}`));
+}
+function createAuthorizationProvider() {
+    const authProvider = new authenticationProvider_1.AuthenticationProvider();
+    return async () => {
+        const { accessToken, authType } = await authProvider.getAuthConfigWithAutoRenew();
+        switch (authType) {
+            case types_1.AuthType.ApiKey:
+                return { key: `${accessToken}`, type: 'key' };
+            case types_1.AuthType.Bearer:
+                return { bearer: `${accessToken}`, type: 'bearer' };
+            default:
+                throw new Error(`Invalid auth type: [${authType}]`);
+        }
+    };
+}
+async function createUploadProgressListener(filePath) {
+    const fileName = (0, path_1.basename)((0, path_1.resolve)(filePath));
+    const { size } = await (0, promises_1.stat)(filePath);
+    let totalBytesSent = 0;
+    return ({ chunkSizeBytes }) => {
+        totalBytesSent += chunkSizeBytes;
+        const completedPercentage = Math.round((totalBytesSent / size) * 100.0);
+        loggingProvider_1.logger.info(`Uploaded ${totalBytesSent}b of ${size}b (${completedPercentage}%) of mobile app file ${fileName}`);
+    };
+}

package/commands/plans/plans.js

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

package/commands/plans/plans_cmds/describe.js

@@ -0,0 +1,23 @@
+"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)('plan');
+exports.builder = (0, describe_1.getDescribeBuilderOptions)();
+exports.handler = (0, util_1.failWrapper)(getPlan);
+async function getPlan(parsed) {
+    var _a;
+    try {
+        const planId = parsed.id;
+        const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+        const plan = await apiClient.getPlan(planId);
+        delete plan.journeys_ddt_migration_backup;
+        (0, describe_1.outputEntity)(plan, parsed.output);
+        return (_a = plan.id) !== null && _a !== void 0 ? _a : '';
+    }
+    catch (error) {
+        throw new Error(`Error getting plan: ${error}`);
+    }
+}

package/commands/plans/plans_cmds/list.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../../constants");
+const util_1 = require("../../commandUtil/util");
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const cli_table3_1 = __importDefault(require("cli-table3"));
+const moment = require("moment");
+const loggingProvider_1 = require("../../../providers/logging/loggingProvider");
+exports.command = 'list';
+exports.describe = 'List plans';
+exports.builder = (yargs) => {
+    yargs
+        .option(constants_1.CommandArgWorkspaceId, {
+        alias: constants_1.CommandArgAliases.WorkspaceId,
+        describe: 'Workspace to list plans for',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgLimitOutput, {
+        alias: constants_1.CommandArgAliases.LimitOutput,
+        describe: 'The number of plans to return',
+        default: 10,
+        nargs: 1,
+        type: 'string',
+    });
+};
+exports.handler = (0, util_1.failWrapper)(listPlans);
+async function listPlans(parsed) {
+    const limit = parsed.limit;
+    const workspaceId = await (0, util_1.getWorkspaceId)(parsed);
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    const plans = await apiClient.getPlans({
+        organization_id: workspaceId,
+        limit,
+    });
+    printPlans(plans);
+    loggingProvider_1.logger.info(`${plans.length} plans returned`);
+    if (plans.length === limit) {
+        loggingProvider_1.logger.info(`... use the --limit flag to return a larger set`);
+    }
+    return plans.length;
+}
+function printPlans(plans) {
+    const table = new cli_table3_1.default({
+        head: ['ID', 'Name', 'Created time'],
+        wordWrap: true,
+    });
+    plans.forEach((plan) => {
+        table.push([
+            { rowSpan: 1, content: plan.id, vAlign: 'center' },
+            { rowSpan: 1, content: plan.name, vAlign: 'center' },
+            {
+                rowSpan: 1,
+                content: moment.utc(plan.created_time).format(constants_1.ListTimeFormat),
+                vAlign: 'center',
+            },
+        ]);
+    });
+    loggingProvider_1.logger.info(table.toString());
+}

package/commands/test-runs/test-runs.js

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

package/commands/test-runs/test-runs_cmds/export.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../../constants");
+const mablApiClientFactory_1 = require("../../../api/mablApiClientFactory");
+const exportRequestProvider_1 = require("../../../providers/exportRequestProvider");
+const util_1 = require("../../commandUtil/util");
+const mablApi_1 = require("../../../mablApi");
+const typesAllFlag = 'all';
+exports.command = `export <id> [options]`;
+exports.describe = 'Export test run images';
+exports.builder = (yargs) => {
+    yargs
+        .positional(constants_1.CommandArgId, {
+        describe: 'test run id',
+        type: 'string',
+        nargs: 1,
+    })
+        .option(constants_1.CommandArgOutputFilePath, {
+        describe: 'export to specific file, default: local path/export name',
+        nargs: 1,
+        type: 'string',
+    })
+        .option(constants_1.CommandArgContentTypes, {
+        describe: 'types to export, defaults to screenshots only',
+        required: false,
+        type: 'array',
+        default: [mablApi_1.ExportRequest.TargetContentEnum.Screenshots.toString()],
+        choices: [
+            typesAllFlag,
+            mablApi_1.ExportRequest.TargetContentEnum.Screenshots,
+            mablApi_1.ExportRequest.TargetContentEnum.ConsoleLogs,
+            mablApi_1.ExportRequest.TargetContentEnum.Doms,
+            mablApi_1.ExportRequest.TargetContentEnum.Hars,
+            mablApi_1.ExportRequest.TargetContentEnum.Traces,
+            mablApi_1.ExportRequest.TargetContentEnum.XrayJson,
+        ],
+        coerce: (arg) => arg.includes(typesAllFlag)
+            ? [
+                mablApi_1.ExportRequest.TargetContentEnum.ConsoleLogs,
+                mablApi_1.ExportRequest.TargetContentEnum.Screenshots,
+                mablApi_1.ExportRequest.TargetContentEnum.Doms,
+                mablApi_1.ExportRequest.TargetContentEnum.Traces,
+                mablApi_1.ExportRequest.TargetContentEnum.Hars,
+            ]
+            : arg,
+    })
+        .example('$0 test-runs export <id>', 'export test run screenshots to file')
+        .example('$0 test-runs export <id> --types screenshots doms', 'export test run screenshots and doms to file')
+        .example('$0 test-runs export <id> --types all', 'export test run all types to file')
+        .check((argv) => {
+        (0, util_1.validateArrayInputs)(argv[constants_1.CommandArgContentTypes], 'export types must be SPACE delimited, e.g. "--types=screenshots doms"');
+        return true;
+    });
+};
+exports.handler = (0, util_1.failWrapper)(createExport);
+async function createExport(parsed) {
+    const targetEntityId = parsed.id;
+    const targetEntityType = 'test run';
+    const outputFilePath = parsed.file;
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClientFromOptionalApiKey(parsed['api-key']);
+    return new exportRequestProvider_1.ExportRequestProvider(apiClient, targetEntityId, targetEntityType, parsed.types, outputFilePath).processExport();
+}

package/commands/tests/mobileEmulationUtil.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeviceDescriptorForEmulation = exports.getProperScreenConfig = void 0;
+const mablApi_1 = require("../../mablApi");
+function getProperScreenConfig(emulationConfig) {
+    var _a, _b, _c, _d;
+    switch (emulationConfig.orientation) {
+        case mablApi_1.DeviceEmulation.OrientationEnum.LandscapePrimary:
+        case mablApi_1.DeviceEmulation.OrientationEnum.LandscapeSecondary:
+            return (_b = (_a = emulationConfig.device_config) === null || _a === void 0 ? void 0 : _a.screen) === null || _b === void 0 ? void 0 : _b.horizontal;
+        case mablApi_1.DeviceEmulation.OrientationEnum.PortraitPrimary:
+        case mablApi_1.DeviceEmulation.OrientationEnum.PortraitSecondary:
+            return (_d = (_c = emulationConfig.device_config) === null || _c === void 0 ? void 0 : _c.screen) === null || _d === void 0 ? void 0 : _d.vertical;
+        default:
+            throw new Error(`Unhandled mobile orientation type [${emulationConfig.orientation}]`);
+    }
+}
+exports.getProperScreenConfig = getProperScreenConfig;
+function getDeviceDescriptorForEmulation(emulationConfig) {
+    var _a, _b, _c, _d, _e;
+    if (emulationConfig) {
+        const screenConfig = getProperScreenConfig(emulationConfig);
+        if (!(screenConfig === null || screenConfig === void 0 ? void 0 : screenConfig.height) && !(screenConfig === null || screenConfig === void 0 ? void 0 : screenConfig.width)) {
+            throw new Error('Could not get viewport settings - invalid emulation config supplied with missing height or width');
+        }
+        return {
+            width: screenConfig.width,
+            height: screenConfig.height,
+            deviceScaleFactor: (_c = (_b = (_a = emulationConfig.device_config) === null || _a === void 0 ? void 0 : _a.screen) === null || _b === void 0 ? void 0 : _b.device_pixel_ratio) !== null && _c !== void 0 ? _c : 1,
+            isMobile: isMobile(emulationConfig),
+            hasTouch: (_e = (_d = emulationConfig.device_config) === null || _d === void 0 ? void 0 : _d.capabilities) === null || _e === void 0 ? void 0 : _e.includes(mablApi_1.DeviceEmulationConfiguration.CapabilitiesEnum.Touch),
+            isLandscape: emulationConfig.orientation ===
+                mablApi_1.DeviceEmulation.OrientationEnum.LandscapePrimary ||
+                emulationConfig.orientation ===
+                    mablApi_1.DeviceEmulation.OrientationEnum.LandscapeSecondary,
+        };
+    }
+    return;
+}
+exports.getDeviceDescriptorForEmulation = getDeviceDescriptorForEmulation;
+function isMobile(emulationConfig) {
+    return (emulationConfig.device_config.type ===
+        mablApi_1.DeviceEmulationConfiguration.TypeEnum.Phone ||
+        emulationConfig.device_config.type ===
+            mablApi_1.DeviceEmulationConfiguration.TypeEnum.Tablet);
+}

package/commands/tests/tests.js

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