test-unit 3.2.0 → 3.3.6

data/lib/test/unit/test-suite-creator.rb

@@ -5,6 +5,8 @@
 #   * Copyright (c) 2011 Kouhei Sutou <tt><kou@clear-code.com></tt>
 # License:: Ruby license.
 
+require "test/unit/data-sets"
+
 module Test
   module Unit
     class TestSuiteCreator # :nodoc:
@@ -22,15 +24,11 @@ module Test
       def create
         suite = TestSuite.new(@test_case.name, @test_case)
         collect_test_names.each do |test_name|
-          data_sets = @test_case.find_attribute(test_name, :data,
-                                                :recursive => false)
+          data_sets = extract_data_sets(test_name)
           if data_sets
-            data_sets.each do |data_set|
-              data_set = data_set.call if data_set.respond_to?(:call)
-              data_set.each do |label, data|
-                append_test(suite, test_name) do |test|
-                  test.assign_test_data(label, data)
-                end
+            data_sets.each do |label, data|
+              append_test(suite, test_name) do |test|
+                test.assign_test_data(label, data)
               end
             end
           else
@@ -42,6 +40,22 @@ module Test
       end
 
       private
+      def extract_data_sets(test_name)
+        data_sets = @test_case.find_attribute(test_name,
+                                              :data,
+                                              :recursive => false)
+        data_method_name = "data_#{test_name}"
+        test = @test_case.new(test_name)
+        if test.respond_to?(data_method_name)
+          data_method = test.method(data_method_name)
+          if data_method.arity <= 0
+            data_sets ||= DataSets.new
+            data_sets << data_method
+          end
+        end
+        data_sets
+      end
+
       def append_test(suite, test_name)
         test = @test_case.new(test_name)
         yield(test) if block_given?

data/lib/test/unit/testcase.rb

@@ -37,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
@@ -109,6 +130,15 @@ module Test
           super
         end
 
+        def include(*modules, &block) # :nodoc:
+          super
+          modules.each do |mod|
+            mod.public_instance_methods(false).each do |method_name|
+              AutoRunnerLoader.check(self, method_name.to_s)
+            end
+          end
+        end
+
         @@added_method_names = {}
         def method_added(name) # :nodoc:
           super
@@ -129,11 +159,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
@@ -155,27 +186,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)
@@ -191,27 +224,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)
@@ -226,20 +261,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
@@ -250,22 +292,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
@@ -299,10 +341,10 @@ 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)
@@ -314,20 +356,22 @@ module Test
         # 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:
         #
@@ -365,6 +409,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]
@@ -377,49 +426,62 @@ 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 = 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
 
@@ -441,9 +503,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)
@@ -508,35 +568,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
@@ -553,35 +615,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
@@ -596,35 +660,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
@@ -644,18 +710,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
 
@@ -733,13 +814,20 @@ 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 @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