committee 2.5.1 → 3.0.0.alpha

data/test/middleware/request_validation_test.rb

@@ -373,6 +373,24 @@ describe Committee::Middleware::RequestValidation do
     assert_match(/invalid request/i, last_response.body)
   end
 
+  it "OpenAPI3 pass through a valid request" do
+    @app = new_rack_app(open_api_3: open_api_3_schema)
+    get "/characters"
+    assert_equal 200, last_response.status
+  end
+
+  it "OpenAPI3 pass not exist href" do
+    @app = new_rack_app(open_api_3: open_api_3_schema)
+    get "/unknown"
+    assert_equal 200, last_response.status
+  end
+
+  it "OpenAPI3 pass not exist href in strict mode" do
+    @app = new_rack_app(open_api_3: open_api_3_schema, strict: true)
+    get "/unknown"
+    assert_equal 404, last_response.status
+  end
+
   private
 
   def new_rack_app(options = {})

data/test/middleware/response_validation_open_api_3_test.rb

@@ -0,0 +1,96 @@
+require_relative "../test_helper"
+
+describe Committee::Middleware::ResponseValidation do
+  include Rack::Test::Methods
+
+  CHARACTERS_RESPONSE = {"Otonokizaka" => ["Honoka.Kousaka"]}
+
+  def app
+    @app
+  end
+
+  it "passes through a valid response" do
+    @app = new_response_rack(JSON.generate(CHARACTERS_RESPONSE), {}, open_api_3: open_api_3_schema)
+    get "/characters"
+    assert_equal 200, last_response.status
+  end
+
+  it "passes through a invalid json" do
+    @app = new_response_rack("not_json", {}, open_api_3: open_api_3_schema)
+
+    get "/characters"
+
+    assert_equal 500, last_response.status
+    assert_equal "{\"id\":\"invalid_response\",\"message\":\"Response wasn't valid JSON.\"}", last_response.body
+  end
+
+  it "passes through not definition" do
+    @app = new_response_rack(JSON.generate(CHARACTERS_RESPONSE), {}, open_api_3: open_api_3_schema)
+    get "/no_data"
+    assert_equal 200, last_response.status
+  end
+
+  it "detects a response invalid due to schema" do
+    @app = new_response_rack("[]", {}, open_api_3: open_api_3_schema)
+
+    e = assert_raises(Committee::InvalidRequest) { # TODO: change invalid request
+      get "/characters"
+    }
+
+    assert_match(/class is Array but it's not valid object/i, e.message)
+  end
+
+  it "passes through a 204 (no content) response" do
+    @app = new_response_rack("", {}, {open_api_3: open_api_3_schema}, {status: 204})
+    post "/validate"
+    assert_equal 204, last_response.status
+  end
+
+  it "passes through a valid response with prefix" do
+    @app = new_response_rack(JSON.generate(CHARACTERS_RESPONSE), {}, open_api_3: open_api_3_schema, prefix: "/v1")
+    get "/v1/characters"
+    assert_equal 200, last_response.status
+  end
+
+  it "passes through a invalid json with prefix" do
+    @app = new_response_rack("not_json", {}, open_api_3: open_api_3_schema, prefix: "/v1")
+
+    get "/v1/characters"
+
+    # TODO: support prefix
+    assert_equal 200, last_response.status
+    # assert_equal 500, last_response.status
+    # assert_equal "{\"id\":\"invalid_response\",\"message\":\"Response wasn't valid JSON.\"}", last_response.body
+  end
+
+  it "rescues JSON errors" do
+    @app = new_response_rack("_42", {}, open_api_3: open_api_3_schema, raise: true)
+    assert_raises(Committee::InvalidResponse) do
+      get "/characters"
+    end
+  end
+
+  it "not parameter requset" do
+    @app = new_response_rack({integer: '1'}.to_json, {}, open_api_3: open_api_3_schema)
+
+    # TODO: error change
+    assert_raises(Committee::InvalidRequest) do
+      patch "/validate_no_parameter", {no_schema: 'no'}
+    end
+  end
+
+  private
+
+  def new_response_rack(response, headers = {}, options = {}, rack_options = {})
+    status = rack_options[:status] || 200
+    headers = {
+      "Content-Type" => "application/json"
+    }.merge(headers)
+    Rack::Builder.new {
+      use Committee::Middleware::ResponseValidation, options
+      run lambda { |_|
+        [options.fetch(:app_status, status), headers, [response]]
+      }
+    }
+  end
+end

data/test/middleware/response_validation_test.rb

@@ -15,8 +15,8 @@ describe Committee::Middleware::ResponseValidation do
 
   it "doesn't call error_handler when response is valid" do
     called = false
-    pr = ->(_e) { called = true }
-    @app = new_rack_app(JSON.generate([ValidApp]), {}, schema: hyper_schema, error_handler: pr)
+    pr = ->(e) { called = true }
+    @app = new_rack_app(JSON.generate([ValidApp]), {}, schema: hyper_schema)
     get "/apps"
     assert !called, "error_handler is called"
   end
@@ -29,7 +29,7 @@ describe Committee::Middleware::ResponseValidation do
   end
 
   it "detects a response invalid due to not being JSON" do
-    @app = new_rack_app("{_}", {}, schema: hyper_schema)
+    @app = new_rack_app("", {}, schema: hyper_schema)
     get "/apps"
     assert_equal 500, last_response.status
     assert_match(/valid JSON/i, last_response.body)
@@ -41,26 +41,10 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal 404, last_response.status
   end
 
-  it "optionally validates non-2xx invalid responses and deprecated option" do
-    mock(Committee).warn_deprecated.with_any_args
-
-    @app = new_rack_app("{_}", {}, app_status: 404, validate_errors: true,
-                        schema: hyper_schema)
-
-    get "/apps"
-    assert_equal 500, last_response.status
-    assert_match(/valid JSON/i, last_response.body)
-  end
-
   it "optionally validates non-2xx invalid responses" do
-    @app = new_rack_app("", {}, app_status: 404, validate_success_only: false, schema: hyper_schema)
-    get "/apps"
-    assert_equal 500, last_response.status
-    assert_match(/Invalid response/i, last_response.body)
-  end
+    @app = new_rack_app("", {}, app_status: 404, validate_errors: true,
+      schema: hyper_schema)
 
-  it "optionally validates non-2xx invalid responses with invalid json" do
-    @app = new_rack_app("{_}", {}, app_status: 404, validate_success_only: false, schema: hyper_schema)
     get "/apps"
     assert_equal 500, last_response.status
     assert_match(/valid JSON/i, last_response.body)
@@ -72,15 +56,8 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal 204, last_response.status
   end
 
-  it "skip validation when 4xx" do
-    @app = new_rack_app("[{x:y}]", {}, schema: hyper_schema, validate_success_only: true, app_status: 400)
-    get "/apps"
-    assert_equal 400, last_response.status
-    assert_match("[{x:y}]", last_response.body)
-  end
-
   it "rescues JSON errors" do
-    @app = new_rack_app("[{x:y}]", {}, schema: hyper_schema, validate_success_only: false)
+    @app = new_rack_app("[{x:y}]", {}, schema: hyper_schema)
     get "/apps"
     assert_equal 500, last_response.status
     assert_match(/valid json/i, last_response.body)
@@ -126,7 +103,7 @@ describe Committee::Middleware::ResponseValidation do
   end
 
   it "detects an invalid response for OpenAPI" do
-    @app = new_rack_app("{_}", {}, schema: open_api_2_schema)
+    @app = new_rack_app("", {}, schema: open_api_2_schema)
     get "/api/pets"
     assert_equal 500, last_response.status
     assert_match(/valid JSON/i, last_response.body)

data/test/middleware/stub_test.rb

@@ -96,6 +96,15 @@ describe Committee::Middleware::Stub do
     assert_equal({ "cached" => true }, data)
   end
 
+  it "caches the response if called multiple times" do
+    cache = {}
+    @app = new_rack_app(cache: cache, open_api_3: open_api_3_schema)
+
+    assert_raises(Committee::NotSupportOpenAPI3) do
+      get "/characters"
+    end
+  end
+
   private
 
   def new_rack_app(options = {})

data/test/request_unpacker_test.rb

@@ -94,46 +94,80 @@ describe Committee::RequestUnpacker do
 
   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"]
 
-      env = {
-        "CONTENT_TYPE" => content_type,
-        "rack.input"   => StringIO.new("x=1"),
-      }
-      request = Rack::Request.new(env)
+      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: schema
+        schema_validator: validator,
       ).call
       assert_equal({ "x" => 1 }, params)
     end
   end
 
-  it "coerces form params with coerce_form_params, coerce_recursive and a schema" do
+  it "coerces form params with coerce_form_params and a OpenAPI3 schema" do
     %w[application/x-www-form-urlencoded multipart/form-data].each do |content_type|
-      schema = JsonSchema::Schema.new
-      schema.properties = { "x" => JsonSchema::Schema.new }
-      schema.properties["x"].type = ["object"]
-      schema.properties["x"].properties = { "y" => JsonSchema::Schema.new }
-      schema.properties["x"].properties["y"].type = ["integer"]
+      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("x[y]=1"),
+          "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,
-        coerce_recursive: true,
-        schema: schema
-      ).call
-      assert_equal({ "x" => { "y" => 1 } }, params)
+          request,
+          allow_form_params: true,
+          coerce_form_params: true,
+          schema_validator: validator,
+          ).call
+      assert_equal({ "limit" => "twenty" }, params)
     end
   end
 

data/test/{request_validator_test.rb → schema_validator/hyper_schema/request_validator_test.rb}

@@ -1,8 +1,8 @@
-require_relative "test_helper"
+require_relative "../../test_helper"
 
 require "stringio"
 
-describe Committee::RequestValidator do
+describe Committee::SchemaValidator::HyperSchema::RequestValidator do
   describe 'HyperSchema' do
     before do
       @schema = JsonSchema.parse!(hyper_schema_data)
@@ -100,7 +100,7 @@ describe Committee::RequestValidator do
     def call(data, headers={}, options={})
       # hyper-schema link should be dropped into driver wrapper before it's used
       link = Committee::Drivers::HyperSchema::Link.new(@link)
-      Committee::RequestValidator.new(link, options).call(@request, data, headers)
+      Committee::SchemaValidator::HyperSchema::RequestValidator.new(link, options).call(@request, data, headers)
     end
   end
 
@@ -143,7 +143,7 @@ describe Committee::RequestValidator do
 
     def call(data, headers={}, options={})
       # hyper-schema link should be dropped into driver wrapper before it's used
-      Committee::RequestValidator.new(@link, options).call(@request, data, headers)
+      Committee::SchemaValidator::HyperSchema::RequestValidator.new(@link, options).call(@request, data, headers)
     end
   end
 end

data/test/{response_generator_test.rb → schema_validator/hyper_schema/response_generator_test.rb}

@@ -1,6 +1,6 @@
-require_relative "test_helper"
+require_relative "../../test_helper"
 
-describe Committee::ResponseGenerator do
+describe Committee::SchemaValidator::HyperSchema::ResponseGenerator do
   before do
     @schema = JsonSchema.parse!(hyper_schema_data)
     @schema.expand_references!
@@ -75,7 +75,7 @@ describe Committee::ResponseGenerator do
     link.target_schema = JsonSchema::Schema.new
     link.target_schema.enum = ["foo"]
     link.target_schema.type = ["string"]
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_equal("foo", data)
   end
 
@@ -84,15 +84,15 @@ describe Committee::ResponseGenerator do
     link.target_schema = JsonSchema::Schema.new
 
     link.target_schema.type = ["integer"]
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_equal 0, data
 
     link.target_schema.type = ["null"]
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_nil data
 
     link.target_schema.type = ["string"]
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_equal "", data
   end
 
@@ -100,7 +100,7 @@ describe Committee::ResponseGenerator do
     link = Committee::Drivers::OpenAPI2::Link.new
     link.target_schema = JsonSchema::Schema.new
     link.target_schema.type = ["array"]
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_equal([], data)
   end
 
@@ -108,7 +108,7 @@ describe Committee::ResponseGenerator do
     link = Committee::Drivers::OpenAPI2::Link.new
     link.target_schema = JsonSchema::Schema.new
     link.target_schema.type = ["object"]
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_equal({}, data)
   end
 
@@ -119,7 +119,7 @@ describe Committee::ResponseGenerator do
     link.target_schema.data = { "example" => 123 }
     link.target_schema.type = ["integer"]
 
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_equal 123, data
   end
 
@@ -128,13 +128,13 @@ describe Committee::ResponseGenerator do
     link.target_schema = JsonSchema::Schema.new
 
     link.target_schema.type = ["null", "integer"]
-    data, _schema = Committee::ResponseGenerator.new.call(link)
+    data, _schema = Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
     assert_equal 0, data
   end
 
   def call
     # hyper-schema link should be dropped into driver wrapper before it's used
     link = Committee::Drivers::HyperSchema::Link.new(@link)
-    Committee::ResponseGenerator.new.call(link)
+    Committee::SchemaValidator::HyperSchema::ResponseGenerator.new.call(link)
   end
 end

data/test/{response_validator_test.rb → schema_validator/hyper_schema/response_validator_test.rb}

@@ -1,6 +1,6 @@
-require_relative "test_helper"
+require_relative "../../test_helper"
 
-describe Committee::ResponseValidator do
+describe Committee::SchemaValidator::HyperSchema::ResponseValidator do
   before do
     @status = 200
     @headers = {
@@ -101,6 +101,6 @@ describe Committee::ResponseValidator do
   def call
     # hyper-schema link should be dropped into driver wrapper before it's used
     link = Committee::Drivers::HyperSchema::Link.new(@link)
-    Committee::ResponseValidator.new(link).call(@status, @headers, @data)
+    Committee::SchemaValidator::HyperSchema::ResponseValidator.new(link).call(@status, @headers, @data)
   end
 end

data/test/{router_test.rb → schema_validator/hyper_schema/router_test.rb}

@@ -1,6 +1,6 @@
-require_relative "test_helper"
+require_relative "../../test_helper"
 
-describe Committee::Router do
+describe Committee::SchemaValidator::HyperSchema::Router do
   it "builds routes without parameters" do
     link, _ = hyper_schema_router.find_link("GET", "/apps")
     refute_nil link
@@ -60,19 +60,17 @@ describe Committee::Router do
     assert_equal '/api/pets/dog', link.href
   end
 
-  it "fewer match not support in HyperSchema" do
-    link, _ = hyper_schema_router.find_link("GET", "/apps/abc")
-    refute_nil link
-    assert_equal '/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fname)}', link.href
-  end
-
   def hyper_schema_router(options = {})
     schema = Committee::Drivers::HyperSchema.new.parse(hyper_schema_data)
-    Committee::Router.new(schema, options)
+    validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
+
+    Committee::SchemaValidator::HyperSchema::Router.new(schema, validator_option)
   end
 
   def open_api_2_router(options = {})
     schema = Committee::Drivers::OpenAPI2.new.parse(open_api_2_data)
-    Committee::Router.new(schema, options)
+    validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
+
+    Committee::SchemaValidator::HyperSchema::Router.new(schema, validator_option)
   end
 end