diff --git a/activesupport/lib/active_support/actionable_error.rb b/activesupport/lib/active_support/actionable_error.rb index 8c05e563745a3..f3045fc6c76d0 100644 --- a/activesupport/lib/active_support/actionable_error.rb +++ b/activesupport/lib/active_support/actionable_error.rb @@ -18,7 +18,7 @@ class NonActionable < StandardError; end end def self.actions(error) # :nodoc: - case error + case when ActionableError, -> it { Class === it && it < ActionableError } error._actions else diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md index df5392242a233..6b681a97bb778 100644 --- a/railties/CHANGELOG.md +++ b/railties/CHANGELOG.md @@ -1,3 +1,32 @@ +* Allow Actionable Errors encountered when running tests to be retried. This can be configured by + `config.actionable_command_line_errors` and is `true` in the test environment unless the `"CI"` env variable + is set, and false otherwise. + + ```txt + Migrations are pending. To resolve this issue, run: + + bin/rails db:migrate + + You have 1 pending migration: + + db/migrate/20240201213806_add_a_to_b.rb + Run pending migrations? [Yn] Y + == 20240201213806 AddAToB: migrating ========================================= + == 20240201213806 AddAToB: migrated (0.0000s) ================================ + + Running 7 tests in a single process (parallelization threshold is 50) + Run options: --seed 22200 + + # Running: + + ....... + + Finished in 0.243394s, 28.7600 runs/s, 45.1942 assertions/s. + 7 runs, 11 assertions, 0 failures, 0 errors, 0 skips + ``` + + *Andrew Novoselac & Gannon McGibbon* + * Commented out lines in .railsrc file should not be treated as arguments when using rails new generator command. Update ARGVScrubber to ignore text after # symbols. diff --git a/railties/lib/rails/application/configuration.rb b/railties/lib/rails/application/configuration.rb index edcbabccf3f49..9ff0ef003e2df 100644 --- a/railties/lib/rails/application/configuration.rb +++ b/railties/lib/rails/application/configuration.rb @@ -23,7 +23,7 @@ class Configuration < ::Rails::Engine::Configuration :content_security_policy_nonce_generator, :content_security_policy_nonce_directives, :require_master_key, :credentials, :disable_sandbox, :sandbox_by_default, :add_autoload_paths_to_load_path, :rake_eager_load, :server_timing, :log_file_size, - :dom_testing_default_html_version + :dom_testing_default_html_version, :actionable_command_line_errors attr_reader :encoding, :api_only, :loaded_config_version, :log_level diff --git a/railties/lib/rails/command/base.rb b/railties/lib/rails/command/base.rb index ee6e04998733e..d8dc424532916 100644 --- a/railties/lib/rails/command/base.rb +++ b/railties/lib/rails/command/base.rb @@ -179,6 +179,22 @@ def invoke_command(command, *) # :nodoc: ensure @current_subcommand = original_subcommand end + + protected + def with_actionable_errors_retried(&block) + block.call + rescue ActiveSupport::ActionableError => e + puts e.to_s.strip + exit 1 unless Rails.application.config.actionable_command_line_errors + + ActiveSupport::ActionableError.actions(e).each_key do |action_name| + if yes? "#{action_name}? [Yn]" + ActiveSupport::ActionableError.dispatch(e, action_name) + return with_actionable_errors_retried(&block) + end + end + exit 1 + end end end end diff --git a/railties/lib/rails/commands/test/test_command.rb b/railties/lib/rails/commands/test/test_command.rb index 505026556b463..784286ef2bef7 100644 --- a/railties/lib/rails/commands/test/test_command.rb +++ b/railties/lib/rails/commands/test/test_command.rb @@ -30,7 +30,9 @@ def perform(*args) Rails::TestUnit::Runner.parse_options(args) run_prepare_task if self.args.none?(EXACT_TEST_ARGUMENT_PATTERN) - Rails::TestUnit::Runner.run(args) + with_actionable_errors_retried do + Rails::TestUnit::Runner.run(args) + end end # Define Thor tasks to avoid going through Rake and booting twice when using bin/rails test:* diff --git a/railties/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt index 5737d2872c120..7481c23f40f10 100644 --- a/railties/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt +++ b/railties/lib/rails/generators/rails/app/templates/config/environments/test.rb.tt @@ -64,4 +64,7 @@ Rails.application.configure do # Raise error when a before_action's only/except options reference missing actions config.action_controller.raise_on_missing_callback_actions = true + + # Prompt user to retry actionable errors on the command line + config.actionable_command_line_errors = !ENV["CI"] end diff --git a/railties/lib/rails/testing/maintain_test_schema.rb b/railties/lib/rails/testing/maintain_test_schema.rb index 3197b77d10928..34991c64032f4 100644 --- a/railties/lib/rails/testing/maintain_test_schema.rb +++ b/railties/lib/rails/testing/maintain_test_schema.rb @@ -1,12 +1,8 @@ # frozen_string_literal: true if defined?(ActiveRecord::Base) - begin - ActiveRecord::Migration.maintain_test_schema! - rescue ActiveRecord::PendingMigrationError => e - puts e.to_s.strip - exit 1 - end + + ActiveRecord::Migration.maintain_test_schema! if Rails.configuration.eager_load ActiveRecord::Base.descendants.each do |model| diff --git a/railties/test/application/test_test.rb b/railties/test/application/test_test.rb index 91dc5b7154593..d154b7cd5c5d4 100644 --- a/railties/test/application/test_test.rb +++ b/railties/test/application/test_test.rb @@ -1,6 +1,7 @@ # frozen_string_literal: true require "isolation/abstract_unit" +require "thor" module ApplicationTests class TestTest < ActiveSupport::TestCase @@ -345,6 +346,44 @@ def self.load_schema! assert_unsuccessful_run "models/user_test.rb", "SCHEMA LOADED!" end + def test_actionable_command_line_error + rails "generate", "scaffold", "user", "name:string" + app_file "config/environments/test.rb", <<-RUBY + Rails.application.configure do + config.actionable_command_line_errors = true + end + RUBY + app_file "config/initializers/thor_yes.rb", <<-RUBY + Rails::Command::Base.class_eval <<-MORERUBY + def yes?(statement, color = nil) + raise ArgumentError unless statement == "Run pending migrations? [Yn]" + true + end + MORERUBY + RUBY + + run_test_file("models/user_test.rb").tap do |output| + assert_match "Migrations are pending. To resolve this issue, run:", output + assert_match "CreateUsers: migrating", output + assert_match "0 runs, 0 assertions, 0 failures, 0 errors, 0 skips", output + end + end + + def test_actionable_command_line_errors_false + rails "generate", "scaffold", "user", "name:string" + app_file "config/environments/test.rb", <<-RUBY + Rails.application.configure do + config.actionable_command_line_errors = false + end + RUBY + + run_test_file("models/user_test.rb").tap do |output| + assert_match "Migrations are pending. To resolve this issue, run:", output + assert_no_match "CreateUsers: migrating", output + assert_no_match "0 runs, 0 assertions, 0 failures, 0 errors, 0 skips", output + end + end + private def assert_unsuccessful_run(name, message) result = run_test_file(name)