Files
zulip/tools/check-openapi
orientor 9170931da3 openapi: Add test for validating examples.
Zulip's openapi specification in zulip.yaml has various examples
for various schemas. Validate the example with their respective
schemas to ensure that all the examples are schematically correct.

Part of #14100.
2020-05-12 23:03:06 -07:00

43 lines
1.4 KiB
JavaScript
Executable File

#!/usr/bin/env node
const fs = require('fs');
const jsyaml = require('js-yaml');
const SwaggerParser = require('swagger-parser');
const ExampleValidator = require('openapi-examples-validator');
(async () => {
// Iterate through the changed files, passed in the arguments.
// The two first arguments are the call to the Node interpreter and this
// script, hence the starting point at 2.
for (const file of process.argv.slice(2)) {
try {
if (
jsyaml.safeLoad(await fs.promises.readFile(file, 'utf8'), {
filename: file,
}).openapi !== undefined
) {
await SwaggerParser.validate(file);
const res = await ExampleValidator.validateFile(file);
if (!res.valid) {
for (const error of res.errors) {
console.error(error);
}
process.exitCode = 1;
}
}
} catch (error) {
if (error instanceof jsyaml.YAMLException) {
console.error(error.message);
} else if (error instanceof SyntaxError) {
console.error(`${file}: ${error.message}`);
} else {
throw error;
}
process.exitCode = 1;
}
}
})().catch((error) => {
console.error(error);
process.exit(1);
});