minitest 5.20.0 → 5.27.0

data/test/minitest/test_minitest_reporter.rb

@@ -1,8 +1,8 @@
 require "minitest/autorun"
-require "minitest/metametameta"
+require_relative "metametameta"
 require "forwardable"
 
-class Runnable
+class FakeTest < Minitest::Test
   def woot
     assert true
   end
@@ -13,10 +13,6 @@ class TestMinitestReporter < MetaMetaMetaTestCase
   attr_accessor :r, :io
 
   def new_composite_reporter
-    # Ruby bug in older versions of 2.2 & 2.3 on all platforms
-    # Latest Windows builds were 2.2.6 and 2.3.3.  Latest Ruby releases were
-    # 2.2.10 and 2.3.8.
-    skip if windows? && RUBY_VERSION < '2.4'
     reporter = Minitest::CompositeReporter.new
     reporter << Minitest::SummaryReporter.new(self.io)
     reporter << Minitest::ProgressReporter.new(self.io)
@@ -31,13 +27,14 @@ class TestMinitestReporter < MetaMetaMetaTestCase
 
   def setup
     super
-    self.io = StringIO.new("")
+    self.io = StringIO.new(+"")
     self.r  = new_composite_reporter
+    @et = @ft = @pt = @st = @sse = nil
   end
 
   def error_test
-    unless defined? @et then
-      @et = Minitest::Test.new(:woot)
+    unless @et then
+      @et = FakeTest.new :woot
       @et.failures << Minitest::UnexpectedError.new(begin
                                                       raise "no"
                                                     rescue => e
@@ -48,9 +45,28 @@ class TestMinitestReporter < MetaMetaMetaTestCase
     @et
   end
 
+  def system_stack_error_test
+    unless @sse then
+
+      ex = SystemStackError.new
+
+      pre  = ("a".."c").to_a
+      mid  = ("aa".."ad").to_a * 67
+      post = ("d".."f").to_a
+      ary  = pre + mid + post
+
+      ex.set_backtrace ary
+
+      @sse = FakeTest.new :woot
+      @sse.failures << Minitest::UnexpectedError.new(ex)
+      @sse = Minitest::Result.from @sse
+    end
+    @sse
+  end
+
   def fail_test
-    unless defined? @ft then
-      @ft = Minitest::Test.new(:woot)
+    unless @ft then
+      @ft = FakeTest.new :woot
       @ft.failures <<   begin
                           raise Minitest::Assertion, "boo"
                         rescue Minitest::Assertion => e
@@ -62,18 +78,18 @@ class TestMinitestReporter < MetaMetaMetaTestCase
   end
 
   def passing_test
-    @pt ||= Minitest::Result.from Minitest::Test.new(:woot)
+    @pt ||= Minitest::Result.from FakeTest.new(:woot)
   end
 
   def passing_test_with_metadata
-    test = Minitest::Test.new(:woot)
+    test = FakeTest.new :woot
     test.metadata[:meta] = :data
     @pt ||= Minitest::Result.from test
   end
 
   def skip_test
-    unless defined? @st then
-      @st = Minitest::Test.new(:woot)
+    unless @st then
+      @st = FakeTest.new :woot
       @st.failures << begin
                         raise Minitest::Skip
                       rescue Minitest::Assertion => e
@@ -229,7 +245,7 @@ class TestMinitestReporter < MetaMetaMetaTestCase
     r.start
     r.report
 
-    exp = clean <<-EOM
+    exp = <<~EOM
       Run options:
 
       # Running:
@@ -249,7 +265,7 @@ class TestMinitestReporter < MetaMetaMetaTestCase
     r.record passing_test
     r.report
 
-    exp = clean <<-EOM
+    exp = <<~EOM
       Run options:
 
       # Running:
@@ -269,7 +285,7 @@ class TestMinitestReporter < MetaMetaMetaTestCase
     r.record fail_test
     r.report
 
-    exp = clean <<-EOM
+    exp = <<~EOM
       Run options:
 
       # Running:
@@ -279,7 +295,7 @@ class TestMinitestReporter < MetaMetaMetaTestCase
       Finished in 0.00
 
         1) Failure:
-      Minitest::Test#woot [FILE:LINE]:
+      FakeTest#woot [FILE:LINE]:
       boo
 
       1 runs, 0 assertions, 1 failures, 0 errors, 0 skips
@@ -293,7 +309,7 @@ class TestMinitestReporter < MetaMetaMetaTestCase
     r.record error_test
     r.report
 
-    exp = clean <<-EOM
+    exp = <<~EOM
       Run options:
 
       # Running:
@@ -303,10 +319,46 @@ class TestMinitestReporter < MetaMetaMetaTestCase
       Finished in 0.00
 
         1) Error:
-      Minitest::Test#woot:
+      FakeTest#woot:
       RuntimeError: no
-          FILE:LINE:in `error_test'
-          FILE:LINE:in `test_report_error'
+          FILE:LINE:in 'error_test'
+          FILE:LINE:in 'test_report_error'
+
+      1 runs, 0 assertions, 0 failures, 1 errors, 0 skips
+    EOM
+
+    assert_equal exp, normalize_output(io.string)
+  end
+
+  def test_report_error__sse
+    r.start
+    r.record system_stack_error_test
+    r.report
+
+    exp = <<~EOM
+      Run options:
+
+      # Running:
+
+      E
+
+      Finished in 0.00
+
+        1) Error:
+      FakeTest#woot:
+      SystemStackError: 274 -> 12
+          a
+          b
+          c
+           +->> 67 cycles of 4 lines:
+           | aa
+           | ab
+           | ac
+           | ad
+           +-<<
+          d
+          e
+          f
 
       1 runs, 0 assertions, 0 failures, 1 errors, 0 skips
     EOM
@@ -322,7 +374,7 @@ class TestMinitestReporter < MetaMetaMetaTestCase
       r.report
     end
 
-    exp = clean <<-EOM
+    exp = <<~EOM
       Run options:
 
       # Running:
@@ -338,4 +390,48 @@ class TestMinitestReporter < MetaMetaMetaTestCase
 
     assert_equal exp, normalize_output(io.string)
   end
+
+  def test_report_failure_uses_backtrace_filter
+    filter = Minitest::BacktraceFilter.new
+    def filter.filter _bt
+      ["foo.rb:123:in 'foo'"]
+    end
+
+    with_backtrace_filter filter do
+      r.start
+      r.record fail_test
+      r.report
+    end
+
+    exp = "FakeTest#woot [foo.rb:123]"
+
+    assert_includes io.string, exp
+  end
+
+  def test_report_failure_uses_backtrace_filter_complex_sorbet
+    backtrace = <<~EOBT
+      /Users/user/.gem/ruby/3.2.2/gems/minitest-5.20.0/lib/minitest/assertions.rb:183:in 'assert'
+      example_test.rb:9:in 'assert_false'
+      /Users/user/.gem/ruby/3.2.2/gems/sorbet-runtime-0.5.11068/lib/types/private/methods/call_validation.rb:256:in 'bind_call'
+      /Users/user/.gem/ruby/3.2.2/gems/sorbet-runtime-0.5.11068/lib/types/private/methods/call_validation.rb:256:in 'validate_call'
+      /Users/user/.gem/ruby/3.2.2/gems/sorbet-runtime-0.5.11068/lib/types/private/methods/_methods.rb:275:in 'block in _on_method_added'
+      example_test.rb:25:in 'test_something'
+      /Users/user/.gem/ruby/3.2.2/gems/minitest-5.20.0/lib/minitest/test.rb:94:in 'block (3 levels) in run'
+      /Users/user/.gem/ruby/3.2.2/gems/minitest-5.20.0/lib/minitest/test.rb:191:in 'capture_exceptions'
+      /Users/user/.gem/ruby/3.2.2/gems/minitest-5.20.0/lib/minitest/test.rb:89:in 'block (2 levels) in run'
+      ... so many lines ...
+    EOBT
+
+    filter = Minitest::BacktraceFilter.new %r%lib/minitest|gems/sorbet%
+
+    with_backtrace_filter filter do
+      begin
+        assert_equal 1, 2
+      rescue Minitest::Assertion => e
+        e.set_backtrace backtrace.lines.map(&:chomp)
+
+        assert_match "example_test.rb:25", e.location
+      end
+    end
+  end
 end

data/test/minitest/test_minitest_spec.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require "minitest/metametameta"
+require_relative "metametameta"
 require "stringio"
 
 class MiniSpecA < Minitest::Spec; end
@@ -12,15 +11,12 @@ class ExampleA; end
 class ExampleB < ExampleA; end
 
 describe Minitest::Spec do
-  # helps to deal with 2.4 deprecation of Fixnum for Integer
-  Int = 1.class
-
   # do not parallelize this suite... it just can"t handle it.
 
   def assert_triggered expected = "blah", klass = Minitest::Assertion
     @assertion_count += 1
 
-    e = assert_raises(klass) do
+    e = assert_raises klass do
       yield
     end
 
@@ -29,17 +25,17 @@ describe Minitest::Spec do
     msg.gsub!(/(\d\.\d{6})\d+/, '\1xxx') # normalize: ruby version, impl, platform
     msg.gsub!(/:0x[Xa-fA-F0-9]{4,}[ @].+?>/, ":0xXXXXXX@PATH>")
 
-    if expected
+    return unless expected
+
+    @assertion_count += 1
+    case expected
+    when String then
+      assert_equal expected, msg
+    when Regexp then
       @assertion_count += 1
-      case expected
-      when String then
-        assert_equal expected, msg
-      when Regexp then
-        @assertion_count += 1
-        assert_match expected, msg
-      else
-        flunk "Unknown: #{expected.inspect}"
-      end
+      assert_match expected, msg
+    else
+      flunk "Unknown: #{expected.inspect}"
     end
   end
 
@@ -112,7 +108,7 @@ describe Minitest::Spec do
   end
 
   it "needs to catch an expected exception" do
-    @assertion_count = 2
+    @assertion_count -= 2
 
     expect { raise "blah" }.must_raise RuntimeError
     expect { raise Minitest::Assertion }.must_raise Minitest::Assertion
@@ -152,25 +148,13 @@ describe Minitest::Spec do
   it "needs to pattern match" do
     @assertion_count = 1
 
-    if RUBY_VERSION > "3" then
-      expect { good_pattern }.must_pattern_match
-    else
-      assert_raises NotImplementedError do
-        expect {}.must_pattern_match
-      end
-    end
+    expect { good_pattern }.must_pattern_match
   end
 
   it "needs to error on bad pattern match" do
-    skip unless RUBY_VERSION > "3"
-
     @assertion_count = 1
 
-    exp = if RUBY_VERSION.start_with? "3.0"
-            "[1, 2, 3]" # terrible error message!
-          else
-            /length mismatch/
-          end
+    exp = /length mismatch/
 
     assert_triggered exp do
       expect { bad_pattern }.must_pattern_match
@@ -196,7 +180,7 @@ describe Minitest::Spec do
     methods = Minitest::Expectations.public_instance_methods.grep(/must|wont/)
     methods.map!(&:to_s) if Symbol === methods.first
 
-    musts, wonts = methods.sort.partition { |m| m =~ /must/ }
+    musts, wonts = methods.sort.partition { |m| m.include? "must" }
 
     expected_musts = %w[must_be
                         must_be_close_to
@@ -216,11 +200,12 @@ describe Minitest::Spec do
                         must_raise
                         must_respond_to
                         must_throw
+                        must_verify
                         path_must_exist]
 
-    bad = %w[not raise throw send output be_silent]
+    bad = %w[not raise throw send output be_silent verify]
 
-    expected_wonts = expected_musts.map { |m| m.sub(/must/, "wont") }.sort
+    expected_wonts = expected_musts.map { |m| m.sub("must", "wont") }.sort
     expected_wonts.reject! { |m| m =~ /wont_#{Regexp.union(*bad)}/ }
 
     _(musts).must_equal expected_musts
@@ -284,18 +269,14 @@ describe Minitest::Spec do
   end
 
   it "needs to warn on equality with nil" do
-    @assertion_count += 1 # extra test
+    @assertion_count = 3
+    @assertion_count += 2 unless error_on_warn? # 2 extra assertions
 
-    out, err = capture_io do
+    exp = /.*?test_minitest_\w+.rb:\d+: warning: DEPRECATED: Use assert_nil if expecting nil. This will fail in Minitest 6./
+
+    assert_deprecation exp do
       assert_success _(nil).must_equal(nil)
     end
-
-    exp = "DEPRECATED: Use assert_nil if expecting nil from #{__FILE__}:#{__LINE__-3}. " \
-      "This will fail in Minitest 6.\n"
-    exp = "" if $-w.nil?
-
-    assert_empty out
-    assert_equal exp, err
   end
 
   it "needs to verify floats outside a delta" do
@@ -403,12 +384,12 @@ describe Minitest::Spec do
   it "needs to verify instances of a class" do
     assert_success _(42).wont_be_instance_of(String)
 
-    assert_triggered "Expected 42 to not be a kind of #{Int.name}." do
-      _(42).wont_be_kind_of Int
+    assert_triggered "Expected 42 to not be a kind of Integer." do
+      _(42).wont_be_kind_of Integer
     end
 
-    assert_triggered "msg.\nExpected 42 to not be an instance of #{Int.name}." do
-      _(42).wont_be_instance_of Int, "msg"
+    assert_triggered "msg.\nExpected 42 to not be an instance of Integer." do
+      _(42).wont_be_instance_of Integer, "msg"
     end
   end
 
@@ -418,26 +399,26 @@ describe Minitest::Spec do
     assert_success _(42).wont_be_kind_of(String)
     assert_success _(proc {}).wont_be_kind_of(String)
 
-    assert_triggered "Expected 42 to not be a kind of #{Int.name}." do
-      _(42).wont_be_kind_of Int
+    assert_triggered "Expected 42 to not be a kind of Integer." do
+      _(42).wont_be_kind_of Integer
     end
 
-    assert_triggered "msg.\nExpected 42 to not be a kind of #{Int.name}." do
-      _(42).wont_be_kind_of Int, "msg"
+    assert_triggered "msg.\nExpected 42 to not be a kind of Integer." do
+      _(42).wont_be_kind_of Integer, "msg"
     end
   end
 
   it "needs to verify kinds of objects" do
     @assertion_count += 3 # extra test
 
-    assert_success _(6 * 7).must_be_kind_of(Int)
+    assert_success _(6 * 7).must_be_kind_of(Integer)
     assert_success _(6 * 7).must_be_kind_of(Numeric)
 
-    assert_triggered "Expected 42 to be a kind of String, not #{Int.name}." do
+    assert_triggered "Expected 42 to be a kind of String, not Integer." do
       _(6 * 7).must_be_kind_of String
     end
 
-    assert_triggered "msg.\nExpected 42 to be a kind of String, not #{Int.name}." do
+    assert_triggered "msg.\nExpected 42 to be a kind of String, not Integer." do
       _(6 * 7).must_be_kind_of String, "msg"
     end
 
@@ -576,7 +557,8 @@ describe Minitest::Spec do
 
     it "can NOT use must_equal in a thread. It must use expect in a thread" do
       skip "N/A" if ENV["MT_NO_EXPECTATIONS"]
-      assert_raises RuntimeError do
+
+      assert_raises RuntimeError, Minitest::UnexpectedWarning do
         capture_io do
           Thread.new { (1 + 1).must_equal 2 }.join
         end
@@ -586,29 +568,33 @@ describe Minitest::Spec do
     it "fails gracefully when expectation used outside of `it`" do
       skip "N/A" if ENV["MT_NO_EXPECTATIONS"]
 
-      @assertion_count += 1
+      @assertion_count += 2 # assert_match is compound
 
-      e = assert_raises RuntimeError do
+      e = assert_raises RuntimeError, Minitest::UnexpectedWarning do
         capture_io do
           Thread.new { # forces ctx to be nil
-            describe("woot") do
+            describe "woot" do
               (1 + 1).must_equal 2
             end
           }.join
         end
       end
 
-      assert_equal "Calling #must_equal outside of test.", e.message
+      exp = "Calling #must_equal outside of test."
+      exp = "DEPRECATED: global use of must_equal from" if error_on_warn?
+
+      assert_match exp, e.message
     end
 
     it "deprecates expectation used without _" do
       skip "N/A" if ENV["MT_NO_EXPECTATIONS"]
 
-      @assertion_count += 3
+      @assertion_count += 1
+      @assertion_count += 2 unless error_on_warn?
 
       exp = /DEPRECATED: global use of must_equal from/
 
-      assert_output "", exp do
+      assert_deprecation exp do
         (1 + 1).must_equal 2
       end
     end
@@ -618,12 +604,13 @@ describe Minitest::Spec do
     it "deprecates expectation used without _ with empty backtrace_filter" do
       skip "N/A" if ENV["MT_NO_EXPECTATIONS"]
 
-      @assertion_count += 3
+      @assertion_count += 1
+      @assertion_count += 2 unless error_on_warn?
 
       exp = /DEPRECATED: global use of must_equal from/
 
       with_empty_backtrace_filter do
-        assert_output "", exp do
+        assert_deprecation exp do
           (1 + 1).must_equal 2
         end
       end
@@ -654,9 +641,9 @@ describe Minitest::Spec do
   end
 
   it "needs to verify types of objects" do
-    assert_success _(6 * 7).must_be_instance_of(Int)
+    assert_success _(6 * 7).must_be_instance_of(Integer)
 
-    exp = "Expected 42 to be an instance of String, not #{Int.name}."
+    exp = "Expected 42 to be an instance of String, not Integer."
 
     assert_triggered exp do
       _(6 * 7).must_be_instance_of String
@@ -683,7 +670,7 @@ describe Minitest::Spec do
     assert_success _(41).must_be(:<, 42)
 
     assert_triggered "Expected 42 to be < 41." do
-      _(42).must_be(:<, 41)
+      _(42).must_be :<, 41
     end
   end
 
@@ -700,19 +687,17 @@ describe Minitest::Spec do
   it "needs to verify using respond_to" do
     assert_success _(42).must_respond_to(:+)
 
-    assert_triggered "Expected 42 (#{Int.name}) to respond to #clear." do
+    assert_triggered "Expected 42 (Integer) to respond to #clear." do
       _(42).must_respond_to :clear
     end
 
-    assert_triggered "msg.\nExpected 42 (#{Int.name}) to respond to #clear." do
+    assert_triggered "msg.\nExpected 42 (Integer) to respond to #clear." do
       _(42).must_respond_to :clear, "msg"
     end
   end
 end
 
 describe Minitest::Spec, :let do
-  i_suck_and_my_tests_are_order_dependent!
-
   def _count
     $let_count ||= 0
   end
@@ -723,21 +708,21 @@ describe Minitest::Spec, :let do
   end
 
   it "is evaluated once per example" do
-    _(_count).must_equal 0
+    exp = _count + 1
 
-    _(count).must_equal 1
-    _(count).must_equal 1
+    _(count).must_equal exp
+    _(count).must_equal exp
 
-    _(_count).must_equal 1
+    _(_count).must_equal exp
   end
 
   it "is REALLY evaluated once per example" do
-    _(_count).must_equal 1
+    exp = _count + 1
 
-    _(count).must_equal 2
-    _(count).must_equal 2
+    _(count).must_equal exp
+    _(count).must_equal exp
 
-    _(_count).must_equal 2
+    _(_count).must_equal exp
   end
 
   it 'raises an error if the name begins with "test"' do
@@ -751,9 +736,9 @@ describe Minitest::Spec, :let do
   it "doesn't raise an error if it is just another let" do
     v = proc do
       describe :outer do
-        let(:bar)
+        let :bar
         describe :inner do
-          let(:bar)
+          let :bar
         end
       end
       :good
@@ -942,6 +927,16 @@ class TestMeta < MetaMetaMetaTestCase
     assert_equal "ExampleB::random_method::addl_context", spec_c.name
   end
 
+  def test_inspect
+    spec_a = describe ExampleA do; end
+    spec_b = describe ExampleB, :random_method do; end
+    spec_c = describe ExampleB, :random_method, :addl_context do; end
+
+    assert_equal "ExampleA", spec_a.inspect
+    assert_equal "ExampleB::random_method", spec_b.inspect
+    assert_equal "ExampleB::random_method::addl_context", spec_c.inspect
+  end
+
   def test_name2
     assert_equal "NamedExampleA", NamedExampleA.name
     assert_equal "NamedExampleB", NamedExampleB.name
@@ -954,6 +949,23 @@ class TestMeta < MetaMetaMetaTestCase
     assert_equal "ExampleB::random_method", spec_b.name
   end
 
+  def test_name_inside_class
+    spec_a = nil
+    spec_b = nil
+    inside_class_example = Class.new Minitest::Spec
+    Object.const_set :InsideClassExample, inside_class_example
+    inside_class_example.class_eval do
+      spec_a = describe "a" do
+        spec_b = describe "b" do; end
+      end
+    end
+
+    assert_equal "InsideClassExample::a", spec_a.name
+    assert_equal "InsideClassExample::a::b", spec_b.name
+  ensure
+    Object.send :remove_const, :InsideClassExample
+  end
+
   def test_structure
     x, y, z, * = util_structure
 
@@ -1016,8 +1028,9 @@ class TestMeta < MetaMetaMetaTestCase
       z = describe "second thingy" do end
     end
 
-    test_methods = ["test_0001_top level it",
-                    "test_0002_не латинские &いった α, β, γ, δ, ε hello!!! world",
+    test_methods = [
+                     "test_0001_top level it",
+                     "test_0002_не латинские &いった α, β, γ, δ, ε hello!!! world",
                    ].sort
 
     assert_equal test_methods, [x1, x2]