actionpack 7.0.4 → 7.1.5.1

data/lib/action_dispatch/system_test_case.rb

@@ -51,7 +51,7 @@ module ActionDispatch
   #     driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
   #   end
   #
-  # By default, <tt>ActionDispatch::SystemTestCase</tt> is driven by the
+  # By default, +ActionDispatch::SystemTestCase+ is driven by the
   # Selenium driver, with the Chrome browser, and a browser size of 1400x1400.
   #
   # Changing the driver configuration options is easy. Let's say you want to use
@@ -106,8 +106,8 @@ module ActionDispatch
   #     end
   #   end
   #
-  # Because <tt>ActionDispatch::SystemTestCase</tt> is a shim between Capybara
-  # and Rails, any driver that is supported by Capybara is supported by system
+  # Because +ActionDispatch::SystemTestCase+ is a shim between Capybara
+  # and \Rails, any driver that is supported by Capybara is supported by system
   # tests as long as you include the required gems and files.
   class SystemTestCase < ActiveSupport::TestCase
     include Capybara::DSL

data/lib/action_dispatch/system_testing/browser.rb

@@ -3,7 +3,7 @@
 module ActionDispatch
   module SystemTesting
     class Browser # :nodoc:
-      attr_reader :name, :options
+      attr_reader :name
 
       def initialize(name)
         @name = name
@@ -21,35 +21,32 @@ module ActionDispatch
         end
       end
 
+      def options
+        @options ||=
+          case type
+          when :chrome
+            ::Selenium::WebDriver::Chrome::Options.new
+          when :firefox
+            ::Selenium::WebDriver::Firefox::Options.new
+          end
+      end
+
       def configure
-        initialize_options
-        yield options if block_given? && options
+        yield options if block_given?
       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.
+      # driver_path is lazily initialized by default. Eagerly set it to
+      # avoid race conditions when using parallel tests.
       def preload
         case type
         when :chrome
-          ::Selenium::WebDriver::Chrome::Service.driver_path&.call
+          resolve_driver_path(::Selenium::WebDriver::Chrome)
         when :firefox
-          ::Selenium::WebDriver::Firefox::Service.driver_path&.call
+          resolve_driver_path(::Selenium::WebDriver::Firefox)
         end
       end
 
       private
-        def initialize_options
-          @options ||=
-            case type
-            when :chrome
-              ::Selenium::WebDriver::Chrome::Options.new
-            when :firefox
-              ::Selenium::WebDriver::Firefox::Options.new
-            end
-        end
-
         def set_default_options
           case name
           when :headless_chrome
@@ -71,6 +68,15 @@ module ActionDispatch
             capabilities.add_argument("-headless")
           end
         end
+
+        def resolve_driver_path(namespace)
+          # The path method has been deprecated in 4.20.0
+          if Gem::Version.new(::Selenium::WebDriver::VERSION) >= Gem::Version.new("4.20.0")
+            namespace::Service.driver_path = ::Selenium::WebDriver::DriverFinder.new(options, namespace::Service.new).driver_path
+          else
+            namespace::Service.driver_path = ::Selenium::WebDriver::DriverFinder.path(options, namespace::Service)
+          end
+        end
     end
   end
 end

data/lib/action_dispatch/system_testing/driver.rb

@@ -12,19 +12,11 @@ module ActionDispatch
         @name = @options.delete(:name) || driver_type
         @capabilities = capabilities
 
-        if [:poltergeist, :webkit].include?(driver_type)
-          ActiveSupport::Deprecation.warn <<~MSG.squish
-            Poltergeist and capybara-webkit are not maintained already.
-            Driver registration of :poltergeist or :webkit is deprecated and will be removed in Rails 7.1.
-            You can still use :selenium, and also :cuprite is available for alternative to Poltergeist.
-          MSG
-        end
-
         if driver_type == :selenium
           gem "selenium-webdriver", ">= 4.0.0"
           require "selenium/webdriver"
           @browser = Browser.new(options[:using])
-          @browser.preload
+          @browser.preload unless @options[:browser] == :remote
         else
           @browser = nil
         end
@@ -38,7 +30,7 @@ module ActionDispatch
 
       private
         def registerable?
-          [:selenium, :poltergeist, :webkit, :cuprite, :rack_test].include?(@driver_type)
+          [:selenium, :cuprite, :rack_test, :playwright].include?(@driver_type)
         end
 
         def register
@@ -47,16 +39,15 @@ module ActionDispatch
           Capybara.register_driver name do |app|
             case @driver_type
             when :selenium then register_selenium(app)
-            when :poltergeist then register_poltergeist(app)
-            when :webkit then register_webkit(app)
             when :cuprite then register_cuprite(app)
             when :rack_test then register_rack_test(app)
+            when :playwright then register_playwright(app)
             end
           end
         end
 
         def browser_options
-          @options.merge(capabilities: @browser.options).compact
+          @options.merge(options: @browser.options).compact
         end
 
         def register_selenium(app)
@@ -65,16 +56,6 @@ module ActionDispatch
           end
         end
 
-        def register_poltergeist(app)
-          Capybara::Poltergeist::Driver.new(app, @options.merge(window_size: @screen_size))
-        end
-
-        def register_webkit(app)
-          Capybara::Webkit::Driver.new(app, Capybara::Webkit::Configuration.to_hash.merge(@options)).tap do |driver|
-            driver.resize_window_to(driver.current_window_handle, *@screen_size)
-          end
-        end
-
         def register_cuprite(app)
           Capybara::Cuprite::Driver.new(app, @options.merge(window_size: @screen_size))
         end
@@ -83,6 +64,17 @@ module ActionDispatch
           Capybara::RackTest::Driver.new(app, respect_data_method: true, **@options)
         end
 
+        def register_playwright(app)
+          screen = { width: @screen_size[0], height: @screen_size[1] } if @screen_size
+          options = {
+            screen: screen,
+            viewport: screen,
+            **@options
+          }.compact
+
+          Capybara::Playwright::Driver.new(app, **options)
+        end
+
         def setup
           Capybara.current_driver = name
         end

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

@@ -13,28 +13,28 @@ module ActionDispatch
         # 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.
-        #
         # The default screenshots directory is +tmp/screenshots+ but you can set a different
         # one with +Capybara.save_path+
         #
-        # You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT_HTML+ environment variable to
-        # save the HTML from the page that is being screenshotted so you can investigate the
-        # elements on the page at the time of the screenshot
+        # You can use the +html+ argument or set the +RAILS_SYSTEM_TESTING_SCREENSHOT_HTML+
+        # environment variable to save the HTML from the page that is being screenshotted
+        # 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:
+        # You can use the +screenshot+ argument or set the +RAILS_SYSTEM_TESTING_SCREENSHOT+
+        # environment variable to control the output. Possible values are:
         # * [+simple+ (default)]    Only displays the screenshot path.
         #                           This is the default value.
         # * [+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-to-html/inline-images/).
-        def take_screenshot
+        def take_screenshot(html: false, screenshot: nil)
+          showing_html = html || html_from_env?
+
           increment_unique
-          save_html if save_html?
+          save_html if showing_html
           save_image
-          puts display_image
+          show display_image(html: showing_html, screenshot_output: screenshot)
         end
 
         # Takes a screenshot of the current page in the browser if the test
@@ -42,13 +42,16 @@ module ActionDispatch
         #
         # +take_failed_screenshot+ is called during system test teardown.
         def take_failed_screenshot
-          take_screenshot if failed? && supports_screenshot? && Capybara::Session.instance_created?
+          return unless failed? && supports_screenshot? && Capybara::Session.instance_created?
+
+          take_screenshot
+          metadata[:failure_screenshot_path] = relative_image_path if Minitest::Runnable.method_defined?(:metadata)
         end
 
         private
           attr_accessor :_screenshot_counter
 
-          def save_html?
+          def html_from_env?
             ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] == "1"
           end
 
@@ -62,7 +65,7 @@ module ActionDispatch
           end
 
           def image_name
-            sanitized_method_name = method_name.tr("/\\", "--")
+            sanitized_method_name = method_name.gsub(/[^\w]+/, "-")
             name = "#{unique}_#{sanitized_method_name}"
             name[0...225]
           end
@@ -87,6 +90,10 @@ module ActionDispatch
             "#{absolute_path}.png"
           end
 
+          def relative_image_path
+            "#{absolute_path.relative_path_from(Rails.root)}.png"
+          end
+
           def absolute_html_path
             "#{absolute_path}.html"
           end
@@ -109,11 +116,15 @@ module ActionDispatch
             output_type
           end
 
-          def display_image
+          def show(img)
+            puts img
+          end
+
+          def display_image(html:, screenshot_output:)
             message = +"[Screenshot Image]: #{image_path}\n"
-            message << +"[Screenshot HTML]: #{html_path}\n" if save_html?
+            message << +"[Screenshot HTML]: #{html_path}\n" if html
 
-            case output_type
+            case screenshot_output || output_type
             when "artifact"
               message << "\e]1338;url=artifact://#{absolute_image_path}\a\n"
             when "inline"

data/lib/action_dispatch/testing/assertion_response.rb

@@ -36,7 +36,7 @@ module ActionDispatch
 
     private
       def code_from_name(name)
-        GENERIC_RESPONSE_CODES[name] || Rack::Utils::SYMBOL_TO_STATUS_CODE[name]
+        GENERIC_RESPONSE_CODES[name] || Rack::Utils.status_code(name)
       end
 
       def name_from_code(code)

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

@@ -20,7 +20,7 @@ module ActionDispatch
       #
       # You can also pass an explicit status number like <tt>assert_response(501)</tt>
       # or its symbolic equivalent <tt>assert_response(:not_implemented)</tt>.
-      # See Rack::Utils::SYMBOL_TO_STATUS_CODE for a full list.
+      # See +Rack::Utils::SYMBOL_TO_STATUS_CODE+ for a full list.
       #
       #   # Asserts that the response was a redirection
       #   assert_response :redirect
@@ -30,7 +30,7 @@ module ActionDispatch
       def assert_response(type, message = nil)
         message ||= generate_response_message(type)
 
-        if RESPONSE_PREDICATES.keys.include?(type)
+        if RESPONSE_PREDICATES.key?(type)
           assert @response.public_send(RESPONSE_PREDICATES[type]), message
         else
           assert_equal AssertionResponse.new(type).code, @response.response_code, message
@@ -50,12 +50,19 @@ module ActionDispatch
       #
       #   # Asserts that the redirection matches the regular expression
       #   assert_redirected_to %r(\Ahttp://example.org)
-      def assert_redirected_to(options = {}, message = nil)
-        assert_response(:redirect, message)
-        return true if options === @response.location
+      #
+      #   # Asserts that the redirection has the HTTP status code 301 (Moved
+      #   # Permanently).
+      #   assert_redirected_to "/some/path", status: :moved_permanently
+      def assert_redirected_to(url_options = {}, options = {}, message = nil)
+        options, message = {}, options unless options.is_a?(Hash)
+
+        status = options[:status] || :redirect
+        assert_response(status, message)
+        return true if url_options === @response.location
 
         redirect_is       = normalize_argument_to_redirection(@response.location)
-        redirect_expected = normalize_argument_to_redirection(options)
+        redirect_expected = normalize_argument_to_redirection(url_options)
 
         message ||= "Expected response to be a redirect to <#{redirect_expected}> but was a redirect to <#{redirect_is}>"
         assert_operator redirect_expected, :===, redirect_is, message
@@ -93,7 +100,7 @@ module ActionDispatch
         end
 
         def code_with_name(code_or_name)
-          if RESPONSE_PREDICATES.values.include?("#{code_or_name}?".to_sym)
+          if RESPONSE_PREDICATES.value?("#{code_or_name}?".to_sym)
             code_or_name = RESPONSE_PREDICATES.invert["#{code_or_name}?".to_sym]
           end
 

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

@@ -9,6 +9,36 @@ module ActionDispatch
   module Assertions
     # Suite of assertions to test routes generated by \Rails and the handling of requests made to them.
     module RoutingAssertions
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # A helper to make it easier to test different route configurations.
+        # This method temporarily replaces @routes with a new RouteSet instance
+        # before each test.
+        #
+        # The new instance is yielded to the passed block. Typically the block
+        # will create some routes using <tt>set.draw { match ... }</tt>:
+        #
+        #   with_routing do |set|
+        #     set.draw do
+        #       resources :users
+        #     end
+        #   end
+        #
+        def with_routing(&block)
+          old_routes, old_controller = nil
+
+          setup do
+            old_routes, old_controller = @routes, @controller
+            create_routes(&block)
+          end
+
+          teardown do
+            reset_routes(old_routes, old_controller)
+          end
+        end
+      end
+
       def setup # :nodoc:
         @routes ||= nil
         super
@@ -83,7 +113,7 @@ 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 %r{://}.match?(expected_path)
+        if expected_path.include?("://")
           fail_on(URI::InvalidURIError, message) do
             uri = URI.parse(expected_path)
             expected_path = uri.path.to_s.empty? ? "/" : uri.path
@@ -150,33 +180,11 @@ module ActionDispatch
       #     assert_equal "/users", users_path
       #   end
       #
-      def with_routing
-        old_routes, @routes = @routes, ActionDispatch::Routing::RouteSet.new
-        if defined?(@controller) && @controller
-          old_controller, @controller = @controller, @controller.clone
-          _routes = @routes
-
-          @controller.singleton_class.include(_routes.url_helpers)
-
-          if @controller.respond_to? :view_context_class
-            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
+      def with_routing(&block)
+        old_routes, old_controller = @routes, @controller
+        create_routes(&block)
       ensure
-        @routes = old_routes
-        if defined?(@controller) && @controller
-          @controller = old_controller
-        end
+        reset_routes(old_routes, old_controller)
       end
 
       # ROUTES TODO: These assertions should really work in an integration context
@@ -190,6 +198,37 @@ module ActionDispatch
       ruby2_keywords(:method_missing)
 
       private
+        def create_routes
+          @routes = ActionDispatch::Routing::RouteSet.new
+          if defined?(@controller) && @controller
+            @controller = @controller.clone
+            _routes = @routes
+
+            @controller.singleton_class.include(_routes.url_helpers)
+
+            if @controller.respond_to? :view_context_class
+              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
+        end
+
+        def reset_routes(old_routes, old_controller)
+          @routes = old_routes
+          if defined?(@controller) && @controller
+            @controller = old_controller
+          end
+        end
+
         # Recognizes the route for a given path.
         def recognized_request_for(path, extras = {}, msg)
           if path.is_a?(Hash)
@@ -202,7 +241,7 @@ module ActionDispatch
           controller = @controller if defined?(@controller)
           request = ActionController::TestRequest.create controller&.class
 
-          if %r{://}.match?(path)
+          if path.include?("://")
             fail_on(URI::InvalidURIError, msg) do
               uri = URI.parse(path)
               request.env["rack.url_scheme"] = uri.scheme || "http"

data/lib/action_dispatch/testing/assertions.rb

@@ -6,6 +6,8 @@ require "action_dispatch/testing/assertions/routing"
 
 module ActionDispatch
   module Assertions
+    extend ActiveSupport::Concern
+
     include ResponseAssertions
     include RoutingAssertions
     include Rails::Dom::Testing::Assertions
@@ -14,7 +16,7 @@ module ActionDispatch
       @html_document ||= if @response.media_type&.end_with?("xml")
         Nokogiri::XML::Document.parse(@response.body)
       else
-        Nokogiri::HTML::Document.parse(@response.body)
+        Rails::Dom::Testing.html_document.parse(@response.body)
       end
     end
   end

data/lib/action_dispatch/testing/integration.rb

@@ -3,7 +3,7 @@
 require "stringio"
 require "uri"
 require "rack/test"
-require "minitest"
+require "active_support/test_case"
 
 require "action_dispatch/testing/request_encoder"
 
@@ -58,7 +58,9 @@ module ActionDispatch
       # 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)
+      #
+      # The HTTP_REFERER header will be set to the previous url.
+      def follow_redirect!(headers: {}, **args)
         raise "not a redirect! #{status} #{status_message}" unless redirect?
 
         method =
@@ -68,7 +70,11 @@ module ActionDispatch
             :get
           end
 
-        public_send(method, response.location, **args)
+        if [ :HTTP_REFERER, "HTTP_REFERER" ].none? { |key| headers.key? key }
+          headers["HTTP_REFERER"] = request.url
+        end
+
+        public_send(method, response.location, headers: headers, **args)
         status
       end
     end
@@ -78,9 +84,8 @@ module ActionDispatch
     # multiple sessions and run them side-by-side, you can also mimic (to some
     # limited extent) multiple simultaneous users interacting with your system.
     #
-    # Typically, you will instantiate a new session using
-    # IntegrationTest#open_session, rather than instantiating
-    # Integration::Session directly.
+    # Typically, you will instantiate a new session using Runner#open_session,
+    # rather than instantiating a \Session directly.
     class Session
       DEFAULT_HOST = "www.example.com"
 
@@ -122,7 +127,7 @@ module ActionDispatch
 
       include ActionDispatch::Routing::UrlFor
 
-      # Create and initialize a new Session instance.
+      # Create and initialize a new \Session instance.
       def initialize(app)
         super()
         @app = app
@@ -206,9 +211,10 @@ module ActionDispatch
       #   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
-      # request method that doesn't have a method defined in the integration tests.
+      # This method is rarely used directly. Use RequestHelpers#get,
+      # RequestHelpers#post, or other standard HTTP methods in integration
+      # tests. +#process+ is only required when using a request method that
+      # doesn't have a method defined in the integration tests.
       #
       # This method returns the response status, after performing the request.
       # Furthermore, if this method was called from an ActionDispatch::IntegrationTest object,
@@ -226,7 +232,7 @@ module ActionDispatch
           method = :post
         end
 
-        if %r{://}.match?(path)
+        if path.include?("://")
           path = build_expanded_path(path) do |location|
             https! URI::HTTPS === location if location.scheme
 
@@ -252,10 +258,13 @@ module ActionDispatch
           "REQUEST_URI"    => path,
           "HTTP_HOST"      => host,
           "REMOTE_ADDR"    => remote_addr,
-          "CONTENT_TYPE"   => request_encoder.content_type,
           "HTTP_ACCEPT"    => request_encoder.accept_header || accept
         }
 
+        if request_encoder.content_type
+          request_env["CONTENT_TYPE"] = request_encoder.content_type
+        end
+
         wrapped_headers = Http::Headers.from_hash({})
         wrapped_headers.merge!(headers) if headers
 
@@ -440,8 +449,9 @@ module ActionDispatch
   # more completely than either unit or functional tests do, exercising the
   # entire stack, from the dispatcher to the database.
   #
-  # At its simplest, you simply extend <tt>IntegrationTest</tt> and write your tests
-  # using the get/post methods:
+  # At its simplest, you simply extend <tt>IntegrationTest</tt> and write your
+  # tests using the Integration::RequestHelpers#get and/or
+  # Integration::RequestHelpers#post methods:
   #
   #   require "test_helper"
   #
@@ -612,7 +622,7 @@ module ActionDispatch
   # the request format to JSON unless overridden), sets the content type to
   # "application/json" and encodes the parameters as JSON.
   #
-  # Calling +parsed_body+ on the response parses the response body based on the
+  # Calling TestResponse#parsed_body on the response parses the response body based on the
   # last response MIME type.
   #
   # Out of the box, only <tt>:json</tt> is supported. But for any custom MIME
@@ -624,9 +634,9 @@ module ActionDispatch
   #
   # Where +param_encoder+ defines how the params should be encoded and
   # +response_parser+ defines how the response body should be parsed through
-  # +parsed_body+.
+  # TestResponse#parsed_body.
   #
-  # Consult the Rails Testing Guide for more.
+  # Consult the {Rails Testing Guide}[https://guides.rubyonrails.org/testing.html] for more.
 
   class IntegrationTest < ActiveSupport::TestCase
     include TestProcess::FixtureFile

data/lib/action_dispatch/testing/request_encoder.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "nokogiri"
+
 module ActionDispatch
   class RequestEncoder # :nodoc:
     class IdentityEncoder
@@ -50,6 +52,7 @@ module ActionDispatch
       @encoders[mime_name] = new(mime_name, param_encoder, response_parser)
     end
 
-    register_encoder :json, response_parser: -> body { JSON.parse(body) }
+    register_encoder :html, response_parser: -> body { Rails::Dom::Testing.html_document.parse(body) }
+    register_encoder :json, response_parser: -> body { JSON.parse(body, object_class: ActiveSupport::HashWithIndifferentAccess) }
   end
 end

data/lib/action_dispatch/testing/test_process.rb

@@ -8,21 +8,22 @@ module ActionDispatch
     module FixtureFile
       # Shortcut for <tt>Rack::Test::UploadedFile.new(File.join(ActionDispatch::IntegrationTest.file_fixture_path, path), type)</tt>:
       #
-      #   post :change_avatar, params: { avatar: fixture_file_upload('david.png', 'image/png') }
+      #   post :change_avatar, params: { avatar: file_fixture_upload('david.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, params: { avatar: fixture_file_upload('david.png', 'image/png', :binary) }
-      def fixture_file_upload(path, mime_type = nil, binary = false)
+      #   post :change_avatar, params: { avatar: file_fixture_upload('david.png', 'image/png', :binary) }
+      def file_fixture_upload(path, mime_type = nil, binary = false)
         if self.class.file_fixture_path && !File.exist?(path)
           path = file_fixture(path)
         end
 
         Rack::Test::UploadedFile.new(path, mime_type, binary)
       end
+      alias_method :fixture_file_upload, :file_fixture_upload
     end
 
     include FixtureFile

data/lib/action_dispatch/testing/test_request.rb

@@ -32,7 +32,7 @@ module ActionDispatch
     end
 
     def port=(number)
-      set_header("SERVER_PORT", number.to_i)
+      set_header("SERVER_PORT", number)
     end
 
     def request_uri=(uri)