test-unit 3.5.7 → 3.7.0

data/lib/test/unit/autorunner.rb

@@ -1,10 +1,12 @@
 require "English"
 require "optparse"
 
-require "test/unit/color-scheme"
-require "test/unit/priority"
-require "test/unit/attribute-matcher"
-require "test/unit/testcase"
+require_relative "color-scheme"
+require_relative "priority"
+require_relative "attribute-matcher"
+require_relative "testcase"
+require_relative "test-suite-thread-runner"
+require_relative "version"
 
 module Test
   module Unit
@@ -85,14 +87,14 @@ module Test
       end
 
       register_collector(:descendant) do |auto_runner|
-        require "test/unit/collector/descendant"
+        require_relative "collector/descendant"
         collector = Collector::Descendant.new
         collector.filter = auto_runner.filters
         collector.collect($0.sub(/\.rb\Z/, ""))
       end
 
       register_collector(:load) do |auto_runner|
-        require "test/unit/collector/load"
+        require_relative "collector/load"
         collector = Collector::Load.new
         unless auto_runner.pattern.empty?
           collector.patterns.replace(auto_runner.pattern)
@@ -108,7 +110,7 @@ module Test
 
       # JUST TEST!
       # register_collector(:xml) do |auto_runner|
-      #   require "test/unit/collector/xml"
+      #   require_relative "collector/xml"
       #   collector = Collector::XML.new
       #   collector.filter = auto_runner.filters
       #   collector.collect(auto_runner.to_run[0])
@@ -116,7 +118,7 @@ module Test
 
       # deprecated
       register_collector(:object_space) do |auto_runner|
-        require "test/unit/collector/objectspace"
+        require_relative "collector/objectspace"
         c = Collector::ObjectSpace.new
         c.filter = auto_runner.filters
         c.collect($0.sub(/\.rb\Z/, ""))
@@ -124,7 +126,7 @@ module Test
 
       # deprecated
       register_collector(:dir) do |auto_runner|
-        require "test/unit/collector/dir"
+        require_relative "collector/dir"
         c = Collector::Dir.new
         c.filter = auto_runner.filters
         unless auto_runner.pattern.empty?
@@ -145,6 +147,7 @@ module Test
       attr_accessor :color_scheme, :listeners
       attr_writer :stop_on_failure
       attr_writer :debug_on_failure
+      attr_writer :gc_stress
       attr_writer :runner, :collector
 
       def initialize(standalone)
@@ -161,12 +164,18 @@ module Test
         @listeners = []
         @stop_on_failure = false
         @debug_on_failure = false
+        @gc_stress = false
+        @test_suite_runner_class = TestSuiteRunner
         config_file = "test-unit.yml"
         if File.exist?(config_file)
           load_config(config_file)
         else
           load_global_config
         end
+        plain_text_config_file = ".test-unit"
+        if File.exist?(plain_text_config_file)
+          load_plain_text_config(plain_text_config_file)
+        end
         yield(self) if block_given?
       end
 
@@ -198,6 +207,8 @@ module Test
 
       def options
         @options ||= OptionParser.new do |o|
+          o.version = VERSION
+
           o.banner = "Test::Unit automatic runner."
           o.banner += "\nUsage: #{$0} [options] [-- untouched arguments]"
 
@@ -393,6 +404,32 @@ module Test
             AssertionFailedError.debug_on_failure = boolean
           end
 
+          o.on("--[no-]gc-stress",
+               "Enable GC.stress only while each test is running",
+               "(#{@gc_stress})") do |boolean|
+            @gc_stress = boolean
+          end
+
+          parallel_options = [
+            :thread,
+          ]
+          o.on("--[no-]parallel=[thread]", parallel_options,
+               "Runs tests in parallel",
+               "(#{parallel_options.first})") do |parallel|
+            case parallel
+            when nil, :thread
+              @test_suite_runner_class = TestSuiteThreadRunner
+            else
+              @test_suite_runner_class = TestSuiteRunner
+            end
+          end
+
+          o.on("--n-workers=N", Integer,
+               "The number of parallelism",
+               "(#{TestSuiteRunner.n_workers})") do |n|
+            TestSuiteRunner.n_workers = n
+          end
+
           ADDITIONAL_OPTIONS.each do |option_builder|
             option_builder.call(self, o)
           end
@@ -437,7 +474,7 @@ module Test
             n = 1
           end
           i += 1
-          keyword.sub(/^(.{#{n}})([A-Za-z]+)(?=\w*$)/, '\\1[\\2]')
+          keyword.sub(/^(.{#{n}})([A-Za-z-]+)(?=\w*$)/, '\\1[\\2]')
         end.join(", ")
       end
 
@@ -454,6 +491,10 @@ module Test
         if @stop_on_failure
           @runner_options[:listeners] << StopOnFailureListener.new
         end
+        if @gc_stress
+          @runner_options[:listeners] << GCStressListener.new
+        end
+        @runner_options[:test_suite_runner_class] = @test_suite_runner_class
         change_work_directory do
           runner.run(suite, @runner_options).passed?
         end
@@ -481,6 +522,15 @@ module Test
         @runner_options = @runner_options.merge(runner_options)
       end
 
+      def load_plain_text_config(file)
+        require "shellwords"
+        File.readlines(file, chomp: true).each do |line|
+          next if line.empty?
+          args = Shellwords.shellsplit(line)
+          @default_arguments.concat(args)
+        end
+      end
+
       private
       def default_runner
         runner = self.class.default_runner
@@ -572,10 +622,24 @@ module Test
           end
         end
       end
+
+      class GCStressListener
+        def attach_to_mediator(mediator)
+          mediator.add_listener(TestCase::STARTED) do |test|
+            GC.start
+            GC.stress = true
+          end
+
+          mediator.add_listener(TestCase::FINISHED) do |test|
+            GC.start
+            GC.stress = false
+          end
+        end
+      end
     end
   end
 end
 
-require "test/unit/runner/console"
-require "test/unit/runner/emacs"
-require "test/unit/runner/xml"
+require_relative "runner/console"
+require_relative "runner/emacs"
+require_relative "runner/xml"

data/lib/test/unit/collector/descendant.rb

@@ -1,4 +1,4 @@
-require 'test/unit/collector'
+require_relative '../collector'
 
 module Test
   module Unit

data/lib/test/unit/collector/dir.rb

@@ -1,5 +1,5 @@
-require 'test/unit/testsuite'
-require 'test/unit/collector'
+require_relative '../testsuite'
+require_relative '../collector'
 
 module Test
   module Unit

data/lib/test/unit/collector/load.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 
-require 'test/unit/testsuite'
-require 'test/unit/collector'
+require_relative '../testsuite'
+require_relative '../collector'
 
 module Test
   module Unit
@@ -39,7 +39,8 @@ module Test
             froms = @default_test_paths if froms.empty?
             froms = ["."] if froms.empty?
             test_suites = []
-            already_gathered = find_test_cases
+            already_gathered = {}
+            find_test_cases(already_gathered)
             froms.each do |from|
               from = resolve_path(from)
               if from.directory?
@@ -66,12 +67,13 @@ module Test
           end
         end
 
-        def find_test_cases(ignore=[])
+        def find_test_cases(already_gathered)
           test_cases = []
           TestCase::DESCENDANTS.each do |test_case|
-            test_cases << test_case unless ignore.include?(test_case)
+            next if already_gathered.key?(test_case)
+            test_cases << test_case
+            already_gathered[test_case] = true
           end
-          ignore.concat(test_cases)
           test_cases
         end
 

data/lib/test/unit/collector/objectspace.rb

@@ -2,7 +2,7 @@
 # Copyright:: Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
 # License:: Ruby license.
 
-require 'test/unit/collector'
+require_relative '../collector'
 
 module Test
   module Unit

data/lib/test/unit/collector/xml.rb

@@ -7,7 +7,7 @@
 
 # just test!!! don't use it yet!!!
 
-require 'test/unit/collector'
+require_relative '../collector'
 
 require 'rexml/document'
 require 'rexml/streamlistener'

data/lib/test/unit/color-scheme.rb

@@ -1,4 +1,4 @@
-require 'test/unit/color'
+require_relative 'color'
 
 module Test
   module Unit

data/lib/test/unit/data.rb

@@ -1,4 +1,4 @@
-require "test/unit/data-sets"
+require_relative "data-sets"
 
 module Test
   module Unit

data/lib/test/unit/error.rb

@@ -4,7 +4,7 @@
 # Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
 # License:: Ruby license.
 
-require 'test/unit/util/backtracefilter'
+require_relative 'util/backtracefilter'
 
 module Test
   module Unit

data/lib/test/unit/failure.rb

@@ -32,7 +32,7 @@ module Test
         @inspected_actual = options[:inspected_actual]
         @user_message = options[:user_message]
       end
-      
+
       # Returns a single character representation of a failure.
       def single_character_display
         SINGLE_CHARACTER

data/lib/test/unit/fault-location-detector.rb

@@ -18,7 +18,7 @@ module Test
         return nil if match_data.nil?
         file, line_number, context = match_data.to_a[1..-1]
         line_number = line_number.to_i
-        if /\Ain `(.+?)'/ =~ context
+        if /\Ain [`'](.+?)'/ =~ context
           method_name = $1
           if /\Ablock (?:\(.+?\) )?in / =~ method_name
             method_name = $POSTMATCH
@@ -71,7 +71,11 @@ module Test
       end
 
       def target_method?(method_name)
-        @fault_method_name == method_name
+        return false if method_name.nil?
+        # method_name may be test_XXX or MyTest#test_XXX (Ruby >= 3.4).
+        return true if @fault_method_name == method_name
+        return true if method_name.end_with?("\##{@fault_method_name}")
+        false
       end
 
       def guess_indent_level(line)

data/lib/test/unit/notification.rb

@@ -1,4 +1,4 @@
-require 'test/unit/util/backtracefilter'
+require_relative 'util/backtracefilter'
 
 module Test
   module Unit

data/lib/test/unit/omission.rb

@@ -1,4 +1,4 @@
-require 'test/unit/util/backtracefilter'
+require_relative 'util/backtracefilter'
 
 module Test
   module Unit

data/lib/test/unit/pending.rb

@@ -1,4 +1,4 @@
-require 'test/unit/util/backtracefilter'
+require_relative 'util/backtracefilter'
 
 module Test
   module Unit

data/lib/test/unit/priority.rb

@@ -180,7 +180,7 @@ module Test
         end
       end
 
-      def priority_setup
+      def priority_setup(&_)
         return unless Priority.enabled?
         Checker.new(self).setup
       end

data/lib/test/unit/runner/console.rb

@@ -1,14 +1,15 @@
-# Copyright (C) 2008-2017  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2008-2023  Sutou Kouhei <kou@clear-code.com>
 
 module Test
   module Unit
     AutoRunner.register_runner(:console) do |auto_runner|
-      require 'test/unit/ui/console/testrunner'
+      require_relative '../ui/console/testrunner'
       Test::Unit::UI::Console::TestRunner
     end
 
     AutoRunner.setup_option do |auto_runner, opts|
-      require 'test/unit/ui/console/outputlevel'
+      require_relative '../ui/console/outputlevel'
+      require_relative '../ui/console/testrunner'
 
       output_levels = [
         ["silent", UI::Console::OutputLevel::SILENT],
@@ -18,7 +19,7 @@ module Test
         ["verbose", UI::Console::OutputLevel::VERBOSE],
       ]
       opts.on('-v', '--verbose=[LEVEL]', output_levels,
-              "Set the output level (default is verbose).",
+              "Set the output level (default is normal).",
               "(#{auto_runner.keyword_display(output_levels)})") do |level|
         level ||= output_levels.assoc("verbose")[1]
         auto_runner.runner_options[:output_level] = level
@@ -51,6 +52,17 @@ module Test
         auto_runner.runner_options[:progress_row_max] = max
       end
 
+      progress_styles = [
+        ["inplace", :inplace],
+        ["mark", :mark],
+        ["fault-only", :fault_only],
+      ]
+      opts.on("--progress-style=STYLE", progress_styles,
+              "Uses STYLE as progress style",
+              "(#{auto_runner.keyword_display(progress_styles)})") do |style|
+        auto_runner.runner_options[:progress_style] = style
+      end
+
       opts.on("--no-show-detail-immediately",
               "Shows not passed test details immediately.",
               "(default is yes)") do |boolean|
@@ -62,6 +74,13 @@ module Test
               "(default is yes for tty output, no otherwise)") do |boolean|
         auto_runner.runner_options[:reverse_output] = boolean
       end
+
+      n_report_slow_tests = UI::Console::TestRunner::N_REPORT_SLOW_TESTS
+      opts.on("--[no-]report-slow-tests",
+              "Shows the top #{n_report_slow_tests} slow tests in the summary output",
+              "(false)") do |boolean|
+        auto_runner.runner_options[:report_slow_tests] = boolean
+      end
     end
   end
 end

data/lib/test/unit/runner/emacs.rb

@@ -1,7 +1,7 @@
 module Test
   module Unit
     AutoRunner.register_runner(:emacs) do |auto_runner|
-      require 'test/unit/ui/emacs/testrunner'
+      require_relative '../ui/emacs/testrunner'
       Test::Unit::UI::Emacs::TestRunner
     end
   end

data/lib/test/unit/runner/xml.rb

@@ -1,7 +1,7 @@
 module Test
   module Unit
     AutoRunner.register_runner(:xml) do |auto_runner|
-      require 'test/unit/ui/xml/testrunner'
+      require_relative '../ui/xml/testrunner'
       Test::Unit::UI::XML::TestRunner
     end
 

data/lib/test/unit/sub-test-result.rb

@@ -0,0 +1,59 @@
+#--
+#
+# Author:: Tsutomu Katsube.
+# Copyright:: Copyright (c) 2024 Tsutomu Katsube. All rights reserved.
+# License:: Ruby license.
+
+module Test
+  module Unit
+    class SubTestResult
+      attr_accessor :stop_tag
+
+      def initialize(parent_test_result)
+        @parent_test_result = parent_test_result
+        @stop_tag = nil
+      end
+
+      def add_run(result=self)
+        @parent_test_result.add_run(result)
+      end
+
+      def add_pass
+        @parent_test_result.add_pass
+      end
+
+      # Records an individual assertion.
+      def add_assertion
+        @parent_test_result.add_assertion
+      end
+
+      def add_error(error)
+        @parent_test_result.add_error(error)
+      end
+
+      def add_failure(failure)
+        @parent_test_result.add_failure(failure)
+      end
+
+      def add_pending(pending)
+        @parent_test_result.add_pending(pending)
+      end
+
+      def add_omission(omission)
+        @parent_test_result.add_omission(omission)
+      end
+
+      def add_notification(notification)
+        @parent_test_result.add_notification(notification)
+      end
+
+      def passed?
+        @parent_test_result.passed?
+      end
+
+      def stop
+        throw @stop_tag
+      end
+    end
+  end
+end

data/lib/test/unit/test-run-context.rb

@@ -0,0 +1,16 @@
+#--
+#
+# Author:: Tsutomu Katsube.
+# Copyright:: Copyright (c) 2025 Tsutomu Katsube. All rights reserved.
+# License:: Ruby license.
+
+module Test
+  module Unit
+    class TestRunContext
+      attr_reader :runner_class
+      def initialize(runner_class)
+        @runner_class = runner_class
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@
 #   * Copyright (c) 2011 Kouhei Sutou <tt><kou@clear-code.com></tt>
 # License:: Ruby license.
 
-require "test/unit/data-sets"
+require_relative "data-sets"
 
 module Test
   module Unit

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

@@ -0,0 +1,130 @@
+#--
+#
+# Author:: Nathaniel Talbott.
+# Copyright:: Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
+# Copyright:: Copyright (c) 2008-2011 Kouhei Sutou. All rights reserved.
+# Copyright:: Copyright (c) 2024 Tsutomu Katsube. All rights reserved.
+# License:: Ruby license.
+
+require "etc"
+
+require_relative "test-run-context"
+
+module Test
+  module Unit
+    class TestSuiteRunner
+      @n_workers = Etc.respond_to?(:nprocessors) ? Etc.nprocessors : 1
+      class << self
+        def run_all_tests
+          yield(TestRunContext.new(self))
+        end
+
+        def n_workers
+          @n_workers
+        end
+
+        def n_workers=(n)
+          @n_workers = n
+        end
+      end
+
+      def initialize(test_suite)
+        @test_suite = test_suite
+      end
+
+      def run(result, run_context: nil, &progress_block)
+        yield(TestSuite::STARTED, @test_suite.name)
+        yield(TestSuite::STARTED_OBJECT, @test_suite)
+        run_startup(result)
+        run_tests(result, run_context: run_context, &progress_block)
+      ensure
+        begin
+          run_shutdown(result)
+        ensure
+          yield(TestSuite::FINISHED, @test_suite.name)
+          yield(TestSuite::FINISHED_OBJECT, @test_suite)
+        end
+      end
+
+      private
+      def run_startup(result)
+        test_case = @test_suite.test_case
+        return if test_case.nil? or !test_case.respond_to?(:startup)
+        begin
+          test_case.startup
+        rescue Exception
+          raise unless handle_exception($!, result)
+        end
+      end
+
+      def run_tests(result, run_context: nil, &progress_block)
+        @test_suite.tests.each do |test|
+          run_test(test, result, run_context: run_context, &progress_block)
+        end
+      end
+
+      def run_test(test, result, run_context: nil)
+        finished_is_yielded = false
+        finished_object_is_yielded = false
+        previous_event_name = nil
+        event_listener = lambda do |event_name, *args|
+          case previous_event_name
+          when Test::Unit::TestCase::STARTED
+            if event_name != Test::Unit::TestCase::STARTED_OBJECT
+              yield(Test::Unit::TestCase::STARTED_OBJECT, test)
+            end
+          when Test::Unit::TestCase::FINISHED
+            if event_name != Test::Unit::TestCase::FINISHED_OBJECT
+              yield(Test::Unit::TestCase::FINISHED_OBJECT, test)
+            end
+            finished_object_is_yielded = true
+          end
+
+          case event_name
+          when Test::Unit::TestCase::STARTED
+            finished_is_yielded = false
+            finished_object_is_yielded = false
+          when Test::Unit::TestCase::FINISHED
+            finished_is_yielded = true
+          end
+
+          previous_event_name = event_name
+          yield(event_name, *args)
+        end
+
+        if test.method(:run).arity == -2
+          test.run(result, run_context: run_context, &event_listener)
+        else
+          # For backward compatibility. There are scripts that overrides
+          # Test::Unit::TestCase#run without keyword arguments.
+          test.run(result, &event_listener)
+        end
+
+        if finished_is_yielded and not finished_object_is_yielded
+          yield(Test::Unit::TestCase::FINISHED_OBJECT, test)
+        end
+      end
+
+      def run_shutdown(result)
+        test_case = @test_suite.test_case
+        return if test_case.nil? or !test_case.respond_to?(:shutdown)
+        begin
+          test_case.shutdown
+        rescue Exception
+          raise unless handle_exception($!, result)
+        end
+      end
+
+      def handle_exception(exception, result)
+        case exception
+        when *ErrorHandler::PASS_THROUGH_EXCEPTIONS
+          false
+        else
+          result.add_error(Error.new(@test_suite.test_case.name, exception))
+          true
+        end
+      end
+    end
+  end
+end
+