committee 3.3.0 → 5.0.0

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,33 +39,24 @@ 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
-
-      it "outputs deprecation warning" do
-        @app = new_rack_app(JSON.generate([ValidApp]))
-        get "/apps"
-        _, err = capture_io do
-          assert_schema_conform
-        end
-        assert_match(/\[DEPRECATION\]/i, err)
-      end
     end
 
     describe "assert_request_schema_confirm" do
@@ -95,14 +89,14 @@ describe Committee::Test::Methods do
       it "passes through a valid response" do
         @app = new_rack_app(JSON.generate([ValidApp]))
         get "/apps"
-        assert_response_schema_confirm
+        assert_response_schema_confirm(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_response_schema_confirm
+          assert_response_schema_confirm(200)
         end
         assert_match(/response header must be set to/i, e.message)
       end
@@ -120,7 +114,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
@@ -129,14 +123,14 @@ describe Committee::Test::Methods do
       it "passes through a valid response" do
         @app = new_rack_app(JSON.generate(@correct_response))
         get "/characters"
-        assert_schema_conform
+        assert_schema_conform(200)
       end
 
       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
+          assert_schema_conform(200)
         end
         assert_match(/response definition does not exist/i, e.message)
       end
@@ -147,19 +141,10 @@ describe Committee::Test::Methods do
         get "/characters"
 
         e = assert_raises(Committee::InvalidResponse) do
-          assert_schema_conform
+          assert_schema_conform(419)
         end
         assert_match(/status code definition does not exist/i, e.message)
       end
-
-      it "outputs deprecation warning" do
-        @app = new_rack_app(JSON.generate(@correct_response))
-        get "/characters"
-        _, err = capture_io do
-          assert_schema_conform
-        end
-        assert_match(/\[DEPRECATION\]/i, err)
-      end
     end
 
     describe "assert_request_schema_confirm" do
@@ -193,14 +178,14 @@ describe Committee::Test::Methods do
       it "passes through a valid response" do
         @app = new_rack_app(JSON.generate(@correct_response))
         get "/characters"
-        assert_response_schema_confirm
+        assert_response_schema_confirm(200)
       end
 
       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_response_schema_confirm
+          assert_response_schema_confirm(200)
         end
         assert_match(/response definition does not exist/i, e.message)
       end
@@ -211,7 +196,7 @@ describe Committee::Test::Methods do
         get "/characters"
 
         e = assert_raises(Committee::InvalidResponse) do
-          assert_response_schema_confirm
+          assert_response_schema_confirm(419)
         end
         assert_match(/status code definition does not exist/i, e.message)
       end
@@ -224,6 +209,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(200)
+          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(200)
+          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(200)
+          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

@@ -11,8 +11,10 @@ SimpleCov.start do
   add_filter "/test/"
 
   # This library has a pretty modest number of lines, so let's try to stick
-  # to a 100% coverage target for a while and see what happens.
-  minimum_coverage 100
+  # to a 99% coverage target for a while and see what happens.
+  # We can't use 100% because old rack version doesn't support media_type and it's not testable :(
+  # https://github.com/interagent/committee/pull/360/files#diff-ce1125b6594690a88a70dbe2869f7fcfa2962c2bca80751f3720888920e2dfabR54
+  minimum_coverage 99
 end
 
 require "minitest"
@@ -55,8 +57,16 @@ def open_api_2_schema
   @open_api_2_schema ||= Committee::Drivers.load_from_file(open_api_2_schema_path)
 end
 
+def open_api_2_form_schema
+  @open_api_2_form_schema ||= Committee::Drivers.load_from_file(open_api_2_form_schema_path)
+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, parser_options:{strict_reference_validation: true})
+end
+
+def open_api_3_coverage_schema
+  @open_api_3_coverage_schema ||= Committee::Drivers.load_from_file(open_api_3_coverage_schema_path, parser_options:{strict_reference_validation: true})
 end
 
 # Don't cache this because we'll often manipulate the created hash in tests.
@@ -69,8 +79,16 @@ def open_api_2_data
   JSON.parse(File.read(open_api_2_schema_path))
 end
 
+def open_api_2_form_data
+  JSON.parse(File.read(open_api_2_form_schema_path))
+end
+
 def open_api_3_data
-  YAML.load_file(open_api_3_schema_path)
+  if YAML.respond_to?(:unsafe_load_file)
+    YAML.unsafe_load_file(open_api_3_schema_path)
+  else
+    YAML.load_file(open_api_3_schema_path)
+  end
 end
 
 def hyper_schema_schema_path
@@ -81,10 +99,22 @@ def open_api_2_schema_path
   "./test/data/openapi2/petstore-expanded.json"
 end
 
+def open_api_2_form_schema_path
+  "./test/data/openapi2/petstore-expanded-form.json"
+end
+
 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
+
+def open_api_3_invalid_reference_path
+  "./test/data/openapi3/invalid_reference.yaml"
+end