minitest 5.25.1 → 5.27.0

data/lib/minitest/test.rb

@@ -1,4 +1,4 @@
-require "minitest" unless defined? Minitest::Runnable
+require_relative "../minitest" unless defined? Minitest::Runnable
 
 module Minitest
   ##
@@ -8,9 +8,9 @@ module Minitest
   # See Minitest::Assertions
 
   class Test < Runnable
-    require "minitest/assertions"
-    include Minitest::Assertions
+    require_relative "assertions"
     include Minitest::Reportable
+    include Minitest::Assertions
 
     def class_name # :nodoc:
       self.class.name # for Minitest::Reportable
@@ -58,6 +58,7 @@ module Minitest
     # tests are awesome.
 
     def self.parallelize_me!
+      return unless Minitest.parallel_executor
       include Minitest::Parallel::Test
       extend Minitest::Parallel::Test::ClassMethods
     end
@@ -234,4 +235,4 @@ module Minitest
   end # Test
 end
 
-require "minitest/unit" if ENV["MT_COMPAT"] # compatibility layer only
+require_relative "unit" if ENV["MT_COMPAT"] # compatibility layer only

data/lib/minitest/test_task.rb

@@ -44,8 +44,16 @@ module Minitest # :nodoc:
     WINDOWS = RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ # :nodoc:
 
     ##
-    # Create several test-oriented tasks under +name+. Takes an
-    # optional block to customize variables.
+    # Create several test-oriented tasks under +name+ (default:
+    # "test"). Takes an optional block to customize variables.
+    # Examples:
+    #
+    #   Minitest::TestTask.create # named "test", all defaults
+    #
+    #   Minitest::TestTask.create do |t|
+    #     t.warning = false # my tests are noisy
+    #     t.framework = %(require_relative "./test/helper.rb")
+    #   end
 
     def self.create name = :test, &block
       task = new name
@@ -69,9 +77,18 @@ module Minitest # :nodoc:
 
     ##
     # The code to load the framework. Defaults to requiring
-    # minitest/autorun...
+    # minitest/autorun.
+    #
+    # If you have a test helper file that requires minitest/autorun
+    # and anything else your project standardizes on, then you'll
+    # probably want to change this to:
+    #
+    #   Minitest::TestTask.create do |t|
+    #     t.framework = %(require_relative "./test/helper.rb")
+    #   end
     #
-    # Why do I have this as an option?
+    # or something similar. NOTE: if you do this, then helper must
+    # require "minitest/autorun" at the top to start the tests.
 
     attr_accessor :framework
 
@@ -100,6 +117,11 @@ module Minitest # :nodoc:
 
     ##
     # Optional: Additional ruby to run before the test framework is loaded.
+    # Example:
+    #
+    #   Minitest::TestTask.create "test:cov" do |t|
+    #     t.test_prelude = %(require "simplecov")
+    #   end
 
     attr_accessor :test_prelude
 
@@ -281,13 +303,8 @@ module Minitest # :nodoc:
 end
 
 class Work < Queue # :nodoc:
-  def initialize jobs = [] # :nodoc:
-    super()
-
-    jobs.each do |job|
-      self << job
-    end
-
+  def initialize jobs # :nodoc:
+    super
     close
   end
 end

data/lib/minitest/unit.rb

@@ -11,7 +11,7 @@ unless defined?(Minitest) then
   module Minitest # :nodoc:
   end
   MiniTest = Minitest # :nodoc: # prevents minitest.rb from requiring back to us
-  require "minitest"
+  require_relative "../minitest"
 end
 
 MiniTest = Minitest unless defined?(MiniTest)

data/lib/minitest.rb

@@ -6,10 +6,11 @@ require_relative "minitest/parallel"
 require_relative "minitest/compress"
 
 ##
-# :include: README.rdoc
+# The top-level namespace for Minitest. Also the location of the main
+# runtime. See +Minitest.run+ for more information.
 
 module Minitest
-  VERSION = "5.25.1" # :nodoc:
+  VERSION = "5.26.2" # :nodoc:
 
   @@installed_at_exit ||= false
   @@after_run = []
@@ -35,7 +36,7 @@ module Minitest
   warn "DEPRECATED: use MT_CPU instead of N for parallel test runs" if ENV["N"] && ENV["N"].to_i > 0
   n_threads = (ENV["MT_CPU"] || ENV["N"] || Etc.nprocessors).to_i
 
-  self.parallel_executor = Parallel::Executor.new n_threads
+  self.parallel_executor = Parallel::Executor.new n_threads if n_threads > 1
 
   ##
   # Filter object for backtraces.
@@ -67,8 +68,7 @@ module Minitest
   # Registers Minitest to run at process exit
 
   def self.autorun
-    Warning[:deprecated] = true if
-      Object.const_defined?(:Warning) && Warning.respond_to?(:[]=)
+    Warning[:deprecated] = true
 
     at_exit {
       next if $! and not ($!.kind_of? SystemExit and $!.success?)
@@ -146,26 +146,32 @@ module Minitest
     orig_args = args.dup
 
     OptionParser.new do |opts|
-      opts.banner  = "minitest options:"
+      opts.program_name = "minitest"
       opts.version = Minitest::VERSION
 
+      opts.banner = [
+        "Usage: rake test [A=options]        (see Minitest::TestTask for more options)",
+        "minitest [paths] [options]   (with minitest-sprint gem)",
+        "ruby path/to/test.rb [options]\n\n",
+      ].join "\n   or: "
+
       opts.on "-h", "--help", "Display this help." do
         puts opts
         exit
       end
 
-      opts.on "--no-plugins", "Bypass minitest plugin auto-loading (or set $MT_NO_PLUGINS)."
+      opts.on "--no-plugins", "Bypass minitest plugin auto-loading (or env: MT_NO_PLUGINS=1)."
 
-      desc = "Sets random seed. Also via env. Eg: SEED=n rake"
+      desc = "Sets random seed. Also via env, eg: SEED=42"
       opts.on "-s", "--seed SEED", Integer, desc do |m|
-        options[:seed] = m.to_i
+        options[:seed] = m
       end
 
-      opts.on "-v", "--verbose", "Verbose. Show progress processing files." do
+      opts.on "-v", "--verbose", "Verbose. Print each name as they run." do
         options[:verbose] = true
       end
 
-      opts.on "-q", "--quiet", "Quiet. Show no progress processing files." do
+      opts.on "-q", "--quiet", "Quiet. Show no dots while processing files." do
         options[:quiet] = true
       end
 
@@ -173,7 +179,7 @@ module Minitest
         options[:show_skips] = true
       end
 
-      opts.on "-n", "--name PATTERN", "Filter run on /regexp/ or string." do |a|
+      opts.on "-n", "--name PATTERN", "Include /regexp/ or string for run." do |a|
         options[:filter] = a
       end
 
@@ -181,21 +187,28 @@ module Minitest
         options[:exclude] = a
       end
 
+      # part of my unofficial embedded gem "makeoptparseworkwell"
+      def opts.topdict(name)   = (name.length > 1 ? top.long : top.short)
+      def opts.alias(from, to) = (dict = topdict(from) ; dict[to] = dict[from])
+
+      # these will work but won't show up in --help output:
+      opts.alias "name", "include"
+      opts.alias "n",    "i"
+      opts.alias "e",    "x"
+
       opts.on "-S", "--skip CODES", String, "Skip reporting of certain types of results (eg E)." do |s|
         options[:skip] = s.chars.to_a
       end
 
-      ruby27plus = ::Warning.respond_to? :[]=
-
       opts.on "-W[error]", String, "Turn Ruby warnings into errors" do |s|
         options[:Werror] = true
         case s
         when "error", "all", nil then
-          require "minitest/error_on_warning"
+          require_relative "minitest/error_on_warning"
           $VERBOSE = true
-          ::Warning[:deprecated] = true if ruby27plus
+          ::Warning[:deprecated] = true
         else
-          ::Warning[s.to_sym] = true if ruby27plus # check validity of category
+          ::Warning[s.to_sym] = true # check validity of category
         end
       end
 
@@ -258,12 +271,13 @@ module Minitest
   #       Minitest.process_args
   #       Minitest.init_plugins
   #       Minitest.__run(reporter, options)
-  #         Runnable.runnables.each
+  #         Runnable.runnables.each |runnable_klass|
   #           runnable_klass.run(reporter, options)
-  #             self.runnable_methods.each
-  #               self.run_one_method(self, runnable_method, reporter)
-  #                 Minitest.run_one_method(klass, runnable_method)
-  #                   klass.new(runnable_method).run
+  #             filtered_methods = runnable_methods.select {...}.reject {...}
+  #             filtered_methods.each |runnable_method|
+  #               runnable_klass.run_one_method(self, runnable_method, reporter)
+  #                 Minitest.run_one_method(runnable_klass, runnable_method)
+  #                   runnable_klass.new(runnable_method).run
 
   def self.run args = []
     self.load_plugins unless args.delete("--no-plugins") || ENV["MT_NO_PLUGINS"]
@@ -285,18 +299,19 @@ module Minitest
     reporter.start
     begin
       __run reporter, options
+      finished = true
     rescue Interrupt
       warn "Interrupted. Exiting..."
     end
-    self.parallel_executor.shutdown
+    self.parallel_executor.shutdown if parallel_executor.respond_to? :shutdown
 
     # might have been removed/replaced during init_plugins:
     summary = reporter.reporters.grep(SummaryReporter).first
 
     reporter.report
 
-    return empty_run! options if summary && summary.count == 0
-    reporter.passed?
+    return empty_run! options if finished && summary && summary.count == 0
+    finished and reporter.passed?
   end
 
   def self.empty_run! options # :nodoc:
@@ -408,6 +423,7 @@ module Minitest
       pos = Regexp.new $1 if pos.kind_of?(String) && pos =~ %r%/(.*)/%
       neg = Regexp.new $1 if neg.kind_of?(String) && neg =~ %r%/(.*)/%
 
+      # at most 1-2% slower than a 1-pass version, stop optimizing this
       filtered_methods = self.runnable_methods
         .select { |m| !pos ||  pos === m || pos === "#{self}##{m}"  }
         .reject { |m|  neg && (neg === m || neg === "#{self}##{m}") }
@@ -571,7 +587,7 @@ module Minitest
     def skipped?
       raise NotImplementedError, "subclass responsibility"
     end
-  end
+  end # Runnable
 
   ##
   # Shared code for anything that can get passed to a Reporter. See
@@ -623,7 +639,7 @@ module Minitest
     def error?
       self.failures.any? UnexpectedError
     end
-  end
+  end # Reportable
 
   ##
   # This represents a test result in a clean way that can be
@@ -677,7 +693,7 @@ module Minitest
         "#{failure.result_label}:\n#{self.location}:\n#{failure.message}\n"
       }.join "\n"
     end
-  end
+  end # Result
 
   ##
   # Defines the API for Reporters. Subclass this and override whatever
@@ -727,7 +743,7 @@ module Minitest
     def synchronize &block # :nodoc:
       @mutex.synchronize(&block)
     end
-  end
+  end # AbstractReportera
 
   class Reporter < AbstractReporter # :nodoc:
     ##
@@ -882,7 +898,7 @@ module Minitest
       self.warnings   = aggregate[UnexpectedWarning].size
       self.skips      = aggregate[Skip].size
     end
-  end
+  end # StatisticsReporter
 
   ##
   # A reporter that prints the header, summary, and failure details at
@@ -960,7 +976,7 @@ module Minitest
       "%d runs, %d assertions, %d failures, %d errors, %d skips%s" %
         [count, assertions, failures, errors, skips, extra.join]
     end
-  end
+  end # SummaryReporter
 
   ##
   # Dispatch to multiple reporters as one.
@@ -1011,7 +1027,7 @@ module Minitest
     def report # :nodoc:
       self.reporters.each(&:report)
     end
-  end
+  end # CompositeReporter
 
   ##
   # Represents run failures.
@@ -1078,7 +1094,7 @@ module Minitest
       self.error.backtrace
     end
 
-    BASE_RE = %r%#{Dir.pwd}/% # :nodoc:
+    BASE_RE = %r%#{Regexp.escape Dir.pwd}/% # :nodoc:
 
     def message # :nodoc:
       bt = Minitest.filter_backtrace(self.backtrace).join("\n    ")
@@ -1231,4 +1247,4 @@ module Minitest
   # :startdoc:
 end
 
-require "minitest/test"
+require_relative "minitest/test"

data/test/minitest/test_minitest_assertions.rb

@@ -142,8 +142,7 @@ class TestMinitestAssertions < Minitest::Test
     exp[1] = Object.new
     act[1] = Object.new
     act_obj = act[1]
-    # TODO: switch to endless when 2.7 is dropped
-    act_obj.define_singleton_method(:inspect) { "#<Object:0xXXXXXX>" }
+    def act_obj.inspect = "#<Object:0xXXXXXX>"
     msg = <<~EOM.chomp % [act]
            No visible difference in the Hash#inspect output.
            You should look at the implementation of #== on Hash or its members.
@@ -292,7 +291,7 @@ class TestMinitestAssertions < Minitest::Test
         @tc.assert_equal nil, nil
       end
     else
-      err_re = /Use assert_nil if expecting nil from .*test_minitest_\w+.rb/
+      err_re = /.*?test_minitest_\w+.rb:\d+: warning: DEPRECATED: Use assert_nil if expecting nil. This will fail in Minitest 6./
       err_re = "" if $-w.nil?
 
       assert_deprecation err_re do
@@ -318,13 +317,13 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_assert_equal_string_both_escaped_unescaped_newlines
-    msg = <<~EOM
+    msg = <<~'EOM' # NOTE: single quotes on heredoc
           --- expected
           +++ actual
           @@ -1,2 +1 @@
-          -"A\\n
+          -"A\n
           -B"
-          +"A\\n\\\\nB"
+          +"A\n\\nB"
           EOM
 
     assert_triggered msg do
@@ -1074,48 +1073,24 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_assert_pattern
-    if RUBY_VERSION > "3" then
-      @tc.assert_pattern do
-        exp = if RUBY_VERSION.start_with? "3.0"
-                "(eval):1: warning: One-line pattern matching is experimental, and the behavior may change in future versions of Ruby!\n"
-              else
-                ""
-              end
-        assert_output nil, exp do
-          eval "[1,2,3] => [Integer, Integer, Integer]" # eval to escape parser for ruby<3
-        end
-      end
-    else
-      @assertion_count = 0
-
-      assert_raises NotImplementedError do
-        @tc.assert_pattern do
-          # do nothing
-        end
+    @tc.assert_pattern do
+      assert_output nil, "" do
+        [1,2,3] => [Integer, Integer, Integer]
       end
     end
   end
 
   def test_assert_pattern_traps_nomatchingpatternerror
-    skip unless RUBY_VERSION > "3"
-    exp = if RUBY_VERSION.start_with? "3.0" then
-            "[1, 2, 3]" # terrible error message!
-          else
-            /length mismatch/
-          end
+    exp = /length mismatch/
 
     assert_triggered exp do
       @tc.assert_pattern do
-        capture_io do # 3.0 is noisy
-          eval "[1,2,3] => [Integer, Integer]" # eval to escape parser for ruby<3
-        end
+        [1,2,3] => [Integer, Integer]
       end
     end
   end
 
   def test_assert_pattern_raises_other_exceptions
-    skip unless RUBY_VERSION >= "3.0"
-
     @assertion_count = 0
 
     assert_raises RuntimeError do
@@ -1126,8 +1101,6 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_assert_pattern_with_no_block
-    skip unless RUBY_VERSION >= "3.0"
-
     assert_triggered "assert_pattern requires a block to capture errors." do
       @tc.assert_pattern
     end
@@ -1280,12 +1253,16 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_refute_in_epsilon_triggered
-    assert_triggered "Expected |10000 - 9990| (10) to not be <= 10.0." do
-      @tc.refute_in_epsilon 10_000, 9990
+    assert_triggered "Expected |10000 - 9991| (9) to not be <= 9.991." do
+      @tc.refute_in_epsilon 10_000, 9991
       flunk
     end
   end
 
+  def test_refute_in_epsilon_minimum
+    @tc.refute_in_epsilon 10_000, 9990
+  end
+
   def test_refute_includes
     @assertion_count = 2
 
@@ -1382,38 +1359,20 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_refute_pattern
-    if RUBY_VERSION >= "3.0"
-      @tc.refute_pattern do
-        capture_io do # 3.0 is noisy
-          eval "[1,2,3] => [Integer, Integer, String]"
-        end
-      end
-    else
-      @assertion_count = 0
-
-      assert_raises NotImplementedError do
-        @tc.refute_pattern do
-          eval "[1,2,3] => [Integer, Integer, String]"
-        end
-      end
+    @tc.refute_pattern do
+      [1,2,3] => [Integer, Integer, String]
     end
   end
 
   def test_refute_pattern_expects_nomatchingpatternerror
-    skip unless RUBY_VERSION > "3"
-
     assert_triggered(/NoMatchingPatternError expected, but nothing was raised./) do
       @tc.refute_pattern do
-        capture_io do # 3.0 is noisy
-          eval "[1,2,3] => [Integer, Integer, Integer]"
-        end
+        [1,2,3] => [Integer, Integer, Integer]
       end
     end
   end
 
   def test_refute_pattern_raises_other_exceptions
-    skip unless RUBY_VERSION >= "3.0"
-
     @assertion_count = 0
 
     assert_raises RuntimeError do
@@ -1424,8 +1383,6 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_refute_pattern_with_no_block
-    skip unless RUBY_VERSION >= "3.0"
-
     assert_triggered "refute_pattern requires a block to capture errors." do
       @tc.refute_pattern
     end

data/test/minitest/test_minitest_mock.rb

@@ -26,7 +26,7 @@ class TestMinitestMock < Minitest::Test
   def test_blow_up_if_not_called
     @mock.foo
 
-    util_verify_bad "expected meaning_of_life() => 42"
+    util_verify_bad "Expected meaning_of_life() => 42"
   end
 
   def test_not_blow_up_if_everything_called
@@ -46,7 +46,7 @@ class TestMinitestMock < Minitest::Test
     @mock.meaning_of_life
     @mock.expect :bar, true
 
-    util_verify_bad "expected bar() => true"
+    util_verify_bad "Expected bar() => true"
   end
 
   def test_blow_up_on_wrong_number_of_arguments
@@ -184,6 +184,73 @@ class TestMinitestMock < Minitest::Test
     assert @mock == 1, "didn't mock :=="
   end
 
+  def test_assert_mock__pass
+    mock = Minitest::Mock.new
+    mock.expect :loose_expectation, true, [Integer]
+    mock.loose_expectation 1
+
+    result = assert_mock mock
+
+    assert_equal true, result
+  end
+
+  def assert_bad_mock klass, msg
+    mock = Minitest::Mock.new
+    mock.expect :foo, nil, [:bar]
+    mock.expect :foo, nil, [:baz]
+
+    mock.foo :bar
+
+    e = assert_raises klass do
+      yield mock
+    end
+
+    assert_equal msg, e.message
+  end
+
+  def test_verify__error
+    exp = "Expected foo(:baz) => nil, got [foo(:bar) => nil]"
+    assert_bad_mock MockExpectationError, exp do |mock|
+      mock.verify
+    end
+  end
+
+  def test_assert_mock__fail
+    exp = "Expected foo(:baz) => nil, got [foo(:bar) => nil]."
+    assert_bad_mock Minitest::Assertion, exp do |mock|
+      assert_mock mock
+    end
+  end
+
+  def test_assert_mock__fail_msg
+    exp = "BLAH.\nExpected foo(:baz) => nil, got [foo(:bar) => nil]."
+    assert_bad_mock Minitest::Assertion, exp do |mock|
+      assert_mock mock, "BLAH"
+    end
+  end
+
+  def test_assert_mock__fail_exp
+    exp = "Expected foo(:baz) => nil, got [foo(:bar) => nil]."
+    assert_bad_mock Minitest::Assertion, exp do |mock|
+      describe "X" do
+        it "y" do
+          _(mock).must_verify
+        end
+      end.new(:blah).send(:test_0001_y)
+    end
+  end
+
+  def test_assert_mock__fail_exp_msg
+    exp = "BLAH.\nExpected foo(:baz) => nil, got [foo(:bar) => nil]."
+    assert_bad_mock Minitest::Assertion, exp do |mock|
+      describe "X" do
+        it "y" do
+          _(mock).must_verify "BLAH"
+        end
+      end.new(:blah).send(:test_0001_y)
+    end
+  end
+
   def test_verify_allows_called_args_to_be_loosely_specified
     mock = Minitest::Mock.new
     mock.expect :loose_expectation, true, [Integer]
@@ -238,7 +305,7 @@ class TestMinitestMock < Minitest::Test
 
     e = assert_raises(MockExpectationError) { mock.verify }
 
-    exp = "expected foo(:baz) => nil, got [foo(:bar) => nil]"
+    exp = "Expected foo(:baz) => nil, got [foo(:bar) => nil]"
 
     assert_equal exp, e.message
   end
@@ -252,7 +319,7 @@ class TestMinitestMock < Minitest::Test
 
     e = assert_raises(MockExpectationError) { mock.verify }
 
-    exp = "expected foo(:bar) => nil, got [foo(:bar) => nil]"
+    exp = "Expected foo(:bar) => nil, got [foo(:bar) => nil]"
 
     assert_equal exp, e.message
   end
@@ -276,7 +343,7 @@ class TestMinitestMock < Minitest::Test
 
     e = assert_raises(MockExpectationError) { mock.verify }
 
-    exp = "expected foo(%p) => nil, got [foo(%p) => nil]" \
+    exp = "Expected foo(%p) => nil, got [foo(%p) => nil]" \
       % [{ :kw => false }, { :kw => true  }]
 
     assert_equal exp.delete("{}"), e.message
@@ -301,11 +368,7 @@ class TestMinitestMock < Minitest::Test
     end
 
     assert_silent do
-      if RUBY_VERSION > "3" then
-        mock.foo arg1, arg2, arg3
-      else
-        mock.foo arg1, arg2, **arg3 # oddity just for ruby 2.7
-      end
+      mock.foo arg1, arg2, arg3
     end
 
     assert_mock mock
@@ -334,8 +397,8 @@ class TestMinitestMock < Minitest::Test
       mock.foo k1: arg1, k2: arg2
     end
 
-    # basically testing ruby ... need ? for ruby < 2.7 :(
-    assert_match(/missing keyword: :?k3/, e.message)
+    # basically testing ruby
+    assert_match(/missing keyword: :k3/, e.message)
   end
 
   def test_mock_block_is_passed_keyword_args__block_bad_extra
@@ -349,8 +412,7 @@ class TestMinitestMock < Minitest::Test
       mock.foo k1: arg1, k2: arg2, k3: arg3
     end
 
-    # basically testing ruby ... need ? for ruby < 2.7 :(
-    assert_match(/unknown keyword: :?k3/, e.message)
+    assert_match(/unknown keyword: :k3/, e.message)
   end
 
   def test_mock_block_is_passed_keyword_args__block_bad_value
@@ -589,7 +651,7 @@ class TestMinitestMock < Minitest::Test
 
 end
 
-require "minitest/metametameta"
+require_relative "metametameta"
 
 class TestMinitestStub < Minitest::Test
   # Do not parallelize since we're calling stub on class methods