Merge pull request #733 from postmanlabs/release/v4.14.0

Release version v4.14.0

Author: VShingala

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## [Unreleased]
 
+## [v4.14.0] - 2023-06-07
+
+### Added
+
+-   Added support for consumption of schema level examples while generating data from XML schemas.
+
+### Fixed
+
+-   Fixed the default value of auth in the generated request when it is not resolved.
+-   Fixed issue where collection name was empty in cases where definition title was defined as empty string.
+
 ## [v4.13.0] - 2023-05-24
 
 ### Added
@@ -562,7 +573,9 @@ Newer releases follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0
 
 -   Base release
 
-[Unreleased]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.13.0...HEAD
+[Unreleased]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.14.0...HEAD
+
+[v4.14.0]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.13.0...v4.14.0
 
 [v4.13.0]: https://github.com/postmanlabs/openapi-to-postman/compare/v4.12.0...v4.13.0
 

OPTIONS.md

@@ -21,3 +21,4 @@ allowUrlPathVarMatching|boolean|-|false|Whether to allow matching path variables
 enableOptionalParameters|boolean|-|true|Optional parameters aren't selected in the collection. Once enabled they will be selected in the collection and request as well.|CONVERSION|v2, v1
 keepImplicitHeaders|boolean|-|false|Whether to keep implicit headers from the OpenAPI specification, which are removed by default.|CONVERSION|v2, v1
 includeDeprecated|boolean|-|true|Select whether to include deprecated operations, parameters, and properties in generated collection or not|CONVERSION, VALIDATION|v2, v1
+alwaysInheritAuthentication|boolean|-|false|Whether authentication details should be included on every request, or always inherited from the collection.|CONVERSION|v2, v1

lib/options.js

@@ -374,6 +374,18 @@ module.exports = {
         usage: ['CONVERSION', 'VALIDATION'],
         supportedIn: [VERSION20, VERSION30, VERSION31],
         supportedModuleVersion: [MODULE_VERSION.V2, MODULE_VERSION.V1]
+      },
+      {
+        name: 'Always inherit authentication',
+        id: 'alwaysInheritAuthentication',
+        type: 'boolean',
+        default: false,
+        description: 'Whether authentication details should be included on every request, or always inherited from ' +
+          'the collection.',
+        external: true,
+        usage: ['CONVERSION'],
+        supportedIn: [VERSION20, VERSION30, VERSION31],
+        supportedModuleVersion: [MODULE_VERSION.V2, MODULE_VERSION.V1]
       }
     ];
 

lib/schemaUtils.js

@@ -13,7 +13,6 @@ const { formatDataPath, checkIsCorrectType, isKnownType } = require('./common/sc
   deref = require('./deref.js'),
   _ = require('lodash'),
   xmlFaker = require('./xmlSchemaFaker.js'),
-  js2xml = require('./common/js2xml.js'),
   openApiErr = require('./error.js'),
   ajvValidationError = require('./ajValidation/ajvValidationError'),
   utils = require('./utils.js'),
@@ -242,7 +241,7 @@ function safeSchemaFaker (oldSchema, resolveTo, resolveFor, parameterSourceOptio
 
   try {
     if (schemaFormat === SCHEMA_FORMATS.XML) {
-      fakedSchema = xmlFaker(null, resolvedSchema, indentCharacter);
+      fakedSchema = xmlFaker(null, resolvedSchema, indentCharacter, resolveTo);
       schemaFakerCache[key] = fakedSchema;
       return fakedSchema;
     }
@@ -1607,15 +1606,27 @@ module.exports = {
 
       // Convert example into XML if present as JSON data
       if (contentType === TEXT_XML || contentType === APP_XML || headerFamily === HEADER_TYPE.XML) {
-        bodyData = js2xml(bodyData, indentCharacter);
+        let bodySchemaWithExample = bodyObj.schema;
+
+        // Assign example at schema level to be faked by xmlSchemaFaker
+        if (typeof bodyObj.schema === 'object') {
+          bodySchemaWithExample = Object.assign({}, bodyObj.schema, { example: bodyData });
+        }
+        bodyData = xmlFaker(null, bodySchemaWithExample, indentCharacter, resolveTo);
       }
     }
     else if (!_.isEmpty(bodyObj.examples) && (resolveTo === 'example' || !bodyObj.schema)) {
       // take one of the examples as the body and not all
       bodyData = this.getExampleData(bodyObj.examples, components, options);
 
       if (contentType === TEXT_XML || contentType === APP_XML || headerFamily === HEADER_TYPE.XML) {
-        bodyData = js2xml(bodyData, indentCharacter);
+        let bodySchemaWithExample = bodyObj.schema;
+
+        // Assign example at schema level to be faked by xmlSchemaFaker
+        if (typeof bodyObj.schema === 'object') {
+          bodySchemaWithExample = Object.assign({}, bodyObj.schema, { example: bodyData });
+        }
+        bodyData = xmlFaker(null, bodySchemaWithExample, indentCharacter, resolveTo);
       }
     }
     else if (bodyObj.schema) {
@@ -1652,17 +1663,8 @@ module.exports = {
           return '<Error: Spec size too large, skipping faking of schemas>';
         }
 
-        if (
-          resolveTo === 'example' &&
-          _.get(bodyObj.schema, 'example') !== undefined &&
-          (contentType === TEXT_XML || contentType === APP_XML || headerFamily === HEADER_TYPE.XML)
-        ) {
-          bodyData = js2xml(bodyObj.schema.example, indentCharacter);
-        }
-        else {
-          bodyData = safeSchemaFaker(bodyObj.schema || {}, resolveTo, PROCESSING_TYPE.CONVERSION, parameterSourceOption,
-            components, schemaFormat, schemaCache, options);
-        }
+        bodyData = safeSchemaFaker(bodyObj.schema || {}, resolveTo, PROCESSING_TYPE.CONVERSION, parameterSourceOption,
+          components, schemaFormat, schemaCache, options);
       }
       else {
         // do not fake if the option is false
@@ -2647,7 +2649,9 @@ module.exports = {
     }
 
     // handling authentication here (for http type only)
-    authHelper = this.getAuthHelper(openapi, operation.security);
+    if (!options.alwaysInheritAuthentication) {
+      authHelper = this.getAuthHelper(openapi, operation.security);
+    }
 
     // creating the request object
     item = new sdk.Item({

lib/schemapack.js

@@ -1,8 +1,6 @@
 'use strict';
 
-// This is the default collection name if one can't be inferred from the OpenAPI spec
-const COLLECTION_NAME = 'Imported from OpenAPI 3.0',
-  { getConcreteSchemaUtils } = require('./common/versionUtils.js'),
+const { getConcreteSchemaUtils } = require('./common/versionUtils.js'),
   { convertToOAS30IfSwagger } = require('./swaggerUtils/swaggerToOpenapi.js'),
   BROWSER = 'browser',
   Ajv = require('ajv'),
@@ -194,12 +192,14 @@ class SchemaPack {
     }
     // if the schema is validated, return the meta data as required.
     else if (this.validated) {
+      let name = utils.getCollectionName(_.get(this.openapi, 'info.title'));
+
       return cb(null, {
         result: true,
-        name: _.get(this.openapi, 'info.title', COLLECTION_NAME),
+        name: name,
         output: [{
           type: 'collection',
-          name: _.get(this.openapi, 'info.title', COLLECTION_NAME)
+          name: name
         }]
       });
     }
@@ -213,12 +213,14 @@ class SchemaPack {
           return cb(null, validationResult);
         }
 
+        let name = utils.getCollectionName(_.get(this.openapi, 'info.title'));
+
         return cb(null, {
           result: true,
-          name: _.get(this.openapi, 'info.title', COLLECTION_NAME),
+          name: name,
           output: [{
             type: 'collection',
-            name: _.get(this.openapi, 'info.title', COLLECTION_NAME)
+            name: name
           }]
         });
       });
@@ -340,7 +342,7 @@ class SchemaPack {
         // All generated folders and requests will go inside this
         generatedStore.collection = new sdk.Collection({
           info: {
-            name: _.isEmpty(_.get(openapi, 'info.title')) ? COLLECTION_NAME : _.get(openapi, 'info.title')
+            name: utils.getCollectionName(_.get(openapi, 'info.title'))
           }
         });
 

lib/utils.js

@@ -1,4 +1,7 @@
-const _ = require('lodash');
+const _ = require('lodash'),
+
+  // This is the default collection name if one can't be inferred from the OpenAPI spec
+  COLLECTION_NAME = 'Imported from OpenAPI';
 
 // this will have non-OAS-related utils
 
@@ -142,5 +145,19 @@ module.exports = {
       res.push(segment);
     }
     return res.join('/');
+  },
+
+  /**
+   * Provides collection name to be used for generated collection
+   *
+   * @param {*} title - Definition title
+   * @returns {String} - Collection name
+   */
+  getCollectionName: function (title) {
+    if (_.isEmpty(title) || !_.isString(title)) {
+      return COLLECTION_NAME;
+    }
+
+    return title;
   }
 };

lib/xmlSchemaFaker.js

@@ -1,9 +1,21 @@
 /* eslint-disable */
-const _ = require('lodash');
+const _ = require('lodash'),
+  js2xml = require('../lib/common/js2xml');
 
-function convertSchemaToXML(name, schema, attribute, indentChar, indent) {
+function indentContent (content, initialIndent) {
+  let contentArr = _.split(content, '\n'),
+    indentedContent = _.join(_.map(contentArr, (contentElement) => { return initialIndent + contentElement; }), '\n');
+
+  return indentedContent;
+}
+
+function convertSchemaToXML(name, schema, attribute, indentChar, indent, resolveTo) {
   var tagPrefix = '',
-    cIndent = _.times(indent, _.constant(indentChar)).join('');
+    cIndent = _.times(indent, _.constant(indentChar)).join(''),
+    retVal = '';
+
+  const schemaExample = typeof schema === 'object' && (schema.example);
+
   name = _.get(schema, 'xml.name', name || 'element');
   if (_.get(schema, 'xml.prefix')) {
     tagPrefix = schema.xml.prefix ? `${schema.xml.prefix}:` : '';
@@ -21,53 +33,81 @@ function convertSchemaToXML(name, schema, attribute, indentChar, indent) {
     else if (schema.type === 'number') {
       actualValue = '(number)';
     }
+
+    if (resolveTo === 'example' && typeof schemaExample !== 'undefined') {
+      actualValue = schemaExample;
+    }
+
     if (attribute) {
       return actualValue;
     }
     else {
-      var retVal = `\n${cIndent}<${tagPrefix+name}`;
+      retVal = `\n${cIndent}<${tagPrefix+name}`;
       if (_.get(schema, 'xml.namespace')) {
         retVal += ` xmlns:${tagPrefix.slice(0,-1)}="${schema.xml.namespace}"`
       }
       retVal += `>${actualValue}</${tagPrefix}${name}>`;
     }
   }
   else if (schema.type === 'object') {
-    // go through all properties
-    var retVal = '\n' + cIndent + `<${tagPrefix}${name}`, propVal, attributes = [], childNodes = '';
-    if (_.get(schema, 'xml.namespace')) {
-      let formattedTagPrefix = tagPrefix ?
-        `:${tagPrefix.slice(0,-1)}` :
-        '';
-      retVal += ` xmlns${formattedTagPrefix}="${schema.xml.namespace}"`
+    if (resolveTo === 'example' && typeof schemaExample !== 'undefined') {
+      const elementName = _.get(schema, 'items.xml.name', name || 'element'),
+        fakedContent = js2xml({ [elementName]: schemaExample }, indentChar);
+
+      retVal = '\n' + indentContent(fakedContent, cIndent);
     }
-    _.forOwn(schema.properties, (value, key) => {
-      propVal = convertSchemaToXML(key, value, _.get(value, 'xml.attribute'), indentChar, indent + 1);
-      if (_.get(value, 'xml.attribute')) {
-        attributes.push(`${key}="${propVal}"`);
+    else {
+      // go through all properties
+      var propVal, attributes = [], childNodes = '';
+
+      retVal = '\n' + cIndent + `<${tagPrefix}${name}`;
+
+      if (_.get(schema, 'xml.namespace')) {
+        let formattedTagPrefix = tagPrefix ?
+          `:${tagPrefix.slice(0,-1)}` :
+          '';
+        retVal += ` xmlns${formattedTagPrefix}="${schema.xml.namespace}"`
       }
-      else {
-        childNodes += _.isString(propVal) ? propVal : '';
+      _.forOwn(schema.properties, (value, key) => {
+        propVal = convertSchemaToXML(key, value, _.get(value, 'xml.attribute'), indentChar, indent + 1, resolveTo);
+        if (_.get(value, 'xml.attribute')) {
+          attributes.push(`${key}="${propVal}"`);
+        }
+        else {
+          childNodes += _.isString(propVal) ? propVal : '';
+        }
+      });
+      if (attributes.length > 0) {
+        retVal += ' ' + attributes.join(' ');
       }
-    });
-    if (attributes.length > 0) {
-      retVal += ' ' + attributes.join(' ');
+      retVal += '>';
+      retVal += childNodes;
+      retVal += `\n${cIndent}</${tagPrefix}${name}>`;
     }
-    retVal += '>';
-    retVal += childNodes;
-    retVal += `\n${cIndent}</${tagPrefix}${name}>`;
   }
   else if (schema.type === 'array') {
     // schema.items must be an object
     var isWrapped = _.get(schema, 'xml.wrapped'),
       extraIndent = isWrapped ? 1 : 0,
-      arrayElemName = _.get(schema, 'items.xml.name', name, 'arrayItem'),
+      arrayElemName = _.get(schema, 'items.xml.name', name || 'element'),
       schemaItemsWithXmlProps = _.cloneDeep(schema.items),
       contents;
 
     schemaItemsWithXmlProps.xml = schema.xml;
-    contents = convertSchemaToXML(arrayElemName, schemaItemsWithXmlProps, false, indentChar, indent + extraIndent) +
-      convertSchemaToXML(arrayElemName, schemaItemsWithXmlProps, false, indentChar, indent + extraIndent);
+
+    if (resolveTo === 'example' && typeof schemaExample !== 'undefined') {
+      const fakedContent = js2xml({ [arrayElemName]: schemaExample }, indentChar);
+
+      contents = '\n' + indentContent(fakedContent, cIndent);
+    }
+    else {
+      let singleElementContent = convertSchemaToXML(arrayElemName, schemaItemsWithXmlProps, false, indentChar,
+        indent + extraIndent, resolveTo);
+
+      // Atleast 2 items per array will be added asame as JSON schema faker
+      contents = singleElementContent + singleElementContent;
+    }
+
     if (isWrapped) {
       return `\n${cIndent}<${tagPrefix}${name}>${contents}\n${cIndent}</${tagPrefix}${name}>`;
     }
@@ -78,9 +118,9 @@ function convertSchemaToXML(name, schema, attribute, indentChar, indent) {
   return retVal;
 }
 
-module.exports = function(name, schema, indentCharacter) {
+module.exports = function(name, schema, indentCharacter, resolveTo) {
   // substring(1) to trim the leading newline
-  return convertSchemaToXML(name, schema, false, indentCharacter, 0).substring(1);
+  return convertSchemaToXML(name, schema, false, indentCharacter, 0, resolveTo).substring(1);
 };
 /*
 a = convertSchemaToXML('Person',{

libV2/helpers/collection/generateCollectionFromOpenAPI.js

@@ -1,6 +1,6 @@
 const _ = require('lodash'),
+  utils = require('../../utils'),
   generateAuthrForCollectionFromOpenAPI = require('./generateAuthForCollectionFromOpenAPI'),
-  COLLECTION_NAME = 'Imported from OpenAPI 3.0',
 
   /**
    * Returns a description that's usable at the collection-level
@@ -96,7 +96,7 @@ module.exports = function ({ openapi }) {
   return {
     data: {
       info: {
-        name: _.get(openapi, 'info.title', COLLECTION_NAME),
+        name: utils.getCollectionName(_.get(openapi, 'info.title')),
         description: getCollectionDescription(openapi)
       },
       auth: generateAuthrForCollectionFromOpenAPI(openapi, openapi.security)