minitest 5.16.0 → 5.16.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9253f08ed8cc9ec5b362ff80aee1be1b0b0d7873fea50c97893d2e62ef013fd2
-  data.tar.gz: e674a1a6f27a4bb130b735585f31658efdec0bb4eae4140e63f1bc30a5d59779
+  metadata.gz: 9c5a4db9f495b34c86f2c39eef6b6d424b22d8d9e6a86038bf0ff84c1c20c975
+  data.tar.gz: b8a1b6cb226d14c6972460bec05ec610d05acdfa0edcffe19bf51e8220486206
 SHA512:
-  metadata.gz: 925355cd00438e04a789b67a4c79796c590d4d18a2e0bedf33592d471a6c3586a77aec61fec8882099ab3980ccb4e9be87de7dd31c6ae9d938f39a13188788f7
-  data.tar.gz: 48e0507f508e989bf2a6dbe137114377b4cb552041d52a1cf232feb062ab6bcfb43097e551f061c23a35fce074093ddbe5259c9a51dbee7e88d10843c15db2f8
+  metadata.gz: 6505a8f386da89263a005ba8eef3f81053e7e666a54ec03abd8f71e06c290ebf318df4f7728e420e3f40fab55ffe1a57824ec435286c89864ea830d330d6b028
+  data.tar.gz: 5b8bbba7d8565026e64da1d3af31a5aa342c3d063acd75de9661bc09fb142f4a469e9febf44daf2764d4fb33021d993a27bd936200efded501158b23c299989e

data/History.rdoc

@@ -1,3 +1,27 @@
+=== 5.16.3 / 2022-08-17
+
+* 2 bug fixes:
+
+  * Fixed exception sanitization by removing TypeError restriction on rescue.
+  * Use A instead of deprecated TESTOPTS in rake test:slow. (davidstosik)
+
+=== 5.16.2 / 2022-07-03
+
+* 4 bug fixes:
+
+  * Added MT_KWARGS_HACK kludge for stub to deal with ruby 2.7 kwargs nastiness. (tsugimoto)
+  * In #expect, pop Hash class from args if $MT_KWARGS_HACK. (casperisfine)
+  * In above scenario, set expected kwargs (as Objects) based on actual kwargs.
+  * Nuke ivars if exception fails to marshal twice (eg better_errors). (irphilli)
+
+=== 5.16.1 / 2022-06-20
+
+* 2 bug fixes:
+
+  * Apparently adding real kwarg support to mocks/stubs broke some code. Fixed.
+    * Use `MT_KWARGS_HACK=1` to activate the kludgy kwargs support w/ caveats.
+  * Clarified some doco wrt the block on #stub.
+
 === 5.16.0 / 2022-06-14
 
 * 2 major enhancements:

data/README.rdoc

@@ -641,6 +641,7 @@ minitest-capistrano         :: Assertions and expectations for testing
                                Capistrano recipes.
 minitest-capybara           :: Capybara matchers support for minitest unit and
                                spec.
+minitest-cc                 :: It provides minimal information about code coverage.
 minitest-chef-handler       :: Run Minitest suites as Chef report handlers
 minitest-ci                 :: CI reporter plugin for Minitest.
 minitest-context            :: Defines contexts for code reuse in Minitest
@@ -739,7 +740,7 @@ minitest-stub-const         :: Stub constants for the duration of a block.
 minitest-tags               :: Add tags for minitest.
 minitest-unordered          :: Adds a new assertion to minitest for checking the
                                contents of a collection, ignoring element order.
-minitest-vcr                :: Automatic cassette managment with Minitest::Spec
+minitest-vcr                :: Automatic cassette management with Minitest::Spec
                                and VCR.
 minitest_log                :: Adds structured logging, data explication, and verdicts.
 minitest_owrapper           :: Get tests results as a TestResult object.

data/lib/minitest/mock.rb

@@ -51,6 +51,8 @@ module Minitest # :nodoc:
       @actual_calls   = Hash.new { |calls, name| calls[name] = [] }
     end
 
+    @@KW_WARNED = false # :nodoc:
+
     ##
     # Expect that method +name+ is called, optionally with +args+ (and
     # +kwargs+ or a +blk+, and returns +retval+.
@@ -91,10 +93,26 @@ module Minitest # :nodoc:
 
       if block_given?
         raise ArgumentError, "args ignored when block given" unless args.empty?
+        raise ArgumentError, "kwargs ignored when block given" unless kwargs.empty?
         @expected_calls[name] << { :retval => retval, :block => blk }
       else
         raise ArgumentError, "args must be an array" unless Array === args
-        @expected_calls[name] << { :retval => retval, :args => args, :kwargs => kwargs }
+
+        if ENV["MT_KWARGS_HAC\K"] && (Hash === args.last ||
+                                      Hash ==  args.last) then
+          if kwargs.empty? then
+            kwargs = args.pop
+          else
+            unless @@KW_WARNED then
+              from = caller.first
+              warn "Using MT_KWARGS_HAC\K yet passing kwargs. From #{from}"
+              @@KW_WARNED = true
+            end
+          end
+        end
+
+        @expected_calls[name] <<
+          { :retval => retval, :args => args, :kwargs => kwargs }
       end
       self
     end
@@ -150,6 +168,9 @@ module Minitest # :nodoc:
       expected_args, expected_kwargs, retval, val_block =
         expected_call.values_at(:args, :kwargs, :retval, :block)
 
+      expected_kwargs = kwargs.map { |ak, av| [ak, Object] }.to_h if
+        Hash == expected_kwargs
+
       if val_block then
         # keep "verify" happy
         @actual_calls[sym] << expected_call
@@ -250,7 +271,7 @@ class Object
   # 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, **block_kwargs
+  def stub name, val_or_callable, *block_args, **block_kwargs, &block
     new_name = "__minitest_stub__#{name}"
 
     metaclass = class << self; self; end
@@ -263,26 +284,37 @@ class Object
 
     metaclass.send :alias_method, new_name, name
 
-    metaclass.send :define_method, name do |*args, **kwargs, &blk|
-      if val_or_callable.respond_to? :call then
-        if kwargs.empty? then # FIX: drop this after 2.7 dead
+    if ENV["MT_KWARGS_HAC\K"] then
+      metaclass.send :define_method, name do |*args, &blk|
+        if val_or_callable.respond_to? :call then
           val_or_callable.call(*args, &blk)
         else
-          val_or_callable.call(*args, **kwargs, &blk)
+          blk.call(*block_args, **block_kwargs) if blk
+          val_or_callable
         end
-      else
-        if blk then
-          if block_kwargs.empty? then # FIX: drop this after 2.7 dead
-            blk.call(*block_args)
+      end
+    else
+      metaclass.send :define_method, name do |*args, **kwargs, &blk|
+        if val_or_callable.respond_to? :call then
+          if kwargs.empty? then # FIX: drop this after 2.7 dead
+            val_or_callable.call(*args, &blk)
           else
-            blk.call(*block_args, **block_kwargs)
+            val_or_callable.call(*args, **kwargs, &blk)
+          end
+        else
+          if blk then
+            if block_kwargs.empty? then # FIX: drop this after 2.7 dead
+              blk.call(*block_args)
+            else
+              blk.call(*block_args, **block_kwargs)
+            end
           end
+          val_or_callable
         end
-        val_or_callable
       end
     end
 
-    yield self
+    block[self]
   ensure
     metaclass.send :undef_method, name
     metaclass.send :alias_method, name, new_name

data/lib/minitest/test.rb

@@ -204,7 +204,7 @@ module Minitest
     def sanitize_exception e # :nodoc:
       Marshal.dump e
       e                                         # good: use as-is
-    rescue TypeError
+    rescue
       neuter_exception e
     end
 
@@ -213,15 +213,22 @@ module Minitest
       msg = e.message.dup
 
       new_exception e.class, msg, bt            # e.class can be a problem...
-    rescue TypeError
+    rescue
       msg.prepend "Neutered Exception #{e.class}: "
 
-      new_exception RuntimeError, msg, bt       # but if this raises, we die
+      new_exception RuntimeError, msg, bt, true # but if this raises, we die
     end
 
-    def new_exception klass, msg, bt
+    def new_exception klass, msg, bt, kill = false
       ne = klass.new msg
       ne.set_backtrace bt
+
+      if kill then
+        ne.instance_variables.each do |v|
+          ne.remove_instance_variable v
+        end
+      end
+
       Marshal.dump ne                           # can raise TypeError
       ne
     end

data/lib/minitest/test_task.rb

@@ -238,7 +238,7 @@ module Minitest # :nodoc:
 
       desc "Show bottom 25 tests wrt time."
       task "#{name}:slow" do
-        sh ["rake #{name} TESTOPTS=-v",
+        sh ["rake #{name} A=-v",
             "egrep '#test_.* s = .'",
             "sort -n -k2 -t=",
             "tail -25"].join " | "

data/lib/minitest.rb

@@ -9,7 +9,7 @@ require "etc"
 # :include: README.rdoc
 
 module Minitest
-  VERSION = "5.16.0" # :nodoc:
+  VERSION = "5.16.3" # :nodoc:
 
   @@installed_at_exit ||= false
   @@after_run = []

data/test/minitest/test_minitest_mock.rb

@@ -1,5 +1,13 @@
 require "minitest/autorun"
 
+def with_kwargs_env
+  ENV["MT_KWARGS_HAC\K"] = "1"
+
+  yield
+ensure
+  ENV.delete "MT_KWARGS_HAC\K"
+end
+
 class TestMinitestMock < Minitest::Test
   parallelize_me!
 
@@ -363,6 +371,61 @@ class TestMinitestMock < Minitest::Test
     assert_mock mock
   end
 
+  def test_mock_allow_all_kwargs__old_style_env
+    with_kwargs_env do
+      mock = Minitest::Mock.new
+      mock.expect :foo, true, [Hash]
+      assert_equal true, mock.foo(bar: 42)
+    end
+  end
+
+  def test_mock_allow_all_kwargs__old_style_env__rewrite
+    with_kwargs_env do
+      mock = Minitest::Mock.new
+      mock.expect :foo, true, [], bar: Integer
+      assert_equal true, mock.foo(bar: 42)
+    end
+  end
+
+  def test_mock_block_is_passed_keyword_args__args__old_style_bad
+    arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+    mock = Minitest::Mock.new
+    mock.expect :foo, nil, [{k1: arg1, k2: arg2, k3: arg3}]
+
+    e = assert_raises ArgumentError do
+      mock.foo(k1: arg1, k2: arg2, k3: arg3)
+    end
+
+    assert_equal "mocked method :foo expects 1 arguments, got []", e.message
+  end
+
+  def test_mock_block_is_passed_keyword_args__args__old_style_env
+    with_kwargs_env do
+      arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+      mock = Minitest::Mock.new
+      mock.expect :foo, nil, [{k1: arg1, k2: arg2, k3: arg3}]
+
+      mock.foo(k1: arg1, k2: arg2, k3: arg3)
+
+      assert_mock mock
+    end
+  end
+
+  def test_mock_block_is_passed_keyword_args__args__old_style_both
+    with_kwargs_env do
+      arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+      mock = Minitest::Mock.new
+
+      assert_output nil, /Using MT_KWARGS_HAC. yet passing kwargs/ do
+        mock.expect :foo, nil, [{}], k1: arg1, k2: arg2, k3: arg3
+      end
+
+      mock.foo({}, k1: arg1, k2: arg2, k3: arg3)
+
+      assert_mock mock
+    end
+  end
+
   def test_mock_block_is_passed_keyword_args__args_bad_missing
     arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
     mock = Minitest::Mock.new
@@ -442,7 +505,7 @@ class TestMinitestMock < Minitest::Test
     assert_equal exp, e.message
   end
 
-  def test_mock_block_throws_if_args_passed
+  def test_mock_block_raises_if_args_passed
     mock = Minitest::Mock.new
 
     e = assert_raises(ArgumentError) do
@@ -456,6 +519,20 @@ class TestMinitestMock < Minitest::Test
     assert_match exp, e.message
   end
 
+  def test_mock_block_raises_if_kwargs_passed
+    mock = Minitest::Mock.new
+
+    e = assert_raises(ArgumentError) do
+      mock.expect :foo, nil, kwargs:1 do
+        true
+      end
+    end
+
+    exp = "kwargs ignored when block given"
+
+    assert_match exp, e.message
+  end
+
   def test_mock_returns_retval_when_called_with_block
     mock = Minitest::Mock.new
     mock.expect(:foo, 32) do
@@ -761,6 +838,26 @@ class TestMinitestStub < Minitest::Test
     end
   end
 
+  def test_stub__hash_as_last_real_arg
+    with_kwargs_env do
+      token = Object.new
+      def token.create_with_retry u, p; raise "shouldn't see this"; end
+
+      controller = Object.new
+      controller.define_singleton_method :create do |u, p|
+        token.create_with_retry u, p
+      end
+
+      params = Object.new
+      def params.to_hash; raise "nah"; end
+
+      token.stub(:create_with_retry, ->(u, p) { 42 }) do
+        act = controller.create :u, params
+        @tc.assert_equal 42, act
+      end
+    end
+  end
+
   def test_stub_callable_block_5 # from tenderlove
     @assertion_count += 1
     Foo.stub5 :blocking, Bar.new do

data/test/minitest/test_minitest_test.rb

@@ -786,6 +786,13 @@ class TestMinitestUnitOrder < MetaMetaMetaTestCase
   end
 end
 
+class BetterError < RuntimeError # like better_error w/o infecting RuntimeError
+  def set_backtrace bt
+    super
+    @bad_ivar = binding
+  end
+end
+
 class TestMinitestRunnable < Minitest::Test
   def setup_marshal klass
     tc = klass.new "whatever"
@@ -895,6 +902,89 @@ class TestMinitestRunnable < Minitest::Test
     assert_equal @tc.failures,   over_the_wire.failures
     assert_equal @tc.klass,      over_the_wire.klass
   end
+
+  def with_runtime_error klass
+    old_runtime = RuntimeError
+    Object.send :remove_const, :RuntimeError
+    Object.const_set :RuntimeError, klass
+    yield
+  ensure
+    Object.send :remove_const, :RuntimeError
+    Object.const_set :RuntimeError, old_runtime
+  end
+
+  def test_spec_marshal_with_exception__better_error_typeerror
+    klass = describe("whatever") {
+      it("raises with binding") {
+        raise BetterError, "boom"
+      }
+    }
+
+    rm = klass.runnable_methods.first
+
+    # Run the test
+    @tc = with_runtime_error BetterError do
+      klass.new(rm).run
+    end
+
+    assert_kind_of Minitest::Result, @tc
+    assert_instance_of Minitest::UnexpectedError, @tc.failure
+
+    msg = @tc.failure.error.message
+    assert_equal "Neutered Exception BetterError: boom", msg
+
+    # Pass it over the wire
+    over_the_wire = Marshal.load Marshal.dump @tc
+
+    assert_equal @tc.time,       over_the_wire.time
+    assert_equal @tc.name,       over_the_wire.name
+    assert_equal @tc.assertions, over_the_wire.assertions
+    assert_equal @tc.failures,   over_the_wire.failures
+    assert_equal @tc.klass,      over_the_wire.klass
+  end
+
+  def test_spec_marshal_with_exception__worse_error_typeerror
+    worse_error_klass = Class.new(StandardError) do
+      # problem #1: anonymous subclass can'tmarshal, fails sanitize_exception
+      def initialize(record = nil)
+
+        super(record.first)
+      end
+    end
+
+    klass = describe("whatever") {
+      it("raises with NoMethodError") {
+        # problem #2: instantiated with a NON-string argument
+        #
+        # problem #3: arg responds to #first, but it becomes message
+        #             which gets passed back in via new_exception
+        #             that passes a string to worse_error_klass#initialize
+        #             which calls first on it, which raises NoMethodError
+        raise worse_error_klass.new(["boom"])
+      }
+    }
+
+    rm = klass.runnable_methods.first
+
+    # Run the test
+    @tc = klass.new(rm).run
+
+    assert_kind_of Minitest::Result, @tc
+    assert_instance_of Minitest::UnexpectedError, @tc.failure
+
+    msg = @tc.failure.error.message.gsub(/0x[A-Fa-f0-9]+/, "0xXXX")
+
+    assert_equal "Neutered Exception #<Class:0xXXX>: boom", msg
+
+    # Pass it over the wire
+    over_the_wire = Marshal.load Marshal.dump @tc
+
+    assert_equal @tc.time,       over_the_wire.time
+    assert_equal @tc.name,       over_the_wire.name
+    assert_equal @tc.assertions, over_the_wire.assertions
+    assert_equal @tc.failures,   over_the_wire.failures
+    assert_equal @tc.klass,      over_the_wire.klass
+  end
 end
 
 class TestMinitestTest < TestMinitestRunnable

data.tar.gz.sig

@@ -1 +1,2 @@
-ot�y^f�/�չ=��M/DV���&d�����Ҙ����C����7W�f�����]��/E�I~0�j+�Ђ��H*>�J�8�;F[u�X������J})����]P��N���*4��[���9b����uF@> �����f�����eH����;���p��^w�c�nR���l&*jhn���⌬��3=k˩E�A/�VQ����ǥ-�A)�Y)c�i�ϗTGi�|S(Q���Bw���R�ǵI	n
+��#3)�~<Lp1���=�ܞb���qG���,]�x,_�.f���	��|Wqn�g�:����ۊ���-5
+�3WP�fG&�����TU�5���tj�Ͷ�AoRvn�ܿ����h��������V�ڌ�Xh3�G׏p��g���|\%d�L�Y#��D�e�=p�={����t�,I���L�����i���2-��$�~�z����]6F�M{t/֦yϭ

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest
 version: !ruby/object:Gem::Version
-  version: 5.16.0
+  version: 5.16.3
 platform: ruby
 authors:
 - Ryan Davis
@@ -29,7 +29,7 @@ cert_chain:
   JFmxn4h9YO/pVdB962BdBNNDia0kgIjI3ENnkLq0dKpYU3+F3KhEuTksLO0L6X/V
   YsuyUzsMz6GQA4khyaMgKNSD
   -----END CERTIFICATE-----
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        version: '3.24'
 description: |-
   minitest provides a complete suite of testing facilities supporting
   TDD, BDD, mocking, and benchmarking.