forked from Azure/oav
-
Notifications
You must be signed in to change notification settings - Fork 0
/
validate.js
134 lines (123 loc) · 5.3 KB
/
validate.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
'use strict';
var msrest = require('ms-rest'),
msrestazure = require('ms-rest-azure'),
ResourceManagementClient = require('azure-arm-resource').ResourceManagementClient,
log = require('./lib/util/logging'),
utils = require('./lib/util/utils'),
Constants = require('./lib/util/constants'),
path = require('path'),
util = require('util'),
SpecValidator = require('./lib/specValidator');
exports.finalValidationResult = { validityStatus: true };
exports.getDocumentsFromCompositeSwagger = function getDocumentsFromCompositeSwagger(compositeSpecPath) {
let compositeSwagger;
let finalDocs = [];
return utils.parseJson(compositeSpecPath).then(function (result) {
compositeSwagger = result;
if (!(compositeSwagger.documents && Array.isArray(compositeSwagger.documents) && compositeSwagger.documents.length > 0)) {
throw new Error(`CompositeSwagger - ${compositeSpecPath} must contain a documents property and it must be of type array and it must be a non empty array.`);
}
let docs = compositeSwagger.documents;
let basePath = path.dirname(compositeSpecPath);
for (let i = 0; i < docs.length; i++) {
if (docs[i].startsWith('.')) {
docs[i] = docs[i].substring(1);
}
let individualPath = '';
if (docs[i].startsWith('http')) {
individualPath = docs[i];
} else {
individualPath = basePath + docs[i];
}
finalDocs.push(individualPath);
}
return finalDocs;
}).catch(function (err) {
log.error(err);
return Promise.reject(err);
});
};
exports.validateSpec = function validateSpec(specPath, consoleLogLevel, logFilepath) {
log.consoleLogLevel = consoleLogLevel || log.consoleLevel;
log.filepath = logFilepath || log.filepath;
let validator = new SpecValidator(specPath);
exports.finalValidationResult[specPath] = validator.specValidationResult;
return validator.initialize().then(function () {
log.info(`Semantically validating ${specPath}:\n`);
return validator.validateSpec().then(function (result) {
exports.updateEndResultOfSingleValidation(validator);
exports.logDetailedInfo(validator);
return Promise.resolve(validator.specValidationResult);
});
}).catch(function (err) {
log.error(err);
return Promise.reject(err);
});
};
exports.validateCompositeSpec = function validateCompositeSpec(compositeSpecPath, consoleLogLevel, logFilepath) {
log.consoleLogLevel = consoleLogLevel || log.consoleLevel;
log.filepath = logFilepath || log.filepath;
return exports.getDocumentsFromCompositeSwagger(compositeSpecPath).then(function (docs) {
let promiseFactories = docs.map(function (doc) {
return function () { return exports.validateSpec(doc, consoleLogLevel, logFilepath) };
});
return utils.executePromisesSequentially(promiseFactories);
}).catch(function (err) {
log.error(err);
return Promise.reject(err);
});
};
exports.validateExamples = function validateExamples(specPath, operationIds, consoleLogLevel, logFilepath) {
log.consoleLogLevel = consoleLogLevel || log.consoleLevel;
log.filepath = logFilepath || log.filepath;
let validator = new SpecValidator(specPath);
exports.finalValidationResult[specPath] = validator.specValidationResult;
return validator.initialize().then(function () {
log.info(`Validating "examples" and "x-ms-examples" in ${specPath}:\n`);
validator.validateOperations(operationIds);
exports.updateEndResultOfSingleValidation(validator);
exports.logDetailedInfo(validator);
return Promise.resolve(validator.specValidationResult);
}).catch(function (err) {
log.error(err);
return Promise.reject(err);
});
};
exports.validateExamplesInCompositeSpec = function validateExamplesInCompositeSpec(compositeSpecPath, consoleLogLevel, logFilepath) {
log.consoleLogLevel = consoleLogLevel || log.consoleLevel;
log.filepath = logFilepath || log.filepath;
return exports.getDocumentsFromCompositeSwagger(compositeSpecPath).then(function (docs) {
let promiseFactories = docs.map(function (doc) {
return function () { return exports.validateExamples(doc, consoleLogLevel, logFilepath); }
});
return utils.executePromisesSequentially(promiseFactories);
}).catch(function (err) {
log.error(err);
return Promise.reject(err);
});
};
exports.updateEndResultOfSingleValidation = function updateEndResultOfSingleValidation(validator) {
if (validator.specValidationResult.validityStatus) {
if (!(log.consoleLogLevel === 'json' || log.consoleLogLevel === 'off')) {
let consoleLevel = log.consoleLogLevel;
log.consoleLogLevel = 'info';
log.info('No Errors were found.');
log.consoleLogLevel = consoleLevel;
}
}
if (!validator.specValidationResult.validityStatus) {
exports.finalValidationResult.validityStatus = validator.specValidationResult.validityStatus;
}
return;
};
exports.logDetailedInfo = function logDetailedInfo(validator) {
if (log.consoleLogLevel === 'json') {
console.dir(validator.specValidationResult, { depth: null, colors: true });
}
log.silly('############################');
log.silly(validator.specValidationResult);
log.silly('----------------------------');
};
exports = module.exports;