aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport
diff options
context:
space:
mode:
authorEdouard CHIN <edouard.chin@shopify.com>2018-04-26 14:38:02 -0400
committerEdouard CHIN <edouard.chin@shopify.com>2018-04-27 01:36:27 -0400
commit1cf8b6c23120e24707a2606a4b159a56faf38212 (patch)
treea8fa1073eba0574d2901e3ad5bff2edc69c193e5 /activesupport
parent7d2400ab61c8e3ed95e14d03ba3844e8ba2e36e4 (diff)
downloadrails-1cf8b6c23120e24707a2606a4b159a56faf38212.tar.gz
rails-1cf8b6c23120e24707a2606a4b159a56faf38212.tar.bz2
rails-1cf8b6c23120e24707a2606a4b159a56faf38212.zip
`SetupAndTeardown` has few caveats that breaks libraries:
- In #32472 I introduced a fix in order for all `after_teardown` method provided by libraries and Rails to run, even if the application's `teardown` method raised an error (That's the default minitest behavior). However this change wasn't enough and doesn't take in consideration the ancestors chain. If a library's module containing an `after_teardown` method get included after the `SetupAndTeardown` module (one example is the [ActiveRecord::TestFixtures module](https://github.com/rails/rails/blob/7d2400ab61c8e3ed95e14d03ba3844e8ba2e36e4/activerecord/lib/active_record/fixtures.rb#L855-L856), then the ancestors of the test class would look something like ```ruby class MyTest < ActiveSupport::TestCase end puts MyTest.ancestors # [MyTest, ActiveSupport::TestCase, ActiveRecord::TestFixtures, ActiveSupport::Testing::SetupAndTeardown] ``` Any class/module in the ancestors chain that are **before** the `ActiveSupport::Testing::SetupAndTeardown` will behave incorrectly: - Their `before_setup` method will get called **after** all regular setup method - Their `after_teardown` method won't even get called in case an exception is raised inside a regular's test `teardown` A simple reproduction script of the problem here https://gist.github.com/Edouard-chin/70705542a59a8593f619b02e1c0a188c - One solution to this problem is to have the `AS::SetupAndTeardown` module be the very first in the ancestors chain. By doing that we ensure that no `before_setup` / `after_teardown` get executed prior to running the teardown callbacks
Diffstat (limited to 'activesupport')
-rw-r--r--activesupport/lib/active_support/test_case.rb2
-rw-r--r--activesupport/lib/active_support/testing/setup_and_teardown.rb14
-rw-r--r--activesupport/test/testing/after_teardown_test.rb8
3 files changed, 11 insertions, 13 deletions
diff --git a/activesupport/lib/active_support/test_case.rb b/activesupport/lib/active_support/test_case.rb
index 4e42db4500..f17743b6db 100644
--- a/activesupport/lib/active_support/test_case.rb
+++ b/activesupport/lib/active_support/test_case.rb
@@ -130,7 +130,7 @@ module ActiveSupport
alias_method :method_name, :name
include ActiveSupport::Testing::TaggedLogging
- include ActiveSupport::Testing::SetupAndTeardown
+ prepend ActiveSupport::Testing::SetupAndTeardown
include ActiveSupport::Testing::Assertions
include ActiveSupport::Testing::Deprecation
include ActiveSupport::Testing::TimeHelpers
diff --git a/activesupport/lib/active_support/testing/setup_and_teardown.rb b/activesupport/lib/active_support/testing/setup_and_teardown.rb
index 35236f1401..35321cd157 100644
--- a/activesupport/lib/active_support/testing/setup_and_teardown.rb
+++ b/activesupport/lib/active_support/testing/setup_and_teardown.rb
@@ -1,6 +1,5 @@
# frozen_string_literal: true
-require "active_support/concern"
require "active_support/callbacks"
module ActiveSupport
@@ -19,11 +18,10 @@ module ActiveSupport
# end
# end
module SetupAndTeardown
- extend ActiveSupport::Concern
-
- included do
- include ActiveSupport::Callbacks
- define_callbacks :setup, :teardown
+ def self.prepended(klass)
+ klass.include ActiveSupport::Callbacks
+ klass.define_callbacks :setup, :teardown
+ klass.extend ClassMethods
end
module ClassMethods
@@ -47,12 +45,10 @@ module ActiveSupport
begin
run_callbacks :teardown
rescue => e
- error = e
+ self.failures << Minitest::UnexpectedError.new(e)
end
super
- ensure
- raise error if error
end
end
end
diff --git a/activesupport/test/testing/after_teardown_test.rb b/activesupport/test/testing/after_teardown_test.rb
index 68c368909c..961af49479 100644
--- a/activesupport/test/testing/after_teardown_test.rb
+++ b/activesupport/test/testing/after_teardown_test.rb
@@ -4,13 +4,14 @@ require "abstract_unit"
module OtherAfterTeardown
def after_teardown
+ super
+
@witness = true
end
end
-class AfterTeardownTest < Minitest::Test
+class AfterTeardownTest < ActiveSupport::TestCase
include OtherAfterTeardown
- include ActiveSupport::Testing::SetupAndTeardown
attr_writer :witness
@@ -21,11 +22,12 @@ class AfterTeardownTest < Minitest::Test
end
def after_teardown
- assert_raises MyError do
+ assert_changes -> { failures.count }, from: 0, to: 1 do
super
end
assert_equal true, @witness
+ failures.clear
end
def test_teardown_raise_but_all_after_teardown_method_are_called