test-unit 3.1.4 → 3.6.2

data/lib/test/unit/testcase.rb

@@ -20,6 +20,7 @@ require 'test/unit/data'
 require 'test/unit/testsuite'
 require 'test/unit/test-suite-creator'
 require 'test/unit/assertion-failed-error'
+require 'test/unit/auto-runner-loader'
 require 'test/unit/util/backtracefilter'
 require 'test/unit/util/output'
 require 'test/unit/util/method-owner-finder'
@@ -36,49 +37,70 @@ module Test
     # You can run two hooks before/after a TestCase run.
     #
     # Example:
-    #   class TestMyClass < Test::Unit::TestCase
-    #     class << self
-    #       def startup
+    #
+    #     class TestMyClass < Test::Unit::TestCase
+    #       class << self
+    #         def startup
+    #           ...
+    #         end
+    #
+    #         def shutdown
+    #           ...
+    #         end
+    #       end
+    #
+    #       def setup
     #         ...
     #       end
     #
-    #       def shutdown
+    #       def cleanup
     #         ...
     #       end
-    #     end
     #
-    #     def setup
-    #       ...
-    #     end
+    #       def teardown
+    #         ...
+    #       end
     #
-    #     def cleanup
-    #       ...
-    #     end
+    #       def test_my_method1
+    #         ...
+    #       end
     #
-    #     def teardown
-    #       ...
+    #       def test_my_method2
+    #         ...
+    #       end
     #     end
     #
-    #     def test_my_method1
-    #       ...
-    #     end
+    # Here is a call order:
     #
-    #     def test_my_method2
-    #       ...
-    #     end
-    #   end
+    # 1. startup
+    # 1. setup
+    # 1. test_my_method1
+    # 1. cleanup
+    # 1. teardown
+    # 1. setup
+    # 1. test_my_method2
+    # 1. cleanup
+    # 1. teardown
+    # 1. shutdown
     #
-    # Here is a call order:
-    # * startup
-    # * setup
-    # * test_my_method1
-    # * cleanup
-    # * teardown
-    # * setup
-    # * test_my_method2
-    # * cleanup
-    # * teardown
-    # * shutdown
+    # You can set an attribute to each test.
+    #
+    # Example:
+    #
+    #     class TestMyClass < Test::Unit::TestCase
+    #       attribute :speed, :fast
+    #       def test_my_fast_method
+    #         # You can get the attribute via `self[]`
+    #         self[:speed] # => :fast
+    #         ...
+    #       end
+    #
+    #       attribute :speed, :slow
+    #       def test_my_slow_method
+    #         self[:speed] # => :slow
+    #         ...
+    #       end
+    #     end
     class TestCase
       include Attribute
       include Fixture
@@ -104,11 +126,20 @@ module Test
 
       class << self
         def inherited(sub_class) # :nodoc:
-          require "test/unit"
           DESCENDANTS << sub_class
           super
         end
 
+        def include(*modules, &block) # :nodoc:
+          result = super
+          modules.each do |mod|
+            mod.public_instance_methods(false).each do |method_name|
+              AutoRunnerLoader.check(self, method_name.to_s)
+            end
+          end
+          result
+        end
+
         @@added_method_names = {}
         def method_added(name) # :nodoc:
           super
@@ -120,16 +151,23 @@ module Test
           source_location = find_attribute(stringified_name, :source_location)
           if source_location
             path, line = source_location
+          elsif respond_to?(:caller_locations, true)
+            location = caller_locations(1, 1)[0]
+            path = location.absolute_path || location.path
+            line = location.lineno
           else
+            # TODO: Remove me when Ruby 1.9 support is dropped
             path, line, = caller[0].split(/:(\d+)/, 2)
             line = line.to_i if line
           end
-          method_locations << {
+          location = {
             :method_name => stringified_name,
             :path => File.expand_path(path),
             :line => line,
           }
+          add_method_location(location)
           added_method_names[stringified_name] = true
+          AutoRunnerLoader.check(self, stringified_name)
         end
 
         def added_method_names # :nodoc:
@@ -149,27 +187,29 @@ module Test
         # scope.
         #
         # Here is an example test case:
-        #   class TestMyClass < Test::Unit::TestCase
-        #     class << self
-        #       def startup
-        #         ...
+        #
+        #     class TestMyClass < Test::Unit::TestCase
+        #       class << self
+        #         def startup
+        #           ...
+        #         end
         #       end
-        #     end
         #
-        #     def setup
-        #       ...
-        #     end
+        #       def setup
+        #         ...
+        #       end
         #
-        #     def test_my_class1
-        #       ...
-        #     end
+        #       def test_my_class1
+        #         ...
+        #       end
         #
-        #     def test_my_class2
-        #       ...
+        #       def test_my_class2
+        #         ...
+        #       end
         #     end
-        #   end
         #
         # Here is a call order:
+        #
         # * startup
         # * setup
         # * test_my_class1 (or test_my_class2)
@@ -185,27 +225,29 @@ module Test
         # down fixture information used in test case scope.
         #
         # Here is an example test case:
-        #   class TestMyClass < Test::Unit::TestCase
-        #     class << self
-        #       def shutdown
-        #         ...
+        #
+        #     class TestMyClass < Test::Unit::TestCase
+        #       class << self
+        #         def shutdown
+        #           ...
+        #         end
         #       end
-        #     end
         #
-        #     def teardown
-        #       ...
-        #     end
+        #       def teardown
+        #         ...
+        #       end
         #
-        #     def test_my_class1
-        #       ...
-        #     end
+        #       def test_my_class1
+        #         ...
+        #       end
         #
-        #     def test_my_class2
-        #       ...
+        #       def test_my_class2
+        #         ...
+        #       end
         #     end
-        #   end
         #
         # Here is a call order:
+        #
         # * test_my_class1 (or test_my_class2)
         # * teardown
         # * test_my_class2 (or test_my_class1)
@@ -220,20 +262,27 @@ module Test
         @@test_orders = {}
 
         # Returns the current test order. This returns
-        # +:alphabetic+ by default.
+        # `:alphabetic` by default.
         def test_order
-          @@test_orders[self] || AVAILABLE_ORDERS.first
+          ancestors.each do |ancestor|
+            order = @@test_orders[ancestor]
+            return order if order
+          end
+          AVAILABLE_ORDERS.first
         end
 
         # Sets the current test order.
         #
         # Here are the available _order_:
-        # [:alphabetic]
-        #   Default. Tests are sorted in alphabetic order.
-        # [:random]
-        #   Tests are sorted in random order.
-        # [:defined]
-        #   Tests are sorted in defined order.
+        #
+        # :alphabetic
+        # : Default. Tests are sorted in alphabetic order.
+        #
+        # :random
+        # : Tests are sorted in random order.
+        #
+        # :defined
+        # : Tests are sorted in defined order.
         def test_order=(order)
           @@test_orders[self] = order
         end
@@ -244,22 +293,22 @@ module Test
         # In declarative syntax usage, the following two
         # test definitions are the almost same:
         #
-        #   description "register user"
-        #   def test_register_user
-        #     ...
-        #   end
+        #     description "register user"
+        #     def test_register_user
+        #       ...
+        #     end
         #
-        #   test "register user" do
-        #     ...
-        #   end
+        #     test "register user" do
+        #       ...
+        #     end
         #
         # In test method mark usage, the "my_test_method" is
         # treated as a test method:
         #
-        #   test
-        #   def my_test_method
-        #     assert_equal("call me", ...)
-        #   end
+        #     test
+        #     def my_test_method
+        #       assert_equal("call me", ...)
+        #     end
         def test(*test_description_or_targets, &block)
           if block_given?
             test_description = test_description_or_targets.first
@@ -281,6 +330,9 @@ module Test
           else
             targets = test_description_or_targets
             attribute(:test, true, {}, *targets)
+            targets.each do |target|
+              AutoRunnerLoader.check(self, target)
+            end
           end
         end
 
@@ -290,35 +342,67 @@ module Test
         # normal user" description with "test_register"
         # test.
         #
-        #   description "register a normal user"
-        #   def test_register
-        #     ...
-        #   end
+        #     description "register a normal user"
+        #     def test_register
+        #       ...
+        #     end
         def description(value, target=nil)
           targets = [target].compact
           attribute(:description, value, {}, *targets)
         end
 
+        # Declares that the following test uses Ractor.
+        #
+        # Tests that use Ractor are executed at the end. Because multi
+        # Ractor mode is enabled in the current process and it's not
+        # disabled even when only one Ractor is running after running
+        # a test that uses Ractor on Ruby 3.0. It will be solved in
+        # the future.
+        #
+        # This is implemented by setting the `:ractor` attribute of
+        # the test to `true`.
+        #
+        # @param options [Hash] See {Attribute::ClassMethods#attribute}
+        #   for details.
+        #
+        # @return [void]
+        #
+        # @example Declares that test_do_something_with_ractor uses Ractor
+        #
+        #   ractor
+        #   def test_do_something_with_ractor
+        #     Ractor.new do
+        #       # ...
+        #     end
+        #   end
+        #
+        # @since 3.4.6
+        def ractor(options={})
+          attribute(:ractor, true, options)
+        end
+
         # Defines a sub test case.
         #
         # This is a syntax sugar. The both of the following codes are
         # the same in meaning:
         #
         # Standard:
-        #   class TestParent < Test::UnitTestCase
-        #     class TestChild < self
-        #       def test_in_child
+        #
+        #     class TestParent < Test::Unit::TestCase
+        #       class TestChild < self
+        #         def test_in_child
+        #         end
         #       end
         #     end
-        #   end
         #
         # Syntax sugar:
-        #   class TestParent < Test::UnitTestCase
-        #     sub_test_case("TestChild") do
-        #       def test_in_child
+        #
+        #     class TestParent < Test::Unit::TestCase
+        #       sub_test_case("TestChild") do
+        #         def test_in_child
+        #         end
         #       end
         #     end
-        #   end
         #
         # The difference of them are the following:
         #
@@ -335,13 +419,7 @@ module Test
         #   case class context.
         # @return [Test::Unit::TestCase] Created sub test case class.
         def sub_test_case(name, &block)
-          parent_test_case = self
-          sub_test_case = Class.new(self) do
-            singleton_class = class << self; self; end
-            singleton_class.__send__(:define_method, :name) do
-              [parent_test_case.name, name].compact.join("::")
-            end
-          end
+          sub_test_case = sub_test_case_class(name)
           sub_test_case.class_eval(&block)
           sub_test_case
         end
@@ -356,6 +434,11 @@ module Test
         # @option query [String] :method_name (nil)
         #   the method name for a test.
         def test_defined?(query)
+          locations = find_locations(query)
+          not locations.empty?
+        end
+
+        def find_locations(query)
           query_path = query[:path]
           query_line = query[:line]
           query_method_name = query[:method_name]
@@ -368,49 +451,73 @@ module Test
             available_location = available_locations.find do |location|
               query_line >= location[:line]
             end
-            return false if available_location.nil?
-            return false if available_location[:test_case] != self
+            return [] if available_location.nil?
+            return [] if available_location[:test_case] != self
             available_locations = [available_location]
           end
           if query_method_name
             available_location = available_locations.find do |location|
-              query_method_name == location[:method_name]
+              location[:test_case] == self and
+                query_method_name == location[:method_name]
             end
-            return false if available_location.nil?
+            return [] if available_location.nil?
             available_locations = [available_location]
           end
 
-          not available_locations.empty?
+          available_locations
         end
 
         private
         # @private
         @@method_locations = {}
+        # @private
+        @@method_location_mutex = Thread::Mutex.new
+
         # @private
         def method_locations
           @@method_locations[self] ||= []
         end
 
         # @private
-        def target_method_locations(path)
-          if path.nil?
-            self_location = method_locations.first
-            path = self_location[:path] if self_location
+        def add_method_location(location)
+          @@method_location_mutex.synchronize do
+            method_locations << location
           end
-          return [] if path.nil?
-
-          target_locations = []
-          @@method_locations.each do |test_case, locations|
-            locations.each do |location|
-              absolete_path = File.expand_path(path)
-              location_path = location[:path]
-              location_basename = File.basename(location_path)
-              if location_path == absolete_path or location_basename == path
-                target_locations << location.merge(:test_case => test_case)
+        end
+
+        # @private
+        def target_method_locations(path)
+          @@method_location_mutex.synchronize do
+            if path.nil?
+              self_location = method_locations.first
+              path = self_location[:path] if self_location
+            end
+            return [] if path.nil?
+
+            target_locations = []
+            @@method_locations.each do |test_case, locations|
+              locations.each do |location|
+                absolete_path = File.expand_path(path)
+                location_path = location[:path]
+                location_basename = File.basename(location_path)
+                if location_path == absolete_path or location_basename == path
+                  target_locations << location.merge(:test_case => test_case)
+                end
               end
             end
+            target_locations
+          end
+        end
+
+        # @private
+        def sub_test_case_class(name)
+          parent_test_case = self
+          Class.new(self) do
+            singleton_class = class << self; self; end
+            singleton_class.__send__(:define_method, :name) do
+              [parent_test_case.name, name].compact.join("::")
+            end
           end
-          target_locations
         end
       end
 
@@ -432,9 +539,7 @@ module Test
       def valid? # :nodoc:
         return false unless respond_to?(@method_name)
         test_method = method(@method_name)
-        if @internal_data.have_test_data?
-          return false unless test_method.arity == 1
-        else
+        unless @internal_data.have_test_data?
           return false unless test_method.arity <= 0
         end
         owner = Util::MethodOwnerFinder.find(self, @method_name)
@@ -453,14 +558,31 @@ module Test
           @internal_data.test_started
           yield(STARTED, name)
           yield(STARTED_OBJECT, self)
+          processed_exception_in_setup = false
           begin
-            run_setup
-            run_test
-            run_cleanup
-            add_pass
+            catch do |tag|
+              run_setup do
+                begin
+                  run_test
+                  run_cleanup
+                  add_pass
+                rescue Exception
+                  @internal_data.interrupted
+                  unless handle_exception($!)
+                    processed_exception_in_setup = true
+                    raise
+                  end
+                  throw(tag)
+                end
+              end
+            end
           rescue Exception
-            @internal_data.interrupted
-            raise unless handle_exception($!)
+            if processed_exception_in_setup
+              raise
+            else
+              @internal_data.interrupted
+              raise unless handle_exception($!)
+            end
           ensure
             begin
               run_teardown
@@ -482,35 +604,37 @@ module Test
       #
       # You can add additional setup tasks by the following
       # code:
-      #   class TestMyClass < Test::Unit::TestCase
-      #     def setup
-      #       ...
-      #     end
       #
-      #     setup
-      #     def my_setup1
-      #       ...
-      #     end
+      #     class TestMyClass < Test::Unit::TestCase
+      #       def setup
+      #         ...
+      #       end
       #
-      #     setup do
-      #       ... # setup callback1
-      #     end
+      #       setup
+      #       def my_setup1
+      #         ...
+      #       end
       #
-      #     setup
-      #     def my_setup2
-      #       ...
-      #     end
+      #       setup do
+      #         ... # setup callback1
+      #       end
       #
-      #     setup do
-      #       ... # setup callback2
-      #     end
+      #       setup
+      #       def my_setup2
+      #         ...
+      #       end
+      #
+      #       setup do
+      #         ... # setup callback2
+      #       end
       #
-      #     def test_my_class
-      #       ...
+      #       def test_my_class
+      #         ...
+      #       end
       #     end
-      #   end
       #
       # Here is a call order:
+      #
       # * setup
       # * my_setup1
       # * setup callback1
@@ -527,35 +651,37 @@ module Test
       #
       # You can add additional cleanup tasks by the following
       # code:
-      #   class TestMyClass < Test::Unit::TestCase
-      #     def cleanup
-      #       ...
-      #     end
       #
-      #     cleanup
-      #     def my_cleanup1
-      #       ...
-      #     end
+      #     class TestMyClass < Test::Unit::TestCase
+      #       def cleanup
+      #         ...
+      #       end
       #
-      #     cleanup do
-      #       ... # cleanup callback1
-      #     end
+      #       cleanup
+      #       def my_cleanup1
+      #         ...
+      #       end
       #
-      #     cleanup
-      #     def my_cleanup2
-      #       ...
-      #     end
+      #       cleanup do
+      #         ... # cleanup callback1
+      #       end
       #
-      #     cleanup do
-      #       ... # cleanup callback2
-      #     end
+      #       cleanup
+      #       def my_cleanup2
+      #         ...
+      #       end
+      #
+      #       cleanup do
+      #         ... # cleanup callback2
+      #       end
       #
-      #     def test_my_class
-      #       ...
+      #       def test_my_class
+      #         ...
+      #       end
       #     end
-      #   end
       #
       # Here is a call order:
+      #
       # * test_my_class
       # * cleanup callback2
       # * my_cleanup2
@@ -570,35 +696,37 @@ module Test
       #
       # You can add additional teardown tasks by the following
       # code:
-      #   class TestMyClass < Test::Unit::TestCase
-      #     def teardown
-      #       ...
-      #     end
       #
-      #     teardown
-      #     def my_teardown1
-      #       ...
-      #     end
+      #     class TestMyClass < Test::Unit::TestCase
+      #       def teardown
+      #         ...
+      #       end
       #
-      #     teardown do
-      #       ... # teardown callback1
-      #     end
+      #       teardown
+      #       def my_teardown1
+      #         ...
+      #       end
       #
-      #     teardown
-      #     def my_teardown2
-      #       ...
-      #     end
+      #       teardown do
+      #         ... # teardown callback1
+      #       end
       #
-      #     teardown do
-      #       ... # teardown callback2
-      #     end
+      #       teardown
+      #       def my_teardown2
+      #         ...
+      #       end
+      #
+      #       teardown do
+      #         ... # teardown callback2
+      #       end
       #
-      #     def test_my_class
-      #       ...
+      #       def test_my_class
+      #         ...
+      #       end
       #     end
-      #   end
       #
       # Here is a call order:
+      #
       # * test_my_class
       # * teardown callback2
       # * my_teardown2
@@ -618,18 +746,33 @@ module Test
 
       # Returns a label of test data for the test. If the
       # test isn't associated with any test data, it returns
-      # +nil+.
+      # `nil`.
       def data_label
         @internal_data.test_data_label
       end
 
+      # Returns test data for the test. If the test isn't associated
+      # with any test data, it returns `nil`.
+      def data
+        @internal_data.test_data
+      end
+
       # Returns a human-readable name for the specific test that
       # this instance of TestCase represents.
       def name
+        "#{local_name}(#{self.class.name})"
+      end
+
+      # Returns a human-readable name for the specific test that this
+      # instance of TestCase represents.
+      #
+      # `#local_name` doesn't include class name. `#name` includes
+      # class name.
+      def local_name
         if @internal_data.have_test_data?
-          "#{@method_name}[#{data_label}](#{self.class.name})"
+          "#{@method_name}[#{data_label}]"
         else
-          "#{@method_name}(#{self.class.name})"
+          @method_name.to_s
         end
       end
 
@@ -707,13 +850,23 @@ module Test
       end
 
       def run_test
+        signature = "#{self.class}\##{@method_name}"
         redefined_info = self[:redefined]
         if redefined_info
-          notify("#{self.class}\##{@method_name} was redefined",
+          notify("<#{signature}> was redefined",
                  :backtrace => redefined_info[:backtrace])
         end
+        if self[:ractor] and not defined?(::Ractor)
+          omit("<#{signature}> requires Ractor")
+        end
         if @internal_data.have_test_data?
-          __send__(@method_name, @internal_data.test_data)
+          test_method = method(@method_name)
+          arity = test_method.arity
+          if arity.zero?
+            __send__(@method_name)
+          else
+            __send__(@method_name, @internal_data.test_data)
+          end
         else
           __send__(@method_name)
         end