committee 1.15.0 → 5.0.0

data/test/drivers_test.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::Drivers do
+  DRIVERS = [
+    :hyper_schema,
+    :open_api_2,
+    :open_api_3,
+  ].freeze
+
+  it "gets driver with .driver_from_name" do
+    DRIVERS.each do |name|
+      driver = Committee::Drivers.driver_from_name(name)
+      assert_kind_of Committee::Drivers::Driver, driver
+    end
+  end
+
+  it "raises an ArgumentError for an unknown driver with .driver_from_name" do
+    e = assert_raises(ArgumentError) do
+      Committee::Drivers.driver_from_name(:blueprint)
+    end
+    assert_equal %{Committee: unknown driver "blueprint".}, e.message
+  end
+
+  describe 'load_from_file(schema_path)' do
+    it 'loads OpenAPI2' do
+      s = Committee::Drivers.load_from_file(open_api_2_schema_path)
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::OpenAPI2::Schema, s
+    end
+
+    it 'loads Hyper-Schema' do
+      s = Committee::Drivers.load_from_file(hyper_schema_schema_path)
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::HyperSchema::Schema, s
+    end
+
+    it 'loads OpenAPI 3' do
+      s = Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true})
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
+    end
+
+    it 'load OpenAPI 3 (patch version 3.0.1)' do
+      s = Committee::Drivers.load_from_file(open_api_3_0_1_schema_path, parser_options:{strict_reference_validation: true})
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
+    end
+
+    it 'fails to load OpenAPI 3 with invalid reference' do
+      parser_options = { strict_reference_validation: true }
+      assert_raises(OpenAPIParser::MissingReferenceError) do
+        Committee::Drivers.load_from_file(open_api_3_invalid_reference_path, parser_options: parser_options)
+      end
+    end
+
+    # This test can be removed when the test above (raising on invalid reference) becomes default behavior?
+    it 'allows loading OpenAPI 3 with invalid reference as existing behavior' do
+      s = Committee::Drivers.load_from_file(open_api_3_invalid_reference_path, parser_options:{strict_reference_validation: false})
+      assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
+    end
+
+    it 'errors on an unsupported file extension' do
+      e = assert_raises(StandardError) do
+        Committee::Drivers.load_from_file('test.xml', parser_options:{strict_reference_validation: true})
+      end
+      assert_equal "Committee only supports the following file extensions: '.json', '.yaml', '.yml'", e.message
+    end
+  end
+
+  describe 'load_from_json(schema_path)' do
+    it 'loads OpenAPI2' do
+      s = Committee::Drivers.load_from_json(open_api_2_schema_path, parser_options:{strict_reference_validation: true})
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::OpenAPI2::Schema, s
+    end
+
+    it 'loads Hyper-Schema' do
+      s = Committee::Drivers.load_from_json(hyper_schema_schema_path, parser_options:{strict_reference_validation: true})
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::HyperSchema::Schema, s
+    end
+  end
+
+  describe 'load_from_yaml(schema_path)' do
+    it 'loads OpenAPI3' do
+      s = Committee::Drivers.load_from_yaml(open_api_3_schema_path, parser_options:{strict_reference_validation: true})
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
+    end
+  end
+
+  describe 'load_from_data(schema_path)' do
+    it 'loads OpenAPI3' do
+      s = Committee::Drivers.load_from_data(open_api_3_data, parser_options:{strict_reference_validation: false})
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
+    end
+
+    it 'loads OpenAPI2' do
+      s = Committee::Drivers.load_from_data(open_api_2_data)
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::OpenAPI2::Schema, s
+    end
+
+    it 'loads Hyper-Schema' do
+      s = Committee::Drivers.load_from_data(hyper_schema_data)
+      assert_kind_of Committee::Drivers::Schema, s
+      assert_kind_of Committee::Drivers::HyperSchema::Schema, s
+    end
+  end
+end
+
+describe Committee::Drivers::Driver do
+  DRIVER_METHODS = {
+    default_allow_get_body: [],
+    default_coerce_form_params: [],
+    default_path_params: [],
+    default_query_params: [],
+    name: [],
+    parse: [nil],
+    schema_class: [],
+  }
+
+  it "has a set of abstract methods" do
+    driver = Committee::Drivers::Driver.new
+    DRIVER_METHODS.each do |name, args|
+      e = assert_raises do
+        driver.send(name, *args)
+      end
+      assert_equal "needs implementation", e.message,
+        "Incorrect error message while sending #{name}: #{e.message}"
+    end
+  end
+end
+
+describe Committee::Drivers::Schema do
+  SCHEMA_METHODS = {
+    driver: [],
+    build_router: [validator_option: nil, prefix: nil]
+  }
+
+  it "has a set of abstract methods" do
+    schema = Committee::Drivers::Schema.new
+    SCHEMA_METHODS.each do |name, args|
+      e = assert_raises do
+        schema.send(name, *args)
+      end
+      assert_equal "needs implementation", e.message,
+        "Incorrect error message while sending #{name}: #{e.message}"
+    end
+  end
+end

data/test/middleware/base_test.rb

@@ -1,4 +1,6 @@
-require_relative "../test_helper"
+# frozen_string_literal: true
+
+require "test_helper"
 
 describe Committee::Middleware::Base do
   include Rack::Test::Methods
@@ -7,8 +9,10 @@ describe Committee::Middleware::Base do
     @app
   end
 
-  it "accepts schema hash" do
-    @app = new_rack_app(schema: JSON.parse(File.read("./test/data/schema.json")))
+  it "accepts just a schema object" do
+    @app = new_rack_app(
+      schema: hyper_schema
+    )
     params = {
       "name" => "cloudnasium"
     }
@@ -17,20 +21,105 @@ describe Committee::Middleware::Base do
     assert_equal 200, last_response.status
   end
 
-  it "accepts schema object" do
-    schema = JsonSchema.parse!(JSON.parse(File.read("./test/data/schema.json")))
-    @app = new_rack_app(schema: schema)
+  it "accepts just a OpenAPI3 schema object" do
+    @app = new_rack_app(schema: open_api_3_schema)
     params = {
-      "name" => "cloudnasium"
+        "name" => "cloudnasium"
     }
     header "Content-Type", "application/json"
     post "/apps", JSON.generate(params)
     assert_equal 200, last_response.status
   end
 
+  it "doesn't accept a schema string" do
+    @app = new_rack_app(
+      schema: JSON.dump(hyper_schema_data)
+    )
+    params = {
+      "name" => "cloudnasium"
+    }
+    header "Content-Type", "application/json"
+
+    e = assert_raises(ArgumentError) do
+      post "/apps", JSON.generate(params)
+    end
+
+    assert_equal "Committee: schema expected to be an instance " +
+                     "of Committee::Drivers::Schema.", e.message
+  end
+
+  it "doesn't accept a schema hash" do
+    @app = new_rack_app(
+      schema: hyper_schema_data
+    )
+    params = {
+      "name" => "cloudnasium"
+    }
+    header "Content-Type", "application/json"
+
+    e = assert_raises(ArgumentError) do
+      post "/apps", JSON.generate(params)
+    end
+
+    assert_equal "Committee: schema expected to be an instance " +
+                     "of Committee::Drivers::Schema.", e.message
+  end
+
+  it "doesn't accept a JsonSchema::Schema object" do
+    @app = new_rack_app(
+      schema: JsonSchema.parse!(hyper_schema_data)
+    )
+    params = {
+      "name" => "cloudnasium"
+    }
+    header "Content-Type", "application/json"
+
+    e = assert_raises(ArgumentError) do
+      post "/apps", JSON.generate(params)
+    end
+
+    assert_equal "Committee: schema expected to be an instance " +
+                     "of Committee::Drivers::Schema.", e.message
+  end
+
+  it "doesn't accept other schema types" do
+    @app = new_rack_app(
+      schema: 7,
+    )
+    e = assert_raises(ArgumentError) do
+      post "/apps"
+    end
+    assert_equal "Committee: schema expected to be an instance of Committee::Drivers::Schema.", e.message
+  end
+
+  it "errors when no schema is specified" do
+    @app = new_rack_app
+    e = assert_raises(ArgumentError) do
+      post "/apps"
+    end
+
+    assert_equal "Committee: need option `schema` or `schema_path`", e.message
+  end
+
+  describe 'initialize option' do
+    it "accepts OpenAPI3 parser config of strict_reference_validation and raises" do
+      assert_raises(OpenAPIParser::MissingReferenceError) do
+        Committee::Middleware::Base.new(nil, schema_path: open_api_3_invalid_reference_path, strict_reference_validation: true)
+      end
+    end
+
+    it "does not raise by default even with invalid reference OpenAPI3 specification" do
+      b = Committee::Middleware::Base.new(nil, schema_path: open_api_3_invalid_reference_path, strict_reference_validation: false)
+      assert_kind_of Committee::Drivers::OpenAPI3::Schema, b.instance_variable_get(:@schema)
+    end
+  end
+
   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 { |_|