test-unit 3.4.4 → 3.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf06d094c228d2826f3ffd368b7587dad9844cb59429790157c1d00f963e527
-  data.tar.gz: d5d07e063a929674b11047dee03b185fdf73f926e48aa8830f2f2fa7d4c88b58
+  metadata.gz: 6f71beead19a58b6dd15eadbce6ba5f773a25dc5e8a69cdfc5e0b227fe60bfef
+  data.tar.gz: c845b3d680a4f8d4d835bbfa3c3d86fdc5b1aa2faa21b9f6ebcb5635628a7e47
 SHA512:
-  metadata.gz: 63d7fa4261919b37f31bd412335cc086778622f4ff63e6f645baf7c8440493e3dc2be0206bff51f5a24bb0f5f90122a61db5cbe31b2499360045092069164605
-  data.tar.gz: 50238b29eda4de9e4ece1c64fe3cd9a583ceeb7cb965c4e6660d39017ded8a27579723dfe206f434ff0bbd71dba9085e4af987d83d6bf76cf3ef16a475f31e4b
+  metadata.gz: 52534de6505e9b791d185d52ac4f8cfba7799c3f937f1fabe9a2419cb43cfae0fef1224727e25f8cb1a69fcef220c49a5a42b57c2b580dee7438d0c8ec64e390
+  data.tar.gz: 233aca4112351087c13b900cf64261d5d730fa16fe2b7ab9c14a8be81a43e1032849e3fcc90f1589528738879ccb9fa5d117b5328345967e0b17693d55105afc

data/README.md

@@ -1,7 +1,8 @@
 # test-unit
 
-[![](https://badge.fury.io/rb/test-unit.svg)](http://badge.fury.io/rb/test-unit)
-[![](https://travis-ci.org/test-unit/test-unit.svg?branch=master)](https://travis-ci.org/test-unit/test-unit)
+[![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+)
+[![Build Status for Ruby 1.9 and 2.0](https://travis-ci.com/test-unit/test-unit.svg?branch=master)](https://travis-ci.com/test-unit/test-unit)
 
 * http://test-unit.github.io/
 * https://github.com/test-unit/test-unit
@@ -24,7 +25,7 @@ writing tests, checking results and automated testing in Ruby.
   to radically change very soon).
 
 * test-unit will be improved actively and may break
-  compatiblity with test-unit 1.2.3. (We will not hope it
+  compatibility with test-unit 1.2.3. (We will not hope it
   if it isn't needed.)
 
 * Some features exist as separated gems like GUI test

data/Rakefile

@@ -24,7 +24,6 @@ require "packnga"
 task :default => :test
 
 base_dir = File.dirname(__FILE__)
-html_base_dir = File.join(base_dir, "doc", "html")
 
 helper = Bundler::GemHelper.new(base_dir)
 def helper.version_tag
@@ -53,14 +52,6 @@ def rake(*arguments)
   ruby($0, *arguments)
 end
 
-namespace :html do
-  desc "Publish HTML to Web site."
-  task :publish do
-    # FIXME Do nothing for now
-    #rsync_to_rubyforge(spec, "#{html_base_dir}/", "")
-  end
-end
-
 task :test do
   ruby("test/run-test.rb")
 end

data/doc/text/getting-started.md

@@ -239,7 +239,7 @@ module Sub
 end
 ~~~
 
-## 7. For more inforomation
+## 7. For more information
 
 Let's read the official document.
 

data/doc/text/news.md

@@ -1,10 +1,63 @@
 # News
 
+## 3.4.8 - 2021-10-11 {#version-3-4-8}
+
+### Improvements
+
+  * Added support for omitting Ractor tests on Ruby 2.7 or earlier
+    automatically.
+
+## 3.4.7 - 2021-09-14 {#version-3-4-7}
+
+### Fixes
+
+  * Suppressed a warning on Ruby 2.
+    [GitHub#205][Patch by Kenichi Kamiya]
+
+### Thanks
+
+  * Kenichi Kamiya
+
+## 3.4.6 - 2021-09-11 {#version-3-4-6}
+
+### Improvements
+
+  * Added support for tests that use Ractor. Use
+    `Test::Unit::TestCase.ractor` to declare that these tests use
+    Ractor.
+
+  * Added `--debug-on-failure` option.
+
+## 3.4.5 - 2021-09-04 {#version-3-4-5}
+
+### Improvements
+
+  * Added more metadata to gemspec.
+    [GitHub#183][Patch by Kenichi Kamiya]
+
+  * Removed needless files from gem.
+    [GitHub#184][Patch by Kenichi Kamiya]
+
+  * Updated documents.
+    [GitHub#191][GitHub#192][GitHub#193][GitHub#199][GitHub#200]
+    [GitHub#201][Patch by Kenichi Kamiya]
+
+  * Added `assert_nothing_leaked_memory`.
+
+### Fixes
+
+  * Fixed typos in documents.
+    [GitHub#189][GitHub#190][GitHub#195][GitHub#197][Patch by Kenichi Kamiya]
+
+### Thanks
+
+  * Kenichi Kamiya
+
 ## 3.4.4 - 2021-06-04 {#version-3-4-4}
 
 ### Improvements
 
-  * Rename `assert_all?` to `assert_all`. `assert_all?` is deprecated
+  * Renamed `assert_all?` to `assert_all`. `assert_all?` is deprecated
     but is available.
 
 ## 3.4.3 - 2021-06-04 {#version-3-4-3}

data/lib/test/unit/assertion-failed-error.rb

@@ -9,6 +9,17 @@ module Test
 
     # Thrown by Test::Unit::Assertions when an assertion fails.
     class AssertionFailedError < StandardError
+      @debug_on_failure = false
+      class << self
+        def debug_on_failure=(boolean)
+          @debug_on_failure = boolean
+        end
+
+        def debug_on_failure?
+          @debug_on_failure
+        end
+      end
+
       attr_accessor :expected, :actual, :user_message
       attr_accessor :inspected_expected, :inspected_actual
       def initialize(message=nil, options=nil)
@@ -19,6 +30,30 @@ module Test
         @inspected_actual = options[:inspected_actual]
         @user_message = options[:user_message]
         super(message)
+        debug_on_failure
+      end
+
+      private
+      def debug_on_failure
+        return unless self.class.debug_on_failure?
+
+        begin
+          require "debug"
+        rescue LoadError
+          return
+        end
+
+        return unless binding.respond_to?(:break)
+
+        frames = caller(0)
+        pre = nil
+        Util::BacktraceFilter.filter_backtrace(frames).each do |location|
+          frame_index = frames.index(location)
+          next if frame_index.nil?
+          pre = "frame #{frame_index}"
+          break
+        end
+        binding.break(pre: pre)
       end
     end
   end

data/lib/test/unit/assertions.rb

@@ -5,6 +5,7 @@
 
 require 'test/unit/assertion-failed-error'
 require 'test/unit/util/backtracefilter'
+require 'test/unit/util/memory-usage'
 require 'test/unit/util/method-owner-finder'
 require 'test/unit/diff'
 
@@ -43,7 +44,7 @@ module Test
 
       ##
       # The assertion upon which all other assertions are based. Passes if the
-      # block yields true.
+      # block yields not false nor nil.
       #
       # @example
       #   assert_block "Couldn't do the thing" do
@@ -454,7 +455,7 @@ EOT
       alias_method :refute_instance_of, :assert_not_instance_of
 
       ##
-      # Passes if `object` is nil.
+      # Passes if `object`.nil?.
       #
       # @example
       #   assert_nil [1, 2].uniq!
@@ -627,7 +628,7 @@ EOT
       ##
       # Compares the `object1` with `object2` using `operator`.
       #
-      # Passes if object1.__send__(operator, object2) is true.
+      # Passes if object1.__send__(operator, object2) is not false nor nil.
       #
       # @example
       #   assert_operator 5, :>=, 4
@@ -647,7 +648,7 @@ EOT
       ##
       # Compares the `object1` with `object2` using `operator`.
       #
-      # Passes if object1.__send__(operator, object2) is not true.
+      # Passes if object1.__send__(operator, object2) is false or nil.
       #
       # @example
       #   assert_not_operator(5, :<, 4) # => pass
@@ -787,7 +788,7 @@ EOT
       alias_method :refute_match, :assert_not_match
 
       ##
-      # Deprecated. Use #assert_not_match instead.
+      # @deprecated Use {#assert_not_match} instead.
       #
       # Passes if `regexp` !~ `string`
       #
@@ -1177,7 +1178,7 @@ EOT
 
       public
       ##
-      # Passes if the method send returns a true value.
+      # Passes if the method `__send__` returns not false nor nil.
       #
       # `send_array` is composed of:
       # * A receiver
@@ -1217,7 +1218,7 @@ EOT
       end
 
       ##
-      # Passes if the method send doesn't return a true value.
+      # Passes if the method `__send__` returns false or nil.
       #
       # `send_array` is composed of:
       # * A receiver
@@ -1267,7 +1268,7 @@ EOT
           assert_block(build_message(message,
                                      "<true> or <false> expected but was\n<?>",
                                      actual)) do
-            [true, false].include?(actual)
+            true == actual || false == actual
           end
         end
       end
@@ -1283,7 +1284,7 @@ EOT
           assert_block(build_message(message,
                                      "<true> expected but was\n<?>",
                                      actual)) do
-            actual == true
+            true == actual
           end
         end
       end
@@ -1299,14 +1300,14 @@ EOT
           assert_block(build_message(message,
                                      "<false> expected but was\n<?>",
                                      actual)) do
-            actual == false
+            false == actual
           end
         end
       end
 
       ##
       # Passes if expression "`expected` `operator`
-      # `actual`" is true.
+      # `actual`" is not false nor nil.
       #
       # @example
       #   assert_compare(1, "<", 10)  # -> pass
@@ -1435,7 +1436,7 @@ EOT
       end
 
       ##
-      # Passes if `object`.`predicate` is _true_.
+      # Passes if `object`.`predicate` is not false nor nil.
       #
       # @example
       #   assert_predicate([], :empty?)  # -> pass
@@ -1457,7 +1458,7 @@ EOT
       end
 
       ##
-      # Passes if `object`.`predicate` is not _true_.
+      # Passes if `object`.`predicate` is false or nil.
       #
       # @example
       #   assert_not_predicate([1], :empty?) # -> pass
@@ -1686,12 +1687,12 @@ EOT
       #   with any `block`.
       #
       #   @example Pass patterns
-      #     assert_all?([1, 2, 3]) {|item| item > 0} # => pass
-      #     assert_all?([1, 2, 3], &:positive?)      # => pass
-      #     assert_all?([]) {|item| false}           # => pass
+      #     assert_all([1, 2, 3]) {|item| item > 0} # => pass
+      #     assert_all([1, 2, 3], &:positive?)      # => pass
+      #     assert_all([]) {|item| false}           # => pass
       #
       #   @example Failure pattern
-      #     assert_all?([0, 1, 2], &:zero?) # => failure
+      #     assert_all([0, 1, 2], &:zero?) # => failure
       #
       #   @param [#each] collection The check target.
       #   @param [String] message The additional user message. It is
@@ -1729,6 +1730,81 @@ EOT
       # @since 3.4.3
       alias_method :assert_all?, :assert_all
 
+      # @overload assert_nothing_leaked_memory(max_increasable_size, target=:physical, message=nil, &block)
+      #
+      #   Asserts that increased memory usage by `block.call` is less
+      #   than `max_increasable_size`. `GC.start` is called before and
+      #   after `block.call`.
+      #
+      #   This assertion may be fragile. Because memory usage is
+      #   depends on the current Ruby process's memory
+      #   usage. Launching a new Ruby process for this will produce
+      #   more stable result but we need to specify target code as
+      #   `String` instead of block for the approach. We choose easy
+      #   to write API approach rather than more stable result
+      #   approach for this case.
+      #
+      #   @example Pass pattern
+      #     require "objspace"
+      #     size_per_object = ObjectSpace.memsize_of("Hello")
+      #     # If memory isn't leaked, physical memory of almost created objects
+      #     # (1000 - 10 objects) must be freed.
+      #     assert_nothing_leaked_memory(size_per_object * 10) do
+      #       1_000.times do
+      #         "Hello".dup
+      #       end
+      #     end # => pass
+      #
+      #   @example Failure pattern
+      #     require "objspace"
+      #     size_per_object = ObjectSpace.memsize_of("Hello")
+      #     strings = []
+      #     assert_nothing_leaked_memory(size_per_object * 10) do
+      #       10_000.times do
+      #         # Created objects aren't GC-ed because they are referred.
+      #         strings << "Hello".dup
+      #       end
+      #     end # => failure
+      #
+      #   @param target [:physical, :virtual] which memory usage is
+      #     used for comparing. `:physical` means physical memory usage
+      #     also known as Resident Set Size (RSS). `:virtual` means
+      #     virtual memory usage.
+      #   @yield [] do anything you want to measure memory usage
+      #     in the block.
+      #   @yieldreturn [void]
+      #   @return [void]
+      #
+      # @since 3.4.5
+      def assert_nothing_leaked_memory(max_increasable_size,
+                                       target=:physical,
+                                       message=nil)
+        _wrap_assertion do
+          GC.start
+          before = Util::MemoryUsage.new
+          unless before.collected?
+            omit("memory usage collection isn't supported on this platform")
+          end
+          yield
+          GC.start
+          after = Util::MemoryUsage.new
+          before_value = before.__send__(target)
+          after_value = after.__send__(target)
+          actual_increased_size = after_value - before_value
+          template = <<-TEMPLATE
+<?> was expected to be less than
+<?>.
+          TEMPLATE
+          full_message = build_message(message,
+                                       template,
+                                       actual_increased_size,
+                                       max_increasable_size)
+          assert_block(full_message) do
+            actual_increased_size < max_increasable_size
+          end
+        end
+      end
+
       ##
       # Builds a failure message.  `user_message` is added before the
       # `template` and `arguments` replaces the '?'s positionally in

data/lib/test/unit/autorunner.rb

@@ -1,10 +1,10 @@
 require "English"
+require "optparse"
 
 require "test/unit/color-scheme"
 require "test/unit/priority"
 require "test/unit/attribute-matcher"
 require "test/unit/testcase"
-require "optparse"
 
 module Test
   module Unit
@@ -144,6 +144,7 @@ module Test
       attr_accessor :pattern, :exclude, :base, :workdir
       attr_accessor :color_scheme, :listeners
       attr_writer :stop_on_failure
+      attr_writer :debug_on_failure
       attr_writer :runner, :collector
 
       def initialize(standalone)
@@ -159,6 +160,7 @@ module Test
         @workdir = nil
         @listeners = []
         @stop_on_failure = false
+        @debug_on_failure = false
         config_file = "test-unit.yml"
         if File.exist?(config_file)
           load_config(config_file)
@@ -172,6 +174,10 @@ module Test
         @stop_on_failure
       end
 
+      def debug_on_failure?
+        @debug_on_failure
+      end
+
       def prepare
         PREPARE_HOOKS.each do |handler|
           handler.call(self)
@@ -381,6 +387,12 @@ module Test
             @stop_on_failure = boolean
           end
 
+          o.on("--[no-]debug-on-failure",
+               "Run debugger if available on failure",
+               "(#{AssertionFailedError.debug_on_failure?})") do |boolean|
+            AssertionFailedError.debug_on_failure = boolean
+          end
+
           ADDITIONAL_OPTIONS.each do |option_builder|
             option_builder.call(self, o)
           end

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

@@ -11,6 +11,7 @@ module Test
         def collect(name=NAME)
           suite = TestSuite.new(name)
           add_test_cases(suite, TestCase::DESCENDANTS)
+          adjust_ractor_tests(suite)
           suite
         end
       end

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

@@ -25,9 +25,9 @@ module Test
           basedir = @base
           $:.push(basedir) if basedir
           if(from.empty?)
-            recursive_collect('.', find_test_cases)
+            suite = recursive_collect('.', find_test_cases)
           elsif(from.size == 1)
-            recursive_collect(from.first, find_test_cases)
+            suite = recursive_collect(from.first, find_test_cases)
           else
             suites = []
             from.each do |f|
@@ -38,6 +38,8 @@ module Test
             sort(suites).each{|s| suite << s}
             suite
           end
+          adjust_ractor_tests(suite)
+          suite
         ensure
           $:.delete_at($:.rindex(basedir)) if basedir
         end

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

@@ -60,6 +60,8 @@ module Test
               test_suite = test_suites.first
             end
 
+            adjust_ractor_tests(test_suite)
+
             test_suite
           end
         end

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

@@ -26,6 +26,7 @@ module Test
             end
           end
           sort(sub_suites).each{|s| suite << s}
+          adjust_ractor_tests(suite)
           suite
         end
       end

data/lib/test/unit/collector.rb

@@ -68,6 +68,37 @@ module Test
           suite << sub_suite
         end
       end
+
+      def adjust_ractor_tests(suite)
+        return if suite.nil?
+        ractor_suites = extract_ractor_tests(suite)
+        ractor_suites.each do |ractor_suite|
+          suite << ractor_suite
+        end
+      end
+
+      def extract_ractor_tests(suite)
+        ractor_suites = []
+        ractor_tests = []
+        suite.tests.each do |test|
+          case test
+          when TestSuite
+            ractor_suites.concat(extract_ractor_tests(test))
+          else
+            next unless test[:ractor]
+            ractor_tests << test
+          end
+        end
+        unless ractor_tests.empty?
+          suite.delete_tests(ractor_tests)
+          ractor_suite = TestSuite.new(suite.name, suite.test_case)
+          ractor_tests.each do |ractor_test|
+            ractor_suite << ractor_test
+          end
+          ractor_suites << ractor_suite
+        end
+        ractor_suites
+      end
     end
   end
 end

data/lib/test/unit/testcase.rb

@@ -351,6 +351,36 @@ module Test
           attribute(:description, value, {}, *targets)
         end
 
+        # Declares that the following test uses Ractor.
+        #
+        # Tests that use Ractor are executed at the end. Because multi
+        # 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.
+        #
+        # This is implemented by setting the `:ractor` attribute of
+        # the test to `true`.
+        #
+        # @param options [Hash] See {Attribute::ClassMethods#attribute}
+        #   for details.
+        #
+        # @return [void]
+        #
+        # @example Declares that test_do_something_with_ractor uses Ractor
+        #
+        #   ractor
+        #   def test_do_something_with_ractor
+        #     Ractor.new do
+        #       # ...
+        #     end
+        #   end
+        #
+        # @since 3.4.6
+        def ractor(options={})
+          attribute(:ractor, true, options)
+        end
+
         # Defines a sub test case.
         #
         # This is a syntax sugar. The both of the following codes are
@@ -447,7 +477,7 @@ module Test
         # @private
         @@method_locations = {}
         # @private
-        @@method_location_mutex = Mutex.new
+        @@method_location_mutex = Thread::Mutex.new
 
         # @private
         def method_locations
@@ -821,6 +851,9 @@ module Test
           notify("<#{signature}> was redefined",
                  :backtrace => redefined_info[:backtrace])
         end
+        if self[:ractor] and not defined?(::Ractor)
+          omit("<#{signature}> requires Ractor")
+        end
         if @internal_data.have_test_data?
           test_method = method(@method_name)
           arity = test_method.arity

data/lib/test/unit/testsuite.rb

@@ -77,7 +77,7 @@ module Test
         @tests -= tests
       end
 
-      # Retuns the rolled up number of tests in this suite;
+      # Returns the rolled up number of tests in this suite;
       # i.e. if the suite contains other suites, it counts the
       # tests within those suites, not the suites themselves.
       def size

data/lib/test/unit/util/memory-usage.rb

@@ -0,0 +1,47 @@
+module Test
+  module Unit
+    module Util
+      class MemoryUsage
+        attr_reader :virtual
+        attr_reader :physical
+        def initialize
+          @virtual = nil
+          @physical = nil
+          collect_data
+        end
+
+        def collected?
+          return false if @virtual.nil?
+          return false if @physical.nil?
+          true
+        end
+
+        private
+        def collect_data
+          collect_data_proc
+        end
+
+        def collect_data_proc
+          status_file = "/proc/self/status"
+          return false unless File.exist?(status_file)
+
+          data = File.binread(status_file)
+          data.each_line do |line|
+            case line
+            when /\AVm(Size|RSS):\s*(\d+)\s*kB/
+              name = $1
+              value = Integer($2, 10) * 1024
+              case name
+              when "Size"
+                @virtual = value
+              when "RSS"
+                @physical = value
+              end
+            end
+          end
+          collected?
+        end
+      end
+    end
+  end
+end

data/lib/test/unit/version.rb

@@ -1,5 +1,5 @@
 module Test
   module Unit
-    VERSION = "3.4.4"
+    VERSION = "3.4.8"
   end
 end