committee 3.3.0 → 4.3.0

data/test/committee_test.rb

@@ -42,7 +42,7 @@ describe Committee do
 
       $VERBOSE = true
       Committee.warn_deprecated "blah"
-      assert_equal "blah\n", $stderr.string
+      assert_equal "[DEPRECATION] blah\n", $stderr.string
     ensure
       $stderr = old_stderr
       $VERBOSE = old_verbose

data/test/middleware/base_test.rb

@@ -103,17 +103,20 @@ describe Committee::Middleware::Base do
 
   describe 'initialize option' do
     it "schema_path option with hyper-schema" do
-      b = Committee::Middleware::Base.new(nil, schema_path: hyper_schema_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: hyper_schema_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::HyperSchema::Schema, b.instance_variable_get(:@schema)
     end
 
     it "schema_path option with OpenAPI2" do
-      b = Committee::Middleware::Base.new(nil, schema_path: open_api_2_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_2_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::OpenAPI2::Schema, b.instance_variable_get(:@schema)
     end
 
     it "schema_path option with OpenAPI3" do
-      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_schema_path)
+      # TODO: delete when 5.0.0 released because default value changed
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_schema_path, parse_response_by_content_type: false)
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, b.instance_variable_get(:@schema)
     end
   end
@@ -121,6 +124,9 @@ describe Committee::Middleware::Base do
   private
 
   def new_rack_app(options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run lambda { |_|

data/test/middleware/request_validation_open_api_3_test.rb

@@ -249,8 +249,7 @@ describe Committee::Middleware::RequestValidation do
     }
     post "/characters", JSON.generate(params)
     assert_equal 400, last_response.status
-    # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-    assert_match(/expected string, but received #{1.class}:/i, last_response.body)
+    assert_match(/expected string, but received Integer:/i, last_response.body)
   end
 
   it "rescues JSON errors" do
@@ -279,8 +278,7 @@ describe Committee::Middleware::RequestValidation do
     header "Content-Type", "application/json"
     post "/v1/characters", JSON.generate(params)
     assert_equal 400, last_response.status
-    # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-    assert_match(/expected string, but received #{1.class}: /i, last_response.body)
+    assert_match(/expected string, but received Integer: /i, last_response.body)
   end
 
   it "ignores paths outside the prefix" do
@@ -415,7 +413,11 @@ describe Committee::Middleware::RequestValidation do
       { check_header: false, description: 'valid value', value: 1, expected: { status: 200 } },
       { check_header: false, description: 'missing value', value: nil, expected: { status: 200 } },
       { check_header: false, description: 'invalid value', value: 'x', expected: { status: 200 } },
-    ].each do |check_header:, description:, value:, expected:|
+    ].each do |h|
+      check_header = h[:check_header]
+      description = h[:description]
+      value = h[:value]
+      expected = h[:expected]
       describe "when #{check_header}" do
         %w(get post put patch delete).each do |method|
           describe method do
@@ -441,7 +443,10 @@ describe Committee::Middleware::RequestValidation do
       { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 400 } },
       { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/c') }, expected: { status: 400 } },
       { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
-    ].each do |description:, accept_request_filter:, expected:|
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
       it description do
         @app = new_rack_app(prefix: '/v1', schema: open_api_3_schema, accept_request_filter: accept_request_filter)
 
@@ -452,6 +457,16 @@ describe Committee::Middleware::RequestValidation do
     end
   end
 
+  it 'does not suppress application error' do
+    @app = new_rack_app_with_lambda(lambda { |_|
+      JSON.load('-') # invalid json
+    }, schema: open_api_3_schema, raise: true)
+
+    assert_raises(JSON::ParserError) do
+      get "/error", nil
+    end
+  end
+
   private
 
   def new_rack_app(options = {})
@@ -461,6 +476,9 @@ describe Committee::Middleware::RequestValidation do
   end
 
   def new_rack_app_with_lambda(check_lambda, options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run check_lambda

data/test/middleware/request_validation_test.rb

@@ -495,7 +495,10 @@ describe Committee::Middleware::RequestValidation do
       { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 400 } },
       { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/a') }, expected: { status: 400 } },
       { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
-    ].each do |description:, accept_request_filter:, expected:|
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
       it description do
         @app = new_rack_app(prefix: '/v1', schema: hyper_schema, accept_request_filter: accept_request_filter)
 
@@ -516,6 +519,9 @@ describe Committee::Middleware::RequestValidation do
 
 
   def new_rack_app_with_lambda(check_lambda, options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run check_lambda

data/test/middleware/response_validation_open_api_3_test.rb

@@ -34,6 +34,14 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal 200, last_response.status
   end
 
+  it "passes through a invalid json with parse_response_by_content_type option" do
+    @app = new_response_rack("csv response", { "Content-Type" => "test/csv"}, schema: open_api_3_schema, parse_response_by_content_type: true)
+
+    get "/csv"
+
+    assert_equal 200, last_response.status
+  end
+
   it "passes through not definition" do
     @app = new_response_rack(JSON.generate(CHARACTERS_RESPONSE), {}, schema: open_api_3_schema)
     get "/no_data"
@@ -99,6 +107,20 @@ describe Committee::Middleware::ResponseValidation do
     assert_match(/valid JSON/i, last_response.body)
   end
 
+  describe "remote schema $ref" do
+    it "passes through a valid response" do
+      @app = new_response_rack(JSON.generate({ "sample" => "value" }), {}, schema: open_api_3_schema)
+      get "/ref-sample"
+      assert_equal 200, last_response.status
+    end
+
+    it "detects a invalid response" do
+      @app = new_response_rack("{}", {}, schema: open_api_3_schema)
+      get "/ref-sample"
+      assert_equal 500, last_response.status
+    end
+  end
+
   describe 'check header' do
     [
       { check_header: true, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
@@ -108,7 +130,11 @@ describe Committee::Middleware::ResponseValidation do
       { check_header: false, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
       { check_header: false, description: 'missing value', header: { 'integer' => nil }, expected: { status: 200 } },
       { check_header: false, description: 'invalid value', header: { 'integer' => 'x' }, expected: { status: 200 } },
-    ].each do |check_header:, description:, header:, expected:|
+    ].each do |h|
+      check_header = h[:check_header]
+      description = h[:description]
+      header = h[:header]
+      expected = h[:expected]
       describe "when #{check_header}" do
         %w(get post put patch delete).each do |method|
           describe method do
@@ -174,7 +200,11 @@ describe Committee::Middleware::ResponseValidation do
       { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 500 } },
       { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/c') }, expected: { status: 500 } },
       { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
-    ].each do |description:, accept_request_filter:, expected:|
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
+
       it description do
         @app = new_response_rack('not_json', {}, schema: open_api_3_schema, prefix: '/v1', accept_request_filter: accept_request_filter)
 
@@ -185,9 +215,25 @@ describe Committee::Middleware::ResponseValidation do
     end
   end
 
+  it 'does not suppress application error' do
+    @app = Rack::Builder.new {
+      use Committee::Middleware::ResponseValidation, {schema: open_api_3_schema, raise: true}
+      run lambda { |_|
+        JSON.load('-') # invalid json  
+      }
+    }
+
+    assert_raises(JSON::ParserError) do
+      get "/error", nil
+    end
+  end
+
   private
 
   def new_response_rack(response, headers = {}, options = {}, rack_options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     status = rack_options[:status] || 200
     headers = {
       "Content-Type" => "application/json"

data/test/middleware/response_validation_test.rb

@@ -167,7 +167,10 @@ describe Committee::Middleware::ResponseValidation do
       { description: 'when not specified, includes everything', accept_request_filter: nil, expected: { status: 500 } },
       { description: 'when predicate matches, performs validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/a') }, expected: { status: 500 } },
       { description: 'when predicate does not match, skips validation', accept_request_filter: -> (request) { request.path.start_with?('/v1/x') }, expected: { status: 200 } },
-    ].each do |description:, accept_request_filter:, expected:|
+    ].each do |h|
+      description = h[:description]
+      accept_request_filter = h[:accept_request_filter]
+      expected = h[:expected]
       it description do
         @app = new_rack_app('not_json', {}, schema: hyper_schema, prefix: '/v1', accept_request_filter: accept_request_filter)
 
@@ -181,6 +184,9 @@ describe Committee::Middleware::ResponseValidation do
   private
 
   def new_rack_app(response, headers = {}, options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     headers = {
       "Content-Type" => "application/json"
     }.merge(headers)

data/test/middleware/stub_test.rb

@@ -112,6 +112,10 @@ describe Committee::Middleware::Stub do
   def new_rack_app(options = {})
     response = options.delete(:response)
     suppress = options.delete(:suppress)
+
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
     Rack::Builder.new {
       use Committee::Middleware::Stub, options
       run lambda { |env|

data/test/request_unpacker_test.rb

@@ -13,6 +13,16 @@ describe Committee::RequestUnpacker do
     assert_equal({ "x" => "y" }, params)
   end
 
+  it "unpacks JSON on Content-Type: application/vnd.api+json" do
+    env = {
+      "CONTENT_TYPE" => "application/vnd.api+json",
+      "rack.input"   => StringIO.new('{"x":"y"}'),
+    }
+    request = Rack::Request.new(env)
+    params, _ = Committee::RequestUnpacker.new(request).call
+    assert_equal({ "x" => "y" }, params)
+  end
+
   it "unpacks JSON on no Content-Type" do
     env = {
       "rack.input"   => StringIO.new('{"x":"y"}'),
@@ -22,6 +32,16 @@ describe Committee::RequestUnpacker do
     assert_equal({ "x" => "y" }, params)
   end
 
+  it "doesn't unpack JSON on application/x-ndjson" do
+    env = {
+      "CONTENT_TYPE" => "application/x-ndjson",
+      "rack.input"   => StringIO.new('{"x":"y"}\n{"a":"b"}'),
+    }
+    request = Rack::Request.new(env)
+    params, _ = Committee::RequestUnpacker.new(request).call
+    assert_equal({}, params)
+  end
+
   it "doesn't unpack JSON under other Content-Types" do
     %w[application/x-www-form-urlencoded multipart/form-data].each do |content_type|
       env = {
@@ -100,7 +120,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = hyper_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = hyper_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       schema = JsonSchema::Schema.new
@@ -133,7 +156,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = open_api_3_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = open_api_3_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       params, _ = Committee::RequestUnpacker.new(
@@ -158,7 +184,10 @@ describe Committee::RequestUnpacker do
       }
       request = Rack::Request.new(env)
 
-      router = open_api_3_schema.build_router({})
+      options = {}
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = false
+      router = open_api_3_schema.build_router(options)
       validator = router.build_schema_validator(request)
 
       params, _ = Committee::RequestUnpacker.new(

data/test/schema_validator/hyper_schema/router_test.rb

@@ -69,6 +69,8 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def hyper_schema_router(options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
     schema = Committee::Drivers::HyperSchema::Driver.new.parse(hyper_schema_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 
@@ -76,6 +78,8 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def open_api_2_router(options = {})
+    # TODO: delete when 5.0.0 released because default value changed
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
     schema = Committee::Drivers::OpenAPI2::Driver.new.parse(open_api_2_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 

data/test/schema_validator/open_api_3/operation_wrapper_test.rb

@@ -9,7 +9,12 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
     before do
       @path = '/validate'
       @method = 'post'
-      @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+
+      # TODO: delete when 5.0.0 released because default value changed
+      options = {}
+      options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+
+      @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
     end
 
     def operation_object
@@ -52,8 +57,8 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         operation_object.validate_request_params({"string" => 1}, HEADER, @validator_option)
       }
 
-      # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-      assert_match(/expected string, but received #{1.class}: 1/i, e.message)
+      assert_match(/expected string, but received Integer: 1/i, e.message)
+      assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
     end
 
     it 'support put method' do
@@ -64,8 +69,8 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         operation_object.validate_request_params({"string" => 1}, HEADER, @validator_option)
       }
 
-      # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-      assert_match(/expected string, but received #{1.class}: 1/i, e.message)
+      assert_match(/expected string, but received Integer: 1/i, e.message)
+      assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
     end
 
     it 'support patch method' do
@@ -77,6 +82,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
       }
 
       assert_match(/expected integer, but received String: str/i, e.message)
+      assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
     end
 
     it 'unknown param' do
@@ -110,6 +116,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         }
 
         assert_match(/missing required parameters: query_string/i, e.message)
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
       end
 
       it 'invalid type' do
@@ -121,8 +128,8 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
           )
         }
 
-        # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
-        assert_match(/expected string, but received #{1.class}: 1/i, e.message)
+        assert_match(/expected string, but received Integer: 1/i, e.message)
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
       end
     end
 
@@ -144,6 +151,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         }
 
         assert_match(/expected integer, but received String: a/i, e.message)
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
       end
     end
 

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -72,6 +72,9 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
     end
 
     def new_rack_app(options = {})
+      # TODO: delete when 5.0.0 released because default value changed
+      options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+    
       Rack::Builder.new {
         use Committee::Middleware::RequestValidation, options
         run lambda { |_|

data/test/schema_validator/open_api_3/response_validator_test.rb

@@ -12,7 +12,12 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
 
     @path = '/validate'
     @method = 'post'
-    @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+
+    # TODO: delete when 5.0.0 released because default value changed
+    options = {}
+    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
+    
+    @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
   end
 
   it "passes through a valid response" do
@@ -29,11 +34,12 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
-  it "passes through a valid response with no registered Content-Type with strict = true" do
+  it "raises InvalidResponse when a valid response with no registered body with strict option" do
     @headers = { "Content-Type" => "application/xml" }
-    assert_raises(Committee::InvalidResponse) {
+    e = assert_raises(Committee::InvalidResponse) {
       call_response_validator(true)
     }
+    assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
   end
 
   it "passes through a valid response with no Content-Type" do
@@ -41,11 +47,12 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     call_response_validator
   end
 
-  it "passes through a valid response with no Content-Type with strict option" do
+  it "raises InvalidResponse when a valid response with no Content-Type headers with strict option" do
     @headers = {}
-    assert_raises(Committee::InvalidResponse) {
+    e = assert_raises(Committee::InvalidResponse) {
       call_response_validator(true)
     }
+    assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
   end
 
   it "passes through a valid list response" do