committee 4.0.0 → 4.4.0.rc1

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

data/test/test/methods_new_version_test.rb

@@ -30,13 +30,16 @@ describe Committee::Test::Methods do
     @committee_schema = nil
 
     @committee_options = {schema: hyper_schema}
+
+    # TODO: delete when 5.0.0 released because default value changed
+    @committee_options[:parse_response_by_content_type] = false
   end
 
   describe "#assert_schema_conform" do
     it "passes through a valid response" do
       @app = new_rack_app(JSON.generate([ValidApp]))
       get "/apps"
-      assert_schema_conform
+      assert_schema_conform(200)
     end
 
     it "passes with prefix" do
@@ -44,18 +47,27 @@ describe Committee::Test::Methods do
 
       @app = new_rack_app(JSON.generate([ValidApp]))
       get "/v1/apps"
-      assert_schema_conform
+      assert_schema_conform(200)
     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
+        assert_schema_conform(200)
       end
       assert_match(/response header must be set to/i, e.message)
     end
 
+    it "it detects unexpected response code" do
+      @app = new_rack_app(JSON.generate([ValidApp]), 400)
+      get "/apps"
+      e = assert_raises(Committee::InvalidResponse) do
+        assert_schema_conform(200)
+      end
+      assert_match(/Expected `200` status code, but it was `400`/i, e.message)
+    end
+
     it "detects an invalid response Content-Type but ignore because it's not success status code" do
       @committee_options.merge!(validate_success_only: true)
       @app = new_rack_app(JSON.generate([ValidApp]), 400, {})
@@ -67,7 +79,7 @@ describe Committee::Test::Methods do
       @app = new_rack_app(JSON.generate([ValidApp]), 400, {})
       get "/apps"
       e = assert_raises(Committee::InvalidResponse) do
-        assert_schema_conform
+        assert_schema_conform(400)
       end
       assert_match(/response header must be set to/i, e.message)
     end

data/test/test/methods_test.rb

@@ -28,7 +28,10 @@ describe Committee::Test::Methods do
     # our purposes here in testing the module.
     @committee_router = nil
     @committee_schema = nil
-    @committee_options = nil
+    @committee_options = {}
+
+    # TODO: delete when 5.0.0 released because default value changed
+    @committee_options[:parse_response_by_content_type] = true
   end
 
   describe "Hyper-Schema" do
@@ -36,21 +39,21 @@ describe Committee::Test::Methods do
       sc = JsonSchema.parse!(hyper_schema_data)
       sc.expand_references!
       s = Committee::Drivers::HyperSchema::Driver.new.parse(sc)
-      @committee_options = {schema: s}
+      @committee_options.merge!({schema: s})
     end
 
     describe "#assert_schema_conform" do
       it "passes through a valid response" do
         @app = new_rack_app(JSON.generate([ValidApp]))
         get "/apps"
-        assert_schema_conform
+        assert_schema_conform(200)
       end
 
       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
+          assert_schema_conform(200)
         end
         assert_match(/response header must be set to/i, e.message)
       end
@@ -61,7 +64,8 @@ describe Committee::Test::Methods do
         _, err = capture_io do
           assert_schema_conform
         end
-        assert_match(/\[DEPRECATION\]/i, err)
+        assert_match(/\[DEPRECATION\] Now assert_schema_conform check response schema only/i, err)
+        assert_match(/\[DEPRECATION\] Pass expected response status code/i, err)
       end
     end
 
@@ -120,7 +124,7 @@ describe Committee::Test::Methods do
 
   describe "OpenAPI3" do
     before do
-      @committee_options = {schema: open_api_3_schema}
+      @committee_options.merge!({schema: open_api_3_schema})
 
       @correct_response = { string_1: :honoka }
     end
@@ -158,7 +162,8 @@ describe Committee::Test::Methods do
         _, err = capture_io do
           assert_schema_conform
         end
-        assert_match(/\[DEPRECATION\]/i, err)
+        assert_match(/\[DEPRECATION\] Now assert_schema_conform check response schema only/i, err)
+        assert_match(/\[DEPRECATION\] Pass expected response status code/i, err)
       end
     end
 
@@ -224,6 +229,145 @@ describe Committee::Test::Methods do
         end
         assert_match(/`GET \/undefined` undefined in schema/i, e.message)
       end
+
+      it "raises error when path does not match prefix" do
+        @committee_options.merge!({prefix: '/api'})
+        @app = new_rack_app(JSON.generate(@correct_response))
+        get "/characters"
+        e = assert_raises(Committee::InvalidResponse) do
+          assert_response_schema_confirm
+        end
+        assert_match(/`GET \/characters` undefined in schema \(prefix: "\/api"\)/i, e.message)
+      end
+
+      describe 'coverage' do
+        before do
+          @schema_coverage = Committee::Test::SchemaCoverage.new(open_api_3_coverage_schema)
+          @committee_options.merge!(schema: open_api_3_coverage_schema, schema_coverage: @schema_coverage)
+
+          @app = new_rack_app(JSON.generate({ success: true }))
+        end
+        it 'records openapi coverage' do
+          get "/posts"
+          assert_response_schema_confirm
+          assert_equal({
+            '/threads/{id}' => {
+              'get' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+            '/posts' => {
+              'get' => {
+                'responses' => {
+                  '200' => true,
+                  '404' => false,
+                  'default' => false,
+                },
+              },
+              'post' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+            '/likes' => {
+              'post' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+              'delete' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+          }, @schema_coverage.report)
+        end
+
+        it 'can record openapi coverage correctly when prefix is set' do
+          @committee_options.merge!(prefix: '/api')
+          post "/api/likes"
+          assert_response_schema_confirm
+          assert_equal({
+            '/threads/{id}' => {
+              'get' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+            '/posts' => {
+              'get' => {
+                'responses' => {
+                  '200' => false,
+                  '404' => false,
+                  'default' => false,
+                },
+              },
+              'post' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+            '/likes' => {
+              'post' => {
+                'responses' => {
+                  '200' => true,
+                },
+              },
+              'delete' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+          }, @schema_coverage.report)
+        end
+
+        it 'records openapi coverage correctly with path param' do
+          get "/threads/asd"
+          assert_response_schema_confirm
+          assert_equal({
+            '/threads/{id}' => {
+              'get' => {
+                'responses' => {
+                  '200' => true,
+                },
+              },
+            },
+            '/posts' => {
+              'get' => {
+                'responses' => {
+                  '200' => false,
+                  '404' => false,
+                  'default' => false,
+                },
+              },
+              'post' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+            '/likes' => {
+              'post' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+              'delete' => {
+                'responses' => {
+                  '200' => false,
+                },
+              },
+            },
+          }, @schema_coverage.report)
+        end
+      end
     end
   end
 

data/test/test/schema_coverage_test.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe Committee::Test::SchemaCoverage do
+  before do
+    @schema_coverage = Committee::Test::SchemaCoverage.new(open_api_3_coverage_schema)
+  end
+
+  describe 'recording coverage' do
+    def response_as_str(response)
+      [:path, :method, :status].map { |key| response[key] }.join(' ')
+    end
+
+    def uncovered_responses
+      @schema_coverage.report_flatten[:responses].select { |r| !r[:is_covered] }.map { |r| response_as_str(r) }
+    end
+
+    def covered_responses
+      @schema_coverage.report_flatten[:responses].select { |r| r[:is_covered] }.map { |r| response_as_str(r) }
+    end
+    it 'can record and report coverage properly' do
+      @schema_coverage.update_response_coverage!('/posts', 'get', '200')
+      assert_equal([
+        '/posts get 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+        '/likes post 200',
+        '/likes delete 200',
+      ], uncovered_responses)
+
+      @schema_coverage.update_response_coverage!('/likes', 'post', '200')
+      assert_equal([
+        '/posts get 200',
+        '/likes post 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+        '/likes delete 200',
+      ], uncovered_responses)
+
+      @schema_coverage.update_response_coverage!('/likes', 'delete', '200')
+      assert_equal([
+        '/posts get 200',
+        '/likes post 200',
+        '/likes delete 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+      ], uncovered_responses)
+
+      @schema_coverage.update_response_coverage!('/posts', 'get', '422')
+      assert_equal([
+        '/posts get 200',
+        '/posts get default',
+        '/likes post 200',
+        '/likes delete 200',
+      ], covered_responses)
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 404',
+        '/posts post 200',
+      ], uncovered_responses)
+
+      assert_equal({
+        '/threads/{id}' => {
+          'get' => {
+            'responses' => {
+              '200' => false,
+            },
+          },
+        },
+        '/posts' => {
+          'get' => {
+            'responses' => {
+              '200' => true,
+              '404' => false,
+              'default' => true,
+            },
+          },
+          'post' => {
+            'responses' => {
+              '200' => false,
+            },
+          },
+        },
+        '/likes' => {
+          'post' => {
+            'responses' => {
+              '200' => true,
+            },
+          },
+          'delete' => {
+            'responses' => {
+              '200' => true,
+            },
+          },
+        },
+      }, @schema_coverage.report)
+
+      @schema_coverage.update_response_coverage!('/posts', 'post', '200')
+      @schema_coverage.update_response_coverage!('/posts', 'get', '404')
+      @schema_coverage.update_response_coverage!('/threads/{id}', 'get', '200')
+      assert_equal([
+        '/threads/{id} get 200',
+        '/posts get 200',
+        '/posts get 404',
+        '/posts get default',
+        '/posts post 200',
+        '/likes post 200',
+        '/likes delete 200',
+      ], covered_responses)
+      assert_equal([], uncovered_responses)
+    end
+  end
+
+  describe '.merge_report' do
+    it 'can merge 2 coverage reports together' do
+      report = Committee::Test::SchemaCoverage.merge_report(
+        {
+          '/posts' => {
+            'get' => {
+              'responses' => {
+                '200' => true,
+                '404' => false,
+              },
+            },
+            'post' => {
+              'responses' => {
+                '200' => false,
+              },
+            },
+          },
+          '/likes' => {
+            'post' => {
+              'responses' => {
+                '200' => true,
+              },
+            },
+          },
+        },
+        {
+          '/posts' => {
+            'get' => {
+              'responses' => {
+                '200' => true,
+                '404' => true,
+              },
+            },
+            'post' => {
+              'responses' => {
+                '200' => false,
+              },
+            },
+          },
+          '/likes' => {
+            'post' => {
+              'responses' => {
+                '200' => false,
+                '400' => false,
+              },
+            },
+          },
+          '/users' => {
+            'get' => {
+              'responses' => {
+                '200' => true,
+              },
+            },
+          },
+        },
+      )
+
+      assert_equal({
+        '/posts' => {
+          'get' => {
+            'responses' => {
+              '200' => true,
+              '404' => true,
+            },
+          },
+          'post' => {
+            'responses' => {
+              '200' => false,
+            },
+          },
+        },
+        '/likes' => {
+          'post' => {
+            'responses' => {
+              '200' => true,
+              '400' => false,
+            },
+          },
+        },
+        '/users' => {
+          'get' => {
+            'responses' => {
+              '200' => true,
+            },
+          },
+        },
+      }, report)
+    end
+  end
+end