Merge pull request #382 from ahx/observe-rack-urlmap

Support observice proc like objects with Test.observe

Author: ahx

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- OpenapiFirst::Test.observe now works with `Rack::URLMap` (returned by `Rack::Builder.app`) and probably all objects that respond to `.call`
+
 ## 2.10.1
 
 - Don't try to track coverage for skipped requests

lib/openapi_first/test/observe.rb

@@ -10,14 +10,23 @@ module Observed; end
     # Inject silent request/response validation to observe rack apps during testing
     module Observe
       def self.observe(app, api: :default)
+        definition = OpenapiFirst::Test[api]
+        mod = OpenapiFirst::Test::Callable[definition]
+
+        if app.respond_to?(:call)
+          return if app.singleton_class.include?(Observed)
+
+          app.singleton_class.prepend(mod)
+          app.singleton_class.include(Observed)
+          return
+        end
+
         unless app.instance_methods.include?(:call)
           raise ObserveError, "Don't know how to observe #{app}, because it has no call instance method."
         end
 
         return if app.include?(Observed)
 
-        definition = OpenapiFirst::Test[api]
-        mod = OpenapiFirst::Test::Callable[definition]
         app.prepend(mod)
         app.include(Observed)
       end

lib/openapi_first/test/observer_middleware.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  module Test
+    # Middleware that observes requests and responses. This is used to trigger hooks added by OpenapiFirst::Tests.
+    class ObserverMiddleware
+      def initialize(app, options = {})
+        @app = app
+        @definition = OpenapiFirst::Test[options.fetch(:api, :default)]
+      end
+
+      def call(env)
+        request = Rack::Request.new(env)
+
+        @definition.validate_request(request, raise_error: false)
+        response = @app.call(env)
+        status, headers, body = response
+        @definition.validate_response(request, Rack::Response[status, headers, body], raise_error: false)
+        response
+      end
+    end
+  end
+end

spec/test/observe_spec.rb

@@ -85,4 +85,33 @@ def call(_env)
 
     it_behaves_like 'an observed app'
   end
+
+  context 'with a proc' do
+    let(:app) do
+      ->(_env) { Rack::Response.new.finish }
+    end
+
+    it_behaves_like 'an observed app'
+
+    it 'injects request/response validation only once' do
+      2.times { described_class.observe(app) }
+
+      expect(definition).to receive(:validate_request).once
+      expect(definition).to receive(:validate_response).once
+
+      callable.call({})
+    end
+  end
+
+  context 'with Rack::Builder.app' do
+    let(:app) do
+      Rack::Builder.app do
+        map '/' do
+          run ->(_env) { Rack::Response.new.finish }
+        end
+      end
+    end
+
+    it_behaves_like 'an observed app'
+  end
 end