test-unit 3.2.5 → 3.4.7

data/lib/test/unit/testcase.rb

@@ -130,6 +130,16 @@ module Test
           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
@@ -150,11 +160,12 @@ module Test
             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
@@ -176,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)
@@ -212,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)
@@ -247,7 +262,7 @@ module Test
         @@test_orders = {}
 
         # Returns the current test order. This returns
-        # +:alphabetic+ by default.
+        # `:alphabetic` by default.
         def test_order
           ancestors.each do |ancestor|
             order = @@test_orders[ancestor]
@@ -259,12 +274,15 @@ module Test
         # 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
@@ -275,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
@@ -324,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
+        # Ruby 3.1.
+        #
+        # 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::Unit::TestCase
-        #     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::Unit::TestCase
-        #     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:
         #
@@ -426,31 +476,43 @@ module Test
         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
-          target_locations
         end
       end
 
@@ -537,35 +599,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
       #
-      #     def test_my_class
-      #       ...
+      #       setup do
+      #         ... # setup callback2
+      #       end
+      #
+      #       def test_my_class
+      #         ...
+      #       end
       #     end
-      #   end
       #
       # Here is a call order:
+      #
       # * setup
       # * my_setup1
       # * setup callback1
@@ -582,35 +646,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
@@ -625,35 +691,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
@@ -673,11 +741,17 @@ 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
@@ -779,15 +853,11 @@ module Test
         end
         if @internal_data.have_test_data?
           test_method = method(@method_name)
-          if test_method.arity == 1 or test_method.arity < 0
-            __send__(@method_name, @internal_data.test_data)
+          arity = test_method.arity
+          if arity.zero?
+            __send__(@method_name)
           else
-            locations = self.class.find_locations(:method_name => @method_name)
-            backtrace = locations.collect do |location|
-              "#{location[:path]}:#{location[:line]}"
-            end
-            notify("<#{signature}> misses a parameter to take test data",
-                   :backtrace => backtrace)
+            __send__(@method_name, @internal_data.test_data)
           end
         else
           __send__(@method_name)

data/lib/test/unit/testsuite.rb

@@ -77,7 +77,7 @@ module Test
         @tests -= tests
       end
 
-      # Retuns the rolled up number of tests in this suite;
+      # Returns the rolled up number of tests in this suite;
       # i.e. if the suite contains other suites, it counts the
       # tests within those suites, not the suites themselves.
       def size