committee 2.5.1 → 3.0.0.alpha

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

@@ -1,6 +1,6 @@
-require_relative "test_helper"
+require_relative "../../test_helper"
 
-describe Committee::StringParamsCoercer do
+describe Committee::SchemaValidator::HyperSchema::StringParamsCoercer do
   before do
     @schema = JsonSchema.parse!(hyper_schema_data)
     @schema.expand_references!
@@ -130,6 +130,6 @@ describe Committee::StringParamsCoercer do
   end
 
   def call(data, options={})
-    Committee::StringParamsCoercer.new(data, @link.schema, options).call!
+    Committee::SchemaValidator::HyperSchema::StringParamsCoercer.new(data, @link.schema, options).call!
   end
 end

data/test/schema_validator/open_api_3/operation_wrapper_test.rb

@@ -0,0 +1,132 @@
+require_relative "../../test_helper"
+
+require "stringio"
+
+describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
+  describe 'validate' do
+    before do
+      @path = '/validate'
+      @method = 'post'
+      @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+    end
+
+    def operation_object
+      open_api_3_schema.operation_object(@path, @method)
+    end
+
+    SCHEMA_PROPERTIES_PAIR = [
+        ['string', 'str'],
+        ['integer', 1],
+        ['boolean', true],
+        ['boolean', false],
+        ['number', 0.1],
+    ]
+
+    it 'correct data' do
+      operation_object.validate_request_params(SCHEMA_PROPERTIES_PAIR.to_h, @validator_option)
+      assert true
+    end
+
+    it 'correct object data' do
+      operation_object.validate_request_params({
+                                     "object_1" =>
+                                         {
+                                             "string_1" => nil,
+                                             "integer_1" => nil,
+                                             "boolean_1" => nil,
+                                             "number_1" => nil
+                                         }
+                                 },
+                                               @validator_option)
+
+      assert true
+    end
+
+    it 'invalid params' do
+      e = assert_raises(Committee::InvalidRequest) {
+        operation_object.validate_request_params({"string" => 1}, @validator_option)
+      }
+
+      # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
+      assert e.message.start_with?("1 class is #{1.class} but it's not valid")
+    end
+
+    it 'support put method' do
+      @method = "put"
+      operation_object.validate_request_params({"string" => "str"}, @validator_option)
+
+      e = assert_raises(Committee::InvalidRequest) {
+        operation_object.validate_request_params({"string" => 1}, @validator_option)
+      }
+
+      # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
+      assert e.message.start_with?("1 class is #{1.class} but it's not valid")
+    end
+
+    it 'support patch method' do
+      @method = "patch"
+      operation_object.validate_request_params({"integer" => 1}, @validator_option)
+
+      e = assert_raises(Committee::InvalidRequest) {
+        operation_object.validate_request_params({"integer" => "str"}, @validator_option)
+      }
+
+      assert e.message.start_with?("str class is String but it's not valid")
+    end
+
+    it 'unknown param' do
+      operation_object.validate_request_params({"unknown" => 1}, @validator_option)
+    end
+
+    describe 'support get method' do
+      before do
+        @method = "get"
+      end
+
+      it 'correct' do
+        operation_object.validate_request_params({"query_string" => "query", "query_integer_list" => [1, 2]}, @validator_option)
+        operation_object.validate_request_params({"query_string" => "query", "query_integer_list" => [1, 2], "optional_integer" => 1}, @validator_option)
+
+        assert true
+      end
+
+      it 'not exist required' do
+        e = assert_raises(Committee::InvalidRequest) {
+          operation_object.validate_request_params({"query_integer_list" => [1, 2]}, @validator_option)
+        }
+
+        assert e.message.start_with?("required parameters query_string not exist in")
+      end
+
+      it 'invalid type' do
+        e = assert_raises(Committee::InvalidRequest) {
+          operation_object.validate_request_params({"query_string" => 1, "query_integer_list" => [1, 2], "optional_integer" => 1}, @validator_option)
+        }
+
+        # FIXME: when ruby 2.3 dropped, fix because ruby 2.3 return Fixnum, ruby 2.4 or later return Integer
+        assert e.message.start_with?("1 class is #{1.class} but")
+      end
+    end
+
+    describe 'support delete method' do
+      before do
+        @path = '/characters'
+        @method = "delete"
+      end
+
+      it 'correct' do
+        operation_object.validate_request_params({"limit" => "1"}, @validator_option)
+
+        assert true
+      end
+
+      it 'invalid type' do
+        e = assert_raises(Committee::InvalidRequest) {
+          operation_object.validate_request_params({"limit" => "a"}, @validator_option)
+        }
+
+        assert e.message.start_with?("a class is String but")
+      end
+    end
+  end
+end

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -0,0 +1,151 @@
+require_relative "../../test_helper"
+
+require "stringio"
+
+# TODO: fix
+
+describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
+  describe 'open_api_3' do
+    before do
+      @schema = JsonSchema.parse!(hyper_schema_data)
+      @schema.expand_references!
+      # POST /apps/:id
+      @link = @schema.properties["app"].links[0]
+      @request = Rack::Request.new({
+                                     "CONTENT_TYPE"   => "application/json",
+                                     "rack.input"     => StringIO.new("{}"),
+                                     "REQUEST_METHOD" => "POST"
+                                   })
+    end
+
+    it "passes through a valid request with Content-Type options" do
+      @headers = { "Content-Type" => "application/json; charset=utf-8" }
+      call({})
+    end
+
+    it "passes through a valid request" do
+      data = {
+        "name" => "heroku-api",
+      }
+      call(data)
+    end
+
+    it "passes through a valid request with Content-Type options" do
+      @request =
+        Rack::Request.new({
+                            "CONTENT_TYPE" => "application/json; charset=utf-8",
+                            "rack.input"   => StringIO.new("{}"),
+                          })
+      data = {
+        "name" => "heroku-api",
+      }
+      call(data)
+    end
+
+    it "detects an invalid request Content-Type" do
+      e = assert_raises(Committee::InvalidRequest) {
+        @request =
+          Rack::Request.new({
+                              "CONTENT_TYPE" => "application/x-www-form-urlencoded",
+                              "rack.input"   => StringIO.new("{}"),
+                            })
+        call({})
+      }
+      message =
+        %{"Content-Type" request header must be set to "application/json".}
+      assert_equal message, e.message
+    end
+
+    it "allows skipping content_type check" do
+      @request =
+        Rack::Request.new({
+                            "CONTENT_TYPE" => "application/x-www-form-urlencoded",
+                            "rack.input"   => StringIO.new("{}"),
+                          })
+      call({}, {}, check_content_type: false)
+    end
+
+    it "detects an missing parameter in GET requests" do
+      # GET /apps/search?query=...
+      @link = @schema.properties["app"].links[5]
+      @request = Rack::Request.new({})
+      e = assert_raises(Committee::InvalidRequest) do
+        call({})
+      end
+      message =
+        %{Invalid request.\n\n#: failed schema #/definitions/app/links/5/schema: "query" wasn't supplied.}
+      assert_equal message, e.message
+    end
+
+    it "allows an invalid Content-Type with an empty body" do
+      @request =
+        Rack::Request.new({
+                            "CONTENT_TYPE" => "application/x-www-form-urlencoded",
+                            "rack.input"   => StringIO.new(""),
+                          })
+      call({})
+    end
+
+    it "detects a parameter of the wrong pattern" do
+      data = {
+        "name" => "%@!"
+      }
+      e = assert_raises(Committee::InvalidRequest) do
+        call(data)
+      end
+      message = %{Invalid request.\n\n#/name: failed schema #/definitions/app/links/0/schema/properties/name: %@! does not match /^[a-z][a-z0-9-]{3,30}$/.}
+      assert_equal message, e.message
+    end
+
+    private
+
+    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::SchemaValidator::HyperSchema::RequestValidator.new(link, options).call(@request, data, headers)
+    end
+  end
+
+  describe 'OpenAPI 2' do
+    before do
+      @schema = open_api_2_schema
+      @link = @schema.routes['GET'][0][1]
+      @request = Rack::Request.new({
+                                     "CONTENT_TYPE"   => "application/json",
+                                     "rack.input"     => StringIO.new("{}"),
+                                     "REQUEST_METHOD" => "POST"
+                                   })
+    end
+
+
+    it "passes through a valid request" do
+      headers = {
+        "AUTH-TOKEN" => "xxx"
+      }
+      call({}, headers)
+    end
+
+    it "detects an missing header parameter in GET requests" do
+      @link = @schema.routes['GET'][0][1]
+      @request = Rack::Request.new({})
+      e = assert_raises(Committee::InvalidRequest) do
+        call({}, {})
+      end
+      message = %{Invalid request.\n\n#: failed schema : "AUTH-TOKEN" wasn't supplied.}
+      assert_equal message, e.message
+    end
+
+    it "allows skipping header schema check" do
+      @link = @schema.routes['GET'][0][1]
+      @request = Rack::Request.new({})
+      call({}, {}, { check_header: false })
+    end
+
+    private
+
+    def call(data, headers={}, options={})
+      # hyper-schema link should be dropped into driver wrapper before it's used
+      Committee::SchemaValidator::HyperSchema::RequestValidator.new(@link, options).call(@request, data, headers)
+    end
+  end
+end

data/test/schema_validator/open_api_3/response_validator_test.rb

@@ -0,0 +1,55 @@
+require_relative "../../test_helper"
+
+describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
+  before do
+    @status = 200
+    @headers = {
+      "Content-Type" => "application/json"
+    }
+    @data = {"string" => "Honoka.Kousaka"}
+
+    @path = '/validate'
+    @method = 'post'
+    @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
+  end
+
+  it "passes through a valid response" do
+    call_response_validator
+  end
+
+  it "passes through a valid response with Content-Type options" do
+    @headers = { "Content-Type" => "application/json; charset=utf-8" }
+    call_response_validator
+  end
+
+  # TODO: raise error option
+  it "passes through a valid response with no registered Content-Type" do
+    @headers = { "Content-Type" => "application/xml" }
+    call_response_validator
+  end
+
+  # TODO: raise error option
+  it "passes through a valid response with no Content-Type" do
+    @headers = {}
+    call_response_validator
+  end
+
+  it "passes through a valid list response" do
+    @path = '/validate_response_array'
+    @method = 'get'
+    @data = ["Mari.Ohara"]
+    call_response_validator
+  end
+
+  it "passes through a 204 No Content response" do
+    @status, @headers, @data = 204, {}, nil
+    call_response_validator
+  end
+
+  private
+
+  def call_response_validator
+    @operation_object = open_api_3_schema.operation_object(@path, @method)
+    Committee::SchemaValidator::OpenAPI3::ResponseValidator.new(@operation_object, @validator_option).call(@status, @headers, @data)
+  end
+end

data/test/test/methods_new_version_test.rb

@@ -12,6 +12,14 @@ describe Committee::Test::Methods do
     @committee_options
   end
 
+  def request_object
+    last_request
+  end
+
+  def response_data
+    [last_response.status, last_response.headers, last_response.body]
+  end
+
   before do
     # This is a little icky, but the test methods will cache router and schema
     # values between tests. This makes sense in real life, but is harmful for
@@ -38,24 +46,7 @@ describe Committee::Test::Methods do
     end
 
     it "detects an invalid response Content-Type" do
-      @app = new_rack_app(JSON.generate([ValidApp]), 200, {})
-      get "/apps"
-      e = assert_raises(Committee::InvalidResponse) do
-        assert_schema_conform
-      end
-      assert_match(/response header must be set to/i, e.message)
-    end
-
-    it "detects an invalid response Content-Type but ignore because it's not success status code" do
-      @app = new_rack_app(JSON.generate([ValidApp]), 400, {})
-      get "/apps"
-      assert_schema_conform
-    end
-
-    it "detects an invalid response Content-Type and check all status code" do
-      @committee_options.merge!(validate_success_only: false)
-
-      @app = new_rack_app(JSON.generate([ValidApp]), 400, {})
+      @app = new_rack_app(JSON.generate([ValidApp]), {})
       get "/apps"
       e = assert_raises(Committee::InvalidResponse) do
         assert_schema_conform
@@ -66,10 +57,10 @@ describe Committee::Test::Methods do
 
   private
 
-  def new_rack_app(response, status=200, headers={ "Content-Type" => "application/json" })
+  def new_rack_app(response, headers={ "Content-Type" => "application/json" })
     Rack::Builder.new {
       run lambda { |_|
-        [status, headers, [response]]
+        [200, headers, [response]]
       }
     }
   end

data/test/test/methods_test.rb

@@ -8,8 +8,16 @@ describe Committee::Test::Methods do
     @app
   end
 
-  def committee_schema
-    hyper_schema
+  def committee_options
+    @committee_options
+  end
+
+  def request_object
+    last_request
+  end
+
+  def response_data
+    [last_response.status, last_response.headers, last_response.body]
   end
 
   before do
@@ -18,73 +26,61 @@ describe Committee::Test::Methods do
     # our purposes here in testing the module.
     @committee_router = nil
     @committee_schema = nil
+    @committee_options = nil
+    @validate_errors = nil
   end
 
-  describe "#assert_schema_content_type" do
-    it "warns about deprecation" do
-      mock(Committee).warn_deprecated.with_any_args
-      assert_schema_content_type
+  describe "Hyper-Schema" do
+    before do
+      sc = JsonSchema.parse!(hyper_schema_data)
+      sc.expand_references!
+      s = Committee::Drivers::HyperSchema.new.parse(sc)
+      @committee_options = {schema: s}
     end
-  end
-
-  describe "#assert_schema_conform" do
-    it "passes through a valid response" do
-      mock(Committee).warn_deprecated.with_any_args.times(2)
-
-      @app = new_rack_app(JSON.generate([ValidApp]))
-      get "/apps"
-      assert_schema_conform
-    end
-
-    it "detects an invalid response Content-Type" do
-      mock(Committee).warn_deprecated.with_any_args.times(2)
 
-      @app = new_rack_app(JSON.generate([ValidApp]), {})
-      get "/apps"
-      e = assert_raises(Committee::InvalidResponse) do
+    describe "#assert_schema_conform" do
+      it "passes through a valid response" do
+        @app = new_rack_app(JSON.generate([ValidApp]))
+        get "/apps"
         assert_schema_conform
       end
-      assert_match(/response header must be set to/i, e.message)
-    end
-
-    it "accepts schema string (legacy behavior)" do
-      mock(Committee).warn_deprecated.with_any_args.times(3)
-
-      stub(self).committee_schema { nil }
-      stub(self).schema_contents { JSON.dump(hyper_schema_data) }
 
-      @app = new_rack_app(JSON.generate([ValidApp]))
-      get "/apps"
-      assert_schema_conform
+      it "detects an invalid response Content-Type" do
+        @app = new_rack_app(JSON.generate([ValidApp]), {})
+        get "/apps"
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_schema_conform
+        end
+        assert_match(/response header must be set to/i, e.message)
+      end
     end
+  end
 
-    it "accepts schema hash (legacy behavior)" do
-      mock(Committee).warn_deprecated.with_any_args.times(3)
-
-      stub(self).committee_schema { nil }
-      stub(self).schema_contents { hyper_schema_data }
+  describe "OpenAPI3" do
+    before do
+      @committee_options = {open_api_3: open_api_3_schema}
 
-      @app = new_rack_app(JSON.generate([ValidApp]))
-      get "/apps"
-      assert_schema_conform
+      @correct_response = { string_1: :honoka }
     end
 
-    it "accepts schema JsonSchema::Schema object (legacy behavior)" do
-      # Note we don't warn here because this is a recent deprecation and
-      # passing a schema object will not be a huge performance hit. We should
-      # probably start warning on the next version.
-      mock(Committee).warn_deprecated.with_any_args.times(2)
-
-      stub(self).committee_schema { nil }
-      stub(self).schema_contents do
-        schema = JsonSchema.parse!(hyper_schema_data)
-        schema.expand_references!
-        schema
+    describe "#assert_schema_conform" do
+      it "passes through a valid response" do
+        @app = new_rack_app(JSON.generate(@correct_response))
+        get "/characters"
+        assert_schema_conform
       end
 
-      @app = new_rack_app(JSON.generate([ValidApp]))
-      get "/apps"
-      assert_schema_conform
+      # TODO: raise don't exist content-type error option
+=begin
+      it "detects an invalid response Content-Type" do
+        @app = new_rack_app(JSON.generate([@correct_response]), {})
+        get "/characters"
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_schema_conform
+        end
+        assert_match(/response header must be set to/i, e.message)
+      end
+=end
     end
   end