minitest 5.10.3 → 5.18.0

data/test/minitest/test_minitest_mock.rb

@@ -1,8 +1,14 @@
 require "minitest/autorun"
 
-class TestMinitestMock < Minitest::Test
-  parallelize_me!
+def with_kwargs_env
+  ENV["MT_KWARGS_HAC\K"] = "1"
+
+  yield
+ensure
+  ENV.delete "MT_KWARGS_HAC\K"
+end
 
+class TestMinitestMock < Minitest::Test
   def setup
     @mock = Minitest::Mock.new.expect(:foo, nil)
     @mock.expect(:meaning_of_life, 42)
@@ -51,7 +57,7 @@ class TestMinitestMock < Minitest::Test
       @mock.sum
     end
 
-    assert_equal "mocked method :sum expects 2 arguments, got 0", e.message
+    assert_equal "mocked method :sum expects 2 arguments, got []", e.message
   end
 
   def test_return_mock_does_not_raise
@@ -64,8 +70,6 @@ class TestMinitestMock < Minitest::Test
   end
 
   def test_mock_args_does_not_raise
-    skip "non-opaque use of ==" if maglev?
-
     arg = Minitest::Mock.new
     mock = Minitest::Mock.new
     mock.expect(:foo, nil, [arg])
@@ -135,7 +139,7 @@ class TestMinitestMock < Minitest::Test
       @mock.expect :blah, 3, false
     end
 
-    assert_equal "args must be an array", e.message
+    assert_match "args must be an array", e.message
   end
 
   def test_respond_appropriately
@@ -152,7 +156,7 @@ class TestMinitestMock < Minitest::Test
 
     expected = "unmocked method :bar, expected one of [:foo, :meaning_of_life]"
 
-    assert_equal expected, e.message
+    assert_match expected, e.message
   end
 
   def test_assign_per_mock_return_values
@@ -212,7 +216,7 @@ class TestMinitestMock < Minitest::Test
       mock.a
     end
 
-    assert_equal "No more expects available for :a: []", e.message
+    assert_equal "No more expects available for :a: [] {}", e.message
   end
 
   def test_same_method_expects_are_verified_when_all_called
@@ -254,6 +258,30 @@ class TestMinitestMock < Minitest::Test
     assert_equal exp, e.message
   end
 
+  def test_delegator_calls_are_propagated
+    delegator = Object.new
+    mock = Minitest::Mock.new delegator
+
+    refute delegator.nil?
+    refute mock.nil?
+    assert_mock mock
+  end
+
+  def test_handles_kwargs_in_error_message
+    mock = Minitest::Mock.new
+
+    mock.expect :foo, nil, [], kw: true
+    mock.expect :foo, nil, [], kw: false
+
+    mock.foo kw: true
+
+    e = assert_raises(MockExpectationError) { mock.verify }
+
+    exp = "expected foo(:kw=>false) => nil, got [foo(:kw=>true) => nil]"
+
+    assert_equal exp, e.message
+  end
+
   def test_verify_passes_when_mock_block_returns_true
     mock = Minitest::Mock.new
     mock.expect :foo, nil do
@@ -272,11 +300,188 @@ class TestMinitestMock < Minitest::Test
       a1 == arg1 && a2 == arg2 && a3 == arg3
     end
 
-    mock.foo arg1, arg2, arg3
+    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
+    end
+
+    assert_mock mock
+  end
+
+  def test_mock_block_is_passed_keyword_args__block
+    arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+    mock = Minitest::Mock.new
+    mock.expect :foo, nil do |k1:, k2:, k3:|
+      k1 == arg1 && k2 == arg2 && k3 == arg3
+    end
+
+    mock.foo(k1: arg1, k2: arg2, k3: arg3)
+
+    assert_mock mock
+  end
+
+  def test_mock_block_is_passed_keyword_args__block_bad_missing
+    arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+    mock = Minitest::Mock.new
+    mock.expect :foo, nil do |k1:, k2:, k3:|
+      k1 == arg1 && k2 == arg2 && k3 == arg3
+    end
+
+    e = assert_raises ArgumentError do
+      mock.foo(k1: arg1, k2: arg2)
+    end
+
+    # basically testing ruby ... need ? for ruby < 2.7 :(
+    assert_match(/missing keyword: :?k3/, e.message)
+  end
+
+  def test_mock_block_is_passed_keyword_args__block_bad_extra
+    arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+    mock = Minitest::Mock.new
+    mock.expect :foo, nil do |k1:, k2:|
+      k1 == arg1 && k2 == arg2 && k3 == arg3
+    end
+
+    e = assert_raises ArgumentError do
+      mock.foo(k1: arg1, k2: arg2, k3: arg3)
+    end
+
+    # basically testing ruby ... need ? for ruby < 2.7 :(
+    assert_match(/unknown keyword: :?k3/, e.message)
+  end
+
+  def test_mock_block_is_passed_keyword_args__block_bad_value
+    arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+    mock = Minitest::Mock.new
+    mock.expect :foo, nil do |k1:, k2:, k3:|
+      k1 == arg1 && k2 == arg2 && k3 == arg3
+    end
+
+    e = assert_raises MockExpectationError do
+      mock.foo(k1: arg1, k2: arg2, k3: :BAD!)
+    end
+
+    exp = "mocked method :foo failed block w/ [] {:k1=>:bar, :k2=>[1, 2, 3], :k3=>:BAD!}"
+    assert_equal exp, e.message
+  end
+
+  def test_mock_block_is_passed_keyword_args__args
+    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
 
+  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
+    mock.expect :foo, nil, k1: arg1, k2: arg2, k3: arg3
+
+    e = assert_raises ArgumentError do
+      mock.foo(k1: arg1, k2: arg2)
+    end
+
+    assert_equal "mocked method :foo expects 3 keyword arguments, got %p" % {k1: arg1, k2: arg2}, e.message
+  end
+
+  def test_mock_block_is_passed_keyword_args__args_bad_extra
+    arg1, arg2, arg3 = :bar, [1, 2, 3], { :a => "a" }
+    mock = Minitest::Mock.new
+    mock.expect :foo, nil, k1: arg1, k2: arg2
+
+    e = assert_raises ArgumentError do
+      mock.foo(k1: arg1, k2: arg2, k3: arg3)
+    end
+
+    assert_equal "mocked method :foo expects 2 keyword arguments, got %p" % {k1: arg1, k2: arg2, k3: arg3}, e.message
+  end
+
+  def test_mock_block_is_passed_keyword_args__args_bad_key
+    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 MockExpectationError do
+      mock.foo(k1: arg1, k2: arg2, BAD: arg3)
+    end
+
+    assert_includes e.message, "unexpected keywords [:k1, :k2, :k3]"
+    assert_includes e.message, "vs [:k1, :k2, :BAD]"
+  end
+
+  def test_mock_block_is_passed_keyword_args__args_bad_val
+    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 MockExpectationError do
+      mock.foo(k1: arg1, k2: :BAD!, k3: arg3)
+    end
+
+    assert_match(/unexpected keyword arguments.* vs .*:k2=>:BAD!/, e.message)
+  end
+
   def test_mock_block_is_passed_function_block
     mock = Minitest::Mock.new
     block = proc { "bar" }
@@ -288,6 +493,13 @@ class TestMinitestMock < Minitest::Test
     assert_mock mock
   end
 
+  def test_mock_forward_keyword_arguments
+    mock = Minitest::Mock.new
+    mock.expect(:foo, nil) { |bar:| bar == 'bar' }
+    mock.foo(bar: 'bar')
+    assert_mock mock
+  end
+
   def test_verify_fails_when_mock_block_returns_false
     mock = Minitest::Mock.new
     mock.expect :foo, nil do
@@ -295,12 +507,12 @@ class TestMinitestMock < Minitest::Test
     end
 
     e = assert_raises(MockExpectationError) { mock.foo }
-    exp = "mocked method :foo failed block w/ []"
+    exp = "mocked method :foo failed block w/ [] {}"
 
     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
@@ -311,7 +523,21 @@ class TestMinitestMock < Minitest::Test
 
     exp = "args ignored when block given"
 
-    assert_equal exp, e.message
+    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
@@ -362,7 +588,7 @@ end
 require "minitest/metametameta"
 
 class TestMinitestStub < Minitest::Test
-  parallelize_me!
+  # Do not parallelize since we're calling stub on class methods
 
   def setup
     super
@@ -374,7 +600,7 @@ class TestMinitestStub < Minitest::Test
 
   def teardown
     super
-    assert_equal @assertion_count, @tc.assertions
+    assert_equal @assertion_count, @tc.assertions if self.passed?
   end
 
   class Time
@@ -494,6 +720,18 @@ class TestMinitestStub < Minitest::Test
     @tc.assert_equal false, dynamic.found
   end
 
+  def test_stub_NameError
+    e = @tc.assert_raises NameError do
+      Time.stub :nope_nope_nope, 42 do
+        # do nothing
+      end
+    end
+
+    exp = jruby? ? /Undefined method nope_nope_nope for '#{self.class}::Time'/ :
+      /undefined method `nope_nope_nope' for( class)? `#{self.class}::Time'/
+    assert_match exp, e.message
+  end
+
   def test_mock_with_yield
     mock = Minitest::Mock.new
     mock.expect(:write, true) do
@@ -509,4 +747,400 @@ class TestMinitestStub < Minitest::Test
     @tc.assert_equal true, rs
   end
 
+  def test_mock_with_yield_kwargs
+    mock = Minitest::Mock.new
+    rs = nil
+
+    File.stub :open, true, mock, kw:42 do
+      File.open "foo.txt", "r" do |f, kw:|
+        rs = kw
+      end
+    end
+
+    @tc.assert_equal 42, rs
+  end
+
+  alias test_stub_value__old test_stub_value # TODO: remove/rename
+
+  ## Permutation Sets:
+
+  # [:value, :lambda]
+  # [:*,     :block,     :block_call]
+  # [:**,    :block_args]
+  #
+  # Where:
+  #
+  # :value      = a normal value
+  # :lambda     = callable or lambda
+  # :*          = no block
+  # :block      = normal block
+  # :block_call = :lambda invokes the block (N/A for :value)
+  # :**         = no args
+  # :args       = args passed to stub
+
+  ## Permutations
+
+  # [:call,   :*,          :**]   =>5 callable+block FIX: CALL BOTH (bug)
+  # [:call,   :*,          :**]   =>6 callable
+
+  # [:lambda, :*,          :**]   =>  lambda result
+
+  # [:lambda, :*,          :args] =>  lambda result NO ARGS
+
+  # [:lambda, :block,      :**]   =>5 lambda result FIX: CALL BOTH (bug)
+  # [:lambda, :block,      :**]   =>6 lambda result
+
+  # [:lambda, :block,      :args] =>5 lambda result FIX: CALL BOTH (bug)
+  # [:lambda, :block,      :args] =>6 lambda result
+  # [:lambda, :block,      :args] =>7 raise ArgumentError
+
+  # [:lambda, :block_call, :**]   =>5 lambda FIX: BUG!-not passed block to lambda
+  # [:lambda, :block_call, :**]   =>6 lambda+block result
+
+  # [:lambda, :block_call, :args] =>5 lambda FIX: BUG!-not passed block to lambda
+  # [:lambda, :block_call, :args] =>6 lambda+block result
+
+  # [:value,  :*,          :**]   =>  value
+
+  # [:value,  :*,          :args] =>  value, ignore args
+
+  # [:value,  :block,      :**]   =>5 value, call block
+  # [:value,  :block,      :**]   =>6 value
+
+  # [:value,  :block,      :args] =>5 value, call block w/ args
+  # [:value,  :block,      :args] =>6 value, call block w/ args, deprecated
+  # [:value,  :block,      :args] =>7 raise ArgumentError
+
+  # [:value,  :block_call, :**]   =>  N/A
+
+  # [:value,  :block_call, :args] =>  N/A
+
+  class Bar
+    def call
+      puts "hi"
+    end
+  end
+
+  class Foo
+    def self.blocking
+      yield
+    end
+  end
+
+  class Thingy
+    def self.identity arg
+      arg
+    end
+  end
+
+  class Keywords
+    def self.args req, kw1:, kw2:24
+      [req, kw1, kw2]
+    end
+  end
+
+  def test_stub_callable_keyword_args
+    Keywords.stub :args, ->(*args, **kws) { [args, kws] } do
+      @tc.assert_equal [["woot"], { kw1: 42 }], Keywords.args("woot", kw1: 42)
+    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
+      @tc.assert_output "hi\n", "" do
+        Foo.blocking do
+          @tc.flunk "shouldn't ever hit this"
+        end
+      end
+    end
+  end
+
+  def test_stub_callable_block_6 # from tenderlove
+    skip_stub6
+
+    @assertion_count += 1
+    Foo.stub6 :blocking, Bar.new do
+      @tc.assert_output "hi\n", "" do
+        Foo.blocking do
+          @tc.flunk "shouldn't ever hit this"
+        end
+      end
+    end
+  end
+
+  def test_stub_lambda
+    Thread.stub :new, lambda { 21+21 } do
+      @tc.assert_equal 42, Thread.new
+    end
+  end
+
+  def test_stub_lambda_args
+    Thread.stub :new, lambda { 21+21 }, :wtf do
+      @tc.assert_equal 42, Thread.new
+    end
+  end
+
+  def test_stub_lambda_block_5
+    Thread.stub5 :new, lambda { 21+21 } do
+      result = Thread.new do
+        @tc.flunk "shouldn't ever hit this"
+      end
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_lambda_block_6
+    skip_stub6
+
+    Thread.stub6 :new, lambda { 21+21 } do
+      result = Thread.new do
+        @tc.flunk "shouldn't ever hit this"
+      end
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_lambda_block_args_5
+    @assertion_count += 1
+    Thingy.stub5 :identity, lambda { |y| @tc.assert_equal :nope, y; 21+21 }, :WTF? do
+      result = Thingy.identity :nope do |x|
+        @tc.flunk "shouldn't reach this"
+      end
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_lambda_block_args_6
+    skip_stub6
+
+    @assertion_count += 1
+    Thingy.stub6 :identity, lambda { |y| @tc.assert_equal :nope, y; 21+21 }, :WTF? do
+      result = Thingy.identity :nope do |x|
+        @tc.flunk "shouldn't reach this"
+      end
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_lambda_block_args_6_2
+    skip_stub6
+
+    @tc.assert_raises ArgumentError do
+      Thingy.stub6_2 :identity, lambda { |y| :__not_run__ }, :WTF? do
+        # doesn't matter
+      end
+    end
+  end
+
+  def test_stub_lambda_block_call_5
+    @assertion_count += 1
+    rs = nil
+    io = StringIO.new "", "w"
+    File.stub5 :open, lambda { |p, m, &blk| blk and blk.call io } do
+      File.open "foo.txt", "r" do |f|
+        rs = f && f.write("woot")
+      end
+    end
+    @tc.assert_equal 4, rs
+    @tc.assert_equal "woot", io.string
+  end
+
+  def test_stub_lambda_block_call_6
+    skip_stub6
+
+    @assertion_count += 1
+    rs = nil
+    io = StringIO.new "", "w"
+    File.stub6 :open, lambda { |p, m, &blk| blk.call io } do
+      File.open "foo.txt", "r" do |f|
+        rs = f.write("woot")
+      end
+    end
+    @tc.assert_equal 4, rs
+    @tc.assert_equal "woot", io.string
+  end
+
+  def test_stub_lambda_block_call_args_5
+    @assertion_count += 1
+    rs = nil
+    io = StringIO.new "", "w"
+    File.stub5(:open, lambda { |p, m, &blk| blk and blk.call io }, :WTF?) do
+      File.open "foo.txt", "r" do |f|
+        rs = f.write("woot")
+      end
+    end
+    @tc.assert_equal 4, rs
+    @tc.assert_equal "woot", io.string
+  end
+
+  def test_stub_lambda_block_call_args_6
+    skip_stub6
+
+    @assertion_count += 1
+    rs = nil
+    io = StringIO.new "", "w"
+    File.stub6(:open, lambda { |p, m, &blk| blk.call io }, :WTF?) do
+      File.open "foo.txt", "r" do |f|
+        rs = f.write("woot")
+      end
+    end
+    @tc.assert_equal 4, rs
+    @tc.assert_equal "woot", io.string
+  end
+
+  def test_stub_lambda_block_call_args_6_2
+    skip_stub6
+
+    @assertion_count += 2
+    rs = nil
+    io = StringIO.new "", "w"
+    @tc.assert_raises ArgumentError do
+      File.stub6_2(:open, lambda { |p, m, &blk| blk.call io }, :WTF?) do
+        File.open "foo.txt", "r" do |f|
+          rs = f.write("woot")
+        end
+      end
+    end
+    @tc.assert_nil rs
+    @tc.assert_equal "", io.string
+  end
+
+  def test_stub_value
+    Thread.stub :new, 42 do
+      result = Thread.new
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_value_args
+    Thread.stub :new, 42, :WTF? do
+      result = Thread.new
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_value_block_5
+    @assertion_count += 1
+    Thread.stub5 :new, 42 do
+      result = Thread.new do
+        @tc.assert true
+      end
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_value_block_6
+    skip_stub6
+
+    Thread.stub6 :new, 42 do
+      result = Thread.new do
+        @tc.flunk "shouldn't hit this"
+      end
+      @tc.assert_equal 42, result
+    end
+  end
+
+  def test_stub_value_block_args_5
+    @assertion_count += 2
+    rs = nil
+    io = StringIO.new "", "w"
+    File.stub5 :open, :value, io do
+      result = File.open "foo.txt", "r" do |f|
+        rs = f.write("woot")
+      end
+      @tc.assert_equal :value, result
+    end
+    @tc.assert_equal 4, rs
+    @tc.assert_equal "woot", io.string
+  end
+
+  def test_stub_value_block_args_5__break_if_not_passed
+    e = @tc.assert_raises NoMethodError do
+      File.stub5 :open, :return_value do # intentionally bad setup w/ no args
+        File.open "foo.txt", "r" do |f|
+          f.write "woot"
+        end
+      end
+    end
+    exp = /undefined method `write' for nil/
+    assert_match exp, e.message
+  end
+
+  def test_stub_value_block_args_6
+    skip_stub6
+
+    @assertion_count += 2
+    rs = nil
+    io = StringIO.new "", "w"
+    assert_deprecated do
+      File.stub6 :open, :value, io do
+        result = File.open "foo.txt", "r" do |f|
+          rs = f.write("woot")
+        end
+        @tc.assert_equal :value, result
+      end
+    end
+    @tc.assert_equal 4, rs
+    @tc.assert_equal "woot", io.string
+  end
+
+  def test_stub_value_block_args_6_2
+    skip_stub6
+
+    @assertion_count += 2
+    rs = nil
+    io = StringIO.new "", "w"
+    @tc.assert_raises ArgumentError do
+      File.stub6_2 :open, :value, io do
+        result = File.open "foo.txt", "r" do |f|
+          @tc.flunk "shouldn't hit this"
+        end
+        @tc.assert_equal :value, result
+      end
+    end
+    @tc.assert_nil rs
+    @tc.assert_equal "", io.string
+  end
+
+  def assert_deprecated re = /deprecated/
+    assert_output "", re do
+      yield
+    end
+  end
+
+  def skip_stub6
+    skip "not yet" unless STUB6
+  end
+end
+
+STUB6 = ENV["STUB6"]
+
+if STUB6 then
+  require "minitest/mock6" if STUB6
+else
+  class Object
+    alias stub5 stub
+    alias stub6 stub
+  end
 end