minitest 5.11.3 → 5.14.4

data/lib/minitest/expectations.rb

@@ -9,10 +9,11 @@
 #
 #     it "should still work in threads" do
 #       my_threaded_thingy do
-#         (1+1).must_equal 2         # bad
-#         assert_equal 2, 1+1        # good
-#         _(1 + 1).must_equal 2      # good
-#         value(1 + 1).must_equal 2  # good, also #expect
+#         (1+1).must_equal 2                  # bad
+#         assert_equal 2, 1+1                 # good
+#         _(1 + 1).must_equal 2               # good
+#         value(1 + 1).must_equal 2           # good, also #expect
+#         _ { 1 + "1" }.must_raise TypeError  # good
 #       end
 #     end
 
@@ -21,7 +22,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_empty.
   #
-  #    collection.must_be_empty
+  #    _(collection).must_be_empty
   #
   # :method: must_be_empty
 
@@ -30,7 +31,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_equal
   #
-  #    a.must_equal b
+  #    _(a).must_equal b
   #
   # :method: must_equal
 
@@ -39,18 +40,18 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_in_delta
   #
-  #    n.must_be_close_to m [, delta]
+  #    _(n).must_be_close_to m [, delta]
   #
   # :method: must_be_close_to
 
   infect_an_assertion :assert_in_delta, :must_be_close_to
 
-  alias :must_be_within_delta :must_be_close_to # :nodoc:
+  infect_an_assertion :assert_in_delta, :must_be_within_delta # :nodoc:
 
   ##
   # See Minitest::Assertions#assert_in_epsilon
   #
-  #    n.must_be_within_epsilon m [, epsilon]
+  #    _(n).must_be_within_epsilon m [, epsilon]
   #
   # :method: must_be_within_epsilon
 
@@ -59,7 +60,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_includes
   #
-  #    collection.must_include obj
+  #    _(collection).must_include obj
   #
   # :method: must_include
 
@@ -68,7 +69,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_instance_of
   #
-  #    obj.must_be_instance_of klass
+  #    _(obj).must_be_instance_of klass
   #
   # :method: must_be_instance_of
 
@@ -77,7 +78,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_kind_of
   #
-  #    obj.must_be_kind_of mod
+  #    _(obj).must_be_kind_of mod
   #
   # :method: must_be_kind_of
 
@@ -86,7 +87,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_match
   #
-  #    a.must_match b
+  #    _(a).must_match b
   #
   # :method: must_match
 
@@ -95,7 +96,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_nil
   #
-  #    obj.must_be_nil
+  #    _(obj).must_be_nil
   #
   # :method: must_be_nil
 
@@ -104,11 +105,11 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_operator
   #
-  #    n.must_be :<=, 42
+  #    _(n).must_be :<=, 42
   #
   # This can also do predicates:
   #
-  #    str.must_be :empty?
+  #    _(str).must_be :empty?
   #
   # :method: must_be
 
@@ -117,7 +118,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_output
   #
-  #    proc { ... }.must_output out_or_nil [, err]
+  #    _ { ... }.must_output out_or_nil [, err]
   #
   # :method: must_output
 
@@ -126,7 +127,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_raises
   #
-  #    proc { ... }.must_raise exception
+  #    _ { ... }.must_raise exception
   #
   # :method: must_raise
 
@@ -135,7 +136,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_respond_to
   #
-  #    obj.must_respond_to msg
+  #    _(obj).must_respond_to msg
   #
   # :method: must_respond_to
 
@@ -144,7 +145,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_same
   #
-  #    a.must_be_same_as b
+  #    _(a).must_be_same_as b
   #
   # :method: must_be_same_as
 
@@ -153,7 +154,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_silent
   #
-  #    proc { ... }.must_be_silent
+  #    _ { ... }.must_be_silent
   #
   # :method: must_be_silent
 
@@ -162,16 +163,34 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#assert_throws
   #
-  #    proc { ... }.must_throw sym
+  #    _ { ... }.must_throw sym
   #
   # :method: must_throw
 
   infect_an_assertion :assert_throws, :must_throw, :block
 
+  ##
+  # See Minitest::Assertions#assert_path_exists
+  #
+  #   _(some_path).path_must_exist
+  #
+  # :method: path_must_exist
+
+  infect_an_assertion :assert_path_exists, :path_must_exist, :unary
+
+  ##
+  # See Minitest::Assertions#refute_path_exists
+  #
+  #   _(some_path).path_wont_exist
+  #
+  # :method: path_wont_exist
+
+  infect_an_assertion :refute_path_exists, :path_wont_exist, :unary
+
   ##
   # See Minitest::Assertions#refute_empty
   #
-  #    collection.wont_be_empty
+  #    _(collection).wont_be_empty
   #
   # :method: wont_be_empty
 
@@ -180,7 +199,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_equal
   #
-  #    a.wont_equal b
+  #    _(a).wont_equal b
   #
   # :method: wont_equal
 
@@ -189,18 +208,18 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_in_delta
   #
-  #    n.wont_be_close_to m [, delta]
+  #    _(n).wont_be_close_to m [, delta]
   #
   # :method: wont_be_close_to
 
   infect_an_assertion :refute_in_delta, :wont_be_close_to
 
-  alias :wont_be_within_delta :wont_be_close_to # :nodoc:
+  infect_an_assertion :refute_in_delta, :wont_be_within_delta # :nodoc:
 
   ##
   # See Minitest::Assertions#refute_in_epsilon
   #
-  #    n.wont_be_within_epsilon m [, epsilon]
+  #    _(n).wont_be_within_epsilon m [, epsilon]
   #
   # :method: wont_be_within_epsilon
 
@@ -209,7 +228,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_includes
   #
-  #    collection.wont_include obj
+  #    _(collection).wont_include obj
   #
   # :method: wont_include
 
@@ -218,7 +237,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_instance_of
   #
-  #    obj.wont_be_instance_of klass
+  #    _(obj).wont_be_instance_of klass
   #
   # :method: wont_be_instance_of
 
@@ -227,7 +246,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_kind_of
   #
-  #    obj.wont_be_kind_of mod
+  #    _(obj).wont_be_kind_of mod
   #
   # :method: wont_be_kind_of
 
@@ -236,7 +255,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_match
   #
-  #    a.wont_match b
+  #    _(a).wont_match b
   #
   # :method: wont_match
 
@@ -245,7 +264,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_nil
   #
-  #    obj.wont_be_nil
+  #    _(obj).wont_be_nil
   #
   # :method: wont_be_nil
 
@@ -254,7 +273,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_operator
   #
-  #    n.wont_be :<=, 42
+  #    _(n).wont_be :<=, 42
   #
   # This can also do predicates:
   #
@@ -267,7 +286,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_respond_to
   #
-  #    obj.wont_respond_to msg
+  #    _(obj).wont_respond_to msg
   #
   # :method: wont_respond_to
 
@@ -276,7 +295,7 @@ module Minitest::Expectations
   ##
   # See Minitest::Assertions#refute_same
   #
-  #    a.wont_be_same_as b
+  #    _(a).wont_be_same_as b
   #
   # :method: wont_be_same_as
 

data/lib/minitest/mock.rb

@@ -207,7 +207,9 @@ class Object
   #         assert obj_under_test.stale?
   #       end
   #     end
-  #
+  #--
+  # NOTE: keyword args in callables are NOT checked for correctness
+  # against the existing method. Too many edge cases to be worth it.
 
   def stub name, val_or_callable, *block_args
     new_name = "__minitest_stub__#{name}"
@@ -231,6 +233,8 @@ class Object
       end
     end
 
+    metaclass.send(:ruby2_keywords, name) if metaclass.respond_to?(:ruby2_keywords, true)
+
     yield self
   ensure
     metaclass.send :undef_method, name

data/lib/minitest/spec.rb

@@ -8,12 +8,16 @@ class Module # :nodoc:
     # warn "%-22p -> %p %p" % [meth, new_name, dont_flip]
     self.class_eval <<-EOM, __FILE__, __LINE__ + 1
       def #{new_name} *args
+        where = Minitest.filter_backtrace(caller).first
+        where = where.split(/:in /, 2).first # clean up noise
+        warn "DEPRECATED: global use of #{new_name} from #\{where}. Use _(obj).#{new_name} instead. This will fail in Minitest 6."
         Minitest::Expectation.new(self, Minitest::Spec.current).#{new_name}(*args)
       end
     EOM
 
     Minitest::Expectation.class_eval <<-EOM, __FILE__, __LINE__ + 1
       def #{new_name} *args
+        raise "Calling ##{new_name} outside of test." unless ctx
         case
         when #{!!dont_flip} then
           ctx.#{meth}(target, *args)
@@ -285,21 +289,28 @@ class Minitest::Spec < Minitest::Test
 
     module InstanceMethods
       ##
-      # Returns a value monad that has all of Expectations methods
-      # available to it.
+      # Takes a value or a block and returns a value monad that has
+      # all of Expectations methods available to it.
       #
-      # Also aliased to #value and #expect for your aesthetic pleasure:
+      #   _(1 + 1).must_equal 2
       #
-      #         _(1 + 1).must_equal 2
-      #     value(1 + 1).must_equal 2
-      #    expect(1 + 1).must_equal 2
+      # And for blocks:
+      #
+      #   _ { 1 + "1" }.must_raise TypeError
       #
       # This method of expectation-based testing is preferable to
       # straight-expectation methods (on Object) because it stores its
       # test context, bypassing our hacky use of thread-local variables.
       #
-      # At some point, the methods on Object will be deprecated and then
-      # removed.
+      # NOTE: At some point, the methods on Object will be deprecated
+      # and then removed.
+      #
+      # It is also aliased to #value and #expect for your aesthetic
+      # pleasure:
+      #
+      #         _(1 + 1).must_equal 2
+      #     value(1 + 1).must_equal 2
+      #    expect(1 + 1).must_equal 2
 
       def _ value = nil, &block
         Minitest::Expectation.new block || value, self

data/lib/minitest.rb

@@ -8,7 +8,7 @@ require "stringio"
 # :include: README.rdoc
 
 module Minitest
-  VERSION = "5.11.3" # :nodoc:
+  VERSION = "5.14.4" # :nodoc:
   ENCS = "".respond_to? :encoding # :nodoc:
 
   @@installed_at_exit ||= false
@@ -21,7 +21,10 @@ module Minitest
   # Parallel test executor
 
   mc.send :attr_accessor, :parallel_executor
-  self.parallel_executor = Parallel::Executor.new((ENV["N"] || 2).to_i)
+
+  warn "DEPRECATED: use MT_CPU instead of N for parallel test runs" if ENV["N"]
+  n_threads = (ENV["MT_CPU"] || ENV["N"] || 2).to_i
+  self.parallel_executor = Parallel::Executor.new n_threads
 
   ##
   # Filter object for backtraces.
@@ -55,7 +58,9 @@ module Minitest
 
       exit_code = nil
 
+      pid = Process.pid
       at_exit {
+        next if Process.pid != pid
         @@after_run.reverse_each(&:call)
         exit exit_code || false
       }
@@ -233,7 +238,9 @@ module Minitest
   end
 
   def self.filter_backtrace bt # :nodoc:
-    backtrace_filter.filter bt
+    result = backtrace_filter.filter bt
+    result = bt.dup if result.empty?
+    result
   end
 
   ##
@@ -301,7 +308,7 @@ module Minitest
 
     def self.run reporter, options = {}
       filter = options[:filter] || "/./"
-      filter = Regexp.new $1 if filter =~ %r%/(.*)/%
+      filter = Regexp.new $1 if filter.is_a?(String) && filter =~ %r%/(.*)/%
 
       filtered_methods = self.runnable_methods.find_all { |m|
         filter === m || filter === "#{self}##{m}"
@@ -422,7 +429,8 @@ module Minitest
 
     ##
     # Returns a single character string to print based on the result
-    # of the run. Eg ".", "F", or "E".
+    # of the run. One of <tt>"."</tt>, <tt>"F"</tt>,
+    # <tt>"E"</tt> or <tt>"S"</tt>.
 
     def result_code
       raise NotImplementedError, "subclass responsibility"
@@ -560,8 +568,10 @@ module Minitest
     end
 
     ##
-    # Record a result and output the Runnable#result_code. Stores the
-    # result of the run if the run did not pass.
+    # Output and record the result of the test. Call
+    # {result#result_code}[rdoc-ref:Runnable#result_code] to get the
+    # result character string. Stores the result of the run if the run
+    # did not pass.
 
     def record result
     end
@@ -628,18 +638,63 @@ module Minitest
   #
   # If you want to create an entirely different type of output (eg,
   # CI, HTML, etc), this is the place to start.
+  #
+  # Example:
+  #
+  #   class JenkinsCIReporter < StatisticsReporter
+  #     def report
+  #       super  # Needed to calculate some statistics
+  #
+  #       print "<testsuite "
+  #       print "tests='#{count}' "
+  #       print "failures='#{failures}' "
+  #       # Remaining XML...
+  #     end
+  #   end
 
   class StatisticsReporter < Reporter
-    # :stopdoc:
+    ##
+    # Total number of assertions.
+
     attr_accessor :assertions
+
+    ##
+    # Total number of test cases.
+
     attr_accessor :count
+
+    ##
+    # An +Array+ of test cases that failed or were skipped.
+
     attr_accessor :results
+
+    ##
+    # Time the test run started. If available, the monotonic clock is
+    # used and this is a +Float+, otherwise it's an instance of
+    # +Time+.
+
     attr_accessor :start_time
+
+    ##
+    # Test run time. If available, the monotonic clock is used and
+    # this is a +Float+, otherwise it's an instance of +Time+.
+
     attr_accessor :total_time
+
+    ##
+    # Total number of tests that failed.
+
     attr_accessor :failures
+
+    ##
+    # Total number of tests that erred.
+
     attr_accessor :errors
+
+    ##
+    # Total number of tests that where skipped.
+
     attr_accessor :skips
-    # :startdoc:
 
     def initialize io = $stdout, options = {} # :nodoc:
       super
@@ -669,7 +724,10 @@ module Minitest
       results << result if not result.passed? or result.skipped?
     end
 
-    def report # :nodoc:
+    ##
+    # Report on the tracked statistics.
+
+    def report
       aggregate = results.group_by { |r| r.failure.class }
       aggregate.default = [] # dumb. group_by should provide this
 
@@ -851,24 +909,21 @@ module Minitest
   # Assertion wrapping an unexpected error that was raised during a run.
 
   class UnexpectedError < Assertion
-    attr_accessor :exception # :nodoc:
+    # TODO: figure out how to use `cause` instead
+    attr_accessor :error # :nodoc:
 
-    def initialize exception # :nodoc:
+    def initialize error # :nodoc:
       super "Unexpected exception"
-      self.exception = exception
+      self.error = error
     end
 
     def backtrace # :nodoc:
-      self.exception.backtrace
-    end
-
-    def error # :nodoc:
-      self.exception
+      self.error.backtrace
     end
 
     def message # :nodoc:
       bt = Minitest.filter_backtrace(self.backtrace).join "\n    "
-      "#{self.exception.class}: #{self.exception.message}\n    #{bt}"
+      "#{self.error.class}: #{self.error.message}\n    #{bt}"
     end
 
     def result_label # :nodoc:
@@ -904,6 +959,9 @@ module Minitest
     # Is this running on maglev?
 
     def maglev? platform = defined?(RUBY_ENGINE) && RUBY_ENGINE
+      where = Minitest.filter_backtrace(caller).first
+      where = where.split(/:in /, 2).first # clean up noise
+      warn "DEPRECATED: `maglev?` called from #{where}. This will fail in Minitest 6."
       "maglev" == platform
     end
 
@@ -914,10 +972,20 @@ module Minitest
       /^ruby/ =~ platform
     end
 
+    ##
+    # Is this running on macOS?
+
+    def osx? platform = RUBY_PLATFORM
+      /darwin/ =~ platform
+    end
+
     ##
     # Is this running on rubinius?
 
     def rubinius? platform = defined?(RUBY_ENGINE) && RUBY_ENGINE
+      where = Minitest.filter_backtrace(caller).first
+      where = where.split(/:in /, 2).first # clean up noise
+      warn "DEPRECATED: `rubinius?` called from #{where}. This will fail in Minitest 6."
       "rbx" == platform
     end
 
@@ -939,12 +1007,13 @@ module Minitest
     MT_RE = %r%lib/minitest% #:nodoc:
 
     ##
-    # Filter +bt+ to something useful. Returns the whole thing if $DEBUG.
+    # Filter +bt+ to something useful. Returns the whole thing if
+    # $DEBUG (ruby) or $MT_DEBUG (env).
 
     def filter bt
       return ["No backtrace"] unless bt
 
-      return bt.dup if $DEBUG
+      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?

data/test/minitest/metametameta.rb

@@ -6,8 +6,27 @@ class Minitest::Test
   def clean s
     s.gsub(/^ {6}/, "")
   end
+
+  def with_empty_backtrace_filter
+    original = Minitest.backtrace_filter
+
+    obj = Minitest::BacktraceFilter.new
+    def obj.filter _bt
+      []
+    end
+
+    Minitest::Test.io_lock.synchronize do # try not to trounce in parallel
+      begin
+        Minitest.backtrace_filter = obj
+        yield
+      ensure
+        Minitest.backtrace_filter = original
+      end
+    end
+  end
 end
 
+
 class FakeNamedTest < Minitest::Test
   @@count = 0
 
@@ -19,9 +38,20 @@ class FakeNamedTest < Minitest::Test
   end
 end
 
+module MyModule; end
+class AnError < StandardError; include MyModule; end
+
 class MetaMetaMetaTestCase < Minitest::Test
   attr_accessor :reporter, :output, :tu
 
+  def with_stderr err
+    old = $stderr
+    $stderr = err
+    yield
+  ensure
+    $stderr = old
+  end
+
   def run_tu_with_fresh_reporter flags = %w[--seed 42]
     options = Minitest.process_args flags
 
@@ -31,18 +61,20 @@ class MetaMetaMetaTestCase < Minitest::Test
     reporter << Minitest::SummaryReporter.new(@output, options)
     reporter << Minitest::ProgressReporter.new(@output, options)
 
-    reporter.start
+    with_stderr @output do
+      reporter.start
 
-    yield(reporter) if block_given?
+      yield(reporter) if block_given?
 
-    @tus ||= [@tu]
-    @tus.each do |tu|
-      Minitest::Runnable.runnables.delete tu
+      @tus ||= [@tu]
+      @tus.each do |tu|
+        Minitest::Runnable.runnables.delete tu
 
-      tu.run reporter, options
-    end
+        tu.run reporter, options
+      end
 
-    reporter.report
+      reporter.report
+    end
   end
 
   def first_reporter
@@ -81,6 +113,8 @@ class MetaMetaMetaTestCase < Minitest::Test
       output.gsub!(/^(\s+)[^:]+:\d+:in/, '\1FILE:LINE:in')
     end
 
+    output.gsub!(/( at )[^:]+:\d+/, '\1[FILE:LINE]')
+
     output
   end