test-unit 3.6.7 → 3.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 238d27a3abf3ab70fa38affa00e2fd5944adde841397d1a5307b68eff94362c2
-  data.tar.gz: 6e6ef248d44e47e83bb45d24b160dfdccb32d167123534445d49c7358bcb3bcb
+  metadata.gz: 8bde71a96227f24a82f006152344801538ecd9ff4cb21cbbc8ce52e28b53d997
+  data.tar.gz: 575aadde532cc7b3c89d35bbf73ae0a01b616656b3ae31e671854cdcfa4f6518
 SHA512:
-  metadata.gz: 44cb65959ff5ee6e9673901218b9a29494158a822682d9d12a4b5ba7ce21f965ef87fdf3a697b8d07c91ca7b1fe9f1f0cee7bf6b3da4d74485fd221dcc03fe2c
-  data.tar.gz: 327924d71d4ec015870afec579d9936a6e0425dada2c3b6185a10ce9a2f11e9b5666f9b41641fe994e4150a513d4dd659517181ab31158881595502a77cac708
+  metadata.gz: 17edcd04d2ba7688110a108e0fc4b2381e066082deb77523cf14e38bbce04ab79fc46e6821d312791b67b038f3d5d2c8989cc85680a40bc3cdf6fad604c0f38d
+  data.tar.gz: 26516f87e2e53c5830f992b313f474b1b61f79bcc5343a5f1f300c90134ffd3ef2d2b1a3bba509968af85b0e28da2a82f9aa21293769db886e4c6027ca4d3406

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/test-unit.png)](http://badge.fury.io/rb/test-unit)
 [![Build Status for Ruby 2.1+](https://github.com/test-unit/test-unit/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/test-unit/test-unit/actions/workflows/test.yml?query=branch%3Amaster+)
 
-* http://test-unit.github.io/
+* https://test-unit.github.io/
 * https://github.com/test-unit/test-unit
 
 ## Description

data/Rakefile

@@ -49,7 +49,7 @@ Packnga::ReleaseTask.new(spec) do |task|
 end
 
 task :test do
-  ruby("test/run-test.rb")
+  ruby("test/run.rb")
 end
 
 namespace :doc do

data/bin/test-unit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "test/unit"
+
+exit(Test::Unit::AutoRunner.run(true))

data/doc/text/getting-started.md

@@ -22,178 +22,52 @@ You will find the following lines.
 !!!plain
 gem list
 ...
-bundler (1.14.6)
+bundler (2.6.3, default: 2.6.2)
 ...
-test-unit (3.2.3)
+test-unit (3.6.8, 3.6.7)
 ~~~
 
 ## 3. Create gem template.
 
 Next, create a gem template using `bundler` command.
 This command generates package skeleton with a testing framework.
-However, this command can't generate test templates for `test-unit`.
 
-So, First create gem template with the `minitest` testing framework.
-(It's similar to `unit-test`).
-After that, replace some files for `test-unit`.
+The `bundle gem -t test-unit sample` command will generate a gem template with the `test-unit` testing framework.
 
-The `bundle gem -t minitest sample` command will generate the following files.
-
-~~~
-!!!plain
-.
-|-- Gemfile
-|-- README.md
-|-- Rakefile
-|-- bin
-|   |-- console
-|   `-- setup
-|-- lib
-|   |-- sample
-|   |   `-- version.rb
-|   `-- sample.rb
-|-- sample.gemspec  # <- Modify
-`-- test
-    |-- sample_test.rb # <- Modify
-    `-- test_helper.rb # <- Modify
-~~~
-
-## 4. Edit files for `test-unit`
-
-### 4.1. Edit gemspec
-
-Edit `sample.gemspec` like the below.
-Replace `minitest` line to `test-unit`.
-
-Before
-
-~~~
-!!!ruby
-  spec.add_development_dependency "minitest", "~> 5.0"
-~~~
-
-After
-
-~~~
-!!!ruby
-  spec.add_development_dependency "test-unit", "~> 3.2.3"
-~~~
-
-### 4.2. Edit `test/test_helper.rb`
-
-Next, edit the `test/test_helper.rb` file.
-
-Before
-
-~~~
-!!!ruby
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'sample'
-
-require 'minitest/autorun' # <-- Modify this line.
-~~~
-
-After
-
-~~~
-!!!ruby
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'sample'
-
-require 'test/unit' # <-- After modification.
-~~~
-
-### 4.3 Rakefile (No edit)
-
-This file doesn't need to modify.
-The output is the below.
-
-~~~
-!!!ruby
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task :default => :test
-~~~
-
-### 4.4 Edit `test/sample_test.rb`
-
-The bundler generate the file `test/sample_test.rb`.
-This file originally templates for `minitest`.
-
-Let's modify this file for `test-unit`
-
-before
-
-~~~
-!!!ruby
-require 'test_helper'
-
-class SampleTest < Minitest::Test # <- Modify here
-  def test_that_it_has_a_version_number
-    refute_nil ::Sample::VERSION
-  end
-
-  def test_it_does_something_useful
-    assert false
-  end
-end
-~~~
-
-After
-
-~~~
-!!!ruby
-require 'test_helper'
-
-class SampleTest < Test::Unit::TestCase # <- After modification
-  def test_that_it_has_a_version_number
-    refute_nil ::Sample::VERSION
-  end
-
-  def test_it_does_something_useful
-    assert false
-  end
-end
-~~~
-
-## 5. Execute test.
+## 4. Execute test.
 
 The `rake test` command execute test scenarios in the `test` directory.
 Now it tries to two tests. One will success the other one fails.
 
 ~~~
 !!!plain
-rake test
-Loaded suite
-/path/to/ruby/lib/ruby/gems/2.3.0/gems/rake-12.0.0/lib/rake/rake_test_loader
+$ rake test
+Loaded suite /path/to/ruby/lib/ruby/gems/3.4.0/gems/rake-13.2.1/lib/rake/rake_test_loader
 Started
 F
 ================================================================================
-Failure: <false> is not true.
-test_it_does_something_useful(SampleTest)
-/path/to/sample/test/sample_test.rb:9:in `test_it_does_something_useful'
-      6:   end
-      7:
-      8:   def test_it_does_something_useful
-  =>  9:     assert false
+Failure: test: something useful(SampleTest)
+/path/to/sample/test/sample_test.rb:13:in 'block in <class:SampleTest>'
      10:   end
-     11: end
+     11:
+     12:   test "something useful" do
+  => 13:     assert_equal("expected", "actual")
+     14:   end
+     15: end
+<"expected"> expected but was
+<"actual">
+
+diff:
+? expected
+? a     ual
+? ????     ??
 ================================================================================
-.
-
-Finished in 0.011521 seconds.
+Finished in 0.013737 seconds.
 --------------------------------------------------------------------------------
 2 tests, 2 assertions, 1 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications
 50% passed
 --------------------------------------------------------------------------------
-173.60 tests/s, 173.60 assertions/s
+145.59 tests/s, 145.59 assertions/s
 rake aborted!
 Command failed with status (1)
 
@@ -201,7 +75,7 @@ Tasks: TOP => test
 (See full trace by running task with --trace)
 ~~~
 
-## 6. Create original tests.
+## 5. Create original tests.
 
 Let's create your original tests with the following rules.
 
@@ -239,7 +113,7 @@ module Sub
 end
 ~~~
 
-## 7. For more information
+## 6. For more information
 
 Let's read the official document.
 

data/doc/text/how-to.md

@@ -2,7 +2,7 @@
 
 ## Run all tests
 
-To make it easy to run all your tests, you can add a `run_test.rb` script
+To make it easy to run all your tests, you can add a `run.rb` script
 to your `test` directory. A simple example might look like:
 
     base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
@@ -17,19 +17,19 @@ to your `test` directory. A simple example might look like:
 
 Then it's easy to run tests via the command line with,
 
-    $ ruby test/run_test.rb
+    $ ruby test/run.rb
 
 ## Change test runner via the command line
 
 The output format can be changed via the command line with
 the `--runner` option. Simply tack it to the end:
 
-    ruby test/run_test.rb --runner tap
+    ruby test/run.rb --runner emacs
 
 
 ## Configure test-unit per-project
 
-Test::Unit reads `test-unit.yml` or `.test-unit.yml` in the current working
+Test::Unit reads `~/.test-unit.yml` or `test-unit.yml` in the current working
 directory as Test::Unit's configuration file. It can contain the following
 settings:
 

data/doc/text/news.md

@@ -1,5 +1,47 @@
 # News
 
+## 3.6.8 - 2025-04-05 {#version-3-6-8}
+
+### Improvements
+
+  * `test-unit`: Added. You can use this instead of creating a custom
+    test run script.
+    * GH-288
+    * GH-289
+    * GH-291
+    * Suggested by gemmaro
+
+  * Updated the "how to" document.
+    * GH-292
+    * GH-293
+    * GH-294
+
+  * Updated the "getting started" document.
+    * GH-295
+    * GH-296
+
+  * Added support for `.test-unit` configuration file. It's useful for
+    specifying default options, and is handier than using `.test-unit.yml`.
+    * GH-300
+    * GH-302
+
+### Fixes
+
+  * parallel: thread: Fixed shutdown execution order.
+    * GH-282
+
+  * testcase: Fixed a bug that instance variables added during the test
+    runs are not garbage collected after each test run.
+    * GH-235
+    * GH-303
+    * Reported by akira yamada
+
+### Thanks
+
+  * gemmaro
+
+  * akira yamada
+
 ## 3.6.7 - 2024-12-17 {#version-3-6-7}
 
 ### Fixes

data/lib/test/unit/autorunner.rb

@@ -171,6 +171,10 @@ module Test
         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
 
@@ -515,6 +519,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

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-runner.rb

@@ -8,13 +8,15 @@
 
 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
+          yield(TestRunContext.new(self))
         end
 
         def n_workers
@@ -30,11 +32,11 @@ module Test
         @test_suite = test_suite
       end
 
-      def run(result, &progress_block)
+      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, &progress_block)
+        run_tests(result, run_context: run_context, &progress_block)
       ensure
         begin
           run_shutdown(result)
@@ -55,13 +57,13 @@ module Test
         end
       end
 
-      def run_tests(result, &progress_block)
+      def run_tests(result, run_context: nil, &progress_block)
         @test_suite.tests.each do |test|
-          run_test(test, result, &progress_block)
+          run_test(test, result, run_context: run_context, &progress_block)
         end
       end
 
-      def run_test(test, result)
+      def run_test(test, result, run_context: nil)
         finished_is_yielded = false
         finished_object_is_yielded = false
         previous_event_name = nil
@@ -91,7 +93,7 @@ module Test
         end
 
         if test.method(:run).arity == -2
-          test.run(result, runner_class: self.class, &event_listener)
+          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.

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

@@ -6,26 +6,29 @@
 
 require_relative "sub-test-result"
 require_relative "test-suite-runner"
+require_relative "test-thread-run-context"
 
 module Test
   module Unit
     class TestSuiteThreadRunner < TestSuiteRunner
-      @task_queue = Thread::Queue.new
       class << self
-        def task_queue
-          @task_queue
-        end
-
         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 = @task_queue.pop
+                  task = queue.pop
                   break if task.nil?
                   catch do |stop_tag|
                     task.call(stop_tag)
@@ -36,31 +39,43 @@ module Test
               end
             end
           end
-
-          yield
-
-          n_workers.times do
-            @task_queue << nil
-          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, &progress_block)
+      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, &progress_block)
+            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, &progress_block)
+              run_test(test, sub_result, run_context: run_context, &progress_block)
             end
-            self.class.task_queue << task
+            run_context.queue << task
           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

@@ -577,9 +577,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, runner_class: nil)
+      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)
@@ -621,6 +623,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
 
@@ -856,6 +861,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
@@ -916,6 +926,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
@@ -923,6 +934,7 @@ module Test
           @interrupted = false
           @test_data_label = nil
           @test_data = nil
+          @run_context = nil
         end
 
         def passed?

data/lib/test/unit/testresult.rb

@@ -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

@@ -47,9 +47,13 @@ module Test
 
       # Runs the tests and/or suites contained in this
       # TestSuite.
-      def run(result, runner_class: nil, &progress_block)
-        runner_class ||= TestSuiteRunner
-        runner_class.new(self).run(result) do |event, *args|
+      def run(result, run_context: nil, &progress_block)
+        if run_context
+          runner_class = run_context.runner_class
+        else
+          runner_class = TestSuiteRunner
+        end
+        runner_class.new(self).run(result, run_context: run_context) do |event, *args|
           case event
           when STARTED
             @start_time = Time.now

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

@@ -40,13 +40,13 @@ module Test
           start_time = Time.now
           begin
             with_listener(result) do
-              @test_suite_runner_class.run_all_tests 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
@@ -65,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, runner_class: @test_suite_runner_class) do |channel, value|
+            @suite.run(result, run_context: run_context) do |channel, value|
               notify_listeners(channel, value)
             end
           end

data/lib/test/unit/version.rb

@@ -1,5 +1,5 @@
 module Test
   module Unit
-    VERSION = "3.6.7"
+    VERSION = "3.6.8"
   end
 end

data/lib/test/unit.rb

@@ -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.
   #
   #

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-unit
 version: !ruby/object:Gem::Version
-  version: 3.6.7
+  version: 3.6.8
 platform: ruby
 authors:
 - Kouhei Sutou
 - Haruka Yoshihara
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: power_assert
@@ -33,7 +32,8 @@ description: |-
 email:
 - kou@cozmixng.org
 - yoshihara@clear-code.com
-executables: []
+executables:
+- test-unit
 extensions: []
 extra_rdoc_files: []
 files:
@@ -42,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
@@ -78,9 +79,11 @@ files:
 - 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
@@ -113,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
@@ -128,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: An xUnit family unit testing framework for Ruby.
 test_files: []