minitest 5.18.1 → 5.23.1

data/lib/minitest.rb

@@ -1,15 +1,15 @@
 require "optparse"
-require "thread"
-require "mutex_m"
-require "minitest/parallel"
 require "stringio"
 require "etc"
 
+require_relative "minitest/parallel"
+require_relative "minitest/compress"
+
 ##
 # :include: README.rdoc
 
 module Minitest
-  VERSION = "5.18.1" # :nodoc:
+  VERSION = "5.23.1" # :nodoc:
 
   @@installed_at_exit ||= false
   @@after_run = []
@@ -60,6 +60,9 @@ module Minitest
   cattr_accessor :info_signal
   self.info_signal = "INFO"
 
+  cattr_accessor :allow_fork
+  self.allow_fork = false
+
   ##
   # Registers Minitest to run at process exit
 
@@ -75,7 +78,7 @@ module Minitest
 
       pid = Process.pid
       at_exit {
-        next if Process.pid != pid
+        next if !Minitest.allow_fork && Process.pid != pid
         @@after_run.reverse_each(&:call)
         exit exit_code || false
       }
@@ -131,7 +134,7 @@ module Minitest
   #     Minitest.run(args)
   #       Minitest.__run(reporter, options)
   #         Runnable.runnables.each
-  #           runnable.run(reporter, options)
+  #           runnable_klass.run(reporter, options)
   #             self.runnable_methods.each
   #               self.run_one_method(self, runnable_method, reporter)
   #                 Minitest.run_one_method(klass, runnable_method)
@@ -147,7 +150,7 @@ module Minitest
 
     reporter = CompositeReporter.new
     reporter << SummaryReporter.new(options[:io], options)
-    reporter << ProgressReporter.new(options[:io], options)
+    reporter << ProgressReporter.new(options[:io], options) unless options[:quiet]
 
     self.reporter = reporter # this makes it available to plugins
     self.init_plugins options
@@ -161,11 +164,32 @@ module Minitest
       warn "Interrupted. Exiting..."
     end
     self.parallel_executor.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?
   end
 
+  def self.empty_run! options # :nodoc:
+    filter = options[:filter]
+    return true unless filter # no filter, but nothing ran == success
+
+    warn "Nothing ran for filter: %s" % [filter]
+
+    require "did_you_mean" # soft dependency, punt if it doesn't load
+
+    ms = Runnable.runnables.flat_map(&:runnable_methods)
+    cs = DidYouMean::SpellChecker.new(dictionary: ms).correct filter
+
+    warn DidYouMean::Formatter.message_for cs unless cs.empty?
+  rescue LoadError
+    # do nothing
+  end
+
   ##
   # Internal run method. Responsible for telling all Runnable
   # sub-classes to run.
@@ -209,6 +233,10 @@ module Minitest
         options[:verbose] = true
       end
 
+      opts.on "-q", "--quiet", "Quiet. Show no progress processing files." do
+        options[:quiet] = true
+      end
+
       opts.on "--show-skips", "Show skipped at the end of run." do
         options[:show_skips] = true
       end
@@ -225,6 +253,20 @@ module Minitest
         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"
+          $VERBOSE = true
+          ::Warning[:deprecated] = true if ruby27plus
+        else
+          ::Warning[s.to_sym] = true if ruby27plus # check validity of category
+        end
+      end
+
       unless extensions.empty?
         opts.separator ""
         opts.separator "Known extensions: #{extensions.join(", ")}"
@@ -331,25 +373,15 @@ module Minitest
     # reporter to record.
 
     def self.run reporter, options = {}
-      filtered_methods = if options[:filter]
-        filter = options[:filter]
-        filter = Regexp.new $1 if filter.is_a?(String) && filter =~ %r%/(.*)/%
-
-        self.runnable_methods.find_all { |m|
-          filter === m || filter === "#{self}##{m}"
-        }
-      else
-        self.runnable_methods
-      end
+      pos = options[:filter]
+      neg = options[:exclude]
 
-      if options[:exclude]
-        exclude = options[:exclude]
-        exclude = Regexp.new $1 if exclude =~ %r%/(.*)/%
+      pos = Regexp.new $1 if pos.is_a?(String) && pos =~ %r%/(.*)/%
+      neg = Regexp.new $1 if neg.is_a?(String) && neg =~ %r%/(.*)/%
 
-        filtered_methods.delete_if { |m|
-          exclude === m || exclude === "#{self}##{m}"
-        }
-      end
+      filtered_methods = self.runnable_methods
+        .select { |m| !pos ||  pos === m || pos === "#{self}##{m}"  }
+        .reject { |m|  neg && (neg === m || neg === "#{self}##{m}") }
 
       return if filtered_methods.empty?
 
@@ -446,6 +478,31 @@ module Minitest
       self.name       = name
       self.failures   = []
       self.assertions = 0
+      # lazy initializer for metadata
+    end
+
+    ##
+    # Metadata you attach to the test results that get sent to the reporter.
+    #
+    # Lazily initializes to a hash, to keep memory down.
+    #
+    # NOTE: this data *must* be plain (read: marshal-able) data!
+    # Hashes! Arrays! Strings!
+
+    def metadata
+      @metadata ||= {}
+    end
+
+    ##
+    # Sets metadata, mainly used for +Result.from+.
+
+    attr_writer :metadata
+
+    ##
+    # Returns true if metadata exists.
+
+    def metadata?
+      defined? @metadata
     end
 
     ##
@@ -497,12 +554,14 @@ module Minitest
       not self.failure
     end
 
+    BASE_DIR = "#{Dir.pwd}/" # :nodoc:
+
     ##
     # The location identifier of this test. Depends on a method
     # existing called class_name.
 
     def location
-      loc = " [#{self.failure.location}]" unless passed? or error?
+      loc = " [#{self.failure.location.delete_prefix BASE_DIR}]" unless passed? or error?
       "#{self.class_name}##{self.name}#{loc}"
     end
 
@@ -566,6 +625,7 @@ module Minitest
       r.assertions = o.assertions
       r.failures   = o.failures.dup
       r.time       = o.time
+      r.metadata   = o.metadata if o.metadata?
 
       r.source_location = o.method(o.name).source_location rescue ["unknown", -1]
 
@@ -590,7 +650,10 @@ module Minitest
   # you want. Go nuts.
 
   class AbstractReporter
-    include Mutex_m
+
+    def initialize # :nodoc:
+      @mutex = Mutex.new
+    end
 
     ##
     # Starts reporting on the run.
@@ -626,6 +689,10 @@ module Minitest
     def passed?
       true
     end
+
+    def synchronize(&block) # :nodoc:
+      @mutex.synchronize(&block)
+    end
   end
 
   class Reporter < AbstractReporter # :nodoc:
@@ -729,6 +796,11 @@ module Minitest
 
     attr_accessor :errors
 
+    ##
+    # Total number of tests that warned.
+
+    attr_accessor :warnings
+
     ##
     # Total number of tests that where skipped.
 
@@ -744,6 +816,7 @@ module Minitest
       self.total_time = nil
       self.failures   = nil
       self.errors     = nil
+      self.warnings   = nil
       self.skips      = nil
     end
 
@@ -772,6 +845,7 @@ module Minitest
       self.total_time = Minitest.clock_time - start_time
       self.failures   = aggregate[Assertion].size
       self.errors     = aggregate[UnexpectedError].size
+      self.warnings   = aggregate[UnexpectedWarning].size
       self.skips      = aggregate[Skip].size
     end
   end
@@ -799,7 +873,7 @@ module Minitest
       io.puts "# Running:"
       io.puts
 
-      self.sync = io.respond_to? :"sync=" # stupid emacs
+      self.sync = io.respond_to? :"sync="
       self.old_sync, io.sync = io.sync, true if self.sync
     end
 
@@ -847,6 +921,8 @@ module Minitest
         results.any?(&:skipped?) unless
         options[:verbose] or options[:show_skips] or ENV["MT_NO_SKIP_MSG"]
 
+      extra.prepend ", %d warnings" % [warnings] if options[:Werror]
+
       "%d runs, %d assertions, %d failures, %d errors, %d skips%s" %
         [count, assertions, failures, errors, skips, extra]
     end
@@ -907,6 +983,8 @@ module Minitest
   # Represents run failures.
 
   class Assertion < Exception
+    RE = /in [`'](?:[^']+[#.])?(?:assert|refute|flunk|pass|fail|raise|must|wont)/ # :nodoc:
+
     def error # :nodoc:
       self
     end
@@ -915,12 +993,11 @@ module Minitest
     # Where was this run before an assertion was raised?
 
     def location
-      last_before_assertion = ""
-      self.backtrace.reverse_each do |s|
-        break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
-        last_before_assertion = s
-      end
-      last_before_assertion.sub(/:in .*$/, "")
+      bt  = Minitest.filter_backtrace self.backtrace
+      idx = bt.rindex { |s| s.match? RE } || -1 # fall back to first item
+      loc = bt[idx+1] || bt.last || "unknown:-1"
+
+      loc.sub(/:in .*$/, "")
     end
 
     def result_code # :nodoc:
@@ -945,11 +1022,21 @@ module Minitest
   # Assertion wrapping an unexpected error that was raised during a run.
 
   class UnexpectedError < Assertion
+    include Minitest::Compress
+
     # TODO: figure out how to use `cause` instead
     attr_accessor :error # :nodoc:
 
     def initialize error # :nodoc:
       super "Unexpected exception"
+
+      if SystemStackError === error then
+        bt = error.backtrace
+        new_bt = compress bt
+        error = error.exception "#{bt.size} -> #{new_bt.size}"
+        error.set_backtrace new_bt
+      end
+
       self.error = error
     end
 
@@ -957,8 +1044,11 @@ module Minitest
       self.error.backtrace
     end
 
+    BASE_RE = %r%#{Dir.pwd}/% # :nodoc:
+
     def message # :nodoc:
-      bt = Minitest.filter_backtrace(self.backtrace).join "\n    "
+      bt = Minitest.filter_backtrace(self.backtrace).join("\n    ")
+        .gsub(BASE_RE, "")
       "#{self.error.class}: #{self.error.message}\n    #{bt}"
     end
 
@@ -967,6 +1057,15 @@ module Minitest
     end
   end
 
+  ##
+  # Assertion raised on warning when running in -Werror mode.
+
+  class UnexpectedWarning < Assertion
+    def result_label # :nodoc:
+      "Warning"
+    end
+  end
+
   ##
   # Provides a simple set of guards that you can use in your tests
   # to skip execution if it is not applicable. These methods are
@@ -1040,7 +1139,13 @@ module Minitest
 
   class BacktraceFilter
 
-    MT_RE = %r%lib/minitest% #:nodoc:
+    MT_RE = %r%lib/minitest|internal:warning% #:nodoc:
+
+    attr_accessor :regexp
+
+    def initialize regexp = MT_RE
+      self.regexp = regexp
+    end
 
     ##
     # Filter +bt+ to something useful. Returns the whole thing if
@@ -1051,9 +1156,9 @@ module Minitest
 
       return bt.dup if $DEBUG || ENV["MT_DEBUG"]
 
-      new_bt = bt.take_while { |line| line !~ MT_RE }
-      new_bt = bt.select     { |line| line !~ MT_RE } if new_bt.empty?
-      new_bt = bt.dup                                 if new_bt.empty?
+      new_bt = bt.take_while { |line| line.to_s !~ regexp }
+      new_bt = bt.select     { |line| line.to_s !~ regexp } if new_bt.empty?
+      new_bt = bt.dup                                       if new_bt.empty?
 
       new_bt
     end

data/test/minitest/metametameta.rb

@@ -8,24 +8,36 @@ class Minitest::Test
   end
 
   def with_empty_backtrace_filter
-    original = Minitest.backtrace_filter
-
-    obj = Minitest::BacktraceFilter.new
-    def obj.filter _bt
-      []
+    with_backtrace_filter Minitest::BacktraceFilter.new %r%.% do
+      yield
     end
+  end
+
+  def with_backtrace_filter filter
+    original = Minitest.backtrace_filter
 
     Minitest::Test.io_lock.synchronize do # try not to trounce in parallel
       begin
-        Minitest.backtrace_filter = obj
+        Minitest.backtrace_filter = filter
         yield
       ensure
         Minitest.backtrace_filter = original
       end
     end
   end
-end
 
+  def error_on_warn?
+    defined?(Minitest::ErrorOnWarning)
+  end
+
+  def assert_deprecation re = /DEPRECATED/
+    assert_output "", re do
+      yield
+    end
+  rescue Minitest::UnexpectedWarning => e # raised if -Werror was used
+    assert_match re, e.message
+  end
+end
 
 class FakeNamedTest < Minitest::Test
   @@count = 0
@@ -55,7 +67,7 @@ class MetaMetaMetaTestCase < Minitest::Test
   def run_tu_with_fresh_reporter flags = %w[--seed 42]
     options = Minitest.process_args flags
 
-    @output = StringIO.new("".encode('UTF-8'))
+    @output = StringIO.new("".encode(Encoding::UTF_8))
 
     self.reporter = Minitest::CompositeReporter.new
     reporter << Minitest::SummaryReporter.new(@output, options)
@@ -105,15 +117,20 @@ class MetaMetaMetaTestCase < Minitest::Test
     output.gsub!(/0x[A-Fa-f0-9]+/, "0xXXX")
     output.gsub!(/ +$/, "")
 
+    file = ->(s) { s.start_with?("/") ? "FULLFILE" : "FILE" }
+
     if windows? then
       output.gsub!(/\[(?:[A-Za-z]:)?[^\]:]+:\d+\]/, "[FILE:LINE]")
-      output.gsub!(/^(\s+)(?:[A-Za-z]:)?[^:]+:\d+:in/, '\1FILE:LINE:in')
+      output.gsub!(/^(\s+)(?:[A-Za-z]:)?[^:]+:\d+:in [`']/, '\1FILE:LINE:in \'')
     else
-      output.gsub!(/\[[^\]:]+:\d+\]/, "[FILE:LINE]")
-      output.gsub!(/^(\s+)[^:]+:\d+:in/, '\1FILE:LINE:in')
+      output.gsub!(/\[([^\]:]+):\d+\]/)         {     "[#{file[$1]}:LINE]"   }
+      output.gsub!(/^(\s+)([^:]+):\d+:in [`']/) { "#{$1}#{file[$2]}:LINE:in '" }
     end
 
-    output.gsub!(/( at )[^:]+:\d+/, '\1[FILE:LINE]')
+    output.gsub!(/in [`']block in (?:([^']+)[#.])?/, "in 'block in")
+    output.gsub!(/in [`'](?:([^']+)[#.])?/, "in '")
+
+    output.gsub!(/( at )[^:]+:\d+/) { "#{$1}[#{file[$2]}:LINE]" } # eval?
 
     output
   end

data/test/minitest/test_minitest_assertions.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 require "minitest/autorun"
+require_relative "metametameta"
 
 if defined? Encoding then
   e = Encoding.default_external
@@ -33,7 +34,6 @@ class TestMinitestAssertions < Minitest::Test
 
   class DummyTest
     include Minitest::Assertions
-    # include Minitest::Reportable # TODO: why do I really need this?
 
     attr_accessor :assertions, :failure
 
@@ -58,15 +58,6 @@ class TestMinitestAssertions < Minitest::Test
                  "expected #{@assertion_count} assertions to be fired during the test, not #{@tc.assertions}")
   end
 
-  def assert_deprecated name
-    dep = /DEPRECATED: #{name}. From #{__FILE__}:\d+(?::.*)?/
-    dep = "" if $-w.nil?
-
-    assert_output nil, dep do
-      yield
-    end
-  end
-
   def assert_triggered expected, klass = Minitest::Assertion
     e = assert_raises klass do
       yield
@@ -301,7 +292,7 @@ class TestMinitestAssertions < Minitest::Test
       err_re = /Use assert_nil if expecting nil from .*test_minitest_\w+.rb/
       err_re = "" if $-w.nil?
 
-      assert_output "", err_re do
+      assert_deprecation err_re do
         @tc.assert_equal nil, nil
       end
     end
@@ -379,7 +370,7 @@ class TestMinitestAssertions < Minitest::Test
           EOM
 
     assert_triggered msg do
-      x = "bad-utf8-\xF1.txt".force_encoding "ASCII"
+      x = "bad-utf8-\xF1.txt".dup.force_encoding Encoding::ASCII
       y = x.dup.force_encoding "binary" # TODO: switch to .b when 1.9 dropped
       @tc.assert_equal x, y
     end
@@ -762,12 +753,13 @@ class TestMinitestAssertions < Minitest::Test
       Class: <SomeError>
       Message: <\"blah\">
       ---Backtrace---
-      FILE:LINE:in \`block in test_assert_raises_default_triggered\'
+      FILE:LINE:in \'block in test_assert_raises_default_triggered\'
       ---------------
     EOM
 
     actual = e.message.gsub(/^.+:\d+/, "FILE:LINE")
     actual.gsub!(RE_LEVELS, "") unless jruby?
+    actual.gsub!(/[`']block in (?:TestMinitestAssertions#)?/, "'block in ")
 
     assert_equal expected, actual
   end
@@ -841,12 +833,13 @@ class TestMinitestAssertions < Minitest::Test
       Class: <AnError>
       Message: <\"some message\">
       ---Backtrace---
-      FILE:LINE:in \`block in test_assert_raises_subclass_triggered\'
+      FILE:LINE:in \'block in test_assert_raises_subclass_triggered\'
       ---------------
     EOM
 
     actual = e.message.gsub(/^.+:\d+/, "FILE:LINE")
     actual.gsub!(RE_LEVELS, "") unless jruby?
+    actual.gsub!(/[`']block in (?:TestMinitestAssertions#)?/, "'block in ")
 
     assert_equal expected.chomp, actual
   end
@@ -863,12 +856,13 @@ class TestMinitestAssertions < Minitest::Test
       Class: <SyntaxError>
       Message: <\"icky\">
       ---Backtrace---
-      FILE:LINE:in \`block in test_assert_raises_triggered_different\'
+      FILE:LINE:in \'block in test_assert_raises_triggered_different\'
       ---------------
     EOM
 
     actual = e.message.gsub(/^.+:\d+/, "FILE:LINE")
     actual.gsub!(RE_LEVELS, "") unless jruby?
+    actual.gsub!(/[`']block in (?:TestMinitestAssertions#)?/, "'block in ")
 
     assert_equal expected, actual
   end
@@ -886,12 +880,13 @@ class TestMinitestAssertions < Minitest::Test
       Class: <SyntaxError>
       Message: <\"icky\">
       ---Backtrace---
-      FILE:LINE:in \`block in test_assert_raises_triggered_different_msg\'
+      FILE:LINE:in \'block in test_assert_raises_triggered_different_msg\'
       ---------------
     EOM
 
     actual = e.message.gsub(/^.+:\d+/, "FILE:LINE")
     actual.gsub!(RE_LEVELS, "") unless jruby?
+    actual.gsub!(/[`']block in (?:TestMinitestAssertions#)?/, "'block in ")
 
     assert_equal expected.chomp, actual
   end
@@ -936,6 +931,16 @@ class TestMinitestAssertions < Minitest::Test
     end
   end
 
+  def test_assert_respond_to__include_all
+    @tc.assert_respond_to @tc, :exit, include_all: true
+  end
+
+  def test_assert_respond_to__include_all_triggered
+    assert_triggered(/Expected .+::DummyTest. to respond to #exit\?/) do
+      @tc.assert_respond_to @tc, :exit?, include_all: true
+    end
+  end
+
   def test_assert_same
     @assertion_count = 3
 
@@ -961,16 +966,24 @@ class TestMinitestAssertions < Minitest::Test
   end
 
   def test_assert_send
-    assert_deprecated :assert_send do
+    @assertion_count = 0 if error_on_warn?
+    assert_deprecation(/DEPRECATED: assert_send/) do
       @tc.assert_send [1, :<, 2]
     end
   end
 
   def test_assert_send_bad
-    assert_deprecated :assert_send do
-      assert_triggered "Expected 1.>(*[2]) to return true." do
+    if error_on_warn? then
+      @assertion_count = 0
+      assert_deprecation(/DEPRECATED: assert_send/) do
         @tc.assert_send [1, :>, 2]
       end
+    else
+      assert_triggered "Expected 1.>(*[2]) to return true." do
+        assert_deprecation(/DEPRECATED: assert_send/) do
+          @tc.assert_send [1, :>, 2]
+        end
+      end
     end
   end
 
@@ -1153,18 +1166,14 @@ class TestMinitestAssertions < Minitest::Test
   def test_class_asserts_match_refutes
     @assertion_count = 0
 
-    methods = Minitest::Assertions.public_instance_methods
-    methods.map!(&:to_s) if Symbol === methods.first
+    methods = Minitest::Assertions.public_instance_methods.map(&:to_s)
 
     # These don't have corresponding refutes _on purpose_. They're
     # useless and will never be added, so don't bother.
     ignores = %w[assert_output assert_raises assert_send
                  assert_silent assert_throws assert_mock]
 
-    # These are test/unit methods. I'm not actually sure why they're still here
-    ignores += %w[assert_no_match assert_not_equal assert_not_nil
-                  assert_not_same assert_nothing_raised
-                  assert_nothing_thrown assert_raise]
+    ignores += %w[assert_allocations] # for minitest-gcstats
 
     asserts = methods.grep(/^assert/).sort - ignores
     refutes = methods.grep(/^refute/).sort - ignores
@@ -1444,6 +1453,16 @@ class TestMinitestAssertions < Minitest::Test
     end
   end
 
+  def test_refute_respond_to__include_all
+    @tc.refute_respond_to "blah", :missing, include_all: true
+  end
+
+  def test_refute_respond_to__include_all_triggered
+    assert_triggered(/Expected .*DummyTest.* to not respond to exit./) do
+      @tc.refute_respond_to @tc, :exit, include_all: true
+    end
+  end
+
   def test_refute_same
     @tc.refute_same 1, 2
   end
@@ -1482,7 +1501,7 @@ class TestMinitestAssertions < Minitest::Test
     d0 = Time.now
     d1 = d0 + 86_400 # I am an idiot
 
-    assert_output "", /Stale skip_until \"not yet\" at .*?:\d+$/ do
+    assert_deprecation(/Stale skip_until \"not yet\" at .*?:\d+$/) do
       assert_skip_until d0, "not yet"
     end
 
@@ -1626,14 +1645,14 @@ class TestMinitestAssertionHelpers < Minitest::Test
   end
 
   def test_mu_pp_for_diff_str_bad_encoding
-    str = "\666".force_encoding Encoding::UTF_8
+    str = "\666".dup.force_encoding Encoding::UTF_8
     exp = "# encoding: UTF-8\n#    valid: false\n\"\\xB6\""
 
     assert_mu_pp_for_diff exp, str, :raw
   end
 
   def test_mu_pp_for_diff_str_bad_encoding_both
-    str = "\666A\\n\nB".force_encoding Encoding::UTF_8
+    str = "\666A\\n\nB".dup.force_encoding Encoding::UTF_8
     exp = "# encoding: UTF-8\n#    valid: false\n\"\\xB6A\\\\n\\nB\""
 
     assert_mu_pp_for_diff exp, str, :raw
@@ -1680,7 +1699,7 @@ class TestMinitestAssertionHelpers < Minitest::Test
   end
 
   def test_mu_pp_str_bad_encoding
-    str = "\666".force_encoding Encoding::UTF_8
+    str = "\666".dup.force_encoding Encoding::UTF_8
     exp = "# encoding: UTF-8\n#    valid: false\n\"\\xB6\""
 
     assert_mu_pp exp, str, :raw