-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
182 lines (154 loc) · 5.08 KB
/
index.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
'use strict';
const fs = require('fs');
const protagonist = require('protagonist');
class ServerlessApibValidator {
constructor(serverless, options) {
this.serverless = serverless;
this.commands = {
validate: {
usage: 'Validate that an API Blueprint has full coverage over a Serverless config',
lifecycleEvents: ['start']
}
};
this.hooks = {
'before:package:initialize': this.validate.bind(this),
'validate:start': this.validate.bind(this, true)
};
}
getOptions() {
return Object.assign({
blueprintFile: './apiary.apib',
basePath: ''
}, this.serverless.service.custom && this.serverless.service.custom.apibValidator || {});
}
/**
* Validate the API blueprint file against a serverless.yml
*/
validate(isCommand = false) {
const options = this.getOptions();
if(isCommand) {
console.log('Validating API blueprint...');
}
if(typeof this.serverless.service.functions == 'undefined') {
if(isCommand) {
console.log('⚠️ No functions defined.');
}
return Promise.resolve();
}
return new Promise((resolve, reject) => {
// Load the API blueprint file
let apib;
try {
apib = fs.readFileSync(options.blueprintFile, 'utf-8');
} catch(e) {
reject(`🚫 API Blueprint file was not found at ${options.blueprintFile}.`);
return;
}
// Get a list of every function defined in serverless.yml
const lambdaEndpoints = [];
const functions = this.serverless.service.functions;
Object.keys(this.serverless.service.functions)
.forEach(name => {
if(!functions[name].events) {
return;
}
functions[name].events
.filter(e => !!e.http)
.forEach(event =>
lambdaEndpoints.push(Object.assign({}, event.http, { name }))
);
});
// Parse the API blueprint
protagonist.parse(apib, (err, blueprint) => {
if(err) {
reject(err);
return;
}
let annotation = null;
this.traverseContent(blueprint.content, 'annotation', a => {
annotation = a;
});
if(annotation) {
reject('🚫 API Blueprint is not valid.\n\t' + annotation.content);
return;
}
const endpointsDocumented = [];
// Find every resource
this.traverseContent(blueprint.content, 'resource', resource => {
if(resource.attributes.href.element == 'string') {
const resourcePath = resource.attributes.href.content;
// Find every action
this.traverseContent(resource.content, 'transition', transition => {
const transitionPath = transition.attributes && transition.attributes.href
? transition.attributes.href.content
: null;
const methodsFound = [];
this.traverseContent(transition.content, 'httpRequest', request => {
const method = request.attributes.method;
if(methodsFound.indexOf(request) == -1) {
methodsFound.push(method);
endpointsDocumented.push({
path: transitionPath || resourcePath,
method: method
});
}
});
});
}
});
const notDocumented = [];
lambdaEndpoints.forEach(endpoint => {
const matchPath = this.cleanPath(options.basePath + endpoint.path);
const matchMethod = endpoint.method.toLowerCase();
const isDocumented = endpointsDocumented.find(doc => {
const docPath = this.cleanPath(doc.path);
const docMethod = doc.method.content.toLowerCase();
return docPath === matchPath && docMethod === matchMethod;
});
if(!isDocumented) {
notDocumented.push(endpoint.name);
}
});
if(notDocumented.length > 0) {
// Stop the serverless deployment
reject(`🚫 API Blueprint does not contain documentation for the following functions:\n\n\t${notDocumented.join(', ')}`);
return;
}
// The API Blueprint is valid
resolve();
if(isCommand) {
console.log('✅ API Blueprint is valid');
}
});
});
}
/**
* Loop through a section of AST content and run
* a callback every time an element is found.
*
* @param {Object} content
* @param {string} element
* @param {function} callback
*/
traverseContent(content, element, callback) {
if(!content || !Array.isArray(content)) {
return;
}
content.forEach(item => {
if(item.element === element) {
callback(item);
} else {
this.traverseContent(item.content, element, callback);
}
});
}
/**
* Remove optional paramters and trailing slash
*
* @param {string} path
*/
cleanPath(path) {
return path.replace(/{\?[^=]+}/g, '').replace(/\/$/, '');
}
}
module.exports = ServerlessApibValidator;