actionpack 5.2.6 → 6.1.4.4

data/lib/action_dispatch/system_testing/browser.rb

@@ -3,10 +3,11 @@
 module ActionDispatch
   module SystemTesting
     class Browser # :nodoc:
-      attr_reader :name
+      attr_reader :name, :options
 
       def initialize(name)
         @name = name
+        set_default_options
       end
 
       def type
@@ -20,29 +21,65 @@ module ActionDispatch
         end
       end
 
-      def options
-        case name
-        when :headless_chrome
-          headless_chrome_browser_options
-        when :headless_firefox
-          headless_firefox_browser_options
+      def configure
+        initialize_options
+        yield options if block_given? && options
+      end
+
+      # driver_path can be configured as a proc. The webdrivers gem uses this
+      # proc to update web drivers. Running this proc early allows us to only
+      # update the webdriver once and avoid race conditions when using
+      # parallel tests.
+      def preload
+        case type
+        when :chrome
+          if ::Selenium::WebDriver::Service.respond_to? :driver_path=
+            ::Selenium::WebDriver::Chrome::Service.driver_path&.call
+          else
+            # Selenium <= v3.141.0
+            ::Selenium::WebDriver::Chrome.driver_path
+          end
+        when :firefox
+          if ::Selenium::WebDriver::Service.respond_to? :driver_path=
+            ::Selenium::WebDriver::Firefox::Service.driver_path&.call
+          else
+            # Selenium <= v3.141.0
+            ::Selenium::WebDriver::Firefox.driver_path
+          end
         end
       end
 
       private
-        def headless_chrome_browser_options
-          options = Selenium::WebDriver::Chrome::Options.new
-          options.args << "--headless"
-          options.args << "--disable-gpu" if Gem.win_platform?
+        def initialize_options
+          @options ||=
+            case type
+            when :chrome
+              ::Selenium::WebDriver::Chrome::Options.new
+            when :firefox
+              ::Selenium::WebDriver::Firefox::Options.new
+            end
+        end
 
-          options
+        def set_default_options
+          case name
+          when :headless_chrome
+            set_headless_chrome_browser_options
+          when :headless_firefox
+            set_headless_firefox_browser_options
+          end
         end
 
-        def headless_firefox_browser_options
-          options = Selenium::WebDriver::Firefox::Options.new
-          options.args << "-headless"
+        def set_headless_chrome_browser_options
+          configure do |capabilities|
+            capabilities.add_argument("--headless")
+            capabilities.add_argument("--disable-gpu") if Gem.win_platform?
+          end
+        end
 
-          options
+        def set_headless_firefox_browser_options
+          configure do |capabilities|
+            capabilities.add_argument("-headless")
+          end
         end
     end
   end

data/lib/action_dispatch/system_testing/driver.rb

@@ -3,11 +3,17 @@
 module ActionDispatch
   module SystemTesting
     class Driver # :nodoc:
-      def initialize(name, **options)
+      def initialize(name, **options, &capabilities)
         @name = name
         @browser = Browser.new(options[:using])
         @screen_size = options[:screen_size]
-        @options = options[:options]
+        @options = options[:options] || {}
+        @capabilities = capabilities
+
+        if name == :selenium
+          require "selenium/webdriver"
+          @browser.preload
+        end
       end
 
       def use
@@ -22,6 +28,8 @@ module ActionDispatch
         end
 
         def register
+          @browser.configure(&@capabilities)
+
           Capybara.register_driver @name do |app|
             case @name
             when :selenium then register_selenium(app)
@@ -36,7 +44,7 @@ module ActionDispatch
         end
 
         def register_selenium(app)
-          Capybara::Selenium::Driver.new(app, { browser: @browser.type }.merge(browser_options)).tap do |driver|
+          Capybara::Selenium::Driver.new(app, **{ browser: @browser.type }.merge(browser_options)).tap do |driver|
             driver.browser.manage.window.size = Selenium::WebDriver::Dimension.new(*@screen_size)
           end
         end

data/lib/action_dispatch/system_testing/test_helpers/screenshot_helper.rb

@@ -9,10 +9,16 @@ module ActionDispatch
         #
         # +take_screenshot+ can be used at any point in your system tests to take
         # a screenshot of the current state. This can be useful for debugging or
-        # automating visual testing.
+        # automating visual testing. You can take multiple screenshots per test
+        # to investigate changes at different points during your test. These will be
+        # named with a sequential prefix (or 'failed' for failing tests)
         #
         # The screenshot will be displayed in your console, if supported.
         #
+        # You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT_HTML+ environment variable to
+        # save the HTML from the page that is being screenhoted so you can investigate the
+        # elements on the page at the time of the screenshot
+        #
         # You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT+ environment variable to
         # control the output. Possible values are:
         # * [+simple+ (default)]    Only displays the screenshot path.
@@ -20,8 +26,10 @@ module ActionDispatch
         # * [+inline+]              Display the screenshot in the terminal using the
         #                           iTerm image protocol (https://iterm2.com/documentation-images.html).
         # * [+artifact+]            Display the screenshot in the terminal, using the terminal
-        #                           artifact format (https://buildkite.github.io/terminal/inline-images/).
+        #                           artifact format (https://buildkite.github.io/terminal-to-html/inline-images/).
         def take_screenshot
+          increment_unique
+          save_html if save_html?
           save_image
           puts display_image
         end
@@ -38,16 +46,49 @@ module ActionDispatch
         end
 
         private
+          attr_accessor :_screenshot_counter
+
+          def save_html?
+            ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] == "1"
+          end
+
+          def increment_unique
+            @_screenshot_counter ||= 0
+            @_screenshot_counter += 1
+          end
+
+          def unique
+            failed? ? "failures" : (_screenshot_counter || 0).to_s
+          end
+
           def image_name
-            failed? ? "failures_#{method_name}" : method_name
+            sanitized_method_name = method_name.tr("/\\", "--")
+            name = "#{unique}_#{sanitized_method_name}"
+            name[0...225]
           end
 
           def image_path
-            @image_path ||= absolute_image_path.relative_path_from(Pathname.pwd).to_s
+            absolute_image_path.to_s
+          end
+
+          def html_path
+            absolute_html_path.to_s
+          end
+
+          def absolute_path
+            Rails.root.join("tmp/screenshots/#{image_name}")
           end
 
           def absolute_image_path
-            Rails.root.join("tmp/screenshots/#{image_name}.png")
+            "#{absolute_path}.png"
+          end
+
+          def absolute_html_path
+            "#{absolute_path}.html"
+          end
+
+          def save_html
+            page.save_page(absolute_html_path)
           end
 
           def save_image
@@ -65,7 +106,8 @@ module ActionDispatch
           end
 
           def display_image
-            message = "[Screenshot]: #{image_path}\n".dup
+            message = +"[Screenshot Image]: #{image_path}\n"
+            message << +"[Screenshot HTML]: #{html_path}\n" if save_html?
 
             case output_type
             when "artifact"
@@ -80,7 +122,7 @@ module ActionDispatch
           end
 
           def inline_base64(path)
-            Base64.encode64(path).gsub("\n", "")
+            Base64.strict_encode64(path)
           end
 
           def failed?

data/lib/action_dispatch/system_testing/test_helpers/setup_and_teardown.rb

@@ -4,24 +4,22 @@ module ActionDispatch
   module SystemTesting
     module TestHelpers
       module SetupAndTeardown # :nodoc:
-        DEFAULT_HOST = "http://127.0.0.1"
-
         def host!(host)
-          super
+          ActiveSupport::Deprecation.warn \
+            "ActionDispatch::SystemTestCase#host! is deprecated with no replacement. " \
+            "Set Capybara.app_host directly or rely on Capybara's default host."
+
           Capybara.app_host = host
         end
 
-        def before_setup
-          host! DEFAULT_HOST
+        def before_teardown
+          take_failed_screenshot
+        ensure
           super
         end
 
         def after_teardown
-          begin
-            take_failed_screenshot
-          ensure
-            Capybara.reset_sessions!
-          end
+          Capybara.reset_sessions!
         ensure
           super
         end

data/lib/action_dispatch/testing/assertion_response.rb

@@ -35,7 +35,6 @@ module ActionDispatch
     end
 
     private
-
       def code_from_name(name)
         GENERIC_RESPONSE_CODES[name] || Rack::Utils::SYMBOL_TO_STATUS_CODE[name]
       end

data/lib/action_dispatch/testing/assertions/response.rb

@@ -31,15 +31,13 @@ module ActionDispatch
         message ||= generate_response_message(type)
 
         if RESPONSE_PREDICATES.keys.include?(type)
-          assert @response.send(RESPONSE_PREDICATES[type]), message
+          assert @response.public_send(RESPONSE_PREDICATES[type]), message
         else
           assert_equal AssertionResponse.new(type).code, @response.response_code, message
         end
       end
 
-      # Asserts that the redirection options passed in match those of the redirect called in the latest action.
-      # This match can be partial, such that <tt>assert_redirected_to(controller: "weblog")</tt> will also
-      # match the redirection of <tt>redirect_to(controller: "weblog", action: "show")</tt> and so on.
+      # Asserts that the response is a redirect to a URL matching the given options.
       #
       #   # Asserts that the redirection was to the "index" action on the WeblogController
       #   assert_redirected_to controller: "weblog", action: "index"
@@ -79,9 +77,8 @@ module ActionDispatch
         end
 
         def generate_response_message(expected, actual = @response.response_code)
-          "Expected response to be a <#{code_with_name(expected)}>,"\
-          " but was a <#{code_with_name(actual)}>"
-            .dup.concat(location_if_redirected).concat(response_body_if_short)
+          (+"Expected response to be a <#{code_with_name(expected)}>,"\
+          " but was a <#{code_with_name(actual)}>").concat(location_if_redirected).concat(response_body_if_short)
         end
 
         def response_body_if_short

data/lib/action_dispatch/testing/assertions/routing.rb

@@ -9,6 +9,11 @@ module ActionDispatch
   module Assertions
     # Suite of assertions to test routes generated by \Rails and the handling of requests made to them.
     module RoutingAssertions
+      def setup # :nodoc:
+        @routes ||= nil
+        super
+      end
+
       # Asserts that the routing of the given +path+ was handled correctly and that the parsed options (given in the +expected_options+ hash)
       # match +path+. Basically, it asserts that \Rails recognizes the route given by +expected_options+.
       #
@@ -78,15 +83,14 @@ module ActionDispatch
       #   # Asserts that the generated route gives us our custom route
       #   assert_generates "changesets/12", { controller: 'scm', action: 'show_diff', revision: "12" }
       def assert_generates(expected_path, options, defaults = {}, extras = {}, message = nil)
-        if expected_path =~ %r{://}
+        if %r{://}.match?(expected_path)
           fail_on(URI::InvalidURIError, message) do
             uri = URI.parse(expected_path)
             expected_path = uri.path.to_s.empty? ? "/" : uri.path
           end
         else
-          expected_path = "/#{expected_path}" unless expected_path.first == "/"
+          expected_path = "/#{expected_path}" unless expected_path.start_with?("/")
         end
-        # Load routes.rb if it hasn't been loaded.
 
         options = options.clone
         generated_path, query_string_keys = @routes.generate_extras(options, defaults)
@@ -155,9 +159,16 @@ module ActionDispatch
           @controller.singleton_class.include(_routes.url_helpers)
 
           if @controller.respond_to? :view_context_class
-            @controller.view_context_class = Class.new(@controller.view_context_class) do
+            view_context_class = Class.new(@controller.view_context_class) do
               include _routes.url_helpers
             end
+
+            custom_view_context = Module.new {
+              define_method(:view_context_class) do
+                view_context_class
+              end
+            }
+            @controller.extend(custom_view_context)
           end
         end
         yield @routes
@@ -171,7 +182,7 @@ module ActionDispatch
       # ROUTES TODO: These assertions should really work in an integration context
       def method_missing(selector, *args, &block)
         if defined?(@controller) && @controller && defined?(@routes) && @routes && @routes.named_routes.route_defined?(selector)
-          @controller.send(selector, *args, &block)
+          @controller.public_send(selector, *args, &block)
         else
           super
         end
@@ -187,9 +198,10 @@ module ActionDispatch
             method = :get
           end
 
-          request = ActionController::TestRequest.create @controller.class
+          controller = @controller if defined?(@controller)
+          request = ActionController::TestRequest.create controller&.class
 
-          if path =~ %r{://}
+          if %r{://}.match?(path)
             fail_on(URI::InvalidURIError, msg) do
               uri = URI.parse(path)
               request.env["rack.url_scheme"] = uri.scheme || "http"
@@ -198,7 +210,7 @@ module ActionDispatch
               request.path = uri.path.to_s.empty? ? "/" : uri.path
             end
           else
-            path = "/#{path}" unless path.first == "/"
+            path = "/#{path}" unless path.start_with?("/")
             request.path = path
           end
 

data/lib/action_dispatch/testing/assertions.rb

@@ -14,7 +14,7 @@ module ActionDispatch
     include Rails::Dom::Testing::Assertions
 
     def html_document
-      @html_document ||= if @response.content_type.to_s.end_with?("xml")
+      @html_document ||= if @response.media_type&.end_with?("xml")
         Nokogiri::XML::Document.parse(@response.body)
       else
         Nokogiri::HTML::Document.parse(@response.body)

data/lib/action_dispatch/testing/integration.rb

@@ -2,8 +2,6 @@
 
 require "stringio"
 require "uri"
-require "active_support/core_ext/kernel/singleton_class"
-require "active_support/core_ext/object/try"
 require "rack/test"
 require "minitest"
 
@@ -44,16 +42,33 @@ module ActionDispatch
 
       # Performs a HEAD request with the given parameters. See ActionDispatch::Integration::Session#process
       # for more details.
-      def head(path, *args)
-        process(:head, path, *args)
+      def head(path, **args)
+        process(:head, path, **args)
+      end
+
+      # Performs an OPTIONS request with the given parameters. See ActionDispatch::Integration::Session#process
+      # for more details.
+      def options(path, **args)
+        process(:options, path, **args)
       end
 
       # Follow a single redirect response. If the last response was not a
       # redirect, an exception will be raised. Otherwise, the redirect is
-      # performed on the location header.
-      def follow_redirect!
+      # performed on the location header. If the redirection is a 307 or 308 redirect,
+      # the same HTTP verb will be used when redirecting, otherwise a GET request
+      # will be performed. Any arguments are passed to the
+      # underlying request.
+      def follow_redirect!(**args)
         raise "not a redirect! #{status} #{status_message}" unless redirect?
-        get(response.location)
+
+        method =
+          if [307, 308].include?(response.status)
+            request.method.downcase
+          else
+            :get
+          end
+
+        public_send(method, response.location, **args)
         status
       end
     end
@@ -72,13 +87,8 @@ module ActionDispatch
       include Minitest::Assertions
       include TestProcess, RequestHelpers, Assertions
 
-      %w( status status_message headers body redirect? ).each do |method|
-        delegate method, to: :response, allow_nil: true
-      end
-
-      %w( path ).each do |method|
-        delegate method, to: :request, allow_nil: true
-      end
+      delegate :status, :status_message, :headers, :body, :redirect?, to: :response, allow_nil: true
+      delegate :path, to: :request, allow_nil: true
 
       # The hostname used in the last request.
       def host
@@ -122,7 +132,7 @@ module ActionDispatch
 
       def url_options
         @url_options ||= default_url_options.dup.tap do |url_options|
-          url_options.reverse_merge!(controller.url_options) if controller
+          url_options.reverse_merge!(controller.url_options) if controller.respond_to?(:url_options)
 
           if @app.respond_to?(:routes)
             url_options.reverse_merge!(@app.routes.default_url_options)
@@ -189,6 +199,12 @@ module ActionDispatch
       #   merged into the Rack env hash.
       # - +env+: Additional env to pass, as a Hash. The headers will be
       #   merged into the Rack env hash.
+      # - +xhr+: Set to +true+ if you want to make and Ajax request.
+      #   Adds request headers characteristic of XMLHttpRequest e.g. HTTP_X_REQUESTED_WITH.
+      #   The headers will be merged into the Rack env hash.
+      # - +as+: Used for encoding the request with different content type.
+      #   Supports +:json+ by default and will set the appropriate request headers.
+      #   The headers will be merged into the Rack env hash.
       #
       # This method is rarely used directly. Use +#get+, +#post+, or other standard
       # HTTP methods in integration tests. +#process+ is only required when using a
@@ -210,7 +226,7 @@ module ActionDispatch
           method = :post
         end
 
-        if path =~ %r{://}
+        if %r{://}.match?(path)
           path = build_expanded_path(path) do |location|
             https! URI::HTTPS === location if location.scheme
 
@@ -303,6 +319,7 @@ module ActionDispatch
       APP_SESSIONS = {}
 
       attr_reader :app
+      attr_accessor :root_session # :nodoc:
 
       def initialize(*args, &blk)
         super(*args, &blk)
@@ -328,7 +345,7 @@ module ActionDispatch
         klass = APP_SESSIONS[app] ||= Class.new(Integration::Session) {
           # If the app is a Rails app, make url_helpers available on the session.
           # This makes app.url_for and app.foo_path available in the console.
-          if app.respond_to?(:routes)
+          if app.respond_to?(:routes) && app.routes.is_a?(ActionDispatch::Routing::RouteSet)
             include app.routes.url_helpers
             include app.routes.mounted_helpers
           end
@@ -341,16 +358,22 @@ module ActionDispatch
       end
 
       %w(get post patch put head delete cookies assigns follow_redirect!).each do |method|
-        define_method(method) do |*args|
-          # reset the html_document variable, except for cookies/assigns calls
-          unless method == "cookies" || method == "assigns"
-            @html_document = nil
-          end
+        # reset the html_document variable, except for cookies/assigns calls
+        unless method == "cookies" || method == "assigns"
+          reset_html_document = "@html_document = nil"
+        end
+
+        definition = RUBY_VERSION >= "2.7" ? "..." : "*args"
+
+        module_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{method}(#{definition})
+            #{reset_html_document}
 
-          integration_session.__send__(method, *args).tap do
+            result = integration_session.#{method}(#{definition})
             copy_session_variables!
+            result
           end
-        end
+        RUBY
       end
 
       # Open a new session instance. If a block is given, the new session is
@@ -366,10 +389,19 @@ module ActionDispatch
       def open_session
         dup.tap do |session|
           session.reset!
+          session.root_session = self.root_session || self
           yield session if block_given?
         end
       end
 
+      def assertions # :nodoc:
+        root_session ? root_session.assertions : super
+      end
+
+      def assertions=(assertions) # :nodoc:
+        root_session ? root_session.assertions = assertions : super
+      end
+
       # Copy the instance variables from the current session instance into the
       # test instance.
       def copy_session_variables! #:nodoc:
@@ -485,7 +517,7 @@ module ActionDispatch
   #
   # A simple integration test that exercises multiple controllers:
   #
-  #   require 'test_helper'
+  #   require "test_helper"
   #
   #   class UserFlowsTest < ActionDispatch::IntegrationTest
   #     test "login and browse site" do
@@ -514,7 +546,7 @@ module ActionDispatch
   #
   # Here's an example of multiple sessions and custom DSL in an integration test
   #
-  #   require 'test_helper'
+  #   require "test_helper"
   #
   #   class UserFlowsTest < ActionDispatch::IntegrationTest
   #     test "login and browse site" do
@@ -634,8 +666,8 @@ module ActionDispatch
           @@app = app
         end
 
-        def register_encoder(*args)
-          RequestEncoder.register_encoder(*args)
+        def register_encoder(*args, **options)
+          RequestEncoder.register_encoder(*args, **options)
         end
       end
 

data/lib/action_dispatch/testing/request_encoder.rb

@@ -38,8 +38,8 @@ module ActionDispatch
     end
 
     def self.parser(content_type)
-      mime = Mime::Type.lookup(content_type)
-      encoder(mime ? mime.ref : nil).response_parser
+      type = Mime::Type.lookup(content_type).ref if content_type
+      encoder(type).response_parser
     end
 
     def self.encoder(name)

data/lib/action_dispatch/testing/test_process.rb

@@ -6,19 +6,44 @@ require "action_dispatch/middleware/flash"
 module ActionDispatch
   module TestProcess
     module FixtureFile
-      # Shortcut for <tt>Rack::Test::UploadedFile.new(File.join(ActionDispatch::IntegrationTest.fixture_path, path), type)</tt>:
+      # Shortcut for <tt>Rack::Test::UploadedFile.new(File.join(ActionDispatch::IntegrationTest.file_fixture_path, path), type)</tt>:
       #
-      #   post :change_avatar, avatar: fixture_file_upload('files/spongebob.png', 'image/png')
+      #   post :change_avatar, params: { avatar: fixture_file_upload('spongebob.png', 'image/png') }
+      #
+      # Default fixture files location is <tt>test/fixtures/files</tt>.
       #
       # To upload binary files on Windows, pass <tt>:binary</tt> as the last parameter.
       # This will not affect other platforms:
       #
-      #   post :change_avatar, avatar: fixture_file_upload('files/spongebob.png', 'image/png', :binary)
+      #   post :change_avatar, params: { avatar: fixture_file_upload('spongebob.png', 'image/png', :binary) }
       def fixture_file_upload(path, mime_type = nil, binary = false)
         if self.class.respond_to?(:fixture_path) && self.class.fixture_path &&
             !File.exist?(path)
-          path = File.join(self.class.fixture_path, path)
+          original_path = path
+          path = Pathname.new(self.class.fixture_path).join(path)
+
+          if !self.class.file_fixture_path
+            ActiveSupport::Deprecation.warn(<<~EOM)
+              Passing a path to `fixture_file_upload` relative to `fixture_path` is deprecated.
+              In Rails 6.2, the path needs to be relative to `file_fixture_path` which you
+              haven't set yet. Set `file_fixture_path` to discard this warning.
+            EOM
+          elsif path.exist?
+            non_deprecated_path = Pathname(File.absolute_path(path)).relative_path_from(Pathname(File.absolute_path(self.class.file_fixture_path)))
+            ActiveSupport::Deprecation.warn(<<~EOM)
+              Passing a path to `fixture_file_upload` relative to `fixture_path` is deprecated.
+              In Rails 6.2, the path needs to be relative to `file_fixture_path`.
+
+              Please modify the call from
+              `fixture_file_upload("#{original_path}")` to `fixture_file_upload("#{non_deprecated_path}")`.
+            EOM
+          else
+            path = file_fixture(original_path)
+          end
+        elsif self.class.file_fixture_path && !File.exist?(path)
+          path = file_fixture(path)
         end
+
         Rack::Test::UploadedFile.new(path, mime_type, binary)
       end
     end

data/lib/action_dispatch/testing/test_request.rb

@@ -6,9 +6,9 @@ require "rack/utils"
 module ActionDispatch
   class TestRequest < Request
     DEFAULT_ENV = Rack::MockRequest.env_for("/",
-      "HTTP_HOST"                => "test.host",
-      "REMOTE_ADDR"              => "0.0.0.0",
-      "HTTP_USER_AGENT"          => "Rails Testing",
+      "HTTP_HOST"                => "test.host".b,
+      "REMOTE_ADDR"              => "0.0.0.0".b,
+      "HTTP_USER_AGENT"          => "Rails Testing".b,
     )
 
     # Create a new test request with default +env+ values.