Pick up :api metadata when using RSpec to find the OAD

Author: ahx

examples/openapi.yaml

@@ -12,7 +12,7 @@ tags:
 paths:
   /:
     get:
-      operationId: things#index
+      operationId: example#root
       summary: Get metadata from the root of the API
       tags: ["Metadata"]
       responses:

examples/rack_handler.rb

@@ -10,7 +10,7 @@
 
   not_found = ->(_request) { [404, {}, []] }
   handlers = {
-    'things#index' => lambda do |_request|
+    'example#root' => lambda do |_request|
       [200, { Rack::CONTENT_TYPE => 'application/json' }, ['{"hello": "world"}']]
     end
   }

lib/openapi_first/test/methods.rb

@@ -7,21 +7,54 @@ module OpenapiFirst
   module Test
     # Methods to use in integration tests
     module Methods
-      def self.[](application_under_test = nil, api: :default)
+      def self.included(base)
+        base.include(DefaultApiMethod)
+        base.include(AssertionMethod)
+      end
+
+      def self.[](application_under_test = nil, api: nil)
         mod = Module.new do
           def self.included(base)
-            OpenapiFirst::Test::Methods.included(base)
+            base.include OpenapiFirst::Test::Methods::AssertionMethod
           end
         end
-        mod.define_method(:app) { OpenapiFirst::Test.app(application_under_test, api:) } if application_under_test
+
+        if api
+          mod.define_method(:openapi_first_default_api) { api }
+        else
+          mod.include(DefaultApiMethod)
+        end
+
+        if application_under_test
+          mod.define_method(:app) { OpenapiFirst::Test.app(application_under_test, api: openapi_first_default_api) }
+        end
+
         mod
       end
 
-      def self.included(base)
-        if Test.minitest?(base)
-          base.include(OpenapiFirst::Test::MinitestHelpers)
-        else
-          base.include(OpenapiFirst::Test::PlainHelpers)
+      # Default methods
+      module DefaultApiMethod
+        # This is the default api that is used by assert_api_conform
+        # :default is the default name that is used if you don't pass an `api:` option to `OpenapiFirst::Test.register`
+        # This is overwritten if you pass an `api:` option to `include OpenapiFirst::Test::Methods[…]`
+        def openapi_first_default_api
+          klass = self.class
+          if klass.respond_to?(:metadata) && klass.metadata[:api]
+            klass.metadata[:api]
+          else
+            :default
+          end
+        end
+      end
+
+      # @visibility private
+      module AssertionMethod
+        def self.included(base)
+          if Test.minitest?(base)
+            base.include(OpenapiFirst::Test::MinitestHelpers)
+          else
+            base.include(OpenapiFirst::Test::PlainHelpers)
+          end
         end
       end
     end

lib/openapi_first/test/minitest_helpers.rb

@@ -5,7 +5,7 @@ module Test
     # Assertion methods for Minitest
     module MinitestHelpers
       # :nocov:
-      def assert_api_conform(status: nil, api: :default)
+      def assert_api_conform(status: nil, api: openapi_first_default_api)
         api = OpenapiFirst::Test[api]
         request = respond_to?(:last_request) ? last_request : @request
         response = respond_to?(:last_response) ? last_response : @response

lib/openapi_first/test/plain_helpers.rb

@@ -5,7 +5,7 @@ module Test
     # Assertion methods to use when no known test framework was found
     # These methods just raise an exception if an error was found
     module PlainHelpers
-      def assert_api_conform(status: nil, api: :default)
+      def assert_api_conform(status: nil, api: openapi_first_default_api)
         api = OpenapiFirst::Test[api]
         # :nocov:
         request = respond_to?(:last_request) ? last_request : @request

spec/test/methods_spec.rb

@@ -24,6 +24,54 @@ def last_response = Rack::Response.new
     end.to raise_error(OpenapiFirst::Error)
   end
 
+  context 'with RSpec' do
+    let(:app) do
+      lambda do |_|
+        res = Rack::Response.new(JSON.generate(hello: 'there'))
+        res.content_type = 'application/json'
+        res.finish
+      end
+    end
+
+    context 'with metadata', api: :v1 do
+      include OpenapiFirst::Test::Methods
+      include Rack::Test::Methods
+
+      it 'targets that api when calling assert_api_conform' do
+        expect do
+          assert_api_conform(status: 200)
+        end.to raise_error(OpenapiFirst::Test::NotRegisteredError) do |ex|
+          expect(ex.message).to start_with("API description ':v1' not found.")
+        end
+      end
+    end
+
+    context 'with an [api:] option', api: :v2 do
+      include OpenapiFirst::Test::Methods[api: :v1]
+
+      it 'targets the api from the argument when calling assert_api_conform' do
+        expect do
+          assert_api_conform(status: 200)
+        end.to raise_error(OpenapiFirst::Test::NotRegisteredError) do |ex|
+          expect(ex.message).to start_with("API description ':v1' not found.")
+        end
+      end
+    end
+
+    context 'with an [Application] argument and metadata', api: :v2 do
+      include OpenapiFirst::Test::Methods[->(_) { Rack::Response.new('hey').finish }]
+      include Rack::Test::Methods
+
+      it 'targets that api when calling the app' do
+        OpenapiFirst::Test.register('./examples/openapi.yaml', as: :v2)
+
+        get('/')
+
+        expect(last_request.env[OpenapiFirst::REQUEST].operation_id).to eq('example#root')
+      end
+    end
+  end
+
   context 'with Minitest' do
     it 'includes MinitestHelpers when included' do
       minitest_class = Class.new(Minitest::Test) do
@@ -78,6 +126,38 @@ def last_response = Rack::Response.new
       expect(env[OpenapiFirst::REQUEST]).to be_valid
     end
 
+    it 'adds an assert_api_conform method that targets the specified API' do
+      OpenapiFirst::Test.register('./examples/openapi.yaml', as: :v1)
+      test_class = Class.new do
+        include OpenapiFirst::Test::Methods[api: :v1]
+
+        def last_request = Rack::Request.new(Rack::MockRequest.env_for('/'))
+        def last_response = Rack::Response.new
+      end
+
+      expect(test_class.new.openapi_first_default_api).to eq(:v1)
+
+      expect do
+        test_class.new.assert_api_conform(status: 444)
+      end.to raise_error(OpenapiFirst::Error)
+    end
+
+    it 'adds an assert_api_conform method that still can target another API' do
+      OpenapiFirst::Test.register('./examples/openapi.yaml', as: :v1)
+      test_class = Class.new do
+        include OpenapiFirst::Test::Methods[api: :v1]
+
+        def last_request = Rack::Request.new(Rack::MockRequest.env_for('/'))
+        def last_response = Rack::Response.new
+      end
+
+      expect do
+        test_class.new.assert_api_conform(status: 444, api: :other)
+      end.to raise_error(OpenapiFirst::Test::NotRegisteredError) do |ex|
+        expect(ex.message).to start_with("API description ':other' not found.")
+      end
+    end
+
     it 'does not add an app method if app is nil' do
       OpenapiFirst::Test.register('./examples/openapi.yaml', as: :v1)