@mablhq/mabl-cli 2.55.0 → 2.57.0

package/commands/constants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CommandArgMablBranchChangesOnly = exports.CommandArgMablBranch = exports.CommandArgMablAutoLogin = exports.CommandArgMablAutoBranch = exports.CommandArgLinkBypass = exports.CommandArgLinkLabel = exports.CommandArgLimitOutput = exports.CommandArgLabels = exports.CommandArgLabelsInclude = exports.CommandArgLabelsExclude = exports.CommandArgTestInteractionSpeed = exports.CommandArgTestRunId = exports.CommandArgTestFile = exports.CommandArgKeepBrowserOpen = exports.CommandArgInput = exports.CommandArgIncludedTests = exports.CommandArgIncludeDefaults = exports.CommandArgId = exports.CommandArgUserAgent = exports.CommandArgHttpHeaders = exports.CommandArgHelp = exports.CommandArgHeadless = exports.CommandArgFromPlanId = exports.CommandArgFrom = exports.CommandArgFormat = exports.CommandArgFindPath = exports.CommandArgFastFailure = exports.CommandArgOverrideEnvironmentId = exports.CommandArgGrep = exports.CommandArgExtraArguments = exports.CommandArgExistingReport = exports.CommandArgExcludedTests = exports.CommandArgEnvironmentId = exports.CommandArgDetailLevel = exports.CommandArgDestination = exports.CommandArgDescription = exports.CommandArgDeploymentId = exports.CommandArgDecrypt = exports.CommandArgDebug = exports.CommandArgDataTables = exports.CommandArgDataTableId = exports.CommandArgCredentials = exports.CommandArgBasicAuthCredentials = exports.CommandArgBrowsers = exports.CommandArgBrowser = exports.CommandArgBranch = exports.CommandArgAuto = exports.CommandArgApplicationId = exports.CommandArgApiKey = exports.CommandArgABConfigFile = void 0;
-exports.DefaultBrowserType = exports.DefaultBranchName = exports.DefaultOutputFormatChoices = exports.DetailLevelFormats = exports.ReporterOptions = exports.OutputFormats = exports.CommandArgAliases = exports.CommandArgBrowserEnableExtensions = exports.CommandArgBrowserIgnoreCertificateErrors = exports.CommandArgBrowserDisableIsolation = exports.ListTimeFormat = exports.CommandArgTimezoneID = exports.CommandArgLocale = exports.CommandArgUseTestExecutionProxy = exports.CommandArgScenarioId = exports.CommandArgReporterOptions = exports.CommandArgReporter = exports.CommandArgWorkspaceId = exports.CommandArgVersion = exports.CommandArgVariables = exports.CommandArgUrlApi = exports.CommandArgUrlApp = exports.CommandArgUrl = exports.CommandArgTo = exports.CommandArgTrainerVersion = exports.CommandArgTraceFile = exports.CommandArgTracesPath = exports.CommandArgTestPath = exports.CommandArgSilent = exports.CommandArgRevision = exports.CommandArgRecordVideoPath = exports.CommandArgMaxHeartbeatAge = exports.CommandArgPlanId = exports.CommandArgContentTypes = exports.CommandArgPreview = exports.CommandArgPath = exports.CommandArgOutputFilePath = exports.CommandArgOutput = exports.CommandArgNoPrompt = exports.CommandArgPrompt = exports.CommandArgProject = exports.CommandArgPortNumber = exports.CommandArgName = exports.CommandArgMobileDeviceName = exports.CommandArgMobilePlatform = exports.CommandArgMobileBuildFileId = exports.CommandArgMobileBuildFilePath = exports.CommandArgiOSdMobileAppFileId = exports.CommandArgAndroidMobileAppFileId = exports.CommandArgMulti = void 0;
+exports.DefaultBrowserType = exports.DefaultBranchName = exports.DefaultOutputFormatChoices = exports.DetailLevelFormats = exports.Reporter = exports.OutputFormats = exports.CommandArgAliases = exports.CommandArgBrowserEnableExtensions = exports.CommandArgBrowserIgnoreCertificateErrors = exports.CommandArgBrowserDisableIsolation = exports.ListTimeFormat = exports.CommandArgTimezoneID = exports.CommandArgLocale = exports.CommandArgUseTestExecutionProxy = exports.CommandArgScenarioId = exports.CommandArgReporterOptions = exports.CommandArgReporter = exports.CommandArgWorkspaceId = exports.CommandArgVersion = exports.CommandArgVariables = exports.CommandArgUrlApi = exports.CommandArgUrlApp = exports.CommandArgUrl = exports.CommandArgTo = exports.CommandArgTrainerVersion = exports.CommandArgTraceFile = exports.CommandArgTracesPath = exports.CommandArgTestPath = exports.CommandArgSilent = exports.CommandArgRevision = exports.CommandArgRecordVideoPath = exports.CommandArgMaxHeartbeatAge = exports.CommandArgPlanId = exports.CommandArgContentTypes = exports.CommandArgPreview = exports.CommandArgPath = exports.CommandArgOutputFilePath = exports.CommandArgOutput = exports.CommandArgNoPrompt = exports.CommandArgPrompt = exports.CommandArgProject = exports.CommandArgPortNumber = exports.CommandArgName = exports.CommandArgMobileDeviceName = exports.CommandArgMobilePlatform = exports.CommandArgMobileBuildFileId = exports.CommandArgMobileBuildFilePath = exports.CommandArgiOSdMobileAppFileId = exports.CommandArgAndroidMobileAppFileId = exports.CommandArgMulti = void 0;
 exports.SCENARIO_ID_HEADER = exports.SCENARIO_NAME_HEADER = exports.ValidBrowserTypesForLocalRuns = exports.BrowserTypeSelections = void 0;
 const browserTypes_1 = require("./browserTypes");
 exports.CommandArgABConfigFile = 'ab-config-file';
@@ -130,10 +130,11 @@ var OutputFormats;
     OutputFormats["Table"] = "table";
     OutputFormats["Yaml"] = "yaml";
 })(OutputFormats || (exports.OutputFormats = OutputFormats = {}));
-var ReporterOptions;
-(function (ReporterOptions) {
-    ReporterOptions["Mochawesome"] = "mochawesome";
-})(ReporterOptions || (exports.ReporterOptions = ReporterOptions = {}));
+var Reporter;
+(function (Reporter) {
+    Reporter["Mabl"] = "mabl";
+    Reporter["Mochawesome"] = "mochawesome";
+})(Reporter || (exports.Reporter = Reporter = {}));
 var DetailLevelFormats;
 (function (DetailLevelFormats) {
     DetailLevelFormats["Full"] = "full";

package/commands/tests/tests_cmds/run-mobile.js

@@ -72,7 +72,7 @@ exports.builder = (yargs) => {
         describe: 'Output test run information for specified reporter',
         hidden: true,
         type: 'string',
-        choices: [constants_1.ReporterOptions.Mochawesome],
+        choices: [constants_1.Reporter.Mochawesome],
     })
         .option(constants_1.CommandArgTestRunId, {
         describe: 'The id of the test run to pull config from',
@@ -183,7 +183,7 @@ async function run(parsed) {
             (0, testsUtil_1.cleanupTestResources)(testContext);
         });
     }
-    await (0, runUtils_1.logTestResults)(results, parsed, commandStartTime, generateRunCommandTemplate(parsed, results));
+    await (0, runUtils_1.logTestResults)(results, parsed, commandStartTime, generateRunCommandTemplate(parsed, results), mablTestsRunner.apiClient);
     if (!results.success && !testRunnerConfig.keepBrowserOpen) {
         process.exit(1);
     }

package/commands/tests/tests_cmds/run.js

@@ -135,10 +135,10 @@ Note: Setting the environment does not override the default URL. Please use the
         type: 'boolean',
     })
         .option(constants_1.CommandArgReporter, {
-        describe: 'Output test run information for specified reporter',
+        describe: 'Output test run information for specified reporter. (mabl reporter requires the mabl_local_reporter feature flag)',
         hidden: true,
         type: 'string',
-        choices: [constants_1.ReporterOptions.Mochawesome],
+        choices: [constants_1.Reporter.Mochawesome, constants_1.Reporter.Mabl],
     })
         .option(constants_1.CommandArgReporterOptions, {
         describe: 'Reporter options as comma separated key/values pairs. e.g. "reportDir=path/to,json=true"',
@@ -284,7 +284,8 @@ async function run(parsed) {
             (0, testsUtil_1.cleanupTestResources)(testContext);
         });
     }
-    await (0, runUtils_1.logTestResults)(results, parsed, commandStartTime, generateRunCommandTemplate(parsed, results));
+    const apiClient = await mablApiClientFactory_1.MablApiClientFactory.createApiClient();
+    await (0, runUtils_1.logTestResults)(results, parsed, commandStartTime, generateRunCommandTemplate(parsed, results), apiClient, workspaceId, browserType);
     if (!testRunnerConfig.keepBrowserOpen) {
         if (!results.success) {
             process.exit(1);

package/commands/tests/tests_cmds/runUtils.js

@@ -9,7 +9,7 @@ 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) {
+async function logTestResults(results, parsed, commandStartTime, rerunCommandTemplate, apiClient, workspaceId, browser) {
     loggingProvider_1.logger.logNewLine();
     loggingProvider_1.logger.info(`Test count: ${results.numTotalTests}`);
     loggingProvider_1.logger.info(`Passed: ${results.numPassedTests}`);
@@ -42,7 +42,7 @@ async function logTestResults(results, parsed, commandStartTime, rerunCommandTem
     }
     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']);
+        await (0, reporter_1.handleReportingForTestsRun)(parsed.reporter, results, apiClient, workspaceId, parsed['reporter-options'], browser);
     }
 }
 exports.logTestResults = logTestResults;

package/core/execution/ApiTestUtils.js

@@ -3,11 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PRE_REQUEST_LISTEN = exports.convertMablAssertionsToExecArray = exports.convertMablVariableAssignmentsToExecArray = exports.createMablGeneratedScripts = exports.insertMablAssertionScripts = exports.toPostmanScript = exports.replaceVariables = exports.getActualValue = exports.readBody = exports.getResponseContentType = exports.valueToUnquotedString = exports.assertionTypeSupportsCaseSensitivity = exports.assertionTargetSupportsCaseSensitivity = exports.humanizeAssertion = exports.getAssertionTargetArgument = exports.assertionHasTest = exports.isValidMablAssertion = exports.normalizeRegExpExpectedValue = exports.normalizeExpectedValue = exports.normalizeAssertionValue = exports.assertionRequiresValue = exports.filterValidMablAssertions = exports.filterValidMablVariableAssignments = exports.isValidMablVariableAssignment = exports.removeMablGeneratedScripts = exports.createEmptyRequestEvent = exports.findFirstMatchingEvent = exports.restoreCustomRequestFields = exports.deduplicateApiTestExecutionResults = exports.createEmptyVariable = exports.createEmptyAssertion = exports.humanizeAssertionType = exports.getAssertionTypesForTarget = exports.caseInsensitiveEquals = exports.compareStringsCaseInsensitive = exports.ASSERT_TYPES = exports.ASSERT_TARGETS = exports.COLLECTION_WITH_FOLDERS_ERROR = exports.HMAC_SHA1_SIGNATURE = exports.DEFAULT_ADD_OAUTH1_TO_HEADER_VALUE = exports.DEFAULT_OAUTH1_VERSION = exports.OAUTH1_AUTH = exports.NO_AUTH = exports.BEARER_TOKEN_AUTH = exports.BASIC_AUTH = exports.API_KEY_AUTH = exports.INHERIT_AUTH_FROM_PARENT_VALUE = exports.MABL_GENERATED_COMMENT = exports.MABL_GENERATED_ASSERTION_TOKEN = exports.TEST_LISTEN = void 0;
-exports.uuid = exports.postmanEventToExecutableSnippets = exports.postmanAuthToApiTestAuth = exports.getValueFromAuthVariables = exports.executableSnippetToApiTestSnippet = exports.executableSnippetsToPostmanEvent = exports.apiTestAuthToPostmanAuth = exports.insertTestConfigurationIntoFlow = exports.createCommentForApiTestSnippet = exports.convertMablSnippetsToExecArray = exports.createPostmanScript = exports.insertMablScriptsIntoCollection = exports.processPostmanItem = exports.replaceRawScriptWithExecArray = exports.removeInvalidHeaders = exports.processItemAuth = exports.mablAuthToPostman = exports.formatContent = exports.getRequestMode = exports.getFormDataArray = exports.isBinary = exports.isText = exports.isXML = exports.isJson = exports.isSupportedAuthType = exports.isItemDefinition = exports.isCollectionDefinition = exports.isItemGroupDefinition = exports.isFolder = exports.validateCollectionFeaturesForApiTestEditor = exports.generateRawScriptField = exports.processPostmanItems = exports.createEmptyRequest = exports.createEmptyRequestEventArray = exports.splitLines = void 0;
+exports.splitLines = exports.PRE_REQUEST_LISTEN = exports.convertMablAssertionsToExecArray = exports.convertMablVariableAssignmentsToExecArray = exports.createMablGeneratedScripts = exports.toPostmanScript = exports.replaceVariables = exports.getActualValue = exports.readBody = exports.getResponseContentType = exports.valueToUnquotedString = exports.assertionTypeSupportsCaseSensitivity = exports.assertionTargetSupportsCaseSensitivity = exports.humanizeAssertion = exports.getAssertionTargetArgument = exports.assertionHasTest = exports.isValidMablAssertion = exports.normalizeRegExpExpectedValue = exports.normalizeExpectedValue = exports.normalizeAssertionValue = exports.assertionRequiresValue = exports.filterValidMablAssertions = exports.filterValidMablVariableAssignments = exports.isValidMablVariableAssignment = exports.removeMablGeneratedScripts = exports.createEmptyRequestEvent = exports.findFirstMatchingEvent = exports.restoreCustomRequestFields = exports.deduplicateApiTestExecutionResults = exports.createEmptyVariable = exports.createEmptyAssertion = exports.humanizeAssertionType = exports.getAssertionTypesForTarget = exports.caseInsensitiveEquals = exports.compareStringsCaseInsensitive = exports.ASSERT_TYPES = exports.ASSERT_TARGETS = exports.COLLECTION_WITH_FOLDERS_ERROR = exports.HMAC_SHA1_SIGNATURE = exports.DEFAULT_ADD_OAUTH1_TO_HEADER_VALUE = exports.DEFAULT_OAUTH1_VERSION = exports.OAUTH1_AUTH = exports.NO_AUTH = exports.BEARER_TOKEN_AUTH = exports.BASIC_AUTH = exports.API_KEY_AUTH = exports.INHERIT_AUTH_FROM_PARENT_VALUE = exports.MABL_GENERATED_COMMENT = exports.MABL_GENERATED_ASSERTION_TOKEN = exports.TEST_LISTEN = void 0;
+exports.getSnippetReferencesInTest = exports.getSnippetReferencesInCollection = exports.uuid = exports.postmanEventToExecutableSnippets = exports.postmanAuthToApiTestAuth = exports.getValueFromAuthVariables = exports.executableSnippetToApiTestSnippet = exports.executableSnippetsToPostmanEvent = exports.apiTestAuthToPostmanAuth = exports.insertTestConfigurationIntoFlow = exports.createCommentForApiTestSnippet = exports.convertMablSnippetsToExecArray = exports.createPostmanScript = exports.insertMablScriptsIntoCollection = exports.processPostmanItem = exports.replaceRawScriptWithExecArray = exports.removeInvalidHeaders = exports.processItemAuth = exports.mablAuthToPostman = exports.formatContent = exports.getRequestMode = exports.getFormDataArray = exports.isBinary = exports.isText = exports.isXML = exports.isJson = exports.isSupportedAuthType = exports.isItemDefinition = exports.isCollectionDefinition = exports.isItemGroupDefinition = exports.isFolder = exports.validateCollectionFeaturesForApiTestEditor = exports.generateRawScriptField = exports.processPostmanItems = exports.createEmptyRequest = exports.createEmptyRequestEventArray = void 0;
 const newman_types_1 = require("./newman-types");
 const lodash_1 = __importDefault(require("lodash"));
 const uuid_1 = require("uuid");
+const mablApi_1 = require("../../mablApi");
 const encodingUtil_1 = require("../../util/encodingUtil");
 const stepValidation_1 = require("../entityValidation/stepValidation");
 exports.TEST_LISTEN = 'test';
@@ -744,20 +745,6 @@ function toPostmanScript(assertion) {
         .map((script) => script);
 }
 exports.toPostmanScript = toPostmanScript;
-function insertMablAssertionScripts(item) {
-    var _a, _b;
-    const { eventValue: existingEventValue } = findFirstMatchingEvent(item.event, exports.TEST_LISTEN);
-    const eventValue = existingEventValue !== null && existingEventValue !== void 0 ? existingEventValue : createEmptyRequestEvent();
-    if (!existingEventValue) {
-        (_a = item.event) === null || _a === void 0 ? void 0 : _a.push(eventValue);
-    }
-    removeMablGeneratedScripts(eventValue);
-    eventValue.mablVariables = filterValidMablVariableAssignments(eventValue.mablVariables);
-    eventValue.mablAssertions = filterValidMablAssertions(eventValue.mablAssertions);
-    const mablScripts = createMablGeneratedScripts(eventValue);
-    (_b = eventValue.script.exec) === null || _b === void 0 ? void 0 : _b.push(...mablScripts);
-}
-exports.insertMablAssertionScripts = insertMablAssertionScripts;
 function createMablGeneratedScripts(event) {
     const mablVariables = convertMablVariableAssignmentsToExecArray(event);
     const mablAssertions = convertMablAssertionsToExecArray(event);
@@ -1104,8 +1091,7 @@ function convertMablSnippetsToExecArray(event, getSnippetFromInvariantId) {
             : apiTestSnippet;
         if (!(snippet === null || snippet === void 0 ? void 0 : snippet.body)) {
             if (apiTestSnippet.reusable) {
-                console.warn(`Unable to find reusable snippet with invariant ID ${apiTestSnippet.invariantId}`);
-                return `// Missing snippet ${apiTestSnippet.invariantId}`;
+                throw new Error(`Unable to find reusable snippet with invariant ID ${apiTestSnippet.invariantId}`);
             }
             return '';
         }
@@ -1348,3 +1334,28 @@ function postmanEventToExecutableSnippets(event) {
 exports.postmanEventToExecutableSnippets = postmanEventToExecutableSnippets;
 const uuid = () => (0, uuid_1.v4)();
 exports.uuid = uuid;
+function getSnippetReferencesInCollection(collection) {
+    var _a, _b;
+    return (((_a = collection.item) !== null && _a !== void 0 ? _a : [])
+        .flatMap((item) => { var _a; return (_a = item.event) !== null && _a !== void 0 ? _a : []; })
+        .concat((_b = collection.event) !== null && _b !== void 0 ? _b : [])
+        .flatMap((event) => { var _a; return (_a = event.mablSnippets) !== null && _a !== void 0 ? _a : []; })
+        .filter((snippet) => snippet.reusable)
+        .map((snippet) => snippet.invariantId)
+        .map((invariantId) => ({
+        id: invariantId,
+        snippetType: mablApi_1.SnippetTypeEnum.Postman,
+    })));
+}
+exports.getSnippetReferencesInCollection = getSnippetReferencesInCollection;
+function getSnippetReferencesInTest(test) {
+    var _a, _b, _c, _d;
+    return ((_b = (_a = test.api_configuration) === null || _a === void 0 ? void 0 : _a.pre_request_snippets) !== null && _b !== void 0 ? _b : [])
+        .concat((_d = (_c = test.api_configuration) === null || _c === void 0 ? void 0 : _c.post_request_snippets) !== null && _d !== void 0 ? _d : [])
+        .filter((snippet) => snippet.reusable)
+        .map(({ invariant_id: invariantId }) => ({
+        id: invariantId,
+        snippetType: mablApi_1.SnippetTypeEnum.Postman,
+    }));
+}
+exports.getSnippetReferencesInTest = getSnippetReferencesInTest;