Add Test-configuration to ignore certain unknown response status

Add `OpenapiFirst::Test::Configuration#ignored_unknown_status` to configure response status(es) that do not have to be descriped in the API description.

Author: ahx

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 
 ## Unreleased
+- Add `OpenapiFirst::Test::Configuration#ignored_unknown_status` to configure response status(es) that do not have to be descriped in the API description.
 - Change `OpenapiFirst::Test` to make tests fail if API description is not covered by tests. You can adapt this behavior via `OpenapiFirst::Test.setup` / `skip_response_coverage_if` or deactivate coverage with `report_coverage = false` or `report_coverage = :warn`
 - Added `OpenapiFirst::Test::Configuration#report_coverage=` to configure the behavior if not all requests/responses of the API under test have been tested.
 - Deprecate  `OpenapiFirst::Test::Configuration#minimum_coverage=` use "#report_coverage" instead to modify the behavior

lib/openapi_first/test.rb

@@ -92,15 +92,26 @@ def self.install
         @after_request_validation = config.after_request_validation do |validated_request, oad|
           Coverage.track_request(validated_request, oad)
         end
-        @after_response_validation = config.after_response_validation do |validated_response, rack_request, oad|
-          raise validated_response.error.exception if configuration.response_raise_error && validated_response.invalid?
 
-          Coverage.track_response(validated_response, rack_request, oad)
+        @after_response_validation = config.after_response_validation do |validated_response, rack_request, oad|
+          after_response_validation(validated_response, rack_request, oad)
         end
       end
       @installed = true
     end
 
+    def self.after_response_validation(validated_response, rack_request, oad)
+      if validated_response.invalid? && raise_response_error?(validated_response)
+        raise validated_response.error.exception
+      end
+
+      Coverage.track_response(validated_response, rack_request, oad)
+    end
+
+    def self.raise_response_error?(validated_response)
+      configuration.response_raise_error && !configuration.ignored_unknown_status.include?(validated_response.status)
+    end
+
     def self.uninstall
       configuration = OpenapiFirst.configuration
       configuration.hooks[:after_request_validation].delete(@after_request_validation)

lib/openapi_first/test/configuration.rb

@@ -10,6 +10,7 @@ def initialize
         @coverage_formatter_options = {}
         @skip_response_coverage = nil
         @response_raise_error = true
+        @ignored_unknown_status = []
         @report_coverage = true
         @registry = {}
       end
@@ -20,7 +21,7 @@ def register(oad, as: :default)
       end
 
       attr_accessor :coverage_formatter_options, :coverage_formatter, :response_raise_error
-      attr_reader :registry, :minimum_coverage, :report_coverage
+      attr_reader :registry, :minimum_coverage, :report_coverage, :ignored_unknown_status
 
       def minimum_coverage=(value)
         warn 'Setting OpenapiFirst::Test::Configuration#minimum_coverage= is deprecated ' \

spec/test_spec.rb

@@ -424,4 +424,41 @@
       end
     end
   end
+
+  describe 'handling unknown response status' do
+    let(:definition) do
+      OpenapiFirst.load('./spec/data/dice.yaml')
+    end
+
+    let(:app) do
+      described_class.app(
+        ->(_env) { [302, { 'content-type' => 'application/json' }, ['5']] },
+        spec: definition
+      )
+    end
+
+    before(:each) do
+      described_class.setup do |test|
+        test.register(definition)
+      end
+    end
+
+    it 'raises an error' do
+      expect do
+        app.call(Rack::MockRequest.env_for('/roll', method: 'POST'))
+      end.to raise_error(OpenapiFirst::ResponseNotFoundError)
+    end
+
+    context 'with ignored_unknown_status' do
+      before(:each) do
+        described_class.configuration.ignored_unknown_status << 302
+      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