-
Notifications
You must be signed in to change notification settings - Fork 22
/
validatable-http-message.coffee
316 lines (257 loc) · 9.86 KB
/
validatable-http-message.coffee
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
jsonlint = require 'jsonlint'
mediaTyper = require 'media-typer'
validators = require '../validators'
# validatable mixin.
#
# @mixin
# @author Peter Grilli <tully@apiary.io>
class Validatable
validatableComponents: ['headers', 'body', 'statusCode']
#Validates all HTTP components available in the message
#@return [Object] :headers {ValidationErrors}, :body {ValidationErrors}, :statusCode [Boolean]
validate: ->
@validation = {}
@validation.version = '2'
@lowercaseHeaders()
@validateHeaders() if @headers? and @expected?.headers?
@validateBody() if @body? and (@expected.body? or @expected.bodySchema?)
@validateStatusCode() if @statusCode?
@validation
#returns true if object has any validatable entity
#@return [Boolean]
isValidatable: ->
result = false
for component in @validatableComponents
if @[component]?
result = true
return result
# returns false if any validatable HTTP component has validation
# property with any result messages with the error severity
# @return [Boolean]
isValid: ->
@validate() unless @validation?
for component in @validatableComponents
if Array.isArray @validation[component]?.results
for result in @validation[component].results when result.severity is 'error'
return false
return true
validationResults: ->
@validate() unless @validation?
@validation
lowercaseHeaders: ->
if @headers?
headers = {}
for name, value of @headers
headers[name.toLowerCase()] = value
@headers = headers
if @expected?.headers?
expectedHeaders = {}
for name, value of @expected.headers
expectedHeaders[name.toLowerCase()] = value
@expected.headers = expectedHeaders
# Headers validation
validateHeaders: ->
@validation.headers = {}
@validation.headers.results = []
@setHeadersRealType()
@setHeadersExpectedType()
@setHeadersValidator()
@runHeadersValidator()
setHeadersRealType: () ->
if @headers instanceof Object and not Array.isArray @headers
@validation.headers.realType =
"application/vnd.apiary.http-headers+json"
else
@validation.headers.realType = null
setHeadersExpectedType: () ->
if @expected.headers instanceof Object and not Array.isArray @expected.headers
@validation.headers.expectedType =
"application/vnd.apiary.http-headers+json"
else
@validation.headers.expectedType = null
setHeadersValidator: () ->
if @validation.headers.realType is @validation.headers.expectedType is
"application/vnd.apiary.http-headers+json"
@validation.headers.validator = "HeadersJsonExample"
else
@validation.headers.validator = null
@validation.headers.results ?= []
entry =
severity: 'error'
message: """
No validator found for real data media type \
"#{JSON.stringify(@validation.headers.realType)}" \
and expected data media type \
"#{JSON.stringify(@validation.headers.expectedType)}".
"""
@validation.headers.results.push entry
runHeadersValidator: () ->
#throw new Error JSON.stringify @validation.headers.validator, null, 2
if @validation.headers.validator == null
@validation.headers.rawData = null
else
validatorClass = validators[@validation.headers.validator]
validator = new validatorClass @headers, @expected.headers
@validation.headers.rawData = validator.validate()
if not Array.isArray @validation.headers.results
@validation.headers.results = []
if @validation.headers.rawData != null
results = validator.evaluateOutputToResults()
@validation.headers.results = results.concat @validation.headers.results
# Body validation
validateBody: () ->
@validation.body = {}
@validation.body.results = []
@setBodyRealType()
@setBodyExpectedType()
@setBodyValidator()
@runBodyValidator()
setBodyRealType: () ->
@validation.body.realType = null
unless typeof @body == 'string'
throw new Error "HTTP Body is not a String."
contentType = @headers?['content-type']
if @isJsonContentType contentType
try
jsonlint.parse @body
@validation.body.realType = contentType
catch error
message = {
message: 'Real body "Content-Type" header is "' +
contentType + '" but body is not a parseble JSON.'
severity: 'error'
}
message.message = message.message + "\n" + error.message
@validation.body.results.push message
else
try
JSON.parse @body
@validation.body.realType = 'application/json'
catch error
@validation.body.realType = 'text/plain'
setBodyExpectedType: () ->
@validation.body.expectedType = null
@validation.body.results ?= []
if @expected.bodySchema?
if typeof @expected.bodySchema == 'string'
try
parsed = JSON.parse @expected.bodySchema
if typeof parsed != 'object' or Array.isArray parsed
message = {
message: 'Cant\'t validate. Expected body JSON Schema is not an Object'
severity: 'error'
}
@validation.body.results.push message
else
@validation.body.expectedType = 'application/schema+json'
catch error
message = {
message: 'Can\'t validate. Expected body JSON Schema is not a parseable JSON'
severity: 'error'
}
@validation.body.results.push message
return
else
@validation.body.expectedType = 'application/schema+json'
else
expectedContentType = @expected.headers?['content-type']
if @isJsonContentType expectedContentType
try
jsonlint.parse @expected.body
@validation.body.expectedType = expectedContentType
catch error
message = {
message: 'Can\'t validate. Expected body Content-Type is ' + expectedContentType + ' but body is not a parseable JSON'
severity: 'error'
}
message.message = message.message + ": " +error.message
@validation.body.results.push message
else
try
JSON.parse @expected.body
@validation.body.expectedType = 'application/json'
catch error
@validation.body.expectedType = 'text/plain'
setBodyValidator: () ->
@validation.body.validator = null
@validation.body.results ?= []
errorsLength = @validation.body.results.reduce (prev, result, index, array) ->
prev += 1 if result['severity'] == 'error'
, 0
if errorsLength == 0
if @isJsonContentType @validation.body.realType
if @validation.body.expectedType == 'application/schema+json'
@validation.body.validator = 'JsonSchema'
else if @isJsonContentType @validation.body.expectedType
@validation.body.validator = 'JsonExample'
else
message =
message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.realType}'."
severity: 'error'
@validation.body.results.push message
else if @validation.body.realType == 'text/plain'
if @validation.body.expectedType == 'text/plain'
@validation.body.validator = 'TextDiff'
else
message =
message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.realType}'."
severity: 'error'
@validation.body.results.push message
else
message =
message: "Can't validate real media type '#{@validation.body.realType}' against expected media type '#{@validation.body.realType}'."
severity: 'error'
@validation.body.results.push message
runBodyValidator: () ->
if @validation.body.validator == null
@validation.body.rawData = null
else
validatorClass = validators[@validation.body.validator]
if @validation.body.validator == 'JsonSchema'
real = @body
expected = @expected.bodySchema
else
real = @body
expected = @expected.body
if @validation.body.validator != null
if not Array.isArray @validation.body.results
@validation.body.results = []
try
validator = new validatorClass real, expected
@validation.body.rawData = validator.validate()
results = validator.evaluateOutputToResults()
@validation.body.results = results.concat @validation.body.results
catch error
message =
message: error.message
severity: 'error'
@validation.body.results.push message
# Status code validation
validateStatusCode: () ->
@validation.statusCode = {}
@validation.statusCode.realType = "text/vnd.apiary.status-code"
@validation.statusCode.expectedType = "text/vnd.apiary.status-code"
@validation.statusCode.validator = 'TextDiff'
real = String(@statusCode).trim()
expected = String(@expected.statusCode).trim()
validator = new validators.TextDiff real, expected
@validation.statusCode.rawData = validator.validate()
@validation.statusCode.results = []
results = validator.evaluateOutputToResults()
@validation.statusCode.results = results.concat @validation.statusCode.results
@validation.statusCode.results = @validation.statusCode.results.map (current, index, arr) ->
if current.message = 'Real and expected data does not match.'
current.message = "Status code is not '#{expected}'"
current
isJsonContentType: (contentType) ->
result = false
if contentType?
parsed = mediaTyper.parse "#{contentType}"
if parsed['type'] == 'application' and parsed['subtype'] == 'json'
result = true
if parsed['suffix'] == 'json'
result = true
result
module.exports = {
Validatable
}