Merge pull request #423 from ahx/fix-configure

Don't reset the global configuration during configuration

Author: ahx

CHANGELOG.md

@@ -7,6 +7,7 @@
   Before this change `GET /things/24/` matched `/things/{id}:`, but it no longer does.
 - Breaking: Failure type `:response_not_found` was split into two more specific types `:response_content_type_not_found` and `:response_status_not_found`. This should be mostly internal stuff. So if your custom error response used `response_not_found`, you will have to adapt.
 - `OpenapiFirst::Test.app` now returns an instance of `OpenapiFirst::Test::App`, instead of `Rack::Builer` and delegates methods other than `#call` to the original app. This wrapper adds validated requests, responses to the rack env at `env[OpenapiFirst::Test::REQUEST]`, `env[OpenapiFirst::Test::RESPONSE]`. This makes it possible to test Rails engines. Thanks to Josh! See [#410](https://github.com/ahx/openapi_first/issues/410).
+- `OpenapiFirst::Test` now falls back to using globally registered OADs if nothing was registered inside `OpenapiFirst::Test.setup`.
 
 ### Added
 - The Coverage feature in `OpenapiFirst::Test` now supports parallel tests via a DRB client/sever. Thanks to Richard! See [#394](https://github.com/ahx/openapi_first/issues/394).

lib/openapi_first.rb

@@ -30,8 +30,7 @@ def self.configuration
   # @return [Configuration]
   # @yield [Configuration]
   def self.configure
-    @configuration = Configuration.new
-    yield @configuration if block_given?
+    yield configuration if block_given?
   end
 
   ERROR_RESPONSES = {} # rubocop:disable Style/MutableConstant

lib/openapi_first/test.rb

@@ -25,6 +25,10 @@ def self.minitest?(base)
       false
     end
 
+    def self.definitions
+      super.empty? ? OpenapiFirst.definitions : super
+    end
+
     def self.configuration
       @configuration ||= Configuration.new
     end
@@ -39,15 +43,16 @@ def self.setup
       install
       yield configuration
 
-      configuration.registry.each { |name, oad| register(oad, as: name) }
-      configuration.apps.each { |name, apps| apps.each { |app| observe(app, api: name) } }
       Coverage.start(skip_response: configuration.skip_response_coverage, skip_route: configuration.skip_coverage)
 
       if definitions.empty?
         raise NotRegisteredError,
               'No API descriptions have been registered. ' \
               'Please register your API description via ' \
-              "OpenapiFirst::Test.setup { |test| test.register('myopenapi.yaml') }"
+              "`OpenapiFirst.register('myopenapi.yaml)` or " \
+              'in a block passed to `OpenapiFirst::Test.setup` like this: ' \
+              "`OpenapiFirst::Test.setup { |test| test.register('myopenapi.yaml') }` " \
+
       end
 
       @exit_handler = method(:handle_exit)

lib/openapi_first/test/configuration.rb

@@ -15,25 +15,23 @@ def initialize
         @ignore_unknown_response_status = false
         @report_coverage = true
         @ignore_unknown_requests = false
-        @registry = {}
-        @apps = {}
       end
 
       # Register OADs, but don't load them just yet
       # @param [OpenapiFirst::OAD] oad The OAD to register
       # @param [Symbol] as The name to register the OAD under
       def register(oad, as: :default)
-        @registry[as] = oad
+        Test.register(oad, as:)
       end
 
       # Observe a rack app
       def observe(app, api: :default)
-        (@apps[api] ||= []) << app
+        Observe.observe(app, api:)
       end
 
       attr_accessor :coverage_formatter_options, :coverage_formatter, :response_raise_error,
                     :ignore_unknown_requests, :ignore_unknown_response_status, :minimum_coverage
-      attr_reader :registry, :apps, :report_coverage, :ignored_unknown_status
+      attr_reader :report_coverage, :ignored_unknown_status
 
       # Configure report coverage
       # @param [Boolean, :warn] value Whether to report coverage or just warn.

spec/openapi_first_spec.rb

@@ -37,6 +37,16 @@
     end
   end
 
+  describe '.configure' do
+    it 'does not reset .configuration' do
+      old_config_instance = described_class.configuration
+      described_class.configure do |_|
+        24
+      end
+      expect(described_class.configuration).to be(old_config_instance)
+    end
+  end
+
   describe '.load' do
     begin
       require 'multi_json'

spec/spec_helper.rb

@@ -28,7 +28,6 @@
   end
 
   config.after(:each) do
-    OpenapiFirst.configure
     OpenapiFirst::Test.definitions.clear
     OpenapiFirst.definitions.clear
     OpenapiFirst::Test.uninstall

spec/test_spec.rb

@@ -135,6 +135,15 @@ def call(_env)
       end.to raise_error ArgumentError
     end
 
+    it 'returns the globally registered OADs if nothing was registered inside the block' do
+      oad = OpenapiFirst.load('./spec/data/dice.yaml')
+      OpenapiFirst.register(oad, as: :dice)
+
+      described_class.setup { |_test| } # rubocop:disable Lint/EmptyBlock
+
+      expect(described_class.definitions).to be(OpenapiFirst.definitions)
+    end
+
     it 'raises an error if no API description was registered' do
       expect do
         described_class.setup { |_test| } # rubocop:disable Lint/EmptyBlock