test-unit 3.5.7 → 3.7.0

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

@@ -0,0 +1,84 @@
+#--
+#
+# Author:: Tsutomu Katsube.
+# Copyright:: Copyright (c) 2024 Tsutomu Katsube. All rights reserved.
+# License:: Ruby license.
+
+require_relative "sub-test-result"
+require_relative "test-suite-runner"
+require_relative "test-thread-run-context"
+
+module Test
+  module Unit
+    class TestSuiteThreadRunner < TestSuiteRunner
+      class << self
+        def run_all_tests
+          n_workers = TestSuiteRunner.n_workers
+
+          queue = Thread::Queue.new
+          shutdowns = []
+          yield(TestThreadRunContext.new(self, queue, shutdowns))
+          n_workers.times do
+            queue << nil
+          end
+
+          workers = []
+          sub_exceptions = []
+          n_workers.times do |i|
+            workers << Thread.new(i) do |worker_id|
+              begin
+                loop do
+                  task = queue.pop
+                  break if task.nil?
+                  catch do |stop_tag|
+                    task.call(stop_tag)
+                  end
+                end
+              rescue Exception => exception
+                sub_exceptions << exception
+              end
+            end
+          end
+          workers.each(&:join)
+
+          shutdowns.each(&:call)
+          sub_exceptions.each do |exception|
+            raise exception
+          end
+        end
+      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
+        run_context.shutdowns << lambda do
+          begin
+            run_shutdown(result)
+          ensure
+            yield(TestSuite::FINISHED, @test_suite.name)
+            yield(TestSuite::FINISHED_OBJECT, @test_suite)
+          end
+        end
+      end
+
+      private
+      def run_tests(result, run_context: nil, &progress_block)
+        @test_suite.tests.each do |test|
+          if test.is_a?(TestSuite) or not @test_suite.parallel_safe?
+            run_test(test, result, run_context: run_context, &progress_block)
+          else
+            task = lambda do |stop_tag|
+              sub_result = SubTestResult.new(result)
+              sub_result.stop_tag = stop_tag
+              run_test(test, sub_result, run_context: run_context, &progress_block)
+            end
+            run_context.queue << task
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+#--
+#
+# Author:: Tsutomu Katsube.
+# Copyright:: Copyright (c) 2025 Tsutomu Katsube. All rights reserved.
+# License:: Ruby license.
+
+require_relative "test-run-context"
+
+module Test
+  module Unit
+    class TestThreadRunContext < TestRunContext
+      attr_reader :queue, :shutdowns
+      def initialize(runner_class, queue, shutdowns)
+        super(runner_class)
+        @queue = queue
+        @shutdowns = shutdowns
+      end
+    end
+  end
+end

data/lib/test/unit/testcase.rb

@@ -6,24 +6,24 @@
 #   * Copyright (c) 2008-2012 Kouhei Sutou <tt><kou@clear-code.com></tt>
 # License:: Ruby license.
 
-require 'test/unit/attribute'
-require 'test/unit/fixture'
-require 'test/unit/exception-handler'
-require 'test/unit/assertions'
-require 'test/unit/failure'
-require 'test/unit/error'
-require 'test/unit/pending'
-require 'test/unit/omission'
-require 'test/unit/notification'
-require 'test/unit/priority'
-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'
+require_relative 'attribute'
+require_relative 'fixture'
+require_relative 'exception-handler'
+require_relative 'assertions'
+require_relative 'failure'
+require_relative 'error'
+require_relative 'pending'
+require_relative 'omission'
+require_relative 'notification'
+require_relative 'priority'
+require_relative 'data'
+require_relative 'testsuite'
+require_relative 'test-suite-creator'
+require_relative 'assertion-failed-error'
+require_relative 'auto-runner-loader'
+require_relative 'util/backtracefilter'
+require_relative 'util/output'
+require_relative 'util/method-owner-finder'
 
 module Test
   module Unit
@@ -125,6 +125,31 @@ module Test
       AVAILABLE_ORDERS = [:alphabetic, :random, :defined] # :nodoc:
 
       class << self
+        # Indicates whether the test is parallel safe.
+        #
+        # Tests that this method returns `false` are executed sequentially
+        # before parallel safe tests run. This only works when the `--parallel`
+        # option is specified.
+        #
+        # @example Indicates that test_parallel_unsafe is parallel unsafe
+        #
+        #   class TestMyClass < Test::Unit::TestCase
+        #     class << self
+        #       def parallel_safe?
+        #         false
+        #       end
+        #     end
+        #
+        #     def test_parallel_unsafe
+        #       # ...
+        #     end
+        #   end
+        #
+        # @since 3.6.3
+        def parallel_safe?
+          true
+        end
+
         def inherited(sub_class) # :nodoc:
           DESCENDANTS << sub_class
           super
@@ -357,7 +382,7 @@ module Test
         # 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.
+        # the future.
         #
         # This is implemented by setting the `:ractor` attribute of
         # the test to `true`.
@@ -376,6 +401,14 @@ module Test
         #     end
         #   end
         #
+        # @example Declares that test_do_something_with_ractor uses Ractor in one line
+        #
+        #   ractor def test_do_something_with_ractor
+        #     Ractor.new do
+        #       # ...
+        #     end
+        #   end
+        #
         # @since 3.4.6
         def ractor(options={})
           attribute(:ractor, true, options)
@@ -552,9 +585,11 @@ module Test
       # Runs the individual test method represented by this
       # instance of the fixture, collecting statistics, failures
       # and errors in result.
-      def run(result)
+      def run(result, run_context: nil)
         begin
           @_result = result
+          instance_variables_before = instance_variables
+          @internal_data.run_context = run_context
           @internal_data.test_started
           yield(STARTED, name)
           yield(STARTED_OBJECT, self)
@@ -596,6 +631,9 @@ module Test
           yield(FINISHED_OBJECT, self)
         ensure
           # @_result = nil # For test-spec's after_all :<
+          (instance_variables - instance_variables_before).each do |name|
+            remove_instance_variable(name)
+          end
         end
       end
 
@@ -831,6 +869,11 @@ module Test
         @internal_data.problem_occurred
       end
 
+      # Returns test suite runner class for easy to test.
+      def runner_class
+        @internal_data.run_context.runner_class
+      end
+
       # Notify that the test is passed. Normally, it is not needed
       # because #run calls it automatically. If you want to override
       # #run, it is not a good idea. Please contact test-unit
@@ -891,6 +934,7 @@ module Test
       class InternalData
         attr_reader :start_time, :elapsed_time
         attr_reader :test_data_label, :test_data
+        attr_accessor :run_context
         def initialize
           @start_time = nil
           @elapsed_time = nil
@@ -898,6 +942,7 @@ module Test
           @interrupted = false
           @test_data_label = nil
           @test_data = nil
+          @run_context = nil
         end
 
         def passed?

data/lib/test/unit/testresult.rb

@@ -3,12 +3,12 @@
 # Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
 # License:: Ruby license.
 
-require 'test/unit/util/observable'
-require 'test/unit/failure'
-require 'test/unit/error'
-require 'test/unit/omission'
-require 'test/unit/pending'
-require 'test/unit/notification'
+require_relative 'util/observable'
+require_relative 'failure'
+require_relative 'error'
+require_relative 'omission'
+require_relative 'pending'
+require_relative 'notification'
 
 module Test
   module Unit
@@ -51,9 +51,9 @@ module Test
       end
 
       # Records a test run.
-      def add_run
+      def add_run(result=self)
         @run_count += 1
-        notify_listeners(FINISHED, self)
+        notify_listeners(FINISHED, result)
         notify_changed
       end
 
@@ -76,7 +76,7 @@ module Test
          *@summary_generators.collect {|generator| __send__(generator)}].join(", ")
       end
 
-      # Returnes a string that shows result status.
+      # Returns a string that shows result status.
       def status
         if passed?
           if pending_count > 0

data/lib/test/unit/testsuite.rb

@@ -5,7 +5,8 @@
 # Copyright:: Copyright (c) 2008-2011 Kouhei Sutou. All rights reserved.
 # License:: Ruby license.
 
-require 'test/unit/error'
+require_relative 'error'
+require_relative 'test-suite-runner'
 
 module Test
   module Unit
@@ -34,32 +35,32 @@ module Test
         @name = name
         @tests = []
         @test_case = test_case
-        @n_tests = 0
         @priority = 0
         @start_time = nil
         @elapsed_time = nil
-        @passed = true
+      end
+
+      def parallel_safe?
+        return true if @test_case.nil?
+        @test_case.parallel_safe?
       end
 
       # Runs the tests and/or suites contained in this
       # TestSuite.
-      def run(result, &progress_block)
-        @start_time = Time.now
-        yield(STARTED, name)
-        yield(STARTED_OBJECT, self)
-        run_startup(result)
-        while test = @tests.shift
-          @n_tests += test.size
-          run_test(test, result, &progress_block)
-          @passed = false unless test.passed?
+      def run(result, run_context: nil, &progress_block)
+        if run_context
+          runner_class = run_context.runner_class
+        else
+          runner_class = TestSuiteRunner
         end
-      ensure
-        begin
-          run_shutdown(result)
-        ensure
-          @elapsed_time = Time.now - @start_time
-          yield(FINISHED, name)
-          yield(FINISHED_OBJECT, self)
+        runner_class.new(self).run(result, run_context: run_context) do |event, *args|
+          case event
+          when STARTED
+            @start_time = Time.now
+          when FINISHED
+            @elapsed_time = Time.now - @start_time
+          end
+          yield(event, *args)
         end
       end
 
@@ -81,7 +82,7 @@ module Test
       # i.e. if the suite contains other suites, it counts the
       # tests within those suites, not the suites themselves.
       def size
-        total_size = @n_tests
+        total_size = 0
         @tests.each { |test| total_size += test.size }
         total_size
       end
@@ -104,71 +105,7 @@ module Test
       end
 
       def passed?
-        @passed
-      end
-
-      private
-      def run_startup(result)
-        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_test(test, result)
-        finished_is_yielded = false
-        finished_object_is_yielded = false
-        previous_event_name = nil
-        test.run(result) 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 finished_is_yielded and not finished_object_is_yielded
-          yield(Test::Unit::TestCase::FINISHED_OBJECT, test)
-        end
-      end
-
-      def run_shutdown(result)
-        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_case.name, exception))
-          @passed = false
-          true
-        end
+        @tests.all?(&:passed?)
       end
     end
   end