Ignore unresolved postman collection/environment variables using an option

Author: VShingala

lib/options.js

@@ -163,6 +163,15 @@ module.exports = {
         description: 'Whether to show mismatches for incorrect name and description of request',
         external: true,
         usage: ['VALIDATION']
+      },
+      {
+        name: 'Ignore mismatch for unresolved postman variables',
+        id: 'ignoreUnresolvedVariables',
+        type: 'boolean',
+        default: false,
+        description: 'Whether to ignore mismatch thrown upon validation of unresolved collection/environment variable',
+        external: true,
+        usage: ['VALIDATION']
       }
     ];
 

lib/schemaUtils.js

@@ -2236,6 +2236,9 @@ module.exports = {
       invalidJson = false,
       ajv, validate,
       valueToUse = value,
+      isPmVariable = (value) => {
+        return _.isString(value) && _.startsWith(value, '{{') && _.endsWith(value, '}}');
+      },
 
       // This is dereferenced schema (converted to JSON schema for validation)
       schema = deref.resolveRefs(openApiSchemaObj, parameterSourceOption, components,
@@ -2257,7 +2260,14 @@ module.exports = {
     // When processing a reference, schema.type could also be undefined
     if (schema && schema.type) {
       if (typeof schemaTypeToJsValidator[schema.type] === 'function') {
-        if (!schemaTypeToJsValidator[schema.type](valueToUse)) {
+        let isCorrectType = schemaTypeToJsValidator[schema.type](valueToUse);
+
+        // Treat unresolved postman collection/environment variable as correct type
+        if (options.ignoreUnresolvedVariables && !isCorrectType && isPmVariable(valueToUse)) {
+          isCorrectType = !isCorrectType;
+        }
+
+        if (!isCorrectType) {
           // if type didn't match, no point checking for AJV
           let reason = '',
             mismatchObj;
@@ -2337,16 +2347,26 @@ module.exports = {
             // input was invalid. Don't throw mismatch
           }
 
-          // As OAS only supports some of Json Schema keywords, and Ajv is supporting all keywords from Draft 7
-          // Remove keyword currently not supported in OAS to make both compatible with each other
+          // Filter validation errors for following cases
           filteredValidationError = _.filter(validate.errors, (validationError) => {
             // for invalid `propertyNames` two error are thrown by Ajv, which include error with `pattern` keyword
             if (validationError.keyword === 'pattern') {
               return !_.has(validationError, 'propertyName');
             }
 
-            // Following are non-supported keywords in OpenAPI spec but supported in Json schema (Ajv)
-            return !_.includes(['propertyNames', 'const', 'additionalItems', 'dependencies'], validationError.keyword);
+            // As OAS only supports some of Json Schema keywords, and Ajv is supporting all keywords from Draft 7
+            // Remove keyword currently not supported in OAS to make both compatible with each other
+            else if (_.includes(['propertyNames', 'const', 'additionalItems', 'dependencies'],
+              validationError.keyword)) {
+              return false;
+            }
+
+            // Ignore unresolved variables from mismatch if option is set
+            else if (options.ignoreUnresolvedVariables &&
+              isPmVariable(_.get(valueToUse, validationError.dataPath.slice(1)))) {
+              return false;
+            }
+            return true;
           });
 
           // sort errors based on dataPath, as this will ensure no overriding later

test/system/structure.test.js

@@ -13,7 +13,8 @@ const optionIds = [
     'showMissingInSchemaErrors',
     'detailedBlobValidation',
     'suggestAvailableFixes',
-    'validateMetadata'
+    'validateMetadata',
+    'ignoreUnresolvedVariables'
   ],
   expectedOptions = {
     collapseFolders: {
@@ -106,6 +107,12 @@ const optionIds = [
       type: 'boolean',
       default: false,
       description: 'Whether to show mismatches for incorrect name and description of request'
+    },
+    ignoreUnresolvedVariables: {
+      name: 'Ignore mismatch for postman variables',
+      type: 'boolean',
+      default: false,
+      description: 'Whether to ignore mismatch thrown upon validation of collection/environment variable'
     }
   };