-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding semantic and model validator to CI (#910)
* added model validation and more refactoring * Dependency on master of openapi-validation-tools
- Loading branch information
1 parent
3015ce5
commit 2940a1c
Showing
9 changed files
with
374 additions
and
257 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. See License in the project root for license information. | ||
|
|
||
| 'use strict'; | ||
| var _ = require('lodash'), | ||
| utils = require('./util/utils'), | ||
| oav = require('openapi-validation-tools'); | ||
|
|
||
| describe('Azure swagger model validation using x-ms-examples and examples in spec', function () { | ||
| let swaggersToProcess = utils.getFilesChangedInPR(); | ||
| _(swaggersToProcess).each(function (swagger) { | ||
| it(swagger + ' should have valid examples.', function (done) { | ||
| oav.validateExamples(swagger, null, false, 'error').catch(function (err) { | ||
| console.log(err); | ||
| }); | ||
| done(); | ||
| }); | ||
| }).value(); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. See License in the project root for license information. | ||
|
|
||
| 'use strict'; | ||
| var _ = require('lodash'), | ||
| utils = require('./util/utils'), | ||
| oav = require('openapi-validation-tools'); | ||
|
|
||
| describe('Azure swagger semantic validation:', function () { | ||
| let swaggersToProcess = utils.getFilesChangedInPR(); | ||
| _(swaggersToProcess).each(function (swagger) { | ||
| it(swagger + ' should be semantically valid.', function (done) { | ||
| oav.validateSpec(swagger, false, 'error').catch(function (err) { | ||
| console.log(err); | ||
| }); | ||
| done(); | ||
| }); | ||
| }).value(); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. See License in the project root for license information. | ||
|
|
||
| 'use strict'; | ||
| var assert = require("assert"), | ||
| fs = require('fs'), | ||
| path = require('path'), | ||
| _ = require('lodash'), | ||
| async = require('async'), | ||
| RefParser = require('json-schema-ref-parser'), | ||
| util = require('util'), | ||
| utils = require('./util/utils'); | ||
|
|
||
| var context; | ||
|
|
||
|
|
||
| // Useful when debugging a test for a particular swagger. | ||
| // Just update the regex. That will return an array of filtered items. | ||
| // swaggers = swaggers.filter(function(item) { | ||
| // return (item.match(/.*arm-redis.*/ig) !== null); | ||
| // }); | ||
|
|
||
|
|
||
| describe('Azure swagger schema validation:', function () { | ||
| before(function (done) { | ||
| utils.initializeValidator(function (err, result) { | ||
| if (err) { | ||
| done(err); | ||
| } | ||
| context = result; | ||
| done(); | ||
| }); | ||
| }); | ||
|
|
||
| _(utils.swaggers).each(function (swagger) { | ||
| it(swagger + ' should be a valid Swagger document.', function (done) { | ||
| utils.parseJsonFromFile(swagger, function (err, parsedData) { | ||
| if (err) { done(err); } | ||
| if (parsedData.documents && util.isArray(parsedData.documents)) { | ||
| console.log(util.format('Skipping the test for \'%s\' document as it seems to be a composite swagger doc.', swagger)); | ||
| done(); | ||
| } | ||
| var valid = context.validator.validate(parsedData, context.extensionSwaggerSchema); | ||
| if (!valid) { | ||
| var error = context.validator.getLastErrors(); | ||
| throw new Error("Schema validation failed: " + util.inspect(error, { depth: null })); | ||
| } | ||
| assert(valid === true); | ||
| done(); | ||
| }); | ||
| }); | ||
| }).value(); | ||
|
|
||
| describe('Azure composite swagger schema validation:', function () { | ||
| _(utils.compositeSwaggers).each(function (compositeSwagger) { | ||
| it('composite: ' + compositeSwagger + ' should be a valid Composite Swagger document.', function (done) { | ||
| utils.parseJsonFromFile(compositeSwagger, function (err, parsedData) { | ||
| if (err) { done(err); } | ||
| var valid = context.validator.validate(parsedData, context.compositeSchema); | ||
| if (!valid) { | ||
| var error = context.validator.getLastErrors(); | ||
| throw new Error("Schema validation for Composite Swagger failed: " + util.inspect(error, { depth: null })); | ||
| } | ||
| assert(valid === true); | ||
| var compositeSwaggerDir = path.dirname(compositeSwagger); | ||
| var messages = []; | ||
| if (parsedData.documents && parsedData.documents.length > 0) { | ||
| async.eachSeries(parsedData.documents, function (docUrl, loopCallback) { | ||
| //construct the absolue path if the item in the documents array is a relative path | ||
| if (!path.isAbsolute(docUrl) && !docUrl.startsWith('http')) { | ||
| docUrl = path.join(compositeSwaggerDir, docUrl); | ||
| } | ||
| //make a request if it is a url | ||
| if (docUrl.startsWith('http')) { | ||
| request({ url: docUrl, json: true }, function (error, response, responseBody) { | ||
| if (error) { | ||
| messages.push('An error occurred while accessing the swagger doc ' + | ||
| docUrl + ' from the documents list. The error is ' + util.inspect(error, { depth: null })); | ||
| } | ||
| if (response.statusCode !== 200) { | ||
| messages.push('\'' + response.statusCode + '\': \'File Not Found\'- error occurred while accessing the swagger doc ' + | ||
| docUrl + ' from the documents list.'); | ||
| } | ||
| loopCallback(); | ||
| }); | ||
| } else { | ||
| //check whether the file exists | ||
| if (!fs.existsSync(docUrl)) { | ||
| messages.push('\'File Not Found\': error occurred while accessing the swagger doc ' + | ||
| docUrl + ' from the documents list on the host filesystem.'); | ||
| } | ||
| loopCallback(); | ||
| } | ||
| }, function (err) { | ||
| if (err) { | ||
| throw err; | ||
| } | ||
| if (messages.length > 0) { | ||
| throw new Error(JSON.stringify(messages)); | ||
| } | ||
| done(); | ||
| }); | ||
| } else { | ||
| done(); | ||
| } | ||
| }); | ||
| }); | ||
| }).value(); | ||
| }); | ||
|
|
||
| describe('Azure x-ms-example schema validation:', function () { | ||
| _(utils.examples).each(function (example) { | ||
| it('x-ms-examples: ' + example + ' should be a valid x-ms-example.', function (done) { | ||
| utils.parseJsonFromFile(example, function (err, parsedData) { | ||
| if (err) { done(err); } | ||
| var valid = context.validator.validate(parsedData, context.exampleSchema); | ||
| if (!valid) { | ||
| var error = context.validator.getLastErrors(); | ||
| throw new Error("Schema validation failed: " + util.inspect(error, { depth: null })); | ||
| } | ||
| assert(valid === true); | ||
| done(); | ||
| }); | ||
| }); | ||
| }).value(); | ||
| }); | ||
| }); | ||
|
|
||
| describe('External file or url references ("$ref") in a swagger spec:', function () { | ||
| _(utils.swaggers).each(function (swagger) { | ||
| it(swagger + ' should be completely resolvable.', function (done) { | ||
| RefParser.bundle(swagger, function (bundleErr, bundleResult) { | ||
| if (bundleErr) { | ||
| var msg = swagger + ' has references that cannot be resolved. They are as follows: \n' + util.inspect(bundleErr.message, { depth: null }); | ||
| console.log(msg); | ||
| throw new Error(msg); | ||
| } | ||
| done(); | ||
| }); | ||
| }); | ||
| }).value(); | ||
| }); |
Oops, something went wrong.