Merge pull request rails#55351 from byroot/test-no-generic-route

Refactor railties tests to not rely on generic route

Author: byroot

railties/test/application/configuration_test.rb

@@ -4090,7 +4090,6 @@ class Post < ActiveRecord::Base
       output = rails("routes", "-g", "active_storage")
       assert_equal <<~MESSAGE, output
                                Prefix Verb URI Pattern                                                                        Controller#Action
-                                           /:controller(/:action(/:id))(.:format)                                             :controller#:action
                    rails_service_blob GET  /files/blobs/redirect/:signed_id/*filename(.:format)                               active_storage/blobs/redirect#show
              rails_service_blob_proxy GET  /files/blobs/proxy/:signed_id/*filename(.:format)                                  active_storage/blobs/proxy#show
                                       GET  /files/blobs/:signed_id/*filename(.:format)                                        active_storage/blobs/redirect#show

railties/test/application/middleware/exceptions_test.rb

@@ -17,7 +17,10 @@ def teardown
     end
 
     test "show exceptions middleware filter backtrace before logging" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
             raise 'oops'
@@ -35,7 +38,10 @@ def index
     end
 
     test "renders active record exceptions as 404" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
             raise ActiveRecord::RecordNotFound
@@ -53,10 +59,7 @@ def index
     end
 
     test "renders unknown http methods as 405 when routes are used as the custom exceptions app" do
-      app_file "config/routes.rb", <<-RUBY
-        Rails.application.routes.draw do
-        end
-      RUBY
+      routes ""
 
       add_to_config "config.exceptions_app = self.routes"
 
@@ -67,7 +70,7 @@ def index
     end
 
     test "renders unknown http formats as 406 when routes are used as the custom exceptions app" do
-      controller :foo, <<-RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
             render plain: "rendering index!"
@@ -79,12 +82,10 @@ def not_acceptable
         end
       RUBY
 
-      app_file "config/routes.rb", <<-RUBY
-        Rails.application.routes.draw do
-          get "/foo", to: "foo#index"
-          post "/foo", to: "foo#index"
-          match "/406", to: "foo#not_acceptable", via: :all
-        end
+      routes <<~'RUBY'
+        get "/foo", to: "foo#index"
+        post "/foo", to: "foo#index"
+        match "/406", to: "foo#not_acceptable", via: :all
       RUBY
 
       add_to_config "config.exceptions_app = self.routes"
@@ -109,7 +110,7 @@ def not_acceptable
     end
 
     test "uses custom exceptions app" do
-      add_to_config <<-RUBY
+      add_to_config <<~'RUBY'
         config.exceptions_app = lambda do |env|
           [404, { "Content-Type" => "text/plain" }, ["YOU FAILED"]]
         end
@@ -123,7 +124,10 @@ def not_acceptable
     end
 
     test "URL generation error when action_dispatch.show_exceptions is set raises an exception" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
             raise ActionController::UrlGenerationError
@@ -141,7 +145,7 @@ def index
       app.config.action_dispatch.show_exceptions = :none
 
       assert_raise(ActionController::RoutingError) do
-        get("/foo", {}, "HTTPS" => "on")
+        get("/does-not-exist", {}, "HTTPS" => "on")
       end
     end
 
@@ -165,10 +169,8 @@ def index
     end
 
     test "routing to a nonexistent controller when action_dispatch.show_exceptions and consider_all_requests_local are set shows diagnostics" do
-      app_file "config/routes.rb", <<-RUBY
-        Rails.application.routes.draw do
-          resources :articles
-        end
+      routes <<~'RUBY'
+        resources :articles
       RUBY
 
       app.config.action_dispatch.show_exceptions = :all
@@ -179,7 +181,10 @@ def index
     end
 
     test "displays diagnostics message when exception raised in template that contains UTF-8" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
           end
@@ -200,7 +205,11 @@ def index
     end
 
     test "displays diagnostics message when malformed query parameters are provided" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
           end
@@ -216,7 +225,10 @@ def index
     end
 
     test "displays diagnostics message when too deep query parameters are provided" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
           end
@@ -235,7 +247,10 @@ def index
     end
 
     test "displays statement invalid template correctly" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
             raise ActiveRecord::StatementInvalid
@@ -258,7 +273,10 @@ def index
     end
 
     test "show_exceptions :rescuable with a rescuable error" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
             raise AbstractController::ActionNotFound
@@ -273,7 +291,10 @@ def index
     end
 
     test "show_exceptions :rescuable with a non-rescuable error" do
-      controller :foo, <<-RUBY
+      routes <<~'RUBY'
+        get "/foo" => "foo#index"
+      RUBY
+      controller :foo, <<~'RUBY'
         class FooController < ActionController::Base
           def index
             raise 'oops'

railties/test/application/test_test.rb

@@ -66,6 +66,9 @@ def test_truth
     end
 
     test "integration test" do
+      routes <<~'RUBY'
+        get "/posts" => "posts#index"
+      RUBY
       controller "posts", <<-RUBY
         class PostsController < ActionController::Base
         end

railties/test/isolation/abstract_unit.rb

@@ -121,13 +121,6 @@ def build_app(options = {})
         end
       end
 
-      routes = File.read("#{app_path}/config/routes.rb")
-      if routes =~ /(\n\s*end\s*)\z/
-        File.open("#{app_path}/config/routes.rb", "w") do |f|
-          f.puts $` + "\nActionDispatch.deprecator.silence { match ':controller(/:action(/:id))(.:format)', via: :all }\n" + $1
-        end
-      end
-
       File.open("#{app_path}/config/database.yml", "w") do |f|
         if options[:multi_db]
           f.puts multi_db_database_configs
@@ -483,6 +476,14 @@ def controller(name, contents)
       app_file("app/controllers/#{name}_controller.rb", contents)
     end
 
+    def routes(routes)
+      app_file("config/routes.rb", <<~RUBY)
+        Rails.application.routes.draw do
+          #{routes}
+        end
+      RUBY
+    end
+
     def use_frameworks(arr)
       to_remove = [:actionmailer, :activerecord, :activestorage, :activejob, :actionmailbox] - arr
 

railties/test/railties/engine_test.rb

@@ -12,6 +12,10 @@ class EngineTest < ActiveSupport::TestCase
     def setup
       build_app({ multi_db: true })
 
+      routes <<~'RUBY'
+        mount Bukkits::Engine, at: "/"
+      RUBY
+
       @plugin = engine "bukkits" do |plugin|
         plugin.write "lib/bukkits.rb", <<-RUBY
           module Bukkits
@@ -326,7 +330,7 @@ class AddFirstNameToUsers < ActiveRecord::Migration::Current
     test "can draw routes in app routes from engines" do
       @plugin.write "config/routes/testing.rb", <<~RUBY
         Rails.application.routes.draw do
-          get "/testing", to: "test#action", as: :testing
+          get "/testing", to: "testing#index", as: :testing
         end
       RUBY
 
@@ -808,13 +812,18 @@ class Engine < ::Rails::Engine
         end
       RUBY
 
+      routes <<~'RUBY'
+        mount Bukkits::Engine, at: "/engine"
+        get "/other" => "other#index"
+      RUBY
+
       boot_rails
 
-      env = Rack::MockRequest.env_for("/")
+      env = Rack::MockRequest.env_for("/engine")
       Bukkits::Engine.call(env)
       assert_equal Bukkits::Engine.routes, env["action_dispatch.routes"]
 
-      env = Rack::MockRequest.env_for("/")
+      env = Rack::MockRequest.env_for("/other")
       Rails.application.call(env)
       assert_equal Rails.application.routes, env["action_dispatch.routes"]
     end