committee 5.6.4 → 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.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/lib/committee/drivers/open_api_2/driver.rb +16 -0
  3. data/lib/committee/drivers/open_api_2/link.rb +2 -0
  4. data/lib/committee/drivers/open_api_3/schema.rb +6 -1
  5. data/lib/committee/drivers.rb +15 -8
  6. data/lib/committee/middleware/response_validation.rb +19 -5
  7. data/lib/committee/middleware/stub.rb +1 -1
  8. data/lib/committee/request_unpacker.rb +19 -9
  9. data/lib/committee/schema_locations.rb +96 -0
  10. data/lib/committee/schema_validator/hyper_schema/request_validator.rb +1 -1
  11. data/lib/committee/schema_validator/hyper_schema/response_validator.rb +13 -3
  12. data/lib/committee/schema_validator/hyper_schema.rb +5 -4
  13. data/lib/committee/schema_validator/open_api_3/operation_wrapper.rb +42 -17
  14. data/lib/committee/schema_validator/open_api_3/parameter_deserializer.rb +66 -20
  15. data/lib/committee/schema_validator/open_api_3/request_validator.rb +2 -3
  16. data/lib/committee/schema_validator/open_api_3/router.rb +1 -3
  17. data/lib/committee/schema_validator/open_api_3.rb +22 -18
  18. data/lib/committee/schema_validator.rb +1 -5
  19. data/lib/committee/test/except_parameter.rb +4 -4
  20. data/lib/committee/test/methods.rb +13 -0
  21. data/lib/committee/test/schema_coverage.rb +11 -2
  22. data/lib/committee/utils.rb +6 -0
  23. data/lib/committee/validation_error.rb +1 -1
  24. data/lib/committee/version.rb +1 -1
  25. data/lib/committee.rb +1 -0
  26. data/test/drivers/open_api_2/driver_test.rb +13 -0
  27. data/test/drivers_test.rb +39 -8
  28. data/test/middleware/request_validation_open_api_3_test.rb +668 -6
  29. data/test/middleware/request_validation_test.rb +50 -0
  30. data/test/middleware/response_validation_open_api_3_test.rb +77 -0
  31. data/test/middleware/response_validation_test.rb +134 -0
  32. data/test/middleware/stub_test.rb +10 -0
  33. data/test/request_unpacker_test.rb +34 -0
  34. data/test/schema_location_test.rb +111 -0
  35. data/test/schema_validator/open_api_3/parameter_deserializer_test.rb +145 -8
  36. data/test/schema_validator_test.rb +10 -0
  37. data/test/test/methods_test.rb +188 -0
  38. data/test/test/schema_coverage_test.rb +34 -0
  39. data/test/test_helper.rb +23 -0
  40. data/test/utils_test.rb +28 -0
  41. data/test/validation_error_test.rb +1 -1
  42. metadata +20 -3
@@ -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 'handles matrix style with missing prefix' do
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
- assert_equal({ 'ids' => [] }, result)
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 'handles matrix style object with missing prefix' do
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
- assert_equal({ 'filter' => {} }, result)
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
- operation = Struct.new(:operation_object).new(Struct.new(:parameters).new(params))
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
@@ -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
@@ -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
@@ -495,6 +496,193 @@ describe Committee::Test::Methods do
495
496
 
496
497
  private
497
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
+
498
686
  def new_rack_app(response = nil, headers = { "Content-Type" => "application/json" }, status_code = 200)
499
687
  Rack::Builder.new {
500
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
@@ -0,0 +1,28 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "test_helper"
4
+
5
+ describe Committee::Utils do
6
+ describe ".schema_type" do
7
+ def schema(type)
8
+ Struct.new(:type).new(type)
9
+ end
10
+
11
+ it "returns a string type as is" do
12
+ assert_equal "integer", Committee::Utils.schema_type(schema("integer"))
13
+ end
14
+
15
+ it "returns the first non-null type of an array-form type" do
16
+ assert_equal "array", Committee::Utils.schema_type(schema(["null", "array"]))
17
+ assert_equal "integer", Committee::Utils.schema_type(schema(["integer", "string"]))
18
+ end
19
+
20
+ it "returns nil when only null is listed" do
21
+ assert_nil Committee::Utils.schema_type(schema(["null"]))
22
+ end
23
+
24
+ it "returns nil without a schema" do
25
+ assert_nil Committee::Utils.schema_type(nil)
26
+ end
27
+ end
28
+ end
@@ -14,7 +14,7 @@ describe Committee::ValidationError do
14
14
  it "creates a Rack response object to render" do
15
15
  body = { id: :bad_request, message: "Error" }
16
16
 
17
- response = [400, { "Content-Type" => "application/json" }, [JSON.generate(body)]]
17
+ response = [400, { "content-type" => "application/json" }, [JSON.generate(body)]]
18
18
 
19
19
  assert_equal @error.render, response
20
20
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: committee
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.6.4
4
+ version: 5.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Brandur
@@ -51,14 +51,14 @@ dependencies:
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: '2.0'
54
+ version: '2.8'
55
55
  type: :runtime
56
56
  prerelease: false
57
57
  version_requirements: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: '2.0'
61
+ version: '2.8'
62
62
  - !ruby/object:Gem::Dependency
63
63
  name: minitest
64
64
  requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,20 @@ dependencies:
101
101
  - - "~>"
102
102
  - !ruby/object:Gem::Version
103
103
  version: '13.1'
104
+ - !ruby/object:Gem::Dependency
105
+ name: rspec-expectations
106
+ requirement: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '3.13'
111
+ type: :development
112
+ prerelease: false
113
+ version_requirements: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '3.13'
104
118
  - !ruby/object:Gem::Dependency
105
119
  name: debug
106
120
  requirement: !ruby/object:Gem::Requirement
@@ -197,6 +211,7 @@ files:
197
211
  - lib/committee/middleware/response_validation.rb
198
212
  - lib/committee/middleware/stub.rb
199
213
  - lib/committee/request_unpacker.rb
214
+ - lib/committee/schema_locations.rb
200
215
  - lib/committee/schema_validator.rb
201
216
  - lib/committee/schema_validator/hyper_schema.rb
202
217
  - lib/committee/schema_validator/hyper_schema/parameter_coercer.rb
@@ -239,6 +254,7 @@ files:
239
254
  - test/middleware/response_validation_test.rb
240
255
  - test/middleware/stub_test.rb
241
256
  - test/request_unpacker_test.rb
257
+ - test/schema_location_test.rb
242
258
  - test/schema_validator/hyper_schema/parameter_coercer_test.rb
243
259
  - test/schema_validator/hyper_schema/request_validator_test.rb
244
260
  - test/schema_validator/hyper_schema/response_generator_test.rb
@@ -255,6 +271,7 @@ files:
255
271
  - test/test/methods_test.rb
256
272
  - test/test/schema_coverage_test.rb
257
273
  - test/test_helper.rb
274
+ - test/utils_test.rb
258
275
  - test/validation_error_test.rb
259
276
  homepage: https://github.com/interagent/committee
260
277
  licenses: