committee 5.6.3 → 5.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/committee/drivers/open_api_2/driver.rb +16 -0
- data/lib/committee/drivers/open_api_2/link.rb +2 -0
- data/lib/committee/drivers/open_api_3/schema.rb +6 -1
- data/lib/committee/drivers.rb +15 -8
- data/lib/committee/middleware/options/response_validation.rb +4 -2
- data/lib/committee/middleware/response_validation.rb +37 -10
- data/lib/committee/middleware/stub.rb +1 -1
- data/lib/committee/request_unpacker.rb +19 -9
- data/lib/committee/schema_locations.rb +96 -0
- data/lib/committee/schema_validator/hyper_schema/request_validator.rb +1 -1
- data/lib/committee/schema_validator/hyper_schema/response_validator.rb +14 -4
- data/lib/committee/schema_validator/hyper_schema.rb +5 -4
- data/lib/committee/schema_validator/open_api_3/operation_wrapper.rb +76 -40
- data/lib/committee/schema_validator/open_api_3/parameter_deserializer.rb +66 -20
- data/lib/committee/schema_validator/open_api_3/request_validator.rb +2 -3
- data/lib/committee/schema_validator/open_api_3/response_validator.rb +2 -1
- data/lib/committee/schema_validator/open_api_3/router.rb +1 -3
- data/lib/committee/schema_validator/open_api_3.rb +26 -18
- data/lib/committee/schema_validator/option.rb +2 -1
- data/lib/committee/schema_validator.rb +1 -5
- data/lib/committee/test/except_parameter.rb +4 -4
- data/lib/committee/test/methods.rb +14 -1
- data/lib/committee/test/schema_coverage.rb +11 -2
- data/lib/committee/utils.rb +6 -0
- data/lib/committee/validation_error.rb +1 -1
- data/lib/committee/version.rb +1 -1
- data/lib/committee.rb +1 -0
- data/test/drivers/open_api_2/driver_test.rb +13 -0
- data/test/drivers_test.rb +39 -8
- data/test/middleware/options/response_validation_test.rb +15 -0
- data/test/middleware/request_validation_open_api_3_test.rb +670 -8
- data/test/middleware/request_validation_test.rb +50 -0
- data/test/middleware/response_validation_open_api_3_test.rb +162 -0
- data/test/middleware/response_validation_test.rb +134 -0
- data/test/middleware/stub_test.rb +10 -0
- data/test/request_unpacker_test.rb +34 -0
- data/test/schema_location_test.rb +111 -0
- data/test/schema_validator/hyper_schema/response_validator_test.rb +16 -0
- data/test/schema_validator/open_api_3/operation_wrapper_test.rb +95 -0
- data/test/schema_validator/open_api_3/parameter_deserializer_test.rb +145 -8
- data/test/schema_validator/open_api_3_test.rb +27 -0
- data/test/schema_validator_test.rb +10 -0
- data/test/test/methods_test.rb +200 -0
- data/test/test/schema_coverage_test.rb +34 -0
- data/test/test_helper.rb +23 -0
- data/test/utils_test.rb +28 -0
- data/test/validation_error_test.rb +1 -1
- metadata +22 -4
|
@@ -156,6 +156,63 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
|
|
|
156
156
|
assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
|
|
157
157
|
end
|
|
158
158
|
|
|
159
|
+
describe 'same-named path and query parameters' do
|
|
160
|
+
%w[get post].each do |method|
|
|
161
|
+
describe method do
|
|
162
|
+
before do
|
|
163
|
+
@path = '/overwrite_same_parameter/123'
|
|
164
|
+
@method = method
|
|
165
|
+
data = open_api_3_data
|
|
166
|
+
path_item = data['paths']['/overwrite_same_parameter/{integer}']
|
|
167
|
+
path_item[method] = path_item['post']
|
|
168
|
+
@open_api_3_schema = Committee::Drivers.load_from_data(data, open_api_3_schema_path, parser_options: { strict_reference_validation: true })
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
it 'rejects an invalid query value without overwriting it with the path value' do
|
|
172
|
+
path_params = { 'integer' => 123 }
|
|
173
|
+
query_params = { 'integer' => 'not-an-integer' }
|
|
174
|
+
|
|
175
|
+
error = assert_raises(Committee::InvalidRequest) do
|
|
176
|
+
operation_object.validate_request_params(path_params, query_params, {}, HEADER, @validator_option)
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
assert_match(/expected integer, but received String: "not-an-integer"/i, error.message)
|
|
180
|
+
assert_kind_of(OpenAPIParser::OpenAPIError, error.original_error)
|
|
181
|
+
assert_equal({ 'integer' => 'not-an-integer' }, query_params)
|
|
182
|
+
assert_equal({ 'integer' => 123 }, path_params)
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
it 'rejects a missing required query parameter even when the path parameter is present' do
|
|
186
|
+
error = assert_raises(Committee::InvalidRequest) do
|
|
187
|
+
operation_object.validate_request_params({ 'integer' => 123 }, {}, {}, HEADER, @validator_option)
|
|
188
|
+
end
|
|
189
|
+
|
|
190
|
+
assert_match(/missing required parameters: integer/i, error.message)
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
it 'coerces the query value independently of the path value' do
|
|
194
|
+
path_params = { 'integer' => 123 }
|
|
195
|
+
query_params = { 'integer' => '456' }
|
|
196
|
+
|
|
197
|
+
operation_object.validate_request_params(path_params, query_params, {}, HEADER, @validator_option)
|
|
198
|
+
|
|
199
|
+
assert_equal({ 'integer' => 123 }, path_params)
|
|
200
|
+
assert_equal({ 'integer' => 456 }, query_params)
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
it 'honors disabled query coercion even when the path value is already an integer' do
|
|
204
|
+
options = Committee::SchemaValidator::Option.new({ coerce_query_params: false }, open_api_3_schema, :open_api_3)
|
|
205
|
+
|
|
206
|
+
error = assert_raises(Committee::InvalidRequest) do
|
|
207
|
+
operation_object.validate_request_params({ 'integer' => 123 }, { 'integer' => '456' }, {}, HEADER, options)
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
assert_match(/expected integer, but received String: "456"/i, error.message)
|
|
211
|
+
end
|
|
212
|
+
end
|
|
213
|
+
end
|
|
214
|
+
end
|
|
215
|
+
|
|
159
216
|
describe '#content_types' do
|
|
160
217
|
it 'returns supported content types' do
|
|
161
218
|
@path = '/validate_content_types'
|
|
@@ -223,5 +280,43 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
|
|
|
223
280
|
assert_kind_of(Integer, body_params["integer"])
|
|
224
281
|
end
|
|
225
282
|
end
|
|
283
|
+
|
|
284
|
+
describe '#find_response_object_for_status' do
|
|
285
|
+
def responses_for(path, method = 'get')
|
|
286
|
+
open_api_3_schema.operation_object(path, method).request_operation.operation_object.responses
|
|
287
|
+
end
|
|
288
|
+
|
|
289
|
+
def find(path, status, method = 'get')
|
|
290
|
+
wrapper = open_api_3_schema.operation_object(path, method)
|
|
291
|
+
wrapper.send(:find_response_object_for_status, responses_for(path, method), status)
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
it 'returns nil when responses is nil' do
|
|
295
|
+
wrapper = open_api_3_schema.operation_object('/characters', 'get')
|
|
296
|
+
assert_nil wrapper.send(:find_response_object_for_status, nil, 200)
|
|
297
|
+
end
|
|
298
|
+
|
|
299
|
+
it 'returns exact status code match' do
|
|
300
|
+
result = find('/characters', 200)
|
|
301
|
+
assert_kind_of OpenAPIParser::Schemas::Response, result
|
|
302
|
+
assert result.content.key?('application/json')
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
it 'returns wildcard match when exact status not defined' do
|
|
306
|
+
result = find('/wildcard_response', 400)
|
|
307
|
+
assert_kind_of OpenAPIParser::Schemas::Response, result
|
|
308
|
+
assert result.content.key?('application/json')
|
|
309
|
+
end
|
|
310
|
+
|
|
311
|
+
it 'returns default when no exact or wildcard match' do
|
|
312
|
+
result = find('/default_response', 500)
|
|
313
|
+
assert_kind_of OpenAPIParser::Schemas::Response, result
|
|
314
|
+
assert result.content.key?('application/json')
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
it 'returns nil when no exact, wildcard, or default match' do
|
|
318
|
+
assert_nil find('/characters', 999)
|
|
319
|
+
end
|
|
320
|
+
end
|
|
226
321
|
end
|
|
227
322
|
end
|
|
@@ -57,6 +57,32 @@ describe Committee::SchemaValidator::OpenAPI3::ParameterDeserializer do
|
|
|
57
57
|
assert_equal({ 'ids' => ['1', '2', '3'] }, result)
|
|
58
58
|
end
|
|
59
59
|
|
|
60
|
+
it 'only restores repeated values for exploded arrays' do
|
|
61
|
+
params = [create_param('exploded', 'query', 'form', true, 'array', 'integer'), create_param('compact', 'query', 'form', false, 'array', 'integer'), create_param('spaced', 'query', 'spaceDelimited', false, 'array', 'integer'), create_param('scalar', 'query', 'form', true, 'string', nil)]
|
|
62
|
+
raw_params = { 'exploded' => '2', 'compact' => '2,3', 'spaced' => '2 3', 'scalar' => '2' }.freeze
|
|
63
|
+
query_values = { 'exploded' => ['1', '2'], 'compact' => ['1', '2,3'], 'spaced' => ['1', '2 3'], 'scalar' => ['1', '2'] }
|
|
64
|
+
deserializer = create_deserializer(params)
|
|
65
|
+
|
|
66
|
+
result = deserializer.deserialize_query_params(raw_params, query_values)
|
|
67
|
+
|
|
68
|
+
assert_equal({ 'exploded' => ['1', '2'], 'compact' => ['2', '3'], 'spaced' => ['2', '3'], 'scalar' => '2' }, result)
|
|
69
|
+
assert_equal '2', raw_params['exploded']
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
[['spaceDelimited', '2 3'], ['pipeDelimited', '2|3']].each do |style, value|
|
|
73
|
+
[nil, false].each do |explode|
|
|
74
|
+
it "uses the last #{style} query value with explode=#{explode.inspect}" do
|
|
75
|
+
param = create_param('ids', 'query', style, explode, 'array', 'integer')
|
|
76
|
+
raw_params = { 'ids' => value }.freeze
|
|
77
|
+
|
|
78
|
+
result = create_deserializer([param]).deserialize_query_params(raw_params, { 'ids' => ['1', value] })
|
|
79
|
+
|
|
80
|
+
assert_equal({ 'ids' => ['2', '3'] }, result)
|
|
81
|
+
assert_equal value, raw_params['ids']
|
|
82
|
+
end
|
|
83
|
+
end
|
|
84
|
+
end
|
|
85
|
+
|
|
60
86
|
it 'deserializes deepObject style' do
|
|
61
87
|
raw_params = { 'filter[role]' => 'admin', 'filter[status]' => 'active' }
|
|
62
88
|
param = create_param('filter', 'query', 'deepObject', true, 'object', { 'role' => 'string', 'status' => 'string' })
|
|
@@ -174,6 +200,30 @@ describe Committee::SchemaValidator::OpenAPI3::ParameterDeserializer do
|
|
|
174
200
|
assert_equal({ 'ids' => ['1', '2', '3'] }, result)
|
|
175
201
|
end
|
|
176
202
|
|
|
203
|
+
it 'deserializes repeated matrix path segments into an array' do
|
|
204
|
+
raw_params = { 'ids' => ';ids=1;ids=2' }
|
|
205
|
+
param = create_param('ids', 'path', 'matrix', true, 'array', 'integer')
|
|
206
|
+
deserializer = create_deserializer([param])
|
|
207
|
+
|
|
208
|
+
assert_equal({ 'ids' => ['1', '2'] }, deserializer.deserialize_path_params(raw_params))
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
it 'deserializes an empty matrix array' do
|
|
212
|
+
param = create_param('ids', 'path', 'matrix', true, 'array', 'integer')
|
|
213
|
+
deserializer = create_deserializer([param])
|
|
214
|
+
|
|
215
|
+
assert_equal({ 'ids' => [] }, deserializer.deserialize_path_params('ids' => ';ids'))
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
it 'rejects other names inside an exploded matrix array' do
|
|
219
|
+
param = create_param('ids', 'path', 'matrix', true, 'array', 'string')
|
|
220
|
+
deserializer = create_deserializer([param])
|
|
221
|
+
|
|
222
|
+
assert_raises(Committee::ParameterDeserializationError) do
|
|
223
|
+
deserializer.deserialize_path_params('ids' => ';ids=1;other=2')
|
|
224
|
+
end
|
|
225
|
+
end
|
|
226
|
+
|
|
177
227
|
it 'deserializes matrix style object with explode=false' do
|
|
178
228
|
raw_params = { 'filter' => ';filter=role,admin,status,active' }
|
|
179
229
|
param = create_param('filter', 'path', 'matrix', false, 'object', { 'role' => 'string', 'status' => 'string' })
|
|
@@ -210,6 +260,17 @@ describe Committee::SchemaValidator::OpenAPI3::ParameterDeserializer do
|
|
|
210
260
|
assert_equal({ 'X-Filter' => { 'role' => 'admin', 'status' => 'active' } }, result)
|
|
211
261
|
end
|
|
212
262
|
|
|
263
|
+
it 'matches header names without regard to case' do
|
|
264
|
+
raw_headers = { 'x-filter' => 'role,admin,status,active', 'X-Other' => 'untouched' }
|
|
265
|
+
param = create_param('X-Filter', 'header', 'simple', false, 'object', { 'role' => 'string', 'status' => 'string' })
|
|
266
|
+
deserializer = create_deserializer([param])
|
|
267
|
+
|
|
268
|
+
result = deserializer.deserialize_headers(raw_headers)
|
|
269
|
+
|
|
270
|
+
assert_equal({ 'X-Filter' => { 'role' => 'admin', 'status' => 'active' }, 'X-Other' => 'untouched' }, result)
|
|
271
|
+
assert_equal 'role,admin,status,active', raw_headers['x-filter']
|
|
272
|
+
end
|
|
273
|
+
|
|
213
274
|
it 'handles empty params gracefully' do
|
|
214
275
|
raw_params = {}
|
|
215
276
|
param = create_param('filter', 'query', 'form', true, 'object', { 'role' => 'string' })
|
|
@@ -313,22 +374,28 @@ describe Committee::SchemaValidator::OpenAPI3::ParameterDeserializer do
|
|
|
313
374
|
assert_equal({ 'id' => '123' }, result)
|
|
314
375
|
end
|
|
315
376
|
|
|
316
|
-
it '
|
|
377
|
+
it 'rejects a matrix array with a missing prefix' do
|
|
317
378
|
raw_params = { 'ids' => 'invalid' }
|
|
318
379
|
param = create_param('ids', 'path', 'matrix', false, 'array', 'integer')
|
|
319
380
|
deserializer = create_deserializer([param])
|
|
320
|
-
result = deserializer.deserialize_path_params(raw_params)
|
|
321
381
|
|
|
322
|
-
|
|
382
|
+
error = assert_raises(Committee::ParameterDeserializationError) do
|
|
383
|
+
deserializer.deserialize_path_params(raw_params)
|
|
384
|
+
end
|
|
385
|
+
assert_equal 'ids', error.parameter_name
|
|
386
|
+
assert_equal 'invalid', error.raw_value
|
|
323
387
|
end
|
|
324
388
|
|
|
325
|
-
it '
|
|
389
|
+
it 'rejects a matrix object with a missing prefix' do
|
|
326
390
|
raw_params = { 'filter' => 'invalid' }
|
|
327
391
|
param = create_param('filter', 'path', 'matrix', false, 'object', { 'role' => 'string' })
|
|
328
392
|
deserializer = create_deserializer([param])
|
|
329
|
-
result = deserializer.deserialize_path_params(raw_params)
|
|
330
393
|
|
|
331
|
-
|
|
394
|
+
error = assert_raises(Committee::ParameterDeserializationError) do
|
|
395
|
+
deserializer.deserialize_path_params(raw_params)
|
|
396
|
+
end
|
|
397
|
+
assert_equal 'filter', error.parameter_name
|
|
398
|
+
assert_equal 'invalid', error.raw_value
|
|
332
399
|
end
|
|
333
400
|
|
|
334
401
|
it 'handles matrix style primitive without prefix' do
|
|
@@ -433,10 +500,75 @@ describe Committee::SchemaValidator::OpenAPI3::ParameterDeserializer do
|
|
|
433
500
|
end
|
|
434
501
|
end
|
|
435
502
|
|
|
503
|
+
describe 'path item parameters' do
|
|
504
|
+
[
|
|
505
|
+
['query', 'form', :deserialize_query_params],
|
|
506
|
+
['header', 'simple', :deserialize_headers],
|
|
507
|
+
['path', 'simple', :deserialize_path_params],
|
|
508
|
+
].each do |location, style, method|
|
|
509
|
+
it "prefers the operation definition for a #{location} parameter" do
|
|
510
|
+
parameter = create_param('ids', location, style, false, 'array', 'integer')
|
|
511
|
+
inherited = create_param('ids', location, style, false, 'string', nil)
|
|
512
|
+
deserializer = create_deserializer([parameter], [inherited])
|
|
513
|
+
|
|
514
|
+
result = deserializer.public_send(method, { 'ids' => '1,2,3' })
|
|
515
|
+
|
|
516
|
+
assert_equal({ 'ids' => ['1', '2', '3'] }, result)
|
|
517
|
+
end
|
|
518
|
+
end
|
|
519
|
+
|
|
520
|
+
it 'keeps parameters with the same name in different locations' do
|
|
521
|
+
query_parameter = create_param('ids', 'query', 'form', false, 'array', 'integer')
|
|
522
|
+
header_parameter = create_param('ids', 'header', 'simple', false, 'array', 'integer')
|
|
523
|
+
deserializer = create_deserializer([header_parameter], [query_parameter])
|
|
524
|
+
|
|
525
|
+
assert_equal({ 'ids' => ['1', '2'] }, deserializer.deserialize_query_params({ 'ids' => '1,2' }))
|
|
526
|
+
assert_equal({ 'ids' => ['3', '4'] }, deserializer.deserialize_headers({ 'ids' => '3,4' }))
|
|
527
|
+
end
|
|
528
|
+
end
|
|
529
|
+
|
|
530
|
+
describe 'array-form type (OpenAPI 3.1)' do
|
|
531
|
+
it 'deserializes form style array with explode=false' do
|
|
532
|
+
param = nullable(create_param('ids', 'query', 'form', false, 'array', 'integer'))
|
|
533
|
+
result = create_deserializer([param]).deserialize_query_params({ 'ids' => '1,2,3' })
|
|
534
|
+
|
|
535
|
+
assert_equal({ 'ids' => ['1', '2', '3'] }, result)
|
|
536
|
+
end
|
|
537
|
+
|
|
538
|
+
it 'deserializes form style object with explode=true' do
|
|
539
|
+
param = nullable(create_param('filter', 'query', 'form', true, 'object', { 'role' => 'string' }))
|
|
540
|
+
result = create_deserializer([param]).deserialize_query_params({ 'role' => 'admin' })
|
|
541
|
+
|
|
542
|
+
assert_equal({ 'filter' => { 'role' => 'admin' } }, result)
|
|
543
|
+
end
|
|
544
|
+
|
|
545
|
+
it 'deserializes simple style array' do
|
|
546
|
+
param = nullable(create_param('ids', 'path', 'simple', false, 'array', 'integer'))
|
|
547
|
+
result = create_deserializer([param]).deserialize_path_params({ 'ids' => '1,2,3' })
|
|
548
|
+
|
|
549
|
+
assert_equal({ 'ids' => ['1', '2', '3'] }, result)
|
|
550
|
+
end
|
|
551
|
+
|
|
552
|
+
it 'deserializes label style array' do
|
|
553
|
+
param = nullable(create_param('ids', 'path', 'label', false, 'array', 'integer'))
|
|
554
|
+
result = create_deserializer([param]).deserialize_path_params({ 'ids' => '.1,2,3' })
|
|
555
|
+
|
|
556
|
+
assert_equal({ 'ids' => ['1', '2', '3'] }, result)
|
|
557
|
+
end
|
|
558
|
+
|
|
559
|
+
it 'deserializes matrix style array' do
|
|
560
|
+
param = nullable(create_param('ids', 'path', 'matrix', false, 'array', 'integer'))
|
|
561
|
+
result = create_deserializer([param]).deserialize_path_params({ 'ids' => ';ids=1,2,3' })
|
|
562
|
+
|
|
563
|
+
assert_equal({ 'ids' => ['1', '2', '3'] }, result)
|
|
564
|
+
end
|
|
565
|
+
end
|
|
566
|
+
|
|
436
567
|
private
|
|
437
568
|
|
|
438
|
-
def create_deserializer(params)
|
|
439
|
-
|
|
569
|
+
def create_deserializer(params, path_item_params = nil)
|
|
570
|
+
path_item = Struct.new(:parameters).new(path_item_params)
|
|
571
|
+
operation = Struct.new(:operation_object, :path_item).new(Struct.new(:parameters).new(params), path_item)
|
|
440
572
|
Committee::SchemaValidator::OpenAPI3::ParameterDeserializer.new(operation)
|
|
441
573
|
end
|
|
442
574
|
|
|
@@ -454,4 +586,9 @@ describe Committee::SchemaValidator::OpenAPI3::ParameterDeserializer do
|
|
|
454
586
|
Struct.new(:type, :properties, :items).new(type, nil, nil)
|
|
455
587
|
end
|
|
456
588
|
end
|
|
589
|
+
|
|
590
|
+
def nullable(param)
|
|
591
|
+
param.schema.type = [param.schema.type, "null"]
|
|
592
|
+
param
|
|
593
|
+
end
|
|
457
594
|
end
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "test_helper"
|
|
4
|
+
|
|
5
|
+
describe Committee::SchemaValidator::OpenAPI3 do
|
|
6
|
+
before do
|
|
7
|
+
@router = open_api_3_schema.build_router(schema: open_api_3_schema)
|
|
8
|
+
end
|
|
9
|
+
|
|
10
|
+
def validator_for(path, method)
|
|
11
|
+
request = Rack::Request.new({ "REQUEST_METHOD" => method, "PATH_INFO" => path, "rack.input" => StringIO.new("") })
|
|
12
|
+
@router.build_schema_validator(request)
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
describe "#operation_object" do
|
|
16
|
+
it "returns the matched operation wrapper" do
|
|
17
|
+
operation_object = validator_for("/validate", "POST").operation_object
|
|
18
|
+
|
|
19
|
+
assert_kind_of Committee::SchemaValidator::OpenAPI3::OperationWrapper, operation_object
|
|
20
|
+
assert_equal "/validate", operation_object.original_path
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
it "returns nil when the request matches no operation" do
|
|
24
|
+
assert_nil validator_for("/no-such-path", "GET").operation_object
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
@@ -61,4 +61,14 @@ describe Committee::SchemaValidator do
|
|
|
61
61
|
assert regexp.match?("/v1/characters")
|
|
62
62
|
refute regexp.match?("/v11/characters")
|
|
63
63
|
end
|
|
64
|
+
|
|
65
|
+
["/v1/", "/"].each do |prefix|
|
|
66
|
+
it "preserves the path's leading slash after removing prefix #{prefix.inspect}" do
|
|
67
|
+
regexp = Committee::SchemaValidator.build_prefix_regexp(prefix)
|
|
68
|
+
|
|
69
|
+
assert_equal "/characters", "#{prefix}characters".sub(regexp, "")
|
|
70
|
+
assert_equal "/", prefix.sub(regexp, "")
|
|
71
|
+
refute regexp.match?("/v11/characters") unless prefix == "/"
|
|
72
|
+
end
|
|
73
|
+
end
|
|
64
74
|
end
|
data/test/test/methods_test.rb
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require "test_helper"
|
|
4
|
+
require "rspec/expectations"
|
|
4
5
|
|
|
5
6
|
describe Committee::Test::Methods do
|
|
6
7
|
include Committee::Test::Methods
|
|
@@ -123,6 +124,18 @@ describe Committee::Test::Methods do
|
|
|
123
124
|
assert_schema_conform(200)
|
|
124
125
|
end
|
|
125
126
|
|
|
127
|
+
it "uses each request's operation for consecutive responses" do
|
|
128
|
+
responses = { "/characters" => JSON.generate(@correct_response), "/validate_response_array" => JSON.generate(["honoka"]), }
|
|
129
|
+
@app = Rack::Builder.new {
|
|
130
|
+
run ->(env) { [200, { "Content-Type" => "application/json" }, [responses.fetch(env["PATH_INFO"])]] }
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
get "/characters"
|
|
134
|
+
assert_schema_conform(200)
|
|
135
|
+
get "/validate_response_array"
|
|
136
|
+
assert_schema_conform(200)
|
|
137
|
+
end
|
|
138
|
+
|
|
126
139
|
it "detects an invalid response Content-Type" do
|
|
127
140
|
@app = new_rack_app(JSON.generate([@correct_response]), {})
|
|
128
141
|
get "/characters"
|
|
@@ -483,6 +496,193 @@ describe Committee::Test::Methods do
|
|
|
483
496
|
|
|
484
497
|
private
|
|
485
498
|
|
|
499
|
+
describe "OpenAPI 3.1" do
|
|
500
|
+
before do
|
|
501
|
+
@committee_options.merge!({ schema: open_api_3_1_schema })
|
|
502
|
+
end
|
|
503
|
+
|
|
504
|
+
describe "assert_request_schema_confirm with except option" do
|
|
505
|
+
it "uses a typed dummy for an array-form type query param" do
|
|
506
|
+
@app = new_rack_app
|
|
507
|
+
get "/except"
|
|
508
|
+
assert_request_schema_confirm(except: { query: ['count'] })
|
|
509
|
+
end
|
|
510
|
+
|
|
511
|
+
it "uses a typed dummy for an array-form type JSON body param" do
|
|
512
|
+
@app = new_rack_app
|
|
513
|
+
post "/except", JSON.generate({}), { "CONTENT_TYPE" => "application/json" }
|
|
514
|
+
assert_request_schema_confirm(except: { body: ['count'] })
|
|
515
|
+
end
|
|
516
|
+
|
|
517
|
+
it "uses a typed dummy for an array-form type form param" do
|
|
518
|
+
@app = new_rack_app
|
|
519
|
+
post "/except", "", { "CONTENT_TYPE" => "application/x-www-form-urlencoded" }
|
|
520
|
+
assert_request_schema_confirm(except: { body: ['count'] })
|
|
521
|
+
end
|
|
522
|
+
end
|
|
523
|
+
end
|
|
524
|
+
|
|
525
|
+
describe "with test_failure_handler" do
|
|
526
|
+
before do
|
|
527
|
+
@handled_errors = []
|
|
528
|
+
@correct_response = { string_1: :honoka }
|
|
529
|
+
@committee_options.merge!({ schema: open_api_3_schema, test_failure_handler: ->(error) { @handled_errors << error } })
|
|
530
|
+
end
|
|
531
|
+
|
|
532
|
+
describe "#assert_schema_conform" do
|
|
533
|
+
it "passes an invalid response to the handler instead of raising" do
|
|
534
|
+
@app = new_rack_app(JSON.generate([@correct_response]), {})
|
|
535
|
+
get "/characters"
|
|
536
|
+
assert_schema_conform(200)
|
|
537
|
+
assert_equal 1, @handled_errors.size
|
|
538
|
+
assert_instance_of Committee::InvalidResponse, @handled_errors.first
|
|
539
|
+
assert_match(/response definition does not exist/i, @handled_errors.first.message)
|
|
540
|
+
end
|
|
541
|
+
|
|
542
|
+
it "aggregates schema and subsequent RSpec expectation failures" do
|
|
543
|
+
@committee_options[:test_failure_handler] = ->(error) { RSpec::Expectations.fail_with(error.message) }
|
|
544
|
+
@app = new_rack_app(JSON.generate({ string_1: 123 }))
|
|
545
|
+
get "/characters"
|
|
546
|
+
rspec = Object.new.extend(RSpec::Matchers)
|
|
547
|
+
|
|
548
|
+
e = assert_raises(RSpec::Expectations::MultipleExpectationsNotMetError) do
|
|
549
|
+
rspec.aggregate_failures do
|
|
550
|
+
assert_schema_conform(200)
|
|
551
|
+
rspec.expect(last_response.status).to rspec.eq(201)
|
|
552
|
+
end
|
|
553
|
+
end
|
|
554
|
+
|
|
555
|
+
assert_equal 2, e.failures.size
|
|
556
|
+
assert_empty e.other_errors
|
|
557
|
+
assert_match(/string_1.*expected string/, e.failures.first.message)
|
|
558
|
+
assert_match(/expected: 201/, e.failures.last.message)
|
|
559
|
+
end
|
|
560
|
+
|
|
561
|
+
it "does not call the handler when the request and the response conform" do
|
|
562
|
+
@app = new_rack_app(JSON.generate(@correct_response))
|
|
563
|
+
get "/characters"
|
|
564
|
+
assert_schema_conform(200)
|
|
565
|
+
assert_empty @handled_errors
|
|
566
|
+
end
|
|
567
|
+
|
|
568
|
+
it "passes both failures to the handler when the request and the response are invalid" do
|
|
569
|
+
@app = new_rack_app(nil, { "Content-Type" => "application/json" }, 500)
|
|
570
|
+
get "/validate", { "query_integer_list" => [1, 2] }
|
|
571
|
+
assert_schema_conform(200)
|
|
572
|
+
assert_equal [Committee::InvalidRequest, Committee::InvalidResponse], @handled_errors.map(&:class)
|
|
573
|
+
assert_match(/missing required parameters: query_string/i, @handled_errors.first.message)
|
|
574
|
+
assert_match(/Expected `200` status code, but it was `500`/, @handled_errors.last.message)
|
|
575
|
+
end
|
|
576
|
+
end
|
|
577
|
+
|
|
578
|
+
describe "#assert_request_schema_confirm" do
|
|
579
|
+
it "passes an invalid request to the handler instead of raising" do
|
|
580
|
+
@app = new_rack_app
|
|
581
|
+
get "/validate", { "query_integer_list" => [1, 2] }
|
|
582
|
+
assert_request_schema_confirm
|
|
583
|
+
assert_equal [Committee::InvalidRequest], @handled_errors.map(&:class)
|
|
584
|
+
assert_match(/missing required parameters: query_string/i, @handled_errors.first.message)
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
it "passes a path undefined in schema to the handler" do
|
|
588
|
+
@app = new_rack_app
|
|
589
|
+
get "/undefined"
|
|
590
|
+
assert_request_schema_confirm
|
|
591
|
+
assert_equal [Committee::InvalidRequest], @handled_errors.map(&:class)
|
|
592
|
+
assert_match(/`GET \/undefined` undefined in schema/i, @handled_errors.first.message)
|
|
593
|
+
end
|
|
594
|
+
|
|
595
|
+
it "passes a non-object JSON body to the handler" do
|
|
596
|
+
@app = new_rack_app
|
|
597
|
+
post "/test_except_body_params", "[1,2,3]", "CONTENT_TYPE" => "application/json"
|
|
598
|
+
assert_request_schema_confirm(except: { body: ['required_string'] })
|
|
599
|
+
assert_equal [Committee::BadRequest], @handled_errors.map(&:class)
|
|
600
|
+
end
|
|
601
|
+
|
|
602
|
+
it "restores the excepted parameters when the handler is called" do
|
|
603
|
+
@app = new_rack_app
|
|
604
|
+
post "/test_except_body_params", "[1,2,3]", "CONTENT_TYPE" => "application/json"
|
|
605
|
+
assert_request_schema_confirm(except: { headers: ['authorization'], body: ['required_string'] })
|
|
606
|
+
assert_equal 1, @handled_errors.size
|
|
607
|
+
assert_nil last_request.env['HTTP_AUTHORIZATION']
|
|
608
|
+
end
|
|
609
|
+
end
|
|
610
|
+
|
|
611
|
+
describe "#assert_response_schema_confirm" do
|
|
612
|
+
it "passes an invalid response to the handler instead of raising" do
|
|
613
|
+
@app = new_rack_app(JSON.generate([@correct_response]), {})
|
|
614
|
+
get "/characters"
|
|
615
|
+
assert_response_schema_confirm(200)
|
|
616
|
+
assert_equal [Committee::InvalidResponse], @handled_errors.map(&:class)
|
|
617
|
+
assert_match(/response definition does not exist/i, @handled_errors.first.message)
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
it "passes an unexpected status code to the handler" do
|
|
621
|
+
@app = new_rack_app(JSON.generate(@correct_response), { "Content-Type" => "application/json" }, 500)
|
|
622
|
+
get "/characters"
|
|
623
|
+
assert_response_schema_confirm(200)
|
|
624
|
+
assert_equal [Committee::InvalidResponse], @handled_errors.map(&:class)
|
|
625
|
+
assert_match(/Expected `200` status code, but it was `500`/, @handled_errors.first.message)
|
|
626
|
+
end
|
|
627
|
+
|
|
628
|
+
it "passes a path undefined in schema to the handler" do
|
|
629
|
+
@app = new_rack_app
|
|
630
|
+
get "/undefined"
|
|
631
|
+
assert_response_schema_confirm(200)
|
|
632
|
+
assert_equal [Committee::InvalidResponse], @handled_errors.map(&:class)
|
|
633
|
+
assert_match(/`GET \/undefined` undefined in schema/i, @handled_errors.first.message)
|
|
634
|
+
end
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
it "lets an error raised by the handler reach the caller" do
|
|
638
|
+
@committee_options[:test_failure_handler] = ->(error) { flunk(error.message) }
|
|
639
|
+
@app = new_rack_app(nil, { "Content-Type" => "application/json" }, 500)
|
|
640
|
+
get "/validate", { "query_integer_list" => [1, 2] }
|
|
641
|
+
e = assert_raises(Minitest::Assertion) do
|
|
642
|
+
assert_schema_conform(200)
|
|
643
|
+
end
|
|
644
|
+
assert_match(/missing required parameters: query_string/i, e.message)
|
|
645
|
+
end
|
|
646
|
+
|
|
647
|
+
it "raises errors other than validation failures" do
|
|
648
|
+
@app = new_rack_app
|
|
649
|
+
post "/test_except_body_params", "invalid-json", "CONTENT_TYPE" => "application/json"
|
|
650
|
+
assert_raises(JSON::ParserError) do
|
|
651
|
+
assert_request_schema_confirm(except: { body: ['required_string'] })
|
|
652
|
+
end
|
|
653
|
+
assert_empty @handled_errors
|
|
654
|
+
end
|
|
655
|
+
|
|
656
|
+
it "works with Hyper-Schema" do
|
|
657
|
+
sc = JsonSchema.parse!(hyper_schema_data)
|
|
658
|
+
sc.expand_references!
|
|
659
|
+
@committee_options[:schema] = Committee::Drivers::HyperSchema::Driver.new.parse(sc)
|
|
660
|
+
@app = new_rack_app(JSON.generate([ValidApp]), {})
|
|
661
|
+
get "/apps"
|
|
662
|
+
assert_schema_conform(200)
|
|
663
|
+
assert_equal [Committee::InvalidResponse], @handled_errors.map(&:class)
|
|
664
|
+
assert_match(/response header must be set to/i, @handled_errors.first.message)
|
|
665
|
+
end
|
|
666
|
+
end
|
|
667
|
+
|
|
668
|
+
describe "OpenAPI 3.2" do
|
|
669
|
+
before do
|
|
670
|
+
@committee_options.merge!({ schema: open_api_3_2_schema })
|
|
671
|
+
end
|
|
672
|
+
|
|
673
|
+
it "passes assert_schema_conform for a query request" do
|
|
674
|
+
@app = new_rack_app(JSON.generate([{ "name" => "a" }]))
|
|
675
|
+
custom_request("QUERY", "/items", {}, { input: JSON.generate("name" => "a"), "CONTENT_TYPE" => "application/json" })
|
|
676
|
+
assert_schema_conform(200)
|
|
677
|
+
end
|
|
678
|
+
|
|
679
|
+
it "passes assert_schema_conform for an additionalOperations request" do
|
|
680
|
+
@app = new_rack_app(nil, {}, 204)
|
|
681
|
+
custom_request("PURGE", "/items")
|
|
682
|
+
assert_schema_conform(204)
|
|
683
|
+
end
|
|
684
|
+
end
|
|
685
|
+
|
|
486
686
|
def new_rack_app(response = nil, headers = { "Content-Type" => "application/json" }, status_code = 200)
|
|
487
687
|
Rack::Builder.new {
|
|
488
688
|
run lambda { |_|
|
|
@@ -46,6 +46,40 @@ describe Committee::Test::SchemaCoverage do
|
|
|
46
46
|
end
|
|
47
47
|
end
|
|
48
48
|
|
|
49
|
+
describe 'OpenAPI 3.2' do
|
|
50
|
+
it 'reports query and additionalOperations operations' do
|
|
51
|
+
schema_coverage = Committee::Test::SchemaCoverage.new(open_api_3_2_schema)
|
|
52
|
+
schema_coverage.update_response_coverage!('/items', 'QUERY', '200')
|
|
53
|
+
schema_coverage.update_response_coverage!('/items', 'PURGE', '204')
|
|
54
|
+
|
|
55
|
+
report = schema_coverage.report
|
|
56
|
+
assert_equal({ 'responses' => { '200' => true } }, report['/items']['query'])
|
|
57
|
+
assert_equal({ 'responses' => { '204' => true } }, report['/items']['PURGE'])
|
|
58
|
+
assert_equal({ 'responses' => { '204' => false } }, report['/items']['purge'])
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
it 'keeps an additionalOperations method apart from a standard one that differs only in case' do
|
|
62
|
+
schema_coverage = Committee::Test::SchemaCoverage.new(open_api_3_2_schema)
|
|
63
|
+
schema_coverage.update_response_coverage!('/versions', 'Get', '200')
|
|
64
|
+
|
|
65
|
+
report = schema_coverage.report
|
|
66
|
+
assert_equal({ 'responses' => { '200' => true } }, report['/versions']['Get'])
|
|
67
|
+
assert_equal({ 'responses' => { '200' => false } }, report['/versions']['get'])
|
|
68
|
+
|
|
69
|
+
schema_coverage.update_response_coverage!('/versions', 'GET', '200')
|
|
70
|
+
assert_equal({ 'responses' => { '200' => true } }, schema_coverage.report['/versions']['get'])
|
|
71
|
+
end
|
|
72
|
+
|
|
73
|
+
it 'reports a method name containing ~ as covered' do
|
|
74
|
+
schema_coverage = Committee::Test::SchemaCoverage.new(open_api_3_2_schema)
|
|
75
|
+
schema_coverage.update_response_coverage!('/versions', 'SYNC~V2', '200')
|
|
76
|
+
|
|
77
|
+
report = schema_coverage.report
|
|
78
|
+
assert_equal({ 'responses' => { '200' => true } }, report['/versions']['SYNC~V2'])
|
|
79
|
+
refute report['/versions'].key?('SYNC~0V2')
|
|
80
|
+
end
|
|
81
|
+
end
|
|
82
|
+
|
|
49
83
|
describe '.merge_report' do
|
|
50
84
|
it 'can merge 2 coverage reports together' do
|
|
51
85
|
report = Committee::Test::SchemaCoverage.merge_report({ '/posts' => { 'get' => { 'responses' => { '200' => true, '404' => false, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => true, }, }, }, }, { '/posts' => { 'get' => { 'responses' => { '200' => true, '404' => true, }, }, 'post' => { 'responses' => { '200' => false, }, }, }, '/likes' => { 'post' => { 'responses' => { '200' => false, '400' => false, }, }, }, '/users' => { 'get' => { 'responses' => { '200' => true, }, }, }, },)
|
data/test/test_helper.rb
CHANGED
|
@@ -41,6 +41,9 @@ ValidApp = { "maintenance" => false, "name" => "example", }.freeze
|
|
|
41
41
|
# For our OpenAPI example.
|
|
42
42
|
ValidPet = { "id" => 123, "name" => "example", "tag" => "tag-123", }.freeze
|
|
43
43
|
|
|
44
|
+
# For our OpenAPI 3.1 example.
|
|
45
|
+
ValidItem = { "kind" => "widget", "name" => nil, "rating" => 4.5, "point" => [1.5, "a"], }.freeze
|
|
46
|
+
|
|
44
47
|
def hyper_schema
|
|
45
48
|
@hyper_schema ||= Committee::Drivers.load_from_json(hyper_schema_schema_path)
|
|
46
49
|
end
|
|
@@ -65,6 +68,14 @@ def open_api_3_streaming_response_schema
|
|
|
65
68
|
@open_api_3_streaming_response_schema ||= Committee::Drivers.load_from_file(open_api_3_streaming_response_schema_path, parser_options: { strict_reference_validation: true })
|
|
66
69
|
end
|
|
67
70
|
|
|
71
|
+
def open_api_3_1_schema
|
|
72
|
+
@open_api_3_1_schema ||= Committee::Drivers.load_from_file(open_api_3_1_schema_path, parser_options: { strict_reference_validation: true })
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
def open_api_3_2_schema
|
|
76
|
+
@open_api_3_2_schema ||= Committee::Drivers.load_from_file(open_api_3_2_schema_path, parser_options: { strict_reference_validation: true })
|
|
77
|
+
end
|
|
78
|
+
|
|
68
79
|
# Don't cache this because we'll often manipulate the created hash in tests.
|
|
69
80
|
def hyper_schema_data
|
|
70
81
|
JSON.parse(File.read(hyper_schema_schema_path))
|
|
@@ -95,6 +106,14 @@ def open_api_3_1_data
|
|
|
95
106
|
end
|
|
96
107
|
end
|
|
97
108
|
|
|
109
|
+
def open_api_3_2_data
|
|
110
|
+
if YAML.respond_to?(:unsafe_load_file)
|
|
111
|
+
YAML.unsafe_load_file(open_api_3_2_schema_path)
|
|
112
|
+
else
|
|
113
|
+
YAML.load_file(open_api_3_2_schema_path)
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
|
|
98
117
|
def hyper_schema_schema_path
|
|
99
118
|
"./test/data/hyperschema/paas.json"
|
|
100
119
|
end
|
|
@@ -123,6 +142,10 @@ def open_api_3_1_schema_path
|
|
|
123
142
|
"./test/data/openapi3/3_1.yaml"
|
|
124
143
|
end
|
|
125
144
|
|
|
145
|
+
def open_api_3_2_schema_path
|
|
146
|
+
"./test/data/openapi3/3_2.yaml"
|
|
147
|
+
end
|
|
148
|
+
|
|
126
149
|
def open_api_3_invalid_reference_path
|
|
127
150
|
"./test/data/openapi3/invalid_reference.yaml"
|
|
128
151
|
end
|