Move Test.observe into Observe module. Add more tests.

Author: ahx

Gemfile

@@ -12,9 +12,11 @@ group :test, :development do
   gem 'bundler'
   gem 'minitest'
   gem 'rack-test'
+  gem 'rails'
   gem 'rake'
   gem 'rspec'
   gem 'rubocop'
   gem 'rubocop-performance'
   gem 'simplecov'
+  gem 'sinatra'
 end

Gemfile.lock

@@ -10,6 +10,26 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2)
+      actionpack (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
     actionpack (8.0.2)
       actionview (= 8.0.2)
       activesupport (= 8.0.2)
@@ -20,12 +40,34 @@ GEM
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
+    actiontext (8.0.2)
+      actionpack (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
     actionview (8.0.2)
       activesupport (= 8.0.2)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activesupport (= 8.0.2)
+      marcel (~> 1.0)
     activesupport (8.0.2)
       base64
       benchmark (>= 0.3)
@@ -47,13 +89,22 @@ GEM
     concurrent-ruby (1.3.5)
     connection_pool (2.5.3)
     crass (1.0.6)
+    date (3.4.1)
     diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.3)
+    erb (5.0.1)
     erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
     hana (1.3.7)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.2)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.12.2)
     json_schemer (2.4.0)
       bigdecimal
@@ -66,7 +117,26 @@ GEM
     loofah (2.24.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
     minitest (5.25.5)
+    mustermann (3.0.3)
+      ruby2_keywords (~> 0.0.1)
+    net-imap (0.5.9)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
     nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.18.8-x86_64-linux-gnu)
@@ -77,26 +147,65 @@ GEM
     parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.4.0)
+    psych (5.2.6)
+      date
+      stringio
     racc (1.8.1)
     rack (3.1.16)
+    rack-protection (4.1.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
     rack-session (2.1.1)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
     rack-test (2.2.0)
       rack (>= 1.3)
     rackup (2.2.1)
       rack (>= 3)
+    rails (8.0.2)
+      actioncable (= 8.0.2)
+      actionmailbox (= 8.0.2)
+      actionmailer (= 8.0.2)
+      actionpack (= 8.0.2)
+      actiontext (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activemodel (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2)
     rails-dom-testing (2.3.0)
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.6.2)
       loofah (~> 2.21)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.3.0)
+    rdoc (6.14.1)
+      erb
+      psych (>= 4.0.0)
     regexp_parser (2.10.0)
+    reline (0.6.1)
+      io-console (~> 0.5)
+    roda (3.93.0)
+      rack
     rspec (3.13.1)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -129,6 +238,7 @@ GEM
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -137,13 +247,29 @@ GEM
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
     simpleidn (0.2.3)
+    sinatra (4.1.1)
+      logger (>= 1.6.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.1.1)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    stringio (3.1.7)
+    thor (1.3.2)
+    tilt (2.6.0)
+    timeout (0.4.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
     uri (1.0.3)
     useragent (0.16.11)
+    websocket-driver (0.8.0)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   arm64-darwin-21
@@ -159,11 +285,14 @@ DEPENDENCIES
   rack (>= 3.0.0)
   rack-test
   rackup
+  rails
   rake
+  roda
   rspec
   rubocop
   rubocop-performance
   simplecov
+  sinatra
 
 BUNDLED WITH
    2.3.10

lib/openapi_first/test.rb

@@ -9,18 +9,14 @@ module Test
     autoload :Coverage, 'openapi_first/test/coverage'
     autoload :Methods, 'openapi_first/test/methods'
     autoload :Callable, 'openapi_first/test/callable'
+    autoload :Observe, 'openapi_first/test/observe'
     extend Registry
 
     class CoverageError < Error; end
 
-    # @visible private
-    module Observed; end
-
     # Inject request/response validation in a rack app class
     def self.observe(app, api: :default)
-      mod = Callable[api:]
-      app.prepend(mod) unless app.include?(Observed)
-      app.include(Observed)
+      Observe.observe(app, api:)
     end
 
     def self.minitest?(base)

lib/openapi_first/test/callable.rb

@@ -7,11 +7,11 @@ module Test
     module Callable
       # Returns a Module with a `call(env)` method that wraps super inside silent request/response validation
       # You can use this like `Application.prepend(OpenapiFirst::Test.app_module)` to monitor your app during testing.
-      def self.[](api: :default)
-        definition = OpenapiFirst::Test[api]
+      def self.[](definition)
         Module.new.tap do |mod|
           mod.define_method(:call) do |env|
             request = Rack::Request.new(env)
+
             definition.validate_request(request, raise_error: false)
             response = super(env)
             status, headers, body = response

lib/openapi_first/test/observe.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenapiFirst
+  module Test
+    class ObserveError < Error; end
+
+    # @visible private
+    module Observed; end
+
+    # Inject silent request/response validation to observe rack apps during testing
+    module Observe
+      def self.observe(app, api: :default)
+        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
+    end
+  end
+end

spec/test/observe_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+RSpec.describe OpenapiFirst::Test::Observe do
+  RSpec.shared_examples 'an observed app' do
+    it 'injects request/response validation' do
+      described_class.observe(app)
+
+      expect(definition).to receive(:validate_request)
+      expect(definition).to receive(:validate_response)
+
+      callable.call(Rack::MockRequest.env_for('/'))
+    end
+  end
+
+  let(:definition) { OpenapiFirst.load('./examples/openapi.yaml') }
+  let(:callable) { app }
+
+  before do
+    OpenapiFirst::Test.register(definition)
+  end
+
+  context 'with a simple class' do
+    let(:app) do
+      Class.new do
+        def call(_env)
+          Rack::Response.new.finish
+        end
+      end
+    end
+
+    let(:callable) { app.new }
+
+    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 a class that has no call method' do
+    let(:app) do
+      Class.new
+    end
+
+    it 'raises an error when trying to observe' do
+      expect do
+        described_class.observe(app)
+      end.to raise_error OpenapiFirst::Test::ObserveError
+
+      app.instance_methods.include?(:call)
+    end
+  end
+
+  context 'with a Sinatra app' do
+    require 'sinatra/base'
+
+    let(:app) do
+      Class.new(Sinatra::Base)
+    end
+    it_behaves_like 'an observed app'
+
+    context 'when using the class method' do
+      let(:callable) { app }
+
+      it_behaves_like 'an observed app'
+    end
+  end
+
+  context 'with a Rails app' do
+    require 'rails'
+    require 'action_controller/railtie'
+
+    before do
+      Rails.logger = Logger.new(StringIO.new)
+    end
+
+    let(:app) do
+      Class.new(Rails::Application)
+    end
+
+    it_behaves_like 'an observed app'
+  end
+end