actionpack 7.1.3.2 → 7.2.0.beta1

data/lib/action_dispatch/system_testing/browser.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module SystemTesting
     class Browser # :nodoc:
@@ -35,8 +37,8 @@ module ActionDispatch
         yield options if block_given?
       end
 
-      # driver_path is lazily initialized by default. Eagerly set it to
-      # 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
@@ -70,7 +72,12 @@ module ActionDispatch
         end
 
         def resolve_driver_path(namespace)
-          namespace::Service.driver_path = ::Selenium::WebDriver::DriverFinder.path(options, namespace::Service)
+          # 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

data/lib/action_dispatch/system_testing/driver.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module SystemTesting
     class Driver # :nodoc:
@@ -16,7 +18,7 @@ module ActionDispatch
           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

data/lib/action_dispatch/system_testing/server.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module SystemTesting
     class Server # :nodoc:

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module SystemTesting
     module TestHelpers
@@ -7,27 +9,35 @@ module ActionDispatch
       module ScreenshotHelper
         # Takes a screenshot of the current page in the browser.
         #
-        # +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. 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)
+        # `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. 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 default screenshots directory is `tmp/screenshots` but you can set a
+        # different one with `Capybara.save_path`
+        #
+        # 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 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).
         #
-        # The default screenshots directory is +tmp/screenshots+ but you can set a different
-        # one with +Capybara.save_path+
+        #     `artifact`
+        # :       Display the screenshot in the terminal, using the terminal artifact
+        #         format (https://buildkite.github.io/terminal-to-html/inline-images/).
         #
-        # 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 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(html: false, screenshot: nil)
           showing_html = html || html_from_env?
 
@@ -37,10 +47,9 @@ module ActionDispatch
           show display_image(html: showing_html, screenshot_output: screenshot)
         end
 
-        # Takes a screenshot of the current page in the browser if the test
-        # failed.
+        # Takes a screenshot of the current page in the browser if the test failed.
         #
-        # +take_failed_screenshot+ is called during system test teardown.
+        # `take_failed_screenshot` is called during system test teardown.
         def take_failed_screenshot
           return unless failed? && supports_screenshot? && Capybara::Session.instance_created?
 
@@ -98,6 +107,7 @@ module ActionDispatch
             "#{absolute_path}.html"
           end
 
+          # rubocop:disable Lint/Debugger
           def save_html
             page.save_page(absolute_html_path)
           end
@@ -105,6 +115,7 @@ module ActionDispatch
           def save_image
             page.save_screenshot(absolute_image_path)
           end
+          # rubocop:enable Lint/Debugger
 
           def output_type
             # Environment variables have priority

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module SystemTesting
     module TestHelpers

data/lib/action_dispatch/testing/assertion_response.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
-  # This is a class that abstracts away an asserted response. It purposely
-  # does not inherit from Response because it doesn't need it. That means it
-  # does not have headers or a body.
+  # This is a class that abstracts away an asserted response. It purposely does
+  # not inherit from Response because it doesn't need it. That means it does not
+  # have headers or a body.
   class AssertionResponse
     attr_reader :code, :name
 
@@ -14,9 +16,9 @@ module ActionDispatch
       error: "5XX"
     }
 
-    # Accepts a specific response status code as an Integer (404) or String
-    # ('404') or a response status range as a Symbol pseudo-code (:success,
-    # indicating any 200-299 status code).
+    # Accepts a specific response status code as an Integer (404) or String ('404')
+    # or a response status range as a Symbol pseudo-code (:success, indicating any
+    # 200-299 status code).
     def initialize(code_or_name)
       if code_or_name.is_a?(Symbol)
         @name = code_or_name

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

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 module ActionDispatch
   module Assertions
-    # A small suite of assertions that test responses from \Rails applications.
+    # A small suite of assertions that test responses from Rails applications.
     module ResponseAssertions
       RESPONSE_PREDICATES = { # :nodoc:
         success:  :successful?,
@@ -13,20 +15,21 @@ module ActionDispatch
 
       # Asserts that the response is one of the following types:
       #
-      # * <tt>:success</tt>   - Status code was in the 200-299 range
-      # * <tt>:redirect</tt>  - Status code was in the 300-399 range
-      # * <tt>:missing</tt>   - Status code was 404
-      # * <tt>:error</tt>     - Status code was in the 500-599 range
+      # *   `:success`   - Status code was in the 200-299 range
+      # *   `:redirect`  - Status code was in the 300-399 range
+      # *   `:missing`   - Status code was 404
+      # *   `:error`     - Status code was in the 500-599 range
+      #
       #
-      # 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.
+      # You can also pass an explicit status number like `assert_response(501)` or its
+      # symbolic equivalent `assert_response(:not_implemented)`. See
+      # `Rack::Utils::SYMBOL_TO_STATUS_CODE` for a full list.
       #
-      #   # Asserts that the response was a redirection
-      #   assert_response :redirect
+      #     # Asserts that the response was a redirection
+      #     assert_response :redirect
       #
-      #   # Asserts that the response code was status code 401 (unauthorized)
-      #   assert_response 401
+      #     # Asserts that the response code was status code 401 (unauthorized)
+      #     assert_response 401
       def assert_response(type, message = nil)
         message ||= generate_response_message(type)
 
@@ -39,21 +42,21 @@ module ActionDispatch
 
       # 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"
+      #     # Asserts that the redirection was to the "index" action on the WeblogController
+      #     assert_redirected_to controller: "weblog", action: "index"
       #
-      #   # Asserts that the redirection was to the named route login_url
-      #   assert_redirected_to login_url
+      #     # Asserts that the redirection was to the named route login_url
+      #     assert_redirected_to login_url
       #
-      #   # Asserts that the redirection was to the URL for @customer
-      #   assert_redirected_to @customer
+      #     # Asserts that the redirection was to the URL for @customer
+      #     assert_redirected_to @customer
       #
-      #   # Asserts that the redirection matches the regular expression
-      #   assert_redirected_to %r(\Ahttp://example.org)
+      #     # Asserts that the redirection matches the regular expression
+      #     assert_redirected_to %r(\Ahttp://example.org)
       #
-      #   # Asserts that the redirection has the HTTP status code 301 (Moved
-      #   # Permanently).
-      #   assert_redirected_to "/some/path", status: :moved_permanently
+      #     # 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)
 

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "uri"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/string/access"
@@ -7,23 +9,82 @@ require "action_controller/metal/exceptions"
 
 module ActionDispatch
   module Assertions
-    # Suite of assertions to test routes generated by \Rails and the handling of requests made to them.
+    # Suite of assertions to test routes generated by Rails and the handling of
+    # requests made to them.
     module RoutingAssertions
       extend ActiveSupport::Concern
 
+      module WithIntegrationRouting # :nodoc:
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def with_routing(&block)
+            old_routes = nil
+            old_integration_session = nil
+
+            setup do
+              old_routes = app.routes
+              old_integration_session = integration_session
+              create_routes(&block)
+            end
+
+            teardown do
+              reset_routes(old_routes, old_integration_session)
+            end
+          end
+        end
+
+        def with_routing(&block)
+          old_routes = app.routes
+          old_integration_session = integration_session
+          create_routes(&block)
+        ensure
+          reset_routes(old_routes, old_integration_session)
+        end
+
+        private
+          def create_routes
+            app = self.app
+            routes = ActionDispatch::Routing::RouteSet.new
+            rack_app = app.config.middleware.build(routes)
+            https = integration_session.https?
+            host = integration_session.host
+
+            app.instance_variable_set(:@routes, routes)
+            app.instance_variable_set(:@app, rack_app)
+            @integration_session = Class.new(ActionDispatch::Integration::Session) do
+              include app.routes.url_helpers
+              include app.routes.mounted_helpers
+            end.new(app)
+            @integration_session.https! https
+            @integration_session.host! host
+            @routes = routes
+
+            yield routes
+          end
+
+          def reset_routes(old_routes, old_integration_session)
+            old_rack_app = app.config.middleware.build(old_routes)
+
+            app.instance_variable_set(:@routes, old_routes)
+            app.instance_variable_set(:@app, old_rack_app)
+            @integration_session = old_integration_session
+            @routes = old_routes
+          end
+      end
+
       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.
+        # 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>:
+        # The new instance is yielded to the passed block. Typically the block will
+        # create some routes using `set.draw { match ... }`:
         #
-        #   with_routing do |set|
-        #     set.draw do
-        #       resources :users
+        #     with_routing do |set|
+        #       set.draw do
+        #         resources :users
+        #       end
         #     end
-        #   end
         #
         def with_routing(&block)
           old_routes, old_controller = nil
@@ -44,36 +105,62 @@ module ActionDispatch
         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+.
+      # A helper to make it easier to test different route configurations. This method
+      # temporarily replaces @routes with a new RouteSet instance.
+      #
+      # The new instance is yielded to the passed block. Typically the block will
+      # create some routes using `set.draw { match ... }`:
+      #
+      #     with_routing do |set|
+      #       set.draw do
+      #         resources :users
+      #       end
+      #       assert_equal "/users", users_path
+      #     end
+      #
+      def with_routing(&block)
+        old_routes, old_controller = @routes, @controller
+        create_routes(&block)
+      ensure
+        reset_routes(old_routes, old_controller)
+      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`.
       #
-      # Pass a hash in the second argument (+path+) to specify the request method. This is useful for routes
-      # requiring a specific HTTP method. The hash should contain a +:path+ with the incoming request path
-      # and a +:method+ containing the required HTTP verb.
+      # Pass a hash in the second argument (`path`) to specify the request method.
+      # This is useful for routes requiring a specific HTTP method. The hash should
+      # contain a `:path` with the incoming request path and a `:method` containing
+      # the required HTTP verb.
       #
-      #   # Asserts that POSTing to /items will call the create action on ItemsController
-      #   assert_recognizes({controller: 'items', action: 'create'}, {path: 'items', method: :post})
+      #     # Asserts that POSTing to /items will call the create action on ItemsController
+      #     assert_recognizes({controller: 'items', action: 'create'}, {path: 'items', method: :post})
       #
-      # You can also pass in +extras+ with a hash containing URL parameters that would normally be in the query string. This can be used
-      # to assert that values in the query string will end up in the params hash correctly. To test query strings you must use the extras
-      # argument because appending the query string on the path directly will not work. For example:
+      # You can also pass in `extras` with a hash containing URL parameters that would
+      # normally be in the query string. This can be used to assert that values in the
+      # query string will end up in the params hash correctly. To test query strings
+      # you must use the extras argument because appending the query string on the
+      # path directly will not work. For example:
       #
-      #   # Asserts that a path of '/items/list/1?view=print' returns the correct options
-      #   assert_recognizes({controller: 'items', action: 'list', id: '1', view: 'print'}, 'items/list/1', { view: "print" })
+      #     # Asserts that a path of '/items/list/1?view=print' returns the correct options
+      #     assert_recognizes({controller: 'items', action: 'list', id: '1', view: 'print'}, 'items/list/1', { view: "print" })
       #
-      # The +message+ parameter allows you to pass in an error message that is displayed upon failure.
+      # The `message` parameter allows you to pass in an error message that is
+      # displayed upon failure.
       #
-      #   # Check the default route (i.e., the index action)
-      #   assert_recognizes({controller: 'items', action: 'index'}, 'items')
+      #     # Check the default route (i.e., the index action)
+      #     assert_recognizes({controller: 'items', action: 'index'}, 'items')
       #
-      #   # Test a specific action
-      #   assert_recognizes({controller: 'items', action: 'list'}, 'items/list')
+      #     # Test a specific action
+      #     assert_recognizes({controller: 'items', action: 'list'}, 'items/list')
       #
-      #   # Test an action with a parameter
-      #   assert_recognizes({controller: 'items', action: 'destroy', id: '1'}, 'items/destroy/1')
+      #     # Test an action with a parameter
+      #     assert_recognizes({controller: 'items', action: 'destroy', id: '1'}, 'items/destroy/1')
       #
-      #   # Test a custom route
-      #   assert_recognizes({controller: 'items', action: 'show', id: '1'}, 'view/item1')
+      #     # Test a custom route
+      #     assert_recognizes({controller: 'items', action: 'show', id: '1'}, 'view/item1')
       def assert_recognizes(expected_options, path, extras = {}, msg = nil)
         if path.is_a?(Hash) && path[:method].to_s == "all"
           [:get, :post, :put, :delete].each do |method|
@@ -95,23 +182,25 @@ module ActionDispatch
         end
       end
 
-      # Asserts that the provided options can be used to generate the provided path. This is the inverse of +assert_recognizes+.
-      # The +extras+ parameter is used to tell the request the names and values of additional request parameters that would be in
-      # a query string. The +message+ parameter allows you to specify a custom error message for assertion failures.
+      # Asserts that the provided options can be used to generate the provided path.
+      # This is the inverse of `assert_recognizes`. The `extras` parameter is used to
+      # tell the request the names and values of additional request parameters that
+      # would be in a query string. The `message` parameter allows you to specify a
+      # custom error message for assertion failures.
       #
-      # The +defaults+ parameter is unused.
+      # The `defaults` parameter is unused.
       #
-      #   # Asserts that the default action is generated for a route with no action
-      #   assert_generates "/items", controller: "items", action: "index"
+      #     # Asserts that the default action is generated for a route with no action
+      #     assert_generates "/items", controller: "items", action: "index"
       #
-      #   # Tests that the list action is properly routed
-      #   assert_generates "/items/list", controller: "items", action: "list"
+      #     # Tests that the list action is properly routed
+      #     assert_generates "/items/list", controller: "items", action: "list"
       #
-      #   # Tests the generation of a route with a parameter
-      #   assert_generates "/items/list/1", { controller: "items", action: "list", id: "1" }
+      #     # Tests the generation of a route with a parameter
+      #     assert_generates "/items/list/1", { controller: "items", action: "list", id: "1" }
       #
-      #   # Asserts that the generated route gives us our custom route
-      #   assert_generates "changesets/12", { controller: 'scm', action: 'show_diff', revision: "12" }
+      #     # 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.include?("://")
           fail_on(URI::InvalidURIError, message) do
@@ -134,27 +223,28 @@ module ActionDispatch
         assert_equal(expected_path, generated_path, msg)
       end
 
-      # Asserts that path and options match both ways; in other words, it verifies that <tt>path</tt> generates
-      # <tt>options</tt> and then that <tt>options</tt> generates <tt>path</tt>. This essentially combines +assert_recognizes+
-      # and +assert_generates+ into one step.
+      # Asserts that path and options match both ways; in other words, it verifies
+      # that `path` generates `options` and then that `options` generates `path`. This
+      # essentially combines `assert_recognizes` and `assert_generates` into one step.
       #
-      # The +extras+ hash allows you to specify options that would normally be provided as a query string to the action. The
-      # +message+ parameter allows you to specify a custom error message to display upon failure.
+      # The `extras` hash allows you to specify options that would normally be
+      # provided as a query string to the action. The `message` parameter allows you
+      # to specify a custom error message to display upon failure.
       #
-      #  # Asserts a basic route: a controller with the default action (index)
-      #  assert_routing '/home', controller: 'home', action: 'index'
+      #     # Asserts a basic route: a controller with the default action (index)
+      #     assert_routing '/home', controller: 'home', action: 'index'
       #
-      #  # Test a route generated with a specific controller, action, and parameter (id)
-      #  assert_routing '/entries/show/23', controller: 'entries', action: 'show', id: 23
+      #     # Test a route generated with a specific controller, action, and parameter (id)
+      #     assert_routing '/entries/show/23', controller: 'entries', action: 'show', id: 23
       #
-      #  # Asserts a basic route (controller + default action), with an error message if it fails
-      #  assert_routing '/store', { controller: 'store', action: 'index' }, {}, {}, 'Route for store index not generated properly'
+      #     # Asserts a basic route (controller + default action), with an error message if it fails
+      #     assert_routing '/store', { controller: 'store', action: 'index' }, {}, {}, 'Route for store index not generated properly'
       #
-      #  # Tests a route, providing a defaults hash
-      #  assert_routing 'controller/action/9', {id: "9", item: "square"}, {controller: "controller", action: "action"}, {}, {item: "square"}
+      #     # Tests a route, providing a defaults hash
+      #     assert_routing 'controller/action/9', {id: "9", item: "square"}, {controller: "controller", action: "action"}, {}, {item: "square"}
       #
-      #  # Tests a route with an HTTP method
-      #  assert_routing({ method: 'put', path: '/product/321' }, { controller: "product", action: "update", id: "321" })
+      #     # Tests a route with an HTTP method
+      #     assert_routing({ method: 'put', path: '/product/321' }, { controller: "product", action: "update", id: "321" })
       def assert_routing(path, options, defaults = {}, extras = {}, message = nil)
         assert_recognizes(options, path, extras, message)
 
@@ -167,40 +257,19 @@ module ActionDispatch
         assert_generates(path.is_a?(Hash) ? path[:path] : path, generate_options, defaults, extras, message)
       end
 
-      # A helper to make it easier to test different route configurations.
-      # This method temporarily replaces @routes with a new RouteSet instance.
-      #
-      # 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
-      #     assert_equal "/users", users_path
-      #   end
-      #
-      def with_routing(&block)
-        old_routes, old_controller = @routes, @controller
-        create_routes(&block)
-      ensure
-        reset_routes(old_routes, old_controller)
-      end
-
       # 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.public_send(selector, *args, &block)
+      def method_missing(selector, ...)
+        if @controller && @routes&.named_routes&.route_defined?(selector)
+          @controller.public_send(selector, ...)
         else
           super
         end
       end
-      ruby2_keywords(:method_missing)
 
       private
         def create_routes
           @routes = ActionDispatch::Routing::RouteSet.new
-          if defined?(@controller) && @controller
+          if @controller
             @controller = @controller.clone
             _routes = @routes
 
@@ -224,7 +293,7 @@ module ActionDispatch
 
         def reset_routes(old_routes, old_controller)
           @routes = old_routes
-          if defined?(@controller) && @controller
+          if @controller
             @controller = old_controller
           end
         end

data/lib/action_dispatch/testing/assertions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "rails-dom-testing"
 require "action_dispatch/testing/assertions/response"
 require "action_dispatch/testing/assertions/routing"