alihan/fastapi-openapi-to-postman
1
0
Fork 0
mirror of https://github.com/postmanlabs/openapi-to-postman.git synced 2022-11-29 22:05:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge develop into feature/meta-data-function

Browse Source
This commit is contained in:
umeshp7
2020-04-27 21:01:19 +05:30
parent 1e344ae7ba 65f62405a8
commit 46b7913911
20 changed files with 1151 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CHANGELOG.md
View File

@@ -1,4 +1,11 @@
# OpenAPI-Postman Changelog
#### v1.1.13 (April 21, 2020)
* Added support for detailed validation body mismatches with option detailedBlobValidation.
* Fix for [#8098](https://github.com/postmanlabs/postman-app-support/issues/8098) - Unable to validate schema with type array.
* Fixed URIError for invalid URI in transaction.
* Fix for [#152](https://github.com/postmanlabs/openapi-to-postman/issues/152) - Path references not resolved due to improver handling of special characters.
* Fix for [#160](https://github.com/postmanlabs/openapi-to-postman/issues/160) - Added handling for variables in local servers not a part of a URL segment. All path servers to be added as collection variables.
* Unresolved refs will not be stored in schemaResolutionCache.
#### v1.1.12 (Mar 26, 2020)
* Fix for https://github.com/postmanlabs/openapi-to-postman/issues/133 and https://github.com/postmanlabs/openapi-to-postman/issues/101

4
index.js
View File

@@ -28,8 +28,8 @@ module.exports = {
schema.mergeAndValidate(cb);
},
getOptions: function() {
return SchemaPack.getOptions();
getOptions: function(mode, criteria) {
return SchemaPack.getOptions(mode, criteria);
},
// new API

49
lib/ajvValidationError.js Normal file
View File

@@ -0,0 +1,49 @@
var _ = require('lodash');
/**
* This function generates reason and reasonCodes (used in mismatch objects) using Ajv Validation Error
*
* @param {Object} ajvValidationErrorObj Ajv Validation Error Object (reference: https://ajv.js.org/#validation-errors)
* @param {Object} data data needed for generation of mismatch Object
*
* @returns {Object} mismatchObj with reason and reasonCode properties
*/
function ajvValidationError(ajvValidationErrorObj, data) {
var mismatchPropName = _.get(ajvValidationErrorObj, 'dataPath', '').slice(1),
mismatchObj = {
reason: `The ${data.humanPropName} property "${mismatchPropName}" ` +
`${ajvValidationErrorObj.message}`,
reasonCode: 'INVALID_TYPE'
};
switch (ajvValidationErrorObj.keyword) {
case 'additionalProperties':
mismatchObj.reasonCode = 'MISSING_IN_SCHEMA';
break;
case 'dependencies':
mismatchObj.reason = `The ${data.humanPropName} property "${mismatchPropName}" ` +
`should have property "${_.get(ajvValidationErrorObj, 'params.missingProperty')}" when property ` +
`"${_.get(ajvValidationErrorObj, 'params.property')}" is present`;
break;
case 'required':
mismatchObj.reasonCode = 'MISSING_IN_REQUEST';
mismatchObj.reason = `The ${data.humanPropName} property "${mismatchPropName}" should have required ` +
`property "${_.get(ajvValidationErrorObj, 'params.missingProperty')}"`;
break;
case 'propertyNames':
mismatchObj.reason = `The ${data.humanPropName} property "${mismatchPropName}" contains invalid ` +
`property named "${_.get(ajvValidationErrorObj, 'params.propertyName')}"`;
break;
default:
break;
}
return mismatchObj;
}
module.exports = ajvValidationError;

76
lib/deref.js
View File

@@ -54,23 +54,28 @@ module.exports = {
* @param {string} parameterSourceOption tells that the schema object is of request or response
* @param {*} components components in openapi spec.
* @param {object} schemaResolutionCache stores already resolved references
* @param {*} resolveFor - resolve refs for validation/conversion (value to be one of VALIDATION/CONVERSION)
* @param {*} stack counter which keeps a tab on nested schemas
* @param {*} seenRef References that are repeated. Used to identify circular references.
* @returns {*} schema - schema that adheres to all individual schemas in schemaArr
*/
resolveAllOf: function (schemaArr, parameterSourceOption, components, schemaResolutionCache, stack = 0, seenRef) {
resolveAllOf: function (schemaArr, parameterSourceOption, components, schemaResolutionCache,
resolveFor = 'CONVERSION', stack = 0, seenRef) {
if (!(schemaArr instanceof Array)) {
return null;
}
if (schemaArr.length === 1) {
// for just one entry in allOf, don't need to enforce type: object restriction
return this.resolveRefs(schemaArr[0], parameterSourceOption, components, schemaResolutionCache, stack, seenRef);
return this.resolveRefs(schemaArr[0], parameterSourceOption, components, schemaResolutionCache, resolveFor,
stack, seenRef);
}
// generate one object for each schema
let indivObjects = schemaArr.map((schema) => {
return this.resolveRefs(schema, parameterSourceOption, components, schemaResolutionCache, stack, seenRef);
return this.resolveRefs(schema, parameterSourceOption, components, schemaResolutionCache, resolveFor,
stack, seenRef);
}).filter((schema) => {
return schema.type === 'object';
}),
@@ -107,16 +112,22 @@ module.exports = {
* @param {string} parameterSourceOption tells that the schema object is of request or response
* @param {*} components components in openapi spec.
* @param {object} schemaResolutionCache stores already resolved references
* @param {*} resolveFor - resolve refs for validation/conversion (value to be one of VALIDATION/CONVERSION)
* @param {*} stack counter which keeps a tab on nested schemas
* @param {*} seenRef - References that are repeated. Used to identify circular references.
* @returns {*} schema satisfying JSON-schema-faker.
*/
resolveRefs: function (schema, parameterSourceOption, components, schemaResolutionCache, stack = 0, seenRef = {}) {
var resolvedSchema, prop, splitRef;
resolveRefs: function (schema, parameterSourceOption, components, schemaResolutionCache,
resolveFor = 'CONVERSION', stack = 0, seenRef = {}) {
var resolvedSchema, prop, splitRef,
ERR_TOO_MANY_LEVELS = '<Error: Too many levels of nesting to fake this schema>';
stack++;
schemaResolutionCache = schemaResolutionCache || {};
if (stack > 20) {
return { value: '<Error: Too many levels of nesting to fake this schema>' };
return { value: ERR_TOO_MANY_LEVELS };
}
if (!schema) {
@@ -124,16 +135,16 @@ module.exports = {
}
if (schema.anyOf) {
return this.resolveRefs(schema.anyOf[0], parameterSourceOption, components, schemaResolutionCache, stack,
_.cloneDeep(seenRef));
return this.resolveRefs(schema.anyOf[0], parameterSourceOption, components, schemaResolutionCache, resolveFor,
stack, _.cloneDeep(seenRef));
}
if (schema.oneOf) {
return this.resolveRefs(schema.oneOf[0], parameterSourceOption, components, schemaResolutionCache, stack,
_.cloneDeep(seenRef));
return this.resolveRefs(schema.oneOf[0], parameterSourceOption, components, schemaResolutionCache, resolveFor,
stack, _.cloneDeep(seenRef));
}
if (schema.allOf) {
return this.resolveAllOf(schema.allOf, parameterSourceOption, components, schemaResolutionCache, stack,
_.cloneDeep(seenRef));
return this.resolveAllOf(schema.allOf, parameterSourceOption, components, schemaResolutionCache, resolveFor,
stack, _.cloneDeep(seenRef));
}
if (schema.$ref && _.isFunction(schema.$ref.split)) {
let refKey = schema.$ref;
@@ -160,12 +171,27 @@ module.exports = {
// will be resolved - we don't care about anything after the components part
// splitRef.slice(1) will return ['components', 'schemas', 'PaginationEnvelope', 'properties', 'page']
// not using _.get here because that fails if there's a . in the property name (Pagination.Envelope, for example)
resolvedSchema = this._getEscaped(components, splitRef.slice(1));
splitRef = splitRef.slice(1).map((elem) => {
// https://swagger.io/docs/specification/using-ref#escape
// since / is the default delimiter, slashes are escaped with ~1
return decodeURIComponent(
elem
.replace(/~1/g, '/')
.replace(/~0/g, '~')
);
});
resolvedSchema = this._getEscaped(components, splitRef);
if (resolvedSchema) {
let refResolvedSchema = this.resolveRefs(resolvedSchema, parameterSourceOption,
components, schemaResolutionCache, stack, _.cloneDeep(seenRef));
schemaResolutionCache[refKey] = refResolvedSchema;
components, schemaResolutionCache, resolveFor, stack, _.cloneDeep(seenRef));
if (refResolvedSchema && refResolvedSchema.value !== ERR_TOO_MANY_LEVELS) {
schemaResolutionCache[refKey] = refResolvedSchema;
}
return refResolvedSchema;
}
return { value: 'reference ' + schema.$ref + ' not found in the OpenAPI spec' };
@@ -196,7 +222,7 @@ module.exports = {
}
/* eslint-enable */
tempSchema.properties[prop] = this.resolveRefs(property,
parameterSourceOption, components, schemaResolutionCache, stack, _.cloneDeep(seenRef));
parameterSourceOption, components, schemaResolutionCache, resolveFor, stack, _.cloneDeep(seenRef));
}
}
return tempSchema;
@@ -207,15 +233,19 @@ module.exports = {
}
else if (schema.type === 'array' && schema.items) {
// This nonsense is needed because the schemaFaker doesn't respect options.maxItems/minItems
schema.maxItems = 2;
schema.minItems = 2;
// For VALIDATION - keep minItems and maxItems properties defined by user in schema as is
// FOR CONVERSION - need to set both properties to 2 for schema faking
if (resolveFor === 'CONVERSION') {
// This is needed because the schemaFaker doesn't respect options.maxItems/minItems
schema.maxItems = 2;
schema.minItems = 2;
}
// have to create a shallow clone of schema object,
// so that the original schema.items object will not change
// without this, schemas with circular references aren't faked correctly
let tempSchema = _.omit(schema, 'items');
tempSchema.items = this.resolveRefs(schema.items, parameterSourceOption,
components, schemaResolutionCache, stack, _.cloneDeep(seenRef));
components, schemaResolutionCache, resolveFor, stack, _.cloneDeep(seenRef));
return tempSchema;
}
else if (!schema.hasOwnProperty('default')) {
@@ -251,7 +281,11 @@ module.exports = {
if (!schema.type) {
schema.type = 'string';
}
delete schema.format;
// For VALIDATION - Keep format as is to perform ajv validation on format
if (resolveFor !== 'VALIDATION') {
delete schema.format;
}
}
return schema;

134
lib/options.js
View File

@@ -12,74 +12,80 @@ module.exports = {
* availableOptions - allowed values (only for type=enum)
* description - human-readable description of the item
* external - whether the option is settable via the API
* usage - array of supported types of usage (i.e. CONVERSION, VALIDATION)
*
* @param {string} [mode='document'] Describes use-case. 'document' will return an array
* with all options being described. 'use' will return the default values of all options
* @param {Object} criteria Decribes required criteria for options to be returned. can have properties
* external: <boolean>
* usage: <array> (Array of supported usage type - CONVERSION, VALIDATION)
* @returns {mixed} An array or object (depending on mode) that describes available options
*/
getOptions: function(mode = 'document') {
getOptions: function(mode = 'document', criteria = {}) {
// Override mode & criteria if first arg is criteria (objects)
if (typeof mode === 'object') {
criteria = mode;
mode = 'document';
}
let optsArray = [
{
name: 'Set request name source',
name: 'Naming requests',
id: 'requestNameSource',
type: 'enum',
default: 'fallback',
availableOptions: ['url', 'fallback'],
description: 'Option for setting source for a request name',
external: true
default: 'Fallback',
availableOptions: ['Url', 'Fallback'],
description: 'Determines how the requests inside the generated collection will be named.' +
' If “Fallback” is selected, the request will be named after one of the following schema' +
' values: `description`, `operationid`, `url`.',
external: true,
usage: ['CONVERSION']
},
{
name: 'Set indent character',
id: 'indentCharacter',
type: 'enum',
default: ' ',
availableOptions: [' ', '\t'],
default: 'Space',
availableOptions: ['Space', 'Tab'],
description: 'Option for setting indentation character',
external: true
external: true,
usage: ['CONVERSION']
},
{
name: 'Toggle for collapsing folder for long routes',
name: 'Collapse redundant folders',
id: 'collapseFolders',
type: 'boolean',
default: true,
description: 'Determines whether the importer should attempt to collapse redundant folders into one.' +
'Folders are redundant if they have only one child element, and don\'t' +
'have any folder-level data to persist.',
external: true
description: 'Importing will collapse all folders that have only one child element and lack ' +
'persistent folder-level data.',
external: true,
usage: ['CONVERSION']
},
{
name: 'Set root request parameters type',
name: 'Request parameter generation',
id: 'requestParametersResolution',
type: 'enum',
default: 'schema',
availableOptions: ['example', 'schema'],
description: 'Determines how request parameters (query parameters, path parameters, headers,' +
'or the request body) should be generated. Setting this to schema will cause the importer to' +
'use the parameter\'s schema as an indicator; `example` will cause the example (if provided)' +
'to be picked up.',
external: true
default: 'Schema',
availableOptions: ['Example', 'Schema'],
description: 'Select whether to generate the request parameters based on the' +
' [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the' +
' [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject)' +
' in the schema.',
external: true,
usage: ['CONVERSION']
},
{
name: 'Set example request and response parameters type',
name: 'Response parameter generation',
id: 'exampleParametersResolution',
type: 'enum',
default: 'example',
availableOptions: ['example', 'schema'],
description: 'Determines how response parameters (query parameters, path parameters, headers,' +
'or the request body) should be generated. Setting this to schema will cause the importer to' +
'use the parameter\'s schema as an indicator; `example` will cause the example (if provided)' +
'to be picked up.',
external: true
},
{
name: 'Set folder strategy',
id: 'folderStrategy',
type: 'enum',
default: 'paths',
availableOptions: ['paths', 'tags'],
description: 'Determines whether the importer should attempt to create the folders according' +
'to paths or tags which are given in the spec.',
external: true
default: 'Example',
availableOptions: ['Example', 'Schema'],
description: 'Select whether to generate the response parameters based on the' +
' [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the' +
' [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject)' +
' in the schema.',
external: true,
usage: ['CONVERSION']
},
{
name: 'Enable Schema Faking',
@@ -87,15 +93,17 @@ module.exports = {
type: 'boolean',
default: true,
description: 'Whether or not schemas should be faked.',
external: false
external: false,
usage: ['CONVERSION']
},
{
name: 'Short error messages during request <> schema validation',
id: 'shortValidationErrors',
type: 'boolean',
default: false,
description: 'Whether detailed error messages are required for request <> schema validation operations',
external: false
description: 'Whether detailed error messages are required for request <> schema validation operations.',
external: true,
usage: ['VALIDATION']
},
{
name: 'Properties to ignore during validation',
@@ -105,7 +113,8 @@ module.exports = {
description: 'Specific properties (parts of a request/response pair) to ignore during validation.' +
' Must be sent as an array of strings. Valid inputs in the array: PATHVARIABLE, QUERYPARAM,' +
' HEADER, BODY, RESPONSE_HEADER, RESPONSE_BODY',
external: true
external: true,
usage: ['VALIDATION']
},
{
name: 'Whether MISSING_IN_SCHEMA mismatches should be returned',
@@ -114,15 +123,48 @@ module.exports = {
default: false,
description: 'MISSING_IN_SCHEMA indicates that an extra parameter was included in the request. For most ' +
'use cases, this need not be considered an error.',
external: true
external: true,
usage: ['VALIDATION']
},
{
name: 'Show detailed body validation messages',
id: 'detailedBlobValidation',
type: 'boolean',
default: false,
description: 'Determines whether to show detailed mismatch information for application/json content ' +
'in the request/response body.',
external: true,
usage: ['VALIDATION']
}
];
// Filter options based on criteria
if (_.isObject(criteria)) {
typeof criteria.external === 'boolean' && (optsArray = _.filter(optsArray, { external: criteria.external }));
if (_.isArray(criteria.usage)) {
let tempOptsArray = [];
_.forEach(criteria.usage, (usageCriteria) => {
tempOptsArray = _.concat(tempOptsArray, _.filter(optsArray, (option) => {
return _.includes(option.usage, usageCriteria);
}));
});
optsArray = tempOptsArray;
}
}
if (mode === 'use') {
// options to be used as default kv-pairs
let defOptions = {};
_.each(optsArray, (opt) => {
defOptions[opt.id] = opt.default;
// special handling for indent character as in documentation it states `Tab` and `Space`
// but for the generation mode, we need actual values
if (opt.id === 'indentCharacter') {
defOptions[opt.id] = opt.default === 'tab' ? '\t' : ' ';
}
else {
defOptions[opt.id] = opt.default;
}
});
return defOptions;
}

192
lib/schemaUtils.js
View File

@@ -12,6 +12,7 @@ const async = require('async'),
_ = require('lodash'),
xmlFaker = require('./xmlSchemaFaker.js'),
openApiErr = require('./error.js'),
ajvValidationError = require('./ajvValidationError'),
utils = require('./utils.js'),
defaultOptions = require('../lib/options.js').getOptions('use'),
{ Node, Trie } = require('./trie.js'),
@@ -60,10 +61,15 @@ const async = require('async'),
QUERYPARAM: 'query parameter',
PATHVARIABLE: 'path variable',
HEADER: 'header',
REQUEST_BODY: 'request body',
BODY: 'request body',
RESPONSE_HEADER: 'response header',
RESPONSE_BODY: 'response body'
},
// Specifies types of processing Refs
PROCESSING_TYPE = {
VALIDATION: 'VALIDATION',
CONVERSION: 'CONVERSION'
},
// These are the methods supported in the PathItem schema
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject
@@ -121,7 +127,8 @@ function safeSchemaFaker(oldSchema, resolveTo, parameterSourceOption, components
schemaResolutionCache = _.get(schemaCache, 'schemaResolutionCache', {}),
schemaFakerCache = _.get(schemaCache, 'schemaFakerCache', {});
resolvedSchema = deref.resolveRefs(oldSchema, parameterSourceOption, components, schemaResolutionCache);
resolvedSchema = deref.resolveRefs(oldSchema, parameterSourceOption, components, schemaResolutionCache,
PROCESSING_TYPE.CONVERSION);
key = JSON.stringify(resolvedSchema);
if (resolveTo === 'schema') {
@@ -1522,7 +1529,7 @@ module.exports = {
return path.match(/(\{\{[^\/\{\}]+\}\})/g);
},
/** Separates outs collection and path variables from the reqUrl
/** Separates out collection and path variables from the reqUrl
*
* @param {string} reqUrl Request Url
* @param {Array} pathVars Path variables
@@ -1558,7 +1565,7 @@ module.exports = {
});
}
return { reqUrl, pathVars, collectionVars };
return { url: reqUrl, pathVars, collectionVars };
},
/**
@@ -1605,7 +1612,7 @@ module.exports = {
sanitizeResult = this.sanitizeUrlPathParams(reqUrl, reqParams.path);
// Updated reqUrl
reqUrl = sanitizeResult.reqUrl;
reqUrl = sanitizeResult.url;
// Updated reqParams.path
reqParams.path = sanitizeResult.pathVars;
@@ -1625,24 +1632,59 @@ module.exports = {
if (Array.isArray(localServers) && localServers.length) {
serverObj = operationItem.properties.servers[0];
baseUrl = serverObj.url.replace(/{/g, ':').replace(/}/g, '');
baseUrl += reqUrl;
// convert all {anything} to {{anything}}
baseUrl = this.fixPathVariablesInUrl(serverObj.url);
// add serverObj variables to pathVarArray
if (serverObj.variables) {
pathVarArray = this.convertPathVariables('method', [], serverObj.variables, components, options, schemaCache);
_.forOwn(serverObj.variables, (value, key) => {
pathVarArray.push({
name: key,
value: value.default || '',
description: this.getParameterDescription(value)
});
});
// use pathVarAray to sanitize url for path params and collection variables.
sanitizeResult = this.sanitizeUrlPathParams(baseUrl, pathVarArray);
// update the base url with update url
baseUrl = sanitizeResult.url;
// Add new collection variables to the variableStore
sanitizeResult.collectionVars.forEach((element) => {
if (!variableStore[element.name]) {
variableStore[element.name] = {
id: element.name,
value: element.value || '',
description: element.description,
type: 'collection'
};
}
});
// remove all the collection variables from serverObj.variables
serverObj.pathVariables = {};
sanitizeResult.pathVars.forEach((element) => {
serverObj.pathVariables[element.name] = serverObj.variables[element.name];
});
// use this new filterd serverObj.pathVariables
// to generate pm path variables.
pathVarArray = this.convertPathVariables('method', [],
serverObj.pathVariables, components, options, schemaCache);
}
baseUrl += reqUrl;
}
else {
// accounting for the overriding of the root level servers object if present at the path level
if (Array.isArray(globalServers) && globalServers.length) {
if (operationItem.servers[0].hasOwnProperty('variables')) {
serverObj = operationItem.servers[0];
baseUrl = serverObj.url.replace(/{/g, ':').replace(/}/g, '');
pathVariables = serverObj.variables;
}
else {
displayUrl = '{{' + operationItem.path + 'Url}}' + reqUrl;
}
// All the global servers present at the path level are taken care of in generateTrieFromPaths
// Just adding the same structure of the url as the display URL.
displayUrl = '{{' + operationItem.path + 'Url}}' + reqUrl;
}
// In case there are no server available use the baseUrl
else {
baseUrl += reqUrl;
if (pathVariables) {
@@ -1950,7 +1992,7 @@ module.exports = {
/**
*
* @param {*} property - one of QUERYPARAM, PATHVARIABLE, HEADER, REQUEST_BODY, RESPONSE_HEADER, RESPONSE_BODY
* @param {*} property - one of QUERYPARAM, PATHVARIABLE, HEADER, BODY, RESPONSE_HEADER, RESPONSE_BODY
* @param {*} jsonPathPrefix - this will be prepended to all JSON schema paths on the request
* @param {*} txnParamName - Optional - The name of the param being validated (useful for query params,
* req headers, res headers)
@@ -2035,6 +2077,7 @@ module.exports = {
// simpler cases are handled by a type check
if (schema.type === 'array' || schema.type === 'object') {
try {
// the unknown formats are ones that are allowed in OAS, but not JSON schema
ajv = new Ajv({ unknownFormats: ['int32', 'int64'], allErrors: true });
validate = ajv.compile(schema);
res = validate(valueToUse);
@@ -2044,13 +2087,33 @@ module.exports = {
// input was invalid. Don't throw mismatch
}
if (!res) {
mismatches.push({
property: property,
transactionJsonPath: jsonPathPrefix,
schemaJsonPath: schemaPathPrefix,
reasonCode: 'INVALID_TYPE',
reason: 'The property didn\'t match the specified schema'
});
// Show detailed validation mismatches for only request/response body
if (options.detailedBlobValidation && needJsonMatching) {
_.forEach(validate.errors, (ajvError) => {
mismatches.push(_.assign({
property: property,
transactionJsonPath: jsonPathPrefix + ajvError.dataPath,
schemaJsonPath: schemaPathPrefix + ajvError.schemaPath.replace(/\//g, '.').slice(1)
}, ajvValidationError(ajvError, { property, humanPropName })));
});
}
else {
let mismatchObj = {
reason: 'The property didn\'t match the specified schema',
reasonCode: 'INVALID_TYPE'
};
if (property === 'BODY') {
mismatchObj.reason = 'The request body didn\'t match the specified schema';
mismatchObj.reasonCode = 'INVALID_BODY';
}
mismatches.push(_.assign({
property: property,
transactionJsonPath: jsonPathPrefix,
schemaJsonPath: schemaPathPrefix
}, mismatchObj));
}
// only return AJV mismatches
return callback(null, mismatches);
@@ -2150,7 +2213,8 @@ module.exports = {
pathVar.key,
pathVar.value,
schemaPathVar.pathPrefix + '[?(@.name==\'' + schemaPathVar.name + '\')]',
deref.resolveRefs(schemaPathVar.schema, 'request', components, schemaResolutionCache),
deref.resolveRefs(schemaPathVar.schema, 'request', components, schemaResolutionCache,
PROCESSING_TYPE.VALIDATION),
components, options, cb);
}, 0);
}, (err, res) => {
@@ -2251,7 +2315,8 @@ module.exports = {
pQuery.key,
pQuery.value,
schemaParam.pathPrefix + '[?(@.name==\'' + schemaParam.name + '\')]',
deref.resolveRefs(schemaParam.schema, 'request', components, schemaResolutionCache),
deref.resolveRefs(schemaParam.schema, 'request', components, schemaResolutionCache,
PROCESSING_TYPE.VALIDATION),
components, options,
cb
);
@@ -2312,7 +2377,8 @@ module.exports = {
pHeader.key,
pHeader.value,
schemaHeader.pathPrefix + '[?(@.name==\'' + schemaHeader.name + '\')]',
deref.resolveRefs(schemaHeader.schema, 'request', components, schemaResolutionCache),
deref.resolveRefs(schemaHeader.schema, 'request', components, schemaResolutionCache,
PROCESSING_TYPE.VALIDATION),
components, options,
cb
);
@@ -2362,7 +2428,7 @@ module.exports = {
mismatches.push({
property: mismatchProperty,
transactionJsonPath: transactionPathPrefix + '/' + pHeader.key,
schemaJsonPath: schemaPathPrefix + '/headers',
schemaJsonPath: schemaPathPrefix + '.headers',
reasonCode: 'MISSING_IN_SCHEMA',
reason: `The header ${pHeader.key} was not found in the schema`
});
@@ -2381,7 +2447,8 @@ module.exports = {
pHeader.key,
pHeader.value,
schemaPathPrefix + '.headers[' + pHeader.key + ']',
deref.resolveRefs(schemaHeader.schema, 'response', components, schemaResolutionCache),
deref.resolveRefs(schemaHeader.schema, 'response', components, schemaResolutionCache,
PROCESSING_TYPE.VALIDATION),
components,
options,
cb
@@ -2413,54 +2480,31 @@ module.exports = {
// check for body modes
// TODO: The application/json can be anything that's application/*+json
let jsonSchemaBody = _.get(schemaPath, ['requestBody', 'content', 'application/json', 'schema']),
mismatches = [],
mismatchProperty = 'BODY';
if (options.validationPropertiesToIgnore.includes(mismatchProperty)) {
return callback(null, []);
}
// only raw for now
if (requestBody && requestBody.mode === 'raw' && jsonSchemaBody) {
// only raw for now
// the unknown formats are ones that are allowed in OAS, but not JSON schema
let ajv,
validate,
res = true;
try {
ajv = new Ajv({ unknownFormats: ['int32', 'int64'], allErrors: true });
validate = ajv.compile(deref.resolveRefs(jsonSchemaBody, 'request', components, schemaResolutionCache));
res = validate(JSON.parse(requestBody.raw));
}
catch (e) {
// something went wrong validating the schema
// input was invalid. Don't throw mismatch
}
if (!res) {
mismatches.push({
property: mismatchProperty,
transactionJsonPath: transactionPathPrefix,
schemaJsonPath: schemaPathPrefix + 'requestBody.content.application.json.schema',
reasonCode: 'INVALID_BODY',
reason: 'The request body didn\'t match the specified schema'
});
// Not validating parts of the body for now
// _.each(validate.errors, (error) => {
// // error.keyword can be https://ajv.js.org/keywords.html
// mismatches.push({
// property: 'REQUEST_BODY',
// transactionJsonPath: transactionPathPrefix + error.dataPath,
// schemaJsonPath: schemaPathPrefix + 'requestBody.content.application.json.schema.' + error.schemaPath,
// reasonCode: error.keyword.toUpperCase(),
// reason: error.message
// });
// });
return callback(null, mismatches);
}
setTimeout(() => {
return this.checkValueAgainstSchema(mismatchProperty,
transactionPathPrefix,
null, // no param name for the request body
requestBody.raw,
schemaPathPrefix + '.requestBody.content[application/json].schema',
deref.resolveRefs(jsonSchemaBody, 'request', components, schemaResolutionCache,
PROCESSING_TYPE.VALIDATION),
components,
_.extend({}, options, { shortValidationErrors: true }),
callback
);
}, 0);
}
else {
return callback(null, []);
}
return callback(null, []);
},
checkResponseBody: function (schemaResponse, body, transactionPathPrefix, schemaPathPrefix,
@@ -2489,10 +2533,11 @@ module.exports = {
setTimeout(() => {
return this.checkValueAgainstSchema(mismatchProperty,
transactionPathPrefix,
null, // no param name for the request body
null, // no param name for the response body
body,
schemaPathPrefix + '.content[application/json].schema',
deref.resolveRefs(schemaContent, 'response', components, schemaResolutionCache),
deref.resolveRefs(schemaContent, 'response', components, schemaResolutionCache,
PROCESSING_TYPE.VALIDATION),
components,
_.extend({}, options, { shortValidationErrors: true }),
callback
@@ -2526,13 +2571,13 @@ module.exports = {
async.parallel({
headers: (cb) => {
this.checkResponseHeaders(thisSchemaResponse, response.header,
transactionPathPrefix + '[' + response.id + ']header',
transactionPathPrefix + '[' + response.id + '].header',
schemaPathPrefix + '.responses.' + responsePathPrefix, components, options, schemaResolutionCache, cb);
},
body: (cb) => {
// assume it's JSON at this point
this.checkResponseBody(thisSchemaResponse, response.body,
transactionPathPrefix + '[' + response.id + ']body',
transactionPathPrefix + '[' + response.id + '].body',
schemaPathPrefix + '.responses.' + responsePathPrefix, components, options, schemaResolutionCache, cb);
}
}, (err, result) => {
@@ -2658,4 +2703,3 @@ module.exports = {
};
}
};

7
lib/schemapack.js
View File

@@ -81,7 +81,8 @@ class SchemaPack {
);
// hardcoding this option - not exposed to users yet
this.computedOptions.schemaFaker = true;
this.metaData = null;
let indentCharacter = this.computedOptions.indentCharacter;
this.computedOptions.indentCharacter = indentCharacter === 'tab' ? '\t' : ' ';
this.validate();
}
@@ -515,8 +516,8 @@ class SchemaPack {
}, 0);
}
static getOptions() {
return getOptions();
static getOptions(mode, criteria) {
return getOptions(mode, criteria);
}
}

16
lib/utils.js
View File

@@ -1,3 +1,5 @@
const _ = require('lodash');
// this will have non-OAS-related utils
module.exports = {
@@ -10,6 +12,11 @@ module.exports = {
// set the default value to that option if the user has not defined
if (userOptions[id] === undefined) {
retVal[id] = defaultOptions[id].default;
// ignore case-sensitivity for enum option with type string
if (defaultOptions[id].type === 'enum' && _.isString(retVal[id])) {
retVal[id] = _.toLower(defaultOptions[id].default);
}
continue;
}
@@ -24,12 +31,19 @@ module.exports = {
}
break;
case 'enum':
if (defaultOptions[id].availableOptions.includes(userOptions[id])) {
// ignore case-sensitivity for string options
if ((defaultOptions[id].availableOptions.includes(userOptions[id])) ||
(_.isString(userOptions[id]) &&
_.map(defaultOptions[id].availableOptions, _.toLower).includes(_.toLower(userOptions[id])))) {
retVal[id] = userOptions[id];
}
else {
retVal[id] = defaultOptions[id].default;
}
// ignore case-sensitivity for string options
_.isString(retVal[id]) && (retVal[id] = _.toLower(retVal[id]));
break;
case 'array':
// user input needs to be parsed

2
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{
"name": "openapi-to-postmanv2",
"version": "1.1.12",
"version": "1.1.13",
"lockfileVersion": 1,
"requires": true,
"dependencies": {

2
package.json
View File

@@ -1,6 +1,6 @@
{
"name": "openapi-to-postmanv2",
"version": "1.1.12",
"version": "1.1.13",
"description": "Convert a given OpenAPI specification to Postman Collection v2.0",
"homepage": "https://github.com/postmanlabs/openapi-to-postman",
"bugs": "https://github.com/postmanlabs/openapi-to-postman/issues",

152
test/data/valid_openapi/issue#160.json Normal file
View File

@@ -0,0 +1,152 @@
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "#160",
"license": {
"name": "MIT"
}
},
"servers": [
{
"url": "http://petstore.swagger.io/v1"
}
],
"paths": {
"/pets": {
"servers": [
{
"url": "http://petstore.swagger.io:{port}/{basePath}",
"variables": {
"port": {
"enum": [
"8443",
"443"
],
"default": "8443"
},
"basePath": {
"default": "v2"
}
}
}
],
"get": {
"summary": "List all pets",
"operationId": "listPets",
"tags": [
"pets"
],
"parameters": [
{
"name": "limit",
"in": "query",
"description": "How many items to return at one time (max 100)",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "A paged array of pets",
"headers": {
"x-next": {
"description": "A link to the next page of responses",
"schema": {
"type": "string"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pets"
}
}
}
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"summary": "Create a pet",
"operationId": "createPets",
"tags": [
"pets"
],
"responses": {
"201": {
"description": "Null response"
},
"default": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Pet": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
}
}
},
"Pets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Pet"
}
},
"Error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
}
}
}

113
test/data/valid_openapi/path-refs-error.yaml Normal file
View File

@@ -0,0 +1,113 @@
openapi: 3.0.0
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://petstore.swagger.io/v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
responses:
"200":
description: A paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
properties:
newprop:
type: array
items:
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
default:
description: unexpected error
content:
application/json:
schema:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
post:
summary: Create a pet
operationId: createPets
tags:
- pets
responses:
"201":
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
properties:
data:
type: array
items:
oneOf:
- $ref: "#/paths/~1pets/get/responses/200/content/applicati\
on~1json/schema/properties/newprop"
- $ref: "#/paths/~1pets/get/responses/default/content/appli\
cation~1json/schema"
components:
schemas:
Pet:
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string

14
test/data/valid_openapi/server_overriding.json
View File

@@ -22,7 +22,19 @@
"summary": "Should use the other domain",
"servers": [
{
"url": "https://other-api.example.com"
"url": "http://petstore.swagger.io:{port}/{basePath}",
"variables": {
"port": {
"enum": [
"8443",
"443"
],
"default": "8443"
},
"basePath": {
"default": "v2"
}
}
}
]
}

180
test/data/valid_openapi/too-many-refs.json Normal file
View File

@@ -0,0 +1,180 @@
{
"openapi": "3.0.0",
"info": {
"description": "Too Many Refs",
"version": "v1",
"title": "Too Many Refs",
"termsOfService": "http://www.example.com/termsOfService",
"contact": {
"name": "Sample",
"url": "http://sample.com/",
"email": "sample@sample.com"
}
},
"tags": [
{
"name": "Folder tree"
}
],
"paths": {
"/path": {
"get": {
"tags": [
"Some path"
],
"summary": "Too many refs path",
"description": "Returns a list of folders in a nested, tree structure.",
"operationId": "listFolderTree",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/b"
}
}
}
}
}
}
},
"/path2": {
"get": {
"tags": [
"Some path"
],
"summary": "Too many refs path",
"description": "Returns a list of folders in a nested, tree structure.",
"operationId": "listFolderTree",
"parameters": [],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/k"
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://{host}/sample/api",
"variables": {
"host": {
"default": "unknown"
}
}
}
],
"components": {
"schemas": {
"b": {
"type": "object",
"properties": {
"c": {
"$ref": "#/components/schemas/c"
}
}
},
"c": {
"type": "object",
"properties": {
"d": {
"$ref": "#/components/schemas/d"
}
}
},
"d": {
"type": "object",
"properties": {
"e": {
"$ref": "#/components/schemas/e"
}
}
},
"e": {
"type": "object",
"properties": {
"f": {
"$ref": "#/components/schemas/f"
}
}
},
"f": {
"type": "object",
"properties": {
"g": {
"$ref": "#/components/schemas/g"
}
}
},
"g": {
"type": "object",
"properties": {
"h": {
"$ref": "#/components/schemas/h"
}
}
},
"h": {
"type": "object",
"properties": {
"i": {
"$ref": "#/components/schemas/i"
}
}
},
"i": {
"type": "object",
"properties": {
"j": {
"$ref": "#/components/schemas/j"
}
}
},
"j": {
"type": "object",
"properties": {
"k": {
"$ref": "#/components/schemas/k"
}
}
},
"k": {
"type": "object",
"properties": {
"l": {
"$ref": "#/components/schemas/a"
}
}
},
"a": {
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
}

85
test/data/validationData/detailedValidationExampleCollection.json Normal file
View File

@@ -0,0 +1,85 @@
{
"info": {
"_postman_id": "7a1d1b7f-f6c3-4ce1-8c1f-1e93fc4a470d",
"name": "lets see",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"id": "req",
"name": "Sample endpoint: Returns details about a particular user",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/user?id=1",
"host": [
"{{baseUrl}}"
],
"path": [
"user"
],
"query": [
{
"key": "id",
"value": "1",
"description": "(Required) ID of the user"
}
]
},
"body": {
"mode": "raw",
"raw": "{\n \"data\": [\n {\n \"id\": \"5e5792b234d88e12b8511b92\",\n \"accountNumber\": \"1YNykgIi3T2NDeElON0IqcPOpPI\",\n \"entityName\": \"Farmer Freddy's Veg\",\n \"entityPhone\": \"+4420832132132\",\n \"incType\": \"sole\",\n \"companyNumber\": 10000,\n \"needThisNot\": \"hello\",\n \"website\": \"https://farmer-freddy.null\",\n \"turnover\": 10000,\n \"description\": \"def\",\n \"status\": \"tradingAccepted\",\n \"offers\": [\n \"organic-vegetables\",\n \"organic-fruits\",\n \"101\"\n ],\n \"wants\": [\n \"carpentry\",\n \"beer\",\n \"beer\"\n ],\n \"isFavorite\": true\n }\n ],\n \"meta\": {\n \"notNeeded\": 1,\n \"numberOfResults\": 1,\n \"totalPages\": 1\n }\n}"
}
},
"response": [
{
"id": "res",
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/user?id=1",
"host": [
"{{baseUrl}}"
],
"path": [
"user"
],
"query": [
{
"key": "id",
"value": "1"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"id\": \"5e5792b234d88e12b8511b92\",\n \"accountNumber\": \"1YNykgIi3T2NDeElON0IqcPOpPI\",\n \"entityName\": \"Farmer Freddy's Veg\",\n \"entityPhone\": \"+4420832132132\",\n \"incType\": \"sole\",\n \"companyNumber\": \"none\",\n \"website\": \"https://farmer-freddy.null\",\n \"turnover\": 10000,\n \"description\": \"High quality carpentry at a reasonable price.\",\n \"status\": \"wrongEnum\",\n \"offers\": [\n \"organic-vegetables\",\n \"organic-fruits\"\n ],\n \"wants\": [\n \"carpentry\",\n \"beer\"\n ],\n \"isFavorite\": true\n }\n ],\n \"meta\": {\n \"numberOfResults\": 1,\n \"totalPages\": 1\n }\n}"
}
]
}
],
"variable": [
{
"id": "baseUrl",
"key": "baseUrl",
"value": "http://localhost:3000",
"type": "string"
}
],
"protocolProfileBehavior": {}
}

127
test/data/validationData/detailedValidationExampleSchema.yaml Normal file
View File

@@ -0,0 +1,127 @@
openapi: 3.0.0
info:
version: 1
title: IMPORT-202
servers:
- url: 'http://localhost:3000'
paths:
/user:
get:
summary: 'Sample endpoint: Returns details about a particular user'
operationId: listUser
tags:
- user
parameters:
- name: id
in: query
description: ID of the user
required: true
schema:
type: integer
format: int32
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Entity'
meta:
type: object
properties:
numberOfResults:
type: number
format: int32
totalPages:
type: number
format: int32
responses:
200:
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Entity'
meta:
type: object
maxProperties: 1
additionalProperties: false
propertyNames:
pattern: '^_'
properties:
numberOfResults:
type: number
format: int32
totalPages:
type: number
format: int32
components:
schemas:
Entity:
type: object
title: Entity
description: A single and unique entity linked to a user
minProperties: 50
required: [id, needThis]
dependencies:
id: [needThis, accountNumber]
properties:
id:
type: string
maxLength: 5
accountNumber:
type: string
minLength: 50
entityName:
type: string
format: ipv4
entityPhone:
type: string
incType:
type: string
const: 'Postman'
companyNumber:
type: number
exclusiveMinimum: 10000
website:
type: number
turnover:
type: integer
format: int32
multipleOf: 7
description:
type: string
pattern: '[abc]+'
status:
type: string
enum:
- pending
- accepted
- rejected
- tradingPending
- tradingAccepted
- tradingRejected
offers:
type: array
items: [
type: string,
type: string
]
additionalItems: false
wants:
type: array
uniqueItems: true
items:
type: string
isFavorite:
type: boolean
needThis:
type: string

93
test/system/structure.test.js
View File

@@ -5,70 +5,70 @@ const optionIds = [
'collapseFolders',
'requestParametersResolution',
'exampleParametersResolution',
'folderStrategy',
'indentCharacter',
'requestNameSource',
'shortValidationErrors',
'validationPropertiesToIgnore',
'showMissingInSchemaErrors'
'showMissingInSchemaErrors',
'detailedBlobValidation'
],
expectedOptions = {
collapseFolders: {
name: 'Toggle for collapsing folder for long routes',
name: 'Collapse redundant folders',
type: 'boolean',
default: true,
description: 'Determines whether the importer should attempt to collapse redundant folders into one.' +
'Folders are redundant if they have only one child element, and don\'t' +
'have any folder-level data to persist.'
description: 'Importing will collapse all folders that have only one child element and lack ' +
'persistent folder-level data.'
},
requestParametersResolution: {
name: 'Set root request parameters type',
name: 'Request parameter generation',
type: 'enum',
default: 'schema',
availableOptions: ['example', 'schema'],
description: 'Determines how request parameters (query parameters, path parameters, headers,' +
'or the request body) should be generated. Setting this to schema will cause the importer to' +
'use the parameter\'s schema as an indicator; `example` will cause the example (if provided)' +
'to be picked up.'
default: 'Schema',
availableOptions: ['Example', 'Schema'],
description: 'Select whether to generate the request parameters based on the' +
' [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the' +
' [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject)' +
' in the schema.'
},
exampleParametersResolution: {
name: 'Set example request and response parameters type',
name: 'Response parameter generation',
type: 'enum',
default: 'example',
availableOptions: ['example', 'schema'],
description: 'Determines how response parameters (query parameters, path parameters, headers,' +
'or the request body) should be generated. Setting this to schema will cause the importer to' +
'use the parameter\'s schema as an indicator; `example` will cause the example (if provided)' +
'to be picked up.'
},
folderStrategy: {
name: 'Set folder strategy',
type: 'enum',
default: 'paths',
availableOptions: ['paths', 'tags'],
description: 'Determines whether the importer should attempt to create the folders according' +
'to paths or tags which are given in the spec.'
default: 'Example',
availableOptions: ['Example', 'Schema'],
description: 'Select whether to generate the response parameters based on the' +
' [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the' +
' [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject)' +
' in the schema.'
},
indentCharacter: {
name: 'Set indent character',
type: 'enum',
default: ' ',
availableOptions: [' ', '\t'],
default: 'Space',
availableOptions: ['Space', 'Tab'],
description: 'Option for setting indentation character'
},
requestNameSource: {
name: 'Set request name source',
name: 'Naming requests',
type: 'enum',
default: 'fallback',
availableOptions: ['url', 'uKnown', 'fallback'],
description: 'Option for setting source for a request name'
default: 'Fallback',
availableOptions: ['Url', 'Fallback'],
description: 'Determines how the requests inside the generated collection will be named.' +
' If “Fallback” is selected, the request will be named after one of the following schema' +
' values: `description`, `operationid`, `url`.'
},
shortValidationErrors: {
name: 'Short error messages during request <> schema validation',
type: 'boolean',
default: false,
description: 'Whether detailed error messages are required for request <> schema validation operations.'
},
validationPropertiesToIgnore: {
name: 'Properties to ignore during validation',
type: 'array',
default: [],
description: 'Specific properties (parts of a request/response pair) to ignore during validation.' +
' Must be sent as an array of strings. Valid inputs in the array: PATHVARIABLE, QUERYPARAM,' +
' HEADER, BODY, RESPONSE_HEADER, RESPONSE_BODY'
' Must be sent as an array of strings. Valid inputs in the array: PATHVARIABLE, QUERYPARAM,' +
' HEADER, BODY, RESPONSE_HEADER, RESPONSE_BODY'
},
showMissingInSchemaErrors: {
name: 'Whether MISSING_IN_SCHEMA mismatches should be returned',
@@ -76,6 +76,14 @@ const optionIds = [
default: false,
description: 'MISSING_IN_SCHEMA indicates that an extra parameter was included in the request. For most ' +
'use cases, this need not be considered an error.'
},
detailedBlobValidation: {
name: 'Show detailed body validation messages',
id: 'detailedBlobValidation',
type: 'boolean',
default: false,
description: 'Determines whether to show detailed mismatch information for application/json content ' +
'in the request/response body.'
}
};
@@ -111,5 +119,18 @@ describe('getOptions', function() {
}
});
});
it('must return all valid options based on criteria', function () {
getOptions({ usage: ['CONVERSION'] }).forEach((option) => {
expect(option.id).to.be.oneOf(optionIds);
expect(option.usage).to.include('CONVERSION');
});
getOptions({ external: true, usage: ['VALIDATION'] }).forEach((option) => {
expect(option.id).to.be.oneOf(optionIds);
expect(option.external).to.eql(true);
expect(option.usage).to.include('VALIDATION');
});
});
});

60
test/unit/base.test.js
View File

@@ -12,6 +12,7 @@ describe('CONVERT FUNCTION TESTS ', function() {
var testSpec = path.join(__dirname, VALID_OPENAPI_PATH + '/test.json'),
testSpec1 = path.join(__dirname, VALID_OPENAPI_PATH + '/test1.json'),
issue133 = path.join(__dirname, VALID_OPENAPI_PATH + '/issue#133.json'),
issue160 = path.join(__dirname, VALID_OPENAPI_PATH, '/issue#160.json'),
unique_items_schema = path.join(__dirname, VALID_OPENAPI_PATH + '/unique_items_schema.json'),
serverOverRidingSpec = path.join(__dirname, VALID_OPENAPI_PATH + '/server_overriding.json'),
infoHavingContactOnlySpec = path.join(__dirname, VALID_OPENAPI_PATH + '/info_having_contact_only.json'),
@@ -30,7 +31,44 @@ describe('CONVERT FUNCTION TESTS ', function() {
requiredInParams = path.join(__dirname, VALID_OPENAPI_PATH, '/required_in_parameters.json'),
multipleRefs = path.join(__dirname, VALID_OPENAPI_PATH, '/multiple_refs.json'),
issue150 = path.join(__dirname, VALID_OPENAPI_PATH + '/issue#150.yml'),
issue173 = path.join(__dirname, VALID_OPENAPI_PATH, '/issue#173.yml');
issue173 = path.join(__dirname, VALID_OPENAPI_PATH, '/issue#173.yml'),
issue152 = path.join(__dirname, VALID_OPENAPI_PATH, '/path-refs-error.yaml'),
tooManyRefs = path.join(__dirname, VALID_OPENAPI_PATH, '/too-many-refs.json');
it('Should generate collection conforming to schema for and fail if not valid ' +
tooManyRefs, function(done) {
var openapi = fs.readFileSync(tooManyRefs, 'utf8'),
body;
Converter.convert({ type: 'string', data: openapi }, { schemaFaker: true }, (err, conversionResult) => {
expect(err).to.be.null;
expect(conversionResult.result).to.equal(true);
expect(conversionResult.output.length).to.equal(1);
expect(conversionResult.output[0].type).to.equal('collection');
expect(conversionResult.output[0].data).to.have.property('info');
expect(conversionResult.output[0].data).to.have.property('item');
body = conversionResult.output[0].data.item[1].response[0].body;
expect(body).to.not.contain('<Error: Too many levels of nesting to fake this schema>');
done();
});
});
it('Should generate collection conforming to schema for and fail if not valid ' +
issue152, function(done) {
var openapi = fs.readFileSync(issue152, 'utf8'),
refNotFound = 'reference #/paths/~1pets/get/responses/200/content/application~1json/schema/properties/newprop' +
' not found in the OpenAPI spec';
Converter.convert({ type: 'string', data: openapi }, { schemaFaker: true }, (err, conversionResult) => {
expect(err).to.be.null;
expect(conversionResult.result).to.equal(true);
expect(conversionResult.output.length).to.equal(1);
expect(conversionResult.output[0].type).to.equal('collection');
expect(conversionResult.output[0].data).to.have.property('info');
expect(conversionResult.output[0].data).to.have.property('item');
expect(conversionResult.output[0].data.item[0].item[1].response[1].body).to.not.contain(refNotFound);
done();
});
});
it('Should generate collection conforming to schema for and fail if not valid ' +
testSpec, function(done) {
@@ -79,6 +117,21 @@ describe('CONVERT FUNCTION TESTS ', function() {
});
});
it('#GITHUB-160 should generate correct display url for path containing servers' +
issue160, function(done) {
var openapi = fs.readFileSync(issue160, 'utf8');
Converter.convert({ type: 'string', data: openapi }, {}, (err, conversionResult) => {
expect(err).to.be.null;
expect(conversionResult.result).to.equal(true);
expect(conversionResult.output.length).to.equal(1);
expect(conversionResult.output[0].type).to.equal('collection');
expect(conversionResult.output[0].data).to.have.property('info');
expect(conversionResult.output[0].data).to.have.property('item');
expect(conversionResult.output[0].data.item[0].item[0].request.url.host[0]).to.equal('{{petsUrl}}');
done();
});
});
it('Should not get stuck while resolving circular references' +
unique_items_schema, function(done) {
Converter.convert({ type: 'file', data:
@@ -163,12 +216,13 @@ describe('CONVERT FUNCTION TESTS ', function() {
let request = conversionResult.output[0].data.item[1].request,
protocol = request.url.protocol,
host = request.url.host.join('.'),
port = request.url.port,
path = request.url.path.join('/'),
endPoint = protocol + '://' + host + '/' + path,
endPoint = protocol + '://' + host + ':' + port + '/' + path,
host1 = conversionResult.output[0].data.variable[0].value,
path1 = conversionResult.output[0].data.item[0].request.url.path.join('/'),
endPoint1 = host1 + '/' + path1;
expect(endPoint).to.equal('https://other-api.example.com/secondary-domain/fails');
expect(endPoint).to.equal('http://petstore.swagger.io:{{port}}/:basePath/secondary-domain/fails');
expect(endPoint1).to.equal('https://api.example.com/primary-domain/works');
done();
});

26
test/unit/deref.test.js
View File

@@ -24,6 +24,9 @@ describe('DEREF FUNCTION TESTS ', function() {
}
}]
},
schemaWithTypeArray = {
$ref: '#/components/schemas/schemaTypeArray'
},
componentsAndPaths = {
components: {
schemas: {
@@ -69,6 +72,14 @@ describe('DEREF FUNCTION TESTS ', function() {
format: 'email'
}
}
},
schemaTypeArray: {
type: 'array',
items: {
type: 'string'
},
minItems: 5,
maxItems: 55
}
}
}
@@ -77,7 +88,9 @@ describe('DEREF FUNCTION TESTS ', function() {
output = deref.resolveRefs(schema, parameterSource, componentsAndPaths),
output_withdot = deref.resolveRefs(schemaWithDotInKey, parameterSource, componentsAndPaths),
output_customFormat = deref.resolveRefs(schemaWithCustomFormat, parameterSource, componentsAndPaths),
output_withAllOf = deref.resolveRefs(schemaWithAllOf, parameterSource, componentsAndPaths);
output_withAllOf = deref.resolveRefs(schemaWithAllOf, parameterSource, componentsAndPaths),
output_validationTypeArray = deref.resolveRefs(schemaWithTypeArray, parameterSource, componentsAndPaths,
{}, 'VALIDATION');
expect(output).to.deep.include({ type: 'object',
@@ -100,6 +113,17 @@ describe('DEREF FUNCTION TESTS ', function() {
}
});
// deref.resolveRef() should not change minItems and maxItems for VALIDATION
expect(output_validationTypeArray).to.deep.include({
type: 'array',
items: {
type: 'string',
default: '<string>'
},
minItems: 5,
maxItems: 55
});
done();
});

4
test/unit/util.test.js
View File

@@ -2070,8 +2070,8 @@ describe('SCHEMA UTILITY FUNCTION TESTS ', function () {
resultObj = SchemaUtils.sanitizeUrlPathParams('/anotherpath/{{path}}/{{new-path-variable}}.{{onemore}}',
pathParams);
expect(resultObj).to.have.property('reqUrl');
expect(resultObj.reqUrl).to.equal('/anotherpath/:path/{{new-path-variable}}.{{onemore}}');
expect(resultObj).to.have.property('url');
expect(resultObj.url).to.equal('/anotherpath/:path/{{new-path-variable}}.{{onemore}}');
expect(resultObj).to.have.property('pathVars');
expect(resultObj).to.have.property('collectionVars');