Add option to ignore all unknown responses in API coverage

This is intended to be used just for a short period of time when adapting an existing OAD and should not be used once the OAD is aligned with the implementation.

Author: ahx

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Add `OpenapiFirst::Test::Configuration#ignore_all_unknown_responses=` (use only temporarily when working with an unmaintained OAD)
+
 ## 2.11.1
 
 - OpenapiFirst can now route requests correctly for paths like `/stuffs` and `/stuffs{format}` (https://github.com/ahx/openapi_first/issues/386)

lib/openapi_first/test.rb

@@ -124,7 +124,7 @@ def self.raise_request_error?(validated_request)
     end
 
     def self.raise_response_error?(validated_response)
-      configuration.response_raise_error && !configuration.ignored_unknown_status.include?(validated_response.status)
+      configuration.response_raise_error && !configuration.ignore_response?(validated_response)
     end
 
     def self.uninstall

lib/openapi_first/test/configuration.rb

@@ -12,6 +12,7 @@ def initialize
         @skip_coverage = nil
         @response_raise_error = true
         @ignored_unknown_status = [404]
+        @ignore_all_unknown_responses = false
         @report_coverage = true
         @ignore_unknown_requests = false
         @registry = {}
@@ -31,7 +32,7 @@ def observe(app, api: :default)
       end
 
       attr_accessor :coverage_formatter_options, :coverage_formatter, :response_raise_error,
-                    :ignore_unknown_requests
+                    :ignore_unknown_requests, :ignore_all_unknown_responses
       attr_reader :registry, :apps, :report_coverage, :ignored_unknown_status, :minimum_coverage
 
       # Configure report coverage
@@ -63,6 +64,12 @@ def skip_coverage(&block)
 
         @skip_coverage = block
       end
+
+      def ignore_response?(validated_response)
+        return true if @ignore_all_unknown_responses
+
+        ignored_unknown_status.include?(validated_response.status)
+      end
     end
   end
 end

spec/test/configuration_spec.rb

@@ -19,4 +19,38 @@
       expect(configuration.ignored_unknown_status).to eq [404, 401]
     end
   end
+
+  describe '#ignore_response?' do
+    let(:valid_response) { double(valid?: true, known?: true, status: 302) }
+    let(:invalid_response) { double(valid?: false, known?: true, status: 302) }
+    let(:unknown_response) { double(valid?: false, known?: false, status: 302) }
+
+    it 'returns false by default for a valid responses' do
+      expect(configuration.ignore_response?(valid_response)).to eq(false)
+    end
+
+    it 'returns false by default for an invalid responses' do
+      expect(configuration.ignore_response?(invalid_response)).to eq(false)
+    end
+
+    it 'returns false by default for an unkonwn responses' do
+      expect(configuration.ignore_response?(unknown_response)).to eq(false)
+    end
+
+    context 'when status is ignored' do
+      before { configuration.ignored_unknown_status << invalid_response.status }
+
+      it 'returns true' do
+        expect(configuration.ignore_response?(invalid_response)).to eq(true)
+      end
+    end
+
+    context 'when all responses are ignored' do
+      before { configuration.ignore_all_unknown_responses = true }
+
+      it 'returns true' do
+        expect(configuration.ignore_response?(invalid_response)).to eq(true)
+      end
+    end
+  end
 end

spec/test_spec.rb

@@ -623,5 +623,17 @@ def call(_env)
         end.not_to raise_error
       end
     end
+
+    context 'with ignore_all_unknown_responses = true' do
+      before(:each) do
+        described_class.configuration.ignore_all_unknown_responses = true
+      end
+
+      it 'does not raise an error' do
+        expect do
+          app.call(Rack::MockRequest.env_for('/roll', method: 'POST'))
+        end.not_to raise_error
+      end
+    end
   end
 end