committee 4.0.0 → 4.4.0.rc1

data/test/middleware/request_validation_test.rb

@@ -435,6 +435,19 @@ describe Committee::Middleware::RequestValidation do
     assert_equal 200, last_response.status
   end
 
+  it "corce form params" do
+    check_parameter = lambda { |env|
+      assert_equal 3, env['committee.params']['age']
+      assert_equal 3, env['committee.request_body_hash']['age']
+      [200, {}, []]
+    }
+
+    @app = new_rack_app_with_lambda(check_parameter, schema: open_api_2_form_schema, raise: true, allow_form_params: true, coerce_form_params: true)
+    header "Content-Type", "application/x-www-form-urlencoded"
+    post "/api/pets", "age=3&name=ab"
+    assert_equal 200, last_response.status
+  end
+
   it "detects an invalid request for OpenAPI" do
     @app = new_rack_app(schema: open_api_2_schema)
     get "/api/pets?limit=foo", nil, { "HTTP_AUTH_TOKEN" => "xxx" }
@@ -519,6 +532,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"
@@ -117,7 +125,7 @@ describe Committee::Middleware::ResponseValidation do
     [
       { check_header: true, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
       { check_header: true, description: 'missing value', header: { 'integer' => nil }, expected: { error: 'headers/integer/schema does not allow null values' } },
-      { check_header: true, description: 'invalid value', header: { 'integer' => 'x' }, expected: { error: 'headers/integer/schema expected integer, but received String: x' } },
+      { check_header: true, description: 'invalid value', header: { 'integer' => 'x' }, expected: { error: 'headers/integer/schema expected integer, but received String: "x"' } },
 
       { check_header: false, description: 'valid value', header: { 'integer' => 1 }, expected: { status: 200 } },
       { check_header: false, description: 'missing value', header: { 'integer' => nil }, expected: { status: 200 } },
@@ -169,7 +177,7 @@ describe Committee::Middleware::ResponseValidation do
         get "/characters"
       end
 
-      assert_match(/but received String: 1/i, e.message)
+      assert_match(/but received String: \"1\"/i, e.message)
     end
 
     it "detects an invalid response status code with validate_success_only=true" do
@@ -207,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

@@ -15,6 +15,14 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal 200, last_response.status
   end
 
+  # TODO: remove 5.0.0
+  it "passes through a valid response" do
+    # will show deprecated message
+    @app = new_rack_app(JSON.generate([ValidApp]), {}, schema: hyper_schema, strict: true)
+    get "/apps"
+    assert_equal 200, last_response.status
+  end
+
   it "doesn't call error_handler (has a arg) when response is valid" do
     called = false
     pr = ->(_e) { called = true }
@@ -184,6 +192,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

@@ -9,8 +9,18 @@ describe Committee::RequestUnpacker do
       "rack.input"   => StringIO.new('{"x":"y"}'),
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request).call
-    assert_equal({ "x" => "y" }, params)
+    unpacker = Committee::RequestUnpacker.new
+    assert_equal([{ "x" => "y" }, false], unpacker.unpack_request_params(request))
+  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)
+    unpacker = Committee::RequestUnpacker.new
+    assert_equal([{ "x" => "y" }, false], unpacker.unpack_request_params(request))
   end
 
   it "unpacks JSON on no Content-Type" do
@@ -18,8 +28,18 @@ describe Committee::RequestUnpacker do
       "rack.input"   => StringIO.new('{"x":"y"}'),
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request).call
-    assert_equal({ "x" => "y" }, params)
+    unpacker = Committee::RequestUnpacker.new
+    assert_equal([{ "x" => "y" }, false], unpacker.unpack_request_params(request))
+  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)
+    unpacker = Committee::RequestUnpacker.new
+    assert_equal([{}, false], unpacker.unpack_request_params(request))
   end
 
   it "doesn't unpack JSON under other Content-Types" do
@@ -29,8 +49,8 @@ describe Committee::RequestUnpacker do
         "rack.input"   => StringIO.new('{"x":"y"}'),
       }
       request = Rack::Request.new(env)
-      params, _ = Committee::RequestUnpacker.new(request).call
-      assert_equal({}, params)
+      unpacker = Committee::RequestUnpacker.new
+      assert_equal([{}, false], unpacker.unpack_request_params(request))
     end
   end
 
@@ -41,8 +61,8 @@ describe Committee::RequestUnpacker do
         "rack.input"   => StringIO.new('{"x":"y"}'),
       }
       request = Rack::Request.new(env)
-      params, _ = Committee::RequestUnpacker.new(request, optimistic_json: true).call
-      assert_equal({ "x" => "y" }, params)
+      unpacker = Committee::RequestUnpacker.new(optimistic_json: true)
+      assert_equal([{ "x" => "y" }, false], unpacker.unpack_request_params(request))
     end
   end
 
@@ -53,8 +73,8 @@ describe Committee::RequestUnpacker do
         "rack.input"   => StringIO.new('x=y&foo=42'),
       }
       request = Rack::Request.new(env)
-      params, _ = Committee::RequestUnpacker.new(request, optimistic_json: true).call
-      assert_equal({}, params)
+      unpacker = Committee::RequestUnpacker.new(optimistic_json: true)
+      assert_equal([{}, false], unpacker.unpack_request_params(request))
     end
   end
 
@@ -64,8 +84,8 @@ describe Committee::RequestUnpacker do
       "rack.input"   => StringIO.new(""),
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request).call
-    assert_equal({}, params)
+    unpacker = Committee::RequestUnpacker.new
+    assert_equal([{}, false], unpacker.unpack_request_params(request))
   end
 
   it "doesn't unpack form params" do
@@ -75,8 +95,8 @@ describe Committee::RequestUnpacker do
         "rack.input"   => StringIO.new("x=y"),
       }
       request = Rack::Request.new(env)
-      params, _ = Committee::RequestUnpacker.new(request).call
-      assert_equal({}, params)
+      unpacker = Committee::RequestUnpacker.new
+      assert_equal([{}, false], unpacker.unpack_request_params(request))
     end
   end
 
@@ -87,87 +107,8 @@ describe Committee::RequestUnpacker do
         "rack.input"   => StringIO.new("x=y"),
       }
       request = Rack::Request.new(env)
-      params, _ = Committee::RequestUnpacker.new(request, allow_form_params: true).call
-      assert_equal({ "x" => "y" }, params)
-    end
-  end
-
-  it "coerces form params with coerce_form_params and a schema" do
-    %w[application/x-www-form-urlencoded multipart/form-data].each do |content_type|
-      env = {
-          "CONTENT_TYPE" => content_type,
-          "rack.input"   => StringIO.new("x=1"),
-      }
-      request = Rack::Request.new(env)
-
-      router = hyper_schema.build_router({})
-      validator = router.build_schema_validator(request)
-
-      schema = JsonSchema::Schema.new
-      schema.properties = { "x" => JsonSchema::Schema.new }
-      schema.properties["x"].type = ["integer"]
-
-      link_class = Struct.new(:schema)
-      link_object = link_class.new(schema)
-
-      validator.instance_variable_set(:@link, link_object)
-
-      params, _ = Committee::RequestUnpacker.new(
-        request,
-        allow_form_params: true,
-        coerce_form_params: true,
-        schema_validator: validator,
-      ).call
-      assert_equal({ "x" => 1 }, params)
-    end
-  end
-
-  it "coerces form params with coerce_form_params and an OpenAPI3 schema" do
-    %w[application/x-www-form-urlencoded multipart/form-data].each do |content_type|
-      env = {
-          "CONTENT_TYPE" => content_type,
-          "rack.input"   => StringIO.new("limit=20"),
-          "PATH_INFO" => "/characters",
-          "SCRIPT_NAME" => "",
-          "REQUEST_METHOD" => "GET",
-      }
-      request = Rack::Request.new(env)
-
-      router = open_api_3_schema.build_router({})
-      validator = router.build_schema_validator(request)
-
-      params, _ = Committee::RequestUnpacker.new(
-          request,
-          allow_form_params: true,
-          coerce_form_params: true,
-          schema_validator: validator,
-          ).call
-      # openapi3 not support coerce in request unpacker
-      assert_equal({ "limit" => '20' }, params)
-    end
-  end
-
-  it "coerces error params with coerce_form_params and a OpenAPI3 schema" do
-    %w[application/x-www-form-urlencoded multipart/form-data].each do |content_type|
-      env = {
-          "CONTENT_TYPE" => content_type,
-          "rack.input"   => StringIO.new("limit=twenty"),
-          "PATH_INFO" => "/characters",
-          "SCRIPT_NAME" => "",
-          "REQUEST_METHOD" => "GET",
-      }
-      request = Rack::Request.new(env)
-
-      router = open_api_3_schema.build_router({})
-      validator = router.build_schema_validator(request)
-
-      params, _ = Committee::RequestUnpacker.new(
-          request,
-          allow_form_params: true,
-          coerce_form_params: true,
-          schema_validator: validator,
-          ).call
-      assert_equal({ "limit" => "twenty" }, params)
+      unpacker = Committee::RequestUnpacker.new(allow_form_params: true)
+      assert_equal([{ "x" => "y" }, true], unpacker.unpack_request_params(request))
     end
   end
 
@@ -179,8 +120,8 @@ describe Committee::RequestUnpacker do
         "QUERY_STRING" => "a=b"
       }
       request = Rack::Request.new(env)
-      params, _ = Committee::RequestUnpacker.new(request, allow_form_params: true, allow_query_params: true).call
-      assert_equal({ "x" => "y", "a" => "b" }, params)
+      unpacker = Committee::RequestUnpacker.new(allow_form_params: true, allow_query_params: true)
+      assert_equal([ { "x" => "y"}, true], unpacker.unpack_request_params(request))
     end
   end
 
@@ -190,8 +131,8 @@ describe Committee::RequestUnpacker do
       "QUERY_STRING" => "a=b"
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request, allow_query_params: true).call
-    assert_equal({ "a" => "b" }, params)
+    unpacker = Committee::RequestUnpacker.new(allow_query_params: true)
+    assert_equal({ "a" => "b" }, unpacker.unpack_query_params(request))
   end
 
   it "errors if JSON is not an object" do
@@ -201,7 +142,7 @@ describe Committee::RequestUnpacker do
     }
     request = Rack::Request.new(env)
     assert_raises(Committee::BadRequest) do
-      Committee::RequestUnpacker.new(request).call
+      Committee::RequestUnpacker.new.unpack_request_params(request)
     end
   end
 
@@ -211,8 +152,8 @@ describe Committee::RequestUnpacker do
       "rack.input"   => StringIO.new('{"x":"y"}'),
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request).call
-    assert_equal({}, params)
+    unpacker = Committee::RequestUnpacker.new
+    assert_equal([{}, false], unpacker.unpack_request_params(request))
   end
 
   # this is mostly here for line coverage
@@ -221,8 +162,8 @@ describe Committee::RequestUnpacker do
       "rack.input" => StringIO.new('{"x":[]}'),
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request).call
-    assert_equal({ "x" => [] }, params)
+    unpacker = Committee::RequestUnpacker.new
+    assert_equal([{ "x" => [] }, false], unpacker.unpack_request_params(request))
   end
 
   it "unpacks http header" do
@@ -231,8 +172,8 @@ describe Committee::RequestUnpacker do
       "rack.input"   => StringIO.new(""),
     }
     request = Rack::Request.new(env)
-    _, headers = Committee::RequestUnpacker.new(request, { allow_header_params: true }).call
-    assert_equal({ "FOO-BAR" => "some header value" }, headers)
+    unpacker = Committee::RequestUnpacker.new({ allow_header_params: true })
+    assert_equal({ "FOO-BAR" => "some header value" }, unpacker.unpack_headers(request))
   end
 
   it "includes request body when`use_get_body` is true" do
@@ -242,8 +183,8 @@ describe Committee::RequestUnpacker do
         "QUERY_STRING"=>"data=value&x=aaa",
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request, { allow_query_params: true, allow_get_body: true }).call
-    assert_equal({ 'data' => 'value', 'x' => 1, 'y' => 2 }, params)
+    unpacker = Committee::RequestUnpacker.new({ allow_query_params: true, allow_get_body: true })
+    assert_equal([{ 'x' => 1, 'y' => 2 }, false], unpacker.unpack_request_params(request))
   end
 
   it "doesn't include request body when `use_get_body` is false" do
@@ -253,7 +194,7 @@ describe Committee::RequestUnpacker do
         "QUERY_STRING"=>"data=value&x=aaa",
     }
     request = Rack::Request.new(env)
-    params, _ = Committee::RequestUnpacker.new(request, { allow_query_params: true, use_get_body: false }).call
-    assert_equal({ 'data' => 'value', 'x' => 'aaa' }, params)
+    unpacker = Committee::RequestUnpacker.new({ allow_query_params: true, use_get_body: false })
+    assert_equal({ 'data' => 'value', 'x' => 'aaa' }, unpacker.unpack_query_params(request))
   end
 end

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
@@ -53,6 +58,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
       }
 
       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,6 +70,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
       }
 
       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
@@ -74,7 +81,8 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         operation_object.validate_request_params({"integer" => "str"}, HEADER, @validator_option)
       }
 
-      assert_match(/expected integer, but received String: str/i, e.message)
+      assert_match(/expected integer, but received String: "str"/i, e.message)
+      assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
     end
 
     it 'unknown param' do
@@ -108,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
@@ -120,6 +129,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
         }
 
         assert_match(/expected string, but received Integer: 1/i, e.message)
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
       end
     end
 
@@ -140,7 +150,8 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
           operation_object.validate_request_params({"limit" => "a"}, HEADER, @validator_option)
         }
 
-        assert_match(/expected integer, but received String: a/i, e.message)
+        assert_match(/expected integer, but received String: "a"/i, e.message)
+        assert_kind_of(OpenAPIParser::OpenAPIError, e.original_error)
       end
     end