[test] Generate Rails stub tests for 5.0 through 8.0

Author: chadlwilson

src/spec/ruby/jruby/rack/integration_spec.rb

@@ -82,77 +82,73 @@
 
   end
 
+  it "should have defined Rails stub tests" do
+    expect(File.foreach(__FILE__).select { |line| line.include?("describe") }).to include(/^  describe.*lib: :#{CURRENT_LIB}/),
+      "Expected rails stub tests to be defined for #{CURRENT_LIB} inside integration_spec.rb"
+    expect(File.exist?(File.join(STUB_DIR, CURRENT_LIB.to_s))).to be(true),
+      "Expected rails stub dir for #{CURRENT_LIB.to_s} to exist at #{File.join(STUB_DIR, CURRENT_LIB.to_s).inspect}"
+  end if CURRENT_LIB.to_s.include?('rails')
+
   shared_examples_for 'a rails app', :shared => true do
 
+    base_path = "file://#{STUB_DIR}/#{CURRENT_LIB.to_s}"
+
     let(:servlet_context) do
-      new_servlet_context(base_path).tap { |servlet_context| prepare_servlet_context(servlet_context) }
+      new_servlet_context(base_path).tap { |servlet_context| prepare_servlet_context(servlet_context, base_path) }
     end
 
-    it "initializes pooling when min/max set" do
-      servlet_context.addInitParameter('jruby.min.runtimes', '1')
-      servlet_context.addInitParameter('jruby.max.runtimes', '2')
+    context "runtime" do
 
-      listener = org.jruby.rack.rails.RailsServletContextListener.new
-      listener.contextInitialized javax.servlet.ServletContextEvent.new(servlet_context)
+      it "initializes pooling when min/max set" do
+        servlet_context.addInitParameter('jruby.min.runtimes', '1')
+        servlet_context.addInitParameter('jruby.max.runtimes', '2')
 
-      rack_factory = servlet_context.getAttribute("rack.factory")
-      expect(rack_factory).to be_a(RackApplicationFactory)
-      expect(rack_factory).to be_a(PoolingRackApplicationFactory)
-      expect(rack_factory.realFactory).to be_a(RailsRackApplicationFactory)
+        listener = org.jruby.rack.rails.RailsServletContextListener.new
+        listener.contextInitialized javax.servlet.ServletContextEvent.new(servlet_context)
 
-      expect(servlet_context.getAttribute("rack.context")).to be_a(RackContext)
-      expect(servlet_context.getAttribute("rack.context")).to be_a(ServletRackContext)
+        rack_factory = servlet_context.getAttribute("rack.factory")
+        expect(rack_factory).to be_a(RackApplicationFactory)
+        expect(rack_factory).to be_a(PoolingRackApplicationFactory)
+        expect(rack_factory.realFactory).to be_a(RailsRackApplicationFactory)
 
-      expect(rack_factory.getApplication).to be_a(DefaultRackApplication)
-    end
+        expect(servlet_context.getAttribute("rack.context")).to be_a(RackContext)
+        expect(servlet_context.getAttribute("rack.context")).to be_a(ServletRackContext)
 
-    it "initializes shared (thread-safe) by default" do
-      listener = org.jruby.rack.rails.RailsServletContextListener.new
-      listener.contextInitialized javax.servlet.ServletContextEvent.new(servlet_context)
-
-      rack_factory = servlet_context.getAttribute("rack.factory")
-      expect(rack_factory).to be_a(RackApplicationFactory)
-      expect(rack_factory).to be_a(SharedRackApplicationFactory)
-      expect(rack_factory.realFactory).to be_a(RailsRackApplicationFactory)
-
-      expect(rack_factory.getApplication).to be_a(DefaultRackApplication)
-    end
-
-    it "initializes shared (thread-safe) whem max runtimes is 1" do
-      servlet_context.addInitParameter('jruby.max.runtimes', '1')
+        expect(rack_factory.getApplication).to be_a(DefaultRackApplication)
+      end
 
-      listener = org.jruby.rack.rails.RailsServletContextListener.new
-      listener.contextInitialized javax.servlet.ServletContextEvent.new(servlet_context)
+      it "initializes shared (thread-safe) by default" do
+        listener = org.jruby.rack.rails.RailsServletContextListener.new
+        listener.contextInitialized javax.servlet.ServletContextEvent.new(servlet_context)
 
-      rack_factory = servlet_context.getAttribute("rack.factory")
-      expect(rack_factory).to be_a(RackApplicationFactory)
-      expect(rack_factory).to be_a(SharedRackApplicationFactory)
-      expect(rack_factory.realFactory).to be_a(RailsRackApplicationFactory)
-    end
+        rack_factory = servlet_context.getAttribute("rack.factory")
+        expect(rack_factory).to be_a(RackApplicationFactory)
+        expect(rack_factory).to be_a(SharedRackApplicationFactory)
+        expect(rack_factory.realFactory).to be_a(RailsRackApplicationFactory)
 
-  end
+        expect(rack_factory.getApplication).to be_a(DefaultRackApplication)
+      end
 
-  describe 'rails 7.2', lib: :rails72 do
+      it "initializes shared (thread-safe) whem max runtimes is 1" do
+        servlet_context.addInitParameter('jruby.max.runtimes', '1')
 
-    before(:all) do
-      name = :rails72 # copy_gemfile :
-      raise "Environment variable BUNDLE_GEMFILE seems to not contain #{name.to_s}" unless ENV['BUNDLE_GEMFILE']&.include?(name.to_s)
-      FileUtils.cp ENV['BUNDLE_GEMFILE'], File.join(STUB_DIR, "#{name}/Gemfile")
-      FileUtils.cp "#{ENV['BUNDLE_GEMFILE']}.lock", File.join(STUB_DIR, "#{name}/Gemfile.lock")
-      Dir.chdir File.join(STUB_DIR, name.to_s)
-    end
+        listener = org.jruby.rack.rails.RailsServletContextListener.new
+        listener.contextInitialized javax.servlet.ServletContextEvent.new(servlet_context)
 
-    def base_path
-      "#{STUB_DIR}/rails72"
+        rack_factory = servlet_context.getAttribute("rack.factory")
+        expect(rack_factory).to be_a(RackApplicationFactory)
+        expect(rack_factory).to be_a(SharedRackApplicationFactory)
+        expect(rack_factory.realFactory).to be_a(RailsRackApplicationFactory)
+      end
     end
 
-    it_should_behave_like 'a rails app'
-
     context "initialized" do
 
+      before(:all) { copy_gemfile }
+
       before(:all) do
         initialize_rails('production', "file://#{base_path}") do |servlet_context, _|
-          prepare_servlet_context(servlet_context)
+          prepare_servlet_context(servlet_context, base_path)
         end
       end
       after(:all) { restore_rails }
@@ -168,18 +164,27 @@ def base_path
         should_eval_as_not_nil "defined?(Rails)"
         should_eval_as_not_nil "Rails.logger"
 
-        # Rails 7.x wraps the default in a ActiveSupport::BroadcastLogger
-        should_eval_as_eql_to "Rails.logger.is_a? ActiveSupport::BroadcastLogger", true
-        should_eval_as_eql_to "Rails.logger.broadcasts.size", 1
-        should_eval_as_eql_to "Rails.logger.broadcasts.first.is_a? JRuby::Rack::Logger", true
-        # NOTE: TaggedLogging is a module that extends the logger instance:
-        should_eval_as_eql_to "Rails.logger.broadcasts.first.is_a? ActiveSupport::TaggedLogging", true
-
         # production.rb: config.log_level = 'info'
         should_eval_as_eql_to "Rails.logger.level", Logger::INFO
-        should_eval_as_eql_to "Rails.logger.broadcasts.first.level", Logger::INFO
 
-        unwrap_logger = "logger = Rails.logger.broadcasts.first;"
+        # Rails 7.1+ wraps the default in a ActiveSupport::BroadcastLogger
+        if Rails::VERSION::STRING < '7.1'
+          should_eval_as_eql_to "Rails.logger.is_a? JRuby::Rack::Logger", true
+          should_eval_as_eql_to "Rails.logger.is_a? ActiveSupport::TaggedLogging", true
+          unwrap_logger = "logger = Rails.logger;"
+        else
+          should_eval_as_not_nil "defined?(ActiveSupport::BroadcastLogger)"
+          should_eval_as_eql_to "Rails.logger.is_a? ActiveSupport::BroadcastLogger", true
+          should_eval_as_eql_to "Rails.logger.broadcasts.size", 1
+          should_eval_as_eql_to "Rails.logger.broadcasts.first.is_a? JRuby::Rack::Logger", true
+          # NOTE: TaggedLogging is a module that extends the logger instance:
+          should_eval_as_eql_to "Rails.logger.broadcasts.first.is_a? ActiveSupport::TaggedLogging", true
+
+          should_eval_as_eql_to "Rails.logger.broadcasts.first.level", Logger::INFO
+
+          unwrap_logger = "logger = Rails.logger.broadcasts.first;"
+        end
+
         # sanity check logger-silence works:
         should_eval_as_eql_to "#{unwrap_logger} logger.silence { logger.warn('from-integration-spec') }", true
 
@@ -191,9 +196,45 @@ def base_path
         should_eval_as_eql_to "Rails.public_path.to_s", "#{base_path}/public"
       end
 
+      it "disables rack's chunked support (by default)" do
+        @runtime = @rack_factory.getApplication.getRuntime
+        expect_to_have_monkey_patched_chunked
+      end
     end
   end
 
+  describe 'rails 5.0', lib: :rails50 do
+    it_should_behave_like 'a rails app'
+  end
+
+  describe 'rails 5.2', lib: :rails52 do
+    it_should_behave_like 'a rails app'
+  end
+
+  describe 'rails 6.0', lib: :rails60 do
+    it_should_behave_like 'a rails app'
+  end
+
+  describe 'rails 6.1', lib: :rails61 do
+    it_should_behave_like 'a rails app'
+  end
+
+  describe 'rails 7.0', lib: :rails70 do
+    it_should_behave_like 'a rails app'
+  end
+
+  describe 'rails 7.1', lib: :rails71 do
+    it_should_behave_like 'a rails app'
+  end
+
+  describe 'rails 7.2', lib: :rails72 do
+    it_should_behave_like 'a rails app'
+  end
+
+  describe 'rails 8.0', lib: :rails80 do
+    it_should_behave_like 'a rails app'
+  end
+
   def expect_to_have_monkey_patched_chunked
     @runtime.evalScriptlet "require 'rack/chunked'"
     script = %{
@@ -232,17 +273,19 @@ def new_servlet_context(base_path = nil)
     servlet_context
   end
 
-  def prepare_servlet_context(servlet_context)
+  def prepare_servlet_context(servlet_context, base_path)
     servlet_context.addInitParameter('rails.root', base_path)
     servlet_context.addInitParameter('jruby.rack.layout_class', 'FileSystemLayout')
   end
 
   GEMFILES_DIR = File.expand_path('../../../gemfiles', STUB_DIR)
 
-  def copy_gemfile(name)
-    # e.g. 'rails30'
-    FileUtils.cp File.join(GEMFILES_DIR, "#{name}.gemfile"), File.join(STUB_DIR, "#{name}/WEB-INF/Gemfile")
-    FileUtils.cp File.join(GEMFILES_DIR, "#{name}.gemfile.lock"), File.join(STUB_DIR, "#{name}/WEB-INF/Gemfile.lock")
+  def copy_gemfile
+    name = CURRENT_LIB.to_s
+    raise "Environment variable BUNDLE_GEMFILE seems to not contain #{name}" unless ENV['BUNDLE_GEMFILE']&.include?(name)
+    FileUtils.cp ENV['BUNDLE_GEMFILE'], File.join(STUB_DIR, "#{name}/Gemfile")
+    FileUtils.cp "#{ENV['BUNDLE_GEMFILE']}.lock", File.join(STUB_DIR, "#{name}/Gemfile.lock")
+    Dir.chdir File.join(STUB_DIR, name)
   end
 
   ENV_COPY = ENV.to_h

src/spec/stub/rails50/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

src/spec/stub/rails50/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

src/spec/stub/rails50/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

src/spec/stub/rails50/config/application.rb

@@ -0,0 +1,25 @@
+require_relative 'boot'
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+# require "active_record/railtie"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+# require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Rails50
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end

src/spec/stub/rails50/config/boot.rb

@@ -0,0 +1,6 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+
+# workaround for https://github.com/ruby-concurrency/concurrent-ruby/issues/1077 since https://github.com/rails/rails/pull/54264 wont be backported earlier than 7.1.
+require "logger"

src/spec/stub/rails50/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

src/spec/stub/rails50/config/environments/development.rb

@@ -0,0 +1,39 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  if Rails.root.join('tmp/caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => 'public, max-age=172800'
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

src/spec/stub/rails50/config/environments/production.rb

@@ -0,0 +1,66 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "rails50_#{Rails.env}"
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger = ActiveSupport::TaggedLogging.new(logger)
+  end
+end