actionpack 7.1.5.1 → 8.1.2

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

@@ -1,29 +1,102 @@
 # frozen_string_literal: true
 
+# :markup: markdown
+
 require "uri"
 require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/string/access"
+require "active_support/core_ext/module/redefine_method"
 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_routes_call_method = nil
+            old_integration_session = nil
+
+            setup do
+              old_routes = initialize_lazy_routes(app.routes)
+              old_routes_call_method = old_routes.method(:call)
+              old_integration_session = integration_session
+              create_routes(&block)
+            end
+
+            teardown do
+              reset_routes(old_routes, old_routes_call_method, old_integration_session)
+            end
+          end
+        end
+
+        def with_routing(&block)
+          old_routes = initialize_lazy_routes(app.routes)
+          old_routes_call_method = old_routes.method(:call)
+          old_integration_session = integration_session
+          create_routes(&block)
+        ensure
+          reset_routes(old_routes, old_routes_call_method, old_integration_session)
+        end
+
+        private
+          def initialize_lazy_routes(routes)
+            if defined?(Rails::Engine::LazyRouteSet) && routes.is_a?(Rails::Engine::LazyRouteSet)
+              routes.tap(&:routes)
+            else
+              routes
+            end
+          end
+
+          def create_routes
+            app = self.app
+            routes = ActionDispatch::Routing::RouteSet.new
+
+            @original_routes ||= app.routes
+            @original_routes.singleton_class.redefine_method(:call, &routes.method(:call))
+
+            https = integration_session.https?
+            host = integration_session.host
+
+            app.instance_variable_set(:@routes, routes)
+            @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_routes_call_method, old_integration_session)
+            app.instance_variable_set(:@routes, old_routes)
+            @original_routes.singleton_class.redefine_method(:call, &old_routes_call_method)
+            @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 +117,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
       #
-      # 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.
+      def with_routing(config = nil, &block)
+        old_routes, old_controller = @routes, @controller
+        create_routes(config, &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`.
       #
-      #   # Asserts that POSTing to /items will call the create action on ItemsController
-      #   assert_recognizes({controller: 'items', action: 'create'}, {path: 'items', method: :post})
+      # 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.
       #
-      # 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 POSTing to /items will call the create action on ItemsController
+      #     assert_recognizes({controller: 'items', action: 'create'}, {path: 'items', method: :post})
       #
-      #   # 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" })
+      # 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:
       #
-      # The +message+ parameter allows you to pass in an error message that is displayed upon failure.
+      #     # 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" })
       #
-      #   # Check the default route (i.e., the index action)
-      #   assert_recognizes({controller: 'items', action: 'index'}, 'items')
+      # The `message` parameter allows you to pass in an error message that is
+      # displayed upon failure.
       #
-      #   # Test a specific action
-      #   assert_recognizes({controller: 'items', action: 'list'}, 'items/list')
+      #     # Check the default route (i.e., the index action)
+      #     assert_recognizes({controller: 'items', action: 'index'}, 'items')
       #
-      #   # Test an action with a parameter
-      #   assert_recognizes({controller: 'items', action: 'destroy', id: '1'}, 'items/destroy/1')
+      #     # Test a specific action
+      #     assert_recognizes({controller: 'items', action: 'list'}, 'items/list')
       #
-      #   # Test a custom route
-      #   assert_recognizes({controller: 'items', action: 'show', id: '1'}, 'view/item1')
+      #     # 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')
       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 +194,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 +235,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 +269,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
+        def create_routes(config = nil)
+          @routes = ActionDispatch::Routing::RouteSet.new(config || ActionDispatch::Routing::RouteSet::DEFAULT_CONFIG)
+          if @controller
             @controller = @controller.clone
             _routes = @routes
 
@@ -224,7 +305,7 @@ module ActionDispatch
 
         def reset_routes(old_routes, old_controller)
           @routes = old_routes
-          if defined?(@controller) && @controller
+          if @controller
             @controller = old_controller
           end
         end
@@ -267,7 +348,7 @@ module ActionDispatch
         def fail_on(exception_class, message)
           yield
         rescue exception_class => e
-          raise Minitest::Assertion, message || e.message
+          flunk(message || e.message)
         end
     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"