committee 3.3.0 → 4.3.0

data/test/test/methods_new_version_test.rb

@@ -30,6 +30,9 @@ 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

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,7 +39,7 @@ 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
@@ -120,7 +123,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
@@ -224,6 +227,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

data/test/test_helper.rb

@@ -56,7 +56,11 @@ def open_api_2_schema
 end
 
 def open_api_3_schema
-  @open_api_3_schema ||= Committee::Drivers.load_from_data(open_api_3_data)
+  @open_api_3_schema ||= Committee::Drivers.load_from_file(open_api_3_schema_path)
+end
+
+def open_api_3_coverage_schema
+  @open_api_3_coverage_schema ||= Committee::Drivers.load_from_file(open_api_3_coverage_schema_path)
 end
 
 # Don't cache this because we'll often manipulate the created hash in tests.
@@ -85,6 +89,10 @@ def open_api_3_schema_path
   "./test/data/openapi3/normal.yaml"
 end
 
+def open_api_3_coverage_schema_path
+  "./test/data/openapi3/coverage.yaml"
+end
+
 def open_api_3_0_1_schema_path
   "./test/data/openapi3/3_0_1.yaml"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-15 00:00:00.000000000 Z
+date: 2020-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -52,14 +52,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.11.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +238,7 @@ files:
 - lib/committee/schema_validator/open_api_3/router.rb
 - lib/committee/schema_validator/option.rb
 - lib/committee/test/methods.rb
+- lib/committee/test/schema_coverage.rb
 - lib/committee/validation_error.rb
 - test/bin/committee_stub_test.rb
 - test/bin_test.rb
@@ -268,6 +269,7 @@ files:
 - test/schema_validator/open_api_3/response_validator_test.rb
 - test/test/methods_new_version_test.rb
 - test/test/methods_test.rb
+- test/test/schema_coverage_test.rb
 - test/test_helper.rb
 - test/validation_error_test.rb
 homepage: https://github.com/interagent/committee
@@ -282,14 +284,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.