使用 Mockito 监视带有对象参数的方法会导致 NullPointerException答案

【问题标题】：Using Mockito to spy a method with object argument results in NullPointerException使用 Mockito 监视带有对象参数的方法会导致 NullPointerException
【发布时间】：2019-10-15 10:54:11
【问题描述】：

我正在尝试使用Mockito.spy 测试一些代码，以便为我需要提供的一些功能提供行为。虽然我知道我正在做的事情可能有更好的选择，但我很好奇为什么下面的代码会在 Scala 中抛出 NullPointerException 以及如何解决它。

正在测试Foo 类。它包含一个方法act，就这个问题而言，它只是计算数字的总和。 FooSpec 类是 Foo 类的相应单元测试。 Bar 类是另一个类，用作 Foo 类的参数，以演示发生异常的情况。

以下代码有效。方法Foo.act 不接受任何参数。

package foo

import org.mockito.Matchers.any
import org.mockito.Mockito.{spy, times, verify, when}
import org.scalatest.WordSpec
import org.scalatest.mockito.MockitoSugar

class Foo {
  def act(): Int = {
    (1 to 10).sum
  }
}

class FooSpec extends WordSpec with MockitoSugar {
  "a test" in {
    val spiedFoo = spy(new Foo)
    when(spiedFoo.act()).thenReturn(100)

    val result = spiedFoo.act()

    assert(result == 100)
    verify(spiedFoo, times(1)).act()
  }
}

以下代码中断。方法Foo.act 接受Bar 类型的1 个参数。出于某种原因，它会抛出 java.lang.NullPointerException

package foo

import org.mockito.Matchers.any
import org.mockito.Mockito.{spy, times, verify, when}
import org.scalatest.WordSpec
import org.scalatest.mockito.MockitoSugar

case class Bar(value: Int)

class Foo {
  def act(bar: Bar): Int = {
    (1 to bar.value).sum
  }
}

class FooSpec extends WordSpec with MockitoSugar {
  "a test" in {
    val spiedFoo = spy(new Foo)
    when(spiedFoo.act(any[Bar])).thenReturn(100)

    val aBar = Bar(10)
    val result = spiedFoo.act(aBar)

    assert(result == 100)
    verify(spiedFoo, times(1)).act(any[Bar])
  }
}

下面是测试得到的错误信息：

[info] FooSpec:
[info] - a test *** FAILED ***
[info]   java.lang.NullPointerException:
[info]   at foo.Foo.act(FooSpec.scala:12)
[info]   at foo.FooSpec$$anonfun$1.apply$mcI$sp(FooSpec.scala:19)
[info]   at foo.FooSpec$$anonfun$1.apply(FooSpec.scala:17)
[info]   at foo.FooSpec$$anonfun$1.apply(FooSpec.scala:17)
[info]   at org.scalatest.OutcomeOf$class.outcomeOf(OutcomeOf.scala:85)
[info]   at org.scalatest.OutcomeOf$.outcomeOf(OutcomeOf.scala:104)
[info]   at org.scalatest.Transformer.apply(Transformer.scala:22)
[info]   at org.scalatest.Transformer.apply(Transformer.scala:20)
[info]   at org.scalatest.WordSpecLike$$anon$1.apply(WordSpecLike.scala:1078)
[info]   at org.scalatest.TestSuite$class.withFixture(TestSuite.scala:196)
[info]   ...
[info] Run completed in 761 milliseconds.
[info] Total number of tests run: 1
[info] Suites: completed 1, aborted 0
[info] Tests: succeeded 0, failed 1, canceled 0, ignored 0, pending 0
[info] *** 1 TEST FAILED ***
[error] Failed tests:
[error]         foo.FooSpec
[error] (foo/test:testOnly) sbt.TestsFailedException: Tests unsuccessful
[error] Total time: 6 s, completed Oct 15, 2019 5:50:20 PM

【问题讨论】：

我在涉及处理值类的模拟时看到了类似的行为，请检查是否是这种情况。

标签： scala nullpointerexception mockito scalatest

【解决方案1】：

Important gotcha on spying real objects 状态

有时使用when(Object) 是不可能或不切实际的刺探间谍。因此，在使用间谍时请考虑 doReturn|Answer|Throw() 存根方法系列。

因此尝试

doReturn(100).when(spiedFoo).act(any[Bar])

而不是

when(spiedFoo.act(any[Bar])).thenReturn(100)

还可以考虑转移到mockito-scala，例如

class FooSpec extends WordSpec with Matchers with IdiomaticMockito with ArgumentMatchersSugar {
  "a test" in {
    val spiedFoo = spy(new Foo)
    100 willBe returned by spiedFoo.act(*)

    val aBar = Bar(10)
    val result = spiedFoo.act(aBar)

    result shouldEqual  100
    spiedFoo.act(*) was called
  }
}

【讨论】：