@mablhq/mabl-cli 2.2.2 → 2.4.0

package/commands/tests/tests_cmds/run.js

@@ -32,7 +32,8 @@ exports.builder = (yargs) => {
         type: 'string',
     })
         .option(constants_1.CommandArgFromPlanId, {
-        describe: 'The plan id to get a list of tests from. The environment id and the credentials id will be used as well unless supplied',
+        describe: `The plan id to get a list of tests from.
+Note: running tests with the --from-plan-id option is not a plan run. Advanced plan configurations, such as stages, browser settings or shared variables, are not applied.`,
         type: 'string',
     })
         .option(constants_1.CommandArgMablBranch, {
@@ -64,7 +65,8 @@ exports.builder = (yargs) => {
     })
         .option(constants_1.CommandArgEnvironmentId, {
         alias: constants_1.CommandArgAliases.EnvironmentId,
-        describe: 'Mabl environment to run under. Specify to ensure the test runs with environment variables and the latest find information.',
+        describe: `Mabl environment to run under. Specify to ensure the test runs with environment variables and the latest find information.
+Note: Setting the environment does not override the default URL. Please use the (—url) command to override the URL.`,
         nargs: 1,
         type: 'string',
     })

package/core/execution/ApiTestUtils.js

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isJson = exports.isFolder = exports.validateCollectionFeatures = exports.generateRawScriptField = exports.processPostmanItems = exports.createEmptyRequest = exports.createEmptyRequestEventArray = exports.splitLines = exports.PRE_REQUEST_LISTEN = exports.insertMablAssertionScripts = exports.toPostmanScript = exports.replaceVariables = exports.getActualValue = exports.readBody = exports.getResponseContentType = exports.valueToUnquotedString = exports.humanizeAssertion = exports.getAssertionTargetArgument = exports.assertionHasTest = exports.isValidMablAssertion = exports.normalizeExpectedValue = 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_ASSERTION_TOKEN = exports.TEST_LISTEN = void 0;
-exports.processPostmanItem = exports.replaceRawScriptWithExecArray = exports.removeInvalidHeaders = exports.processItemAuth = exports.mablAuthToPostman = exports.formatContent = exports.getRequestMode = exports.getFormDataArray = exports.isText = exports.isXML = void 0;
+exports.isItemGroupDefinition = exports.isFolder = exports.validateCollectionFeaturesForApiTestEditor = exports.generateRawScriptField = exports.processPostmanItems = exports.createEmptyRequest = exports.createEmptyRequestEventArray = exports.splitLines = exports.PRE_REQUEST_LISTEN = exports.insertMablAssertionScripts = exports.toPostmanScript = exports.replaceVariables = exports.getActualValue = exports.readBody = exports.getResponseContentType = exports.valueToUnquotedString = exports.humanizeAssertion = exports.getAssertionTargetArgument = exports.assertionHasTest = exports.isValidMablAssertion = exports.normalizeExpectedValue = 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_ASSERTION_TOKEN = exports.TEST_LISTEN = void 0;
+exports.processPostmanItem = exports.replaceRawScriptWithExecArray = exports.removeInvalidHeaders = exports.processItemAuth = exports.mablAuthToPostman = exports.formatContent = exports.getRequestMode = exports.getFormDataArray = exports.isText = exports.isXML = exports.isJson = exports.isSupportedAuthType = exports.isItemDefinition = exports.isCollectionDefinition = void 0;
 const newman_types_1 = require("./newman-types");
 const lodash_1 = __importDefault(require("lodash"));
 const uuid_1 = require("uuid");
@@ -601,15 +601,12 @@ const createEmptyRequest = (id = (0, uuid_1.v4)()) => ({
 exports.createEmptyRequest = createEmptyRequest;
 function processPostmanItems(items, handleItem, handleFolder) {
     lodash_1.default.forEach(items, (item) => {
-        const maybeItemGroup = item;
-        if (isFolder(maybeItemGroup)) {
-            if (handleFolder) {
-                handleFolder(maybeItemGroup);
-            }
-            processPostmanItems(maybeItemGroup.item, handleItem);
+        if (isItemGroupDefinition(item)) {
+            handleFolder === null || handleFolder === void 0 ? void 0 : handleFolder(item);
+            processPostmanItems(item.item, handleItem, handleFolder);
         }
         else {
-            handleItem(item);
+            handleItem === null || handleItem === void 0 ? void 0 : handleItem(item);
         }
     });
 }
@@ -620,7 +617,7 @@ function generateRawScriptField(eventValue) {
     }
 }
 exports.generateRawScriptField = generateRawScriptField;
-function validateCollectionFeatures(collection) {
+function validateCollectionFeaturesForApiTestEditor(collection) {
     let hasFolders = false;
     const handleFolder = (_item) => {
         hasFolders = true;
@@ -631,11 +628,30 @@ function validateCollectionFeatures(collection) {
     }
     return undefined;
 }
-exports.validateCollectionFeatures = validateCollectionFeatures;
+exports.validateCollectionFeaturesForApiTestEditor = validateCollectionFeaturesForApiTestEditor;
 function isFolder(item) {
     return 'item' in item && !!item.item;
 }
 exports.isFolder = isFolder;
+function isItemGroupDefinition(item) {
+    return isFolder(item) && !isCollectionDefinition(item);
+}
+exports.isItemGroupDefinition = isItemGroupDefinition;
+function isCollectionDefinition(item) {
+    return isFolder(item) && 'info' in item;
+}
+exports.isCollectionDefinition = isCollectionDefinition;
+function isItemDefinition(item) {
+    return !isFolder(item);
+}
+exports.isItemDefinition = isItemDefinition;
+function isSupportedAuthType(authDefinition) {
+    if (!authDefinition.type) {
+        return false;
+    }
+    return (newman_types_1.MablSupportedPostmanAuthTypes.includes(authDefinition.type) || authDefinition.type === 'noauth');
+}
+exports.isSupportedAuthType = isSupportedAuthType;
 function isJson(contentType) {
     return (!!contentType &&
         (contentType.startsWith('application/json') ||

package/core/execution/newman-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BodyMode = exports.AssertionType = exports.AssertionTarget = void 0;
+exports.BodyMode = exports.MablSupportedPostmanAuthTypes = exports.AssertionType = exports.AssertionTarget = void 0;
 var AssertionTarget;
 (function (AssertionTarget) {
     AssertionTarget["Header"] = "Header";
@@ -17,6 +17,12 @@ var AssertionType;
     AssertionType["NotPresent"] = "NotPresent";
     AssertionType["Present"] = "Present";
 })(AssertionType = exports.AssertionType || (exports.AssertionType = {}));
+exports.MablSupportedPostmanAuthTypes = [
+    'apikey',
+    'basic',
+    'bearer',
+    'oauth1',
+];
 var BodyMode;
 (function (BodyMode) {
     BodyMode["file"] = "file";