test-unit 3.5.7 → 3.7.0

data/lib/test/unit/ui/console/testrunner.rb

@@ -3,21 +3,22 @@
 # Author:: Nathaniel Talbott.
 # Copyright::
 #   * Copyright (c) 2000-2003 Nathaniel Talbott. All rights reserved.
-#   * Copyright (c) 2008-2017 Kouhei Sutou <kou@clear-code.com>
+#   * Copyright (c) 2008-2023 Sutou Kouhei <kou@clear-code.com>
 # License:: Ruby license.
 
 begin
   require 'io/console'
 rescue LoadError
 end
+require "pathname"
 
-require 'test/unit/color-scheme'
-require 'test/unit/code-snippet-fetcher'
-require 'test/unit/fault-location-detector'
-require 'test/unit/diff'
-require 'test/unit/ui/testrunner'
-require 'test/unit/ui/testrunnermediator'
-require 'test/unit/ui/console/outputlevel'
+require_relative '../../color-scheme'
+require_relative '../../code-snippet-fetcher'
+require_relative '../../fault-location-detector'
+require_relative '../../diff'
+require_relative '../testrunner'
+require_relative '../testrunnermediator'
+require_relative 'outputlevel'
 
 module Test
   module Unit
@@ -28,6 +29,8 @@ module Test
         class TestRunner < UI::TestRunner
           include OutputLevel
 
+          N_REPORT_SLOW_TESTS = 5
+
           # Creates a new TestRunner for running the passed
           # suite. If quiet_mode is true, the output while
           # running is limited to progress dots, errors and
@@ -36,12 +39,16 @@ module Test
           # STDOUT.
           def initialize(suite, options={})
             super
-            @output_level = @options[:output_level] || NORMAL
+            @on_github_actions = (ENV["GITHUB_ACTIONS"] == "true")
+            @output_level = @options[:output_level] || guess_output_level
             @output = @options[:output] || STDOUT
             @use_color = @options[:use_color]
             @use_color = guess_color_availability if @use_color.nil?
             @color_scheme = @options[:color_scheme] || ColorScheme.default
             @reset_color = Color.new("reset")
+            @progress_style = @options[:progress_style] || guess_progress_style
+            @progress_marks = ["|", "/", "-", "\\", "|", "/", "-", "\\"]
+            @progress_mark_index = 0
             @progress_row = 0
             @progress_row_max = @options[:progress_row_max]
             @progress_row_max ||= guess_progress_row_max
@@ -54,6 +61,7 @@ module Test
             @faults = []
             @code_snippet_fetcher = CodeSnippetFetcher.new
             @test_suites = []
+            @test_statistics = []
           end
 
           private
@@ -114,10 +122,13 @@ module Test
               nl if output?(NORMAL) and !output?(VERBOSE)
               output_faults
             end
-            nl(PROGRESS_ONLY)
-            change_output_level(IMPORTANT_FAULTS_ONLY) do
-              output_statistics(elapsed_time)
+            case @progress_style
+            when :inplace
+              output_single("\r", nil, PROGRESS_ONLY)
+            when :mark
+              nl(PROGRESS_ONLY)
             end
+            output_statistics(elapsed_time)
           end
 
           def output_faults
@@ -186,12 +197,71 @@ module Test
               output(fault.test_name, fault_color(fault))
               output_fault_backtrace(fault)
               output_failure_message(fault)
+              output_fault_on_github_actions(fault)
             else
               output_single("#{fault.label}: ")
               output_single(fault.test_name, fault_color(fault))
               output_fault_message(fault)
               output_fault_backtrace(fault)
+              output_fault_on_github_actions(fault) if fault.is_a?(Error)
+              if fault.is_a?(Error) and fault.exception.respond_to?(:cause)
+                cause = fault.exception.cause
+                i = 0
+                while cause
+                  sub_fault = Error.new(fault.test_name,
+                                        cause,
+                                        method_name: fault.method_name)
+                  output_single("Cause#{i}", fault_color(sub_fault))
+                  output_fault_message(sub_fault)
+                  output_fault_backtrace(sub_fault)
+                  cause = cause.cause
+                  i += 1
+                end
+              end
+            end
+          end
+
+          def detect_target_location_on_github_actions(fault)
+            return nil unless @on_github_actions
+
+            base_dir = ENV["GITHUB_WORKSPACE"]
+            return nil unless base_dir
+            base_dir = Pathname(base_dir).expand_path
+
+            detector = FaultLocationDetector.new(fault, @code_snippet_fetcher)
+            backtrace = fault.location || []
+            backtrace.each_with_index do |entry, i|
+              next unless detector.target?(entry)
+              file, line, = detector.split_backtrace_entry(entry)
+              file = Pathname(file).expand_path
+              relative_file = file.relative_path_from(base_dir)
+              first_component = relative_file.descend do |component|
+                break component
+              end
+              # file isn't under base_dir
+              next if first_component.to_s == "..."
+              return [relative_file, line]
             end
+            nil
+          end
+
+          def output_fault_on_github_actions(fault)
+            location = detect_target_location_on_github_actions(fault)
+            return unless location
+
+            parameters = [
+              "file=#{location[0]}",
+              "line=#{location[1]}",
+              "title=#{fault.label}",
+            ].join(",")
+            message = fault.message
+            if fault.is_a?(Error)
+              message = ([message] + (fault.location || [])).join("\n")
+            end
+            # We need to use URL encode for new line:
+            # https://github.com/actions/toolkit/issues/193
+            message = message.gsub("\n", "%0A")
+            output("::error #{parameters}::#{message}")
           end
 
           def output_fault_message(fault)
@@ -322,9 +392,29 @@ module Test
           end
 
           def output_statistics(elapsed_time)
-            output("Finished in #{elapsed_time} seconds.")
+            change_output_level(IMPORTANT_FAULTS_ONLY) do
+              output("Finished in #{elapsed_time} seconds.")
+            end
+            if @options[:report_slow_tests]
+              output_summary_marker
+              output("Top #{N_REPORT_SLOW_TESTS} slow tests")
+              @test_statistics.sort_by {|statistic| -statistic[:elapsed_time]}
+                              .first(N_REPORT_SLOW_TESTS)
+                              .each do |slow_statistic|
+                left_side = "#{slow_statistic[:name]}: "
+                right_width = @progress_row_max - left_side.size
+                output("%s%*f" % [
+                         left_side,
+                         right_width,
+                         slow_statistic[:elapsed_time],
+                       ])
+                output("--location #{slow_statistic[:location]}")
+              end
+            end
             output_summary_marker
-            output(@result)
+            change_output_level(IMPORTANT_FAULTS_ONLY) do
+              output(@result)
+            end
             output("%g%% passed" % @result.pass_percentage)
             unless elapsed_time.zero?
               output_summary_marker
@@ -339,11 +429,8 @@ module Test
           end
 
           def output_summary_marker
-            if @progress_row_max > 0
-              output("-" * @progress_row_max, summary_marker_color)
-            else
-              nl
-            end
+            return if @progress_row_max <= 0
+            output("-" * @progress_row_max, summary_marker_color)
           end
 
           def test_started(test)
@@ -367,18 +454,33 @@ module Test
             output_single("#{indent}#{name}#{separator}#{tab_stop}",
                           nil,
                           VERBOSE)
-            @test_start = Time.now
           end
 
           def test_finished(test)
             unless @already_outputted
-              output_progress(".", color("pass-marker"))
+              case @progress_style
+              when :inplace
+                mark = @progress_marks[@progress_mark_index]
+                @progress_mark_index =
+                  (@progress_mark_index + 1) % @progress_marks.size
+                output_progress(mark, color("pass-marker"))
+              when :mark
+                output_progress(".", color("pass-marker"))
+              end
             end
             @already_outputted = false
 
+            if @options[:report_slow_tests]
+              @test_statistics << {
+                name: test.name,
+                elapsed_time: test.elapsed_time,
+                location: test.method(test.method_name).source_location.join(":"),
+              }
+            end
+
             return unless output?(VERBOSE)
 
-            output(": (%f)" % (Time.now - @test_start), nil, VERBOSE)
+            output(": (%f)" % test.elapsed_time, nil, VERBOSE)
           end
 
           def suite_name(prefix, suite)
@@ -448,7 +550,11 @@ module Test
           end
 
           def output_progress(mark, color=nil)
-            if output_single(mark, color, PROGRESS_ONLY)
+            if @progress_style == :inplace
+              output_single("\r#{mark}", color, PROGRESS_ONLY)
+            else
+              return unless output?(PROGRESS_ONLY)
+              output_single(mark, color)
               return unless @progress_row_max > 0
               @progress_row += mark.size
               if @progress_row >= @progress_row_max
@@ -459,24 +565,29 @@ module Test
           end
 
           def output_progress_in_detail_marker(fault)
-            if @progress_row_max > 0
-              output("=" * @progress_row_max)
-            else
-              nl
-            end
+            return if @progress_row_max <= 0
+            output("=" * @progress_row_max)
           end
 
           def output_progress_in_detail(fault)
             return if @output_level == SILENT
-            nl
-            output_progress_in_detail_marker(fault)
-            if categorize_fault(fault) == :need_detail_faults
-              output_fault_in_detail(fault)
+            need_detail_faults = (categorize_fault(fault) == :need_detail_faults)
+            if need_detail_faults
+              log_level = IMPORTANT_FAULTS_ONLY
             else
-              output_fault_in_short(fault)
+              log_level = @current_output_level
+            end
+            change_output_level(log_level) do
+              nl(NORMAL)
+              output_progress_in_detail_marker(fault)
+              if need_detail_faults
+                output_fault_in_detail(fault)
+              else
+                output_fault_in_short(fault)
+              end
+              output_progress_in_detail_marker(fault)
+              @progress_row = 0
             end
-            output_progress_in_detail_marker(fault)
-            @progress_row = 0
           end
 
           def output?(level)
@@ -510,6 +621,14 @@ module Test
             color("#{@result.status}-marker")
           end
 
+          def guess_output_level
+            if @on_github_actions
+              IMPORTANT_FAULTS_ONLY
+            else
+              NORMAL
+            end
+          end
+
           TERM_COLOR_SUPPORT = /
             color|  # explicitly claims color support in the name
             direct| # explicitly claims "direct color" (24 bit) support
@@ -526,7 +645,7 @@ module Test
           /x
 
           def guess_color_availability
-            return true if ENV["GITHUB_ACTIONS"] == "true"
+            return true if @on_github_actions
             return false unless @output.tty?
             return true if windows? and ruby_2_0_or_later?
             case ENV["TERM"]
@@ -540,6 +659,16 @@ module Test
             end
           end
 
+          def guess_progress_style
+            if @output_level >= VERBOSE
+              :mark
+            else
+              return :fault_only if @on_github_actions
+              return :fault_only unless @output.tty?
+              :inplace
+            end
+          end
+
           def windows?
             /mswin|mingw/ === RUBY_PLATFORM
           end

data/lib/test/unit/ui/emacs/testrunner.rb

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

data/lib/test/unit/ui/testrunner.rb

@@ -1,4 +1,4 @@
-require 'test/unit/ui/testrunnerutilities'
+require_relative 'testrunnerutilities'
 
 module Test
   module Unit
@@ -27,7 +27,7 @@ module Test
 
         private
         def setup_mediator
-          @mediator = TestRunnerMediator.new(@suite)
+          @mediator = TestRunnerMediator.new(@suite, @options)
         end
 
         def attach_listeners

data/lib/test/unit/ui/testrunnermediator.rb

@@ -4,8 +4,8 @@
 # Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
 # License:: Ruby license.
 
-require 'test/unit/util/observable'
-require 'test/unit/testresult'
+require_relative '../util/observable'
+require_relative '../testresult'
 
 module Test
   module Unit
@@ -22,8 +22,11 @@ module Test
 
         # Creates a new TestRunnerMediator initialized to run
         # the passed suite.
-        def initialize(suite)
+        def initialize(suite, options={})
           @suite = suite
+          @options = options
+          @test_suite_runner_class = @options[:test_suite_runner_class]
+          @test_suite_runner_class ||= TestSuiteRunner
         end
 
         # Runs the suite the TestRunnerMediator was created
@@ -36,13 +39,15 @@ module Test
           Test::Unit.run_at_start_hooks
           start_time = Time.now
           begin
-            catch do |stop_tag|
-              result.stop_tag = stop_tag
-              with_listener(result) do
-                notify_listeners(RESET, @suite.size)
-                notify_listeners(STARTED, result)
+            with_listener(result) do
+              @test_suite_runner_class.run_all_tests do |run_context|
+                catch do |stop_tag|
+                  result.stop_tag = stop_tag
+                  notify_listeners(RESET, @suite.size)
+                  notify_listeners(STARTED, result)
 
-                run_suite(result)
+                  run_suite(result, run_context)
+                end
               end
             end
           ensure
@@ -60,11 +65,11 @@ module Test
         #
         # See GitHub#38
         #   https://github.com/test-unit/test-unit/issues/38
-        def run_suite(result=nil)
+        def run_suite(result=nil, run_context=nil)
           if result.nil?
             run
           else
-            @suite.run(result) do |channel, value|
+            @suite.run(result, run_context: run_context) do |channel, value|
               notify_listeners(channel, value)
             end
           end

data/lib/test/unit/ui/xml/testrunner.rb

@@ -7,8 +7,9 @@
 
 require 'erb'
 require 'time'
-require 'test/unit/ui/testrunner'
-require 'test/unit/ui/testrunnermediator'
+
+require_relative '../testrunner'
+require_relative '../testrunnermediator'
 
 module Test
   module Unit

data/lib/test/unit/util/observable.rb

@@ -4,7 +4,7 @@
 # Copyright:: Copyright (c) 2000-2002 Nathaniel Talbott. All rights reserved.
 # License:: Ruby license.
 
-require 'test/unit/util/procwrapper'
+require_relative 'procwrapper'
 
 module Test
   module Unit
@@ -55,10 +55,7 @@ module Test
           if (listener_key.instance_of?(Proc))
             key = ProcWrapper.new(listener_key)
           end
-          if (channel.has_key?(key))
-            return channel.delete(key)
-          end
-          return nil
+          return channel.delete(key)
         end
 
         # Calls all the procs registered on the channel
@@ -74,9 +71,8 @@ module Test
         def notify_listeners(channel_name, *arguments)
           channel = channels[channel_name]
           return 0 unless (channel)
-          listeners = channel.values
-          listeners.each { |listener| listener.call(*arguments) }
-          return listeners.size
+          channel.each_value { |listener| listener.call(*arguments) }
+          return channel.size
         end
 
         private

data/lib/test/unit/version.rb

@@ -1,5 +1,5 @@
 module Test
   module Unit
-    VERSION = "3.5.7"
+    VERSION = "3.7.0"
   end
 end

data/lib/test/unit.rb

@@ -1,7 +1,7 @@
-require "test/unit/warning"
+require_relative "unit/warning"
 
-require 'test/unit/testcase'
-require 'test/unit/autorunner'
+require_relative 'unit/testcase'
+require_relative 'unit/autorunner'
 
 module Test # :nodoc:
   #
@@ -28,7 +28,7 @@ module Test # :nodoc:
   #
   # ## Notes
   #
-  # Test::Unit has grown out of and superceded Lapidary.
+  # Test::Unit has grown out of and superseded Lapidary.
   #
   #
   # ## Feedback
@@ -69,7 +69,7 @@ module Test # :nodoc:
   # Masaki Suketa, for his work on RubyUnit, which filled a vital need in
   # the Ruby world for a very long time. I'm also grateful for his help in
   # polishing Test::Unit and getting the RubyUnit compatibility layer
-  # right. His graciousness in allowing Test::Unit to supercede RubyUnit
+  # right. His graciousness in allowing Test::Unit to supersede RubyUnit
   # continues to be a challenge to me to be more willing to defer my own
   # rights.
   #
@@ -109,7 +109,7 @@ module Test # :nodoc:
   #
   # This software is provided "as is" and without any express or
   # implied warranties, including, without limitation, the implied
-  # warranties of merchantibility and fitness for a particular
+  # warranties of merchantability and fitness for a particular
   # purpose.
   #
   #

data/lib/test-unit.rb

@@ -1,6 +1,6 @@
 # Copyright (C) 2012-2015  Kouhei Sutou <kou@clear-code.com>
 
-require "test/unit/warning"
+require_relative "test/unit/warning"
 
 module Test
   module Unit
@@ -14,6 +14,6 @@ unless respond_to?(:run_test, true)
   # Is this API OK or dirty?
   def run_test
     self.class.send(:undef_method, :run_test)
-    require "test/unit"
+    require_relative "test/unit"
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-unit
 version: !ruby/object:Gem::Version
-  version: 3.5.7
+  version: 3.7.0
 platform: ruby
 authors:
 - Kouhei Sutou
 - Haruka Yoshihara
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: power_assert
@@ -25,76 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: kramdown
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: packnga
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: |-
   test-unit (Test::Unit) is unit testing framework for Ruby, based on xUnit
   principles. These were originally designed by Kent Beck, creator of extreme
@@ -103,7 +32,8 @@ description: |-
 email:
 - kou@cozmixng.org
 - yoshihara@clear-code.com
-executables: []
+executables:
+- test-unit
 extensions: []
 extra_rdoc_files: []
 files:
@@ -112,6 +42,7 @@ files:
 - PSFL
 - README.md
 - Rakefile
+- bin/test-unit
 - doc/text/getting-started.md
 - doc/text/how-to.md
 - doc/text/news.md
@@ -147,7 +78,12 @@ files:
 - lib/test/unit/runner/console.rb
 - lib/test/unit/runner/emacs.rb
 - lib/test/unit/runner/xml.rb
+- lib/test/unit/sub-test-result.rb
+- lib/test/unit/test-run-context.rb
 - lib/test/unit/test-suite-creator.rb
+- lib/test/unit/test-suite-runner.rb
+- lib/test/unit/test-suite-thread-runner.rb
+- lib/test/unit/test-thread-run-context.rb
 - lib/test/unit/testcase.rb
 - lib/test/unit/testresult.rb
 - lib/test/unit/testsuite.rb
@@ -171,7 +107,7 @@ files:
 - sample/test_adder.rb
 - sample/test_subtracter.rb
 - sample/test_user.rb
-homepage: http://test-unit.github.io/
+homepage: https://test-unit.github.io/
 licenses:
 - Ruby
 - BSDL
@@ -180,7 +116,6 @@ metadata:
   source_code_uri: https://github.com/test-unit/test-unit
   documentation_uri: https://test-unit.github.io/test-unit/en/
   bug_tracker_uri: https://github.com/test-unit/test-unit/issues
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: An xUnit family unit testing framework for Ruby.
 test_files: []