logo标签列表

Kotlin和ArgumentCaptor - IllegalStateException

androidrobolectrickotlin
63
我在使用ArgumentCaptor捕获Class参数时遇到了问题。我的测试类如下所示：

I have a problem with capturing the Class argument via ArgumentCaptor. My test class looks like this:

@RunWith(RobolectricGradleTestRunner::class)
@Config(sdk = intArrayOf(21), constants = BuildConfig::class)
class MyViewModelTest {
    @Mock
    lateinit var activityHandlerMock: IActivityHandler;

    @Captor
    lateinit var classCaptor: ArgumentCaptor<Class<BaseActivity>>

    @Captor
    lateinit var booleanCaptor: ArgumentCaptor<Boolean>

    private var objectUnderTest: MyViewModel? = null

    @Before
    fun setUp() {
        initMocks(this)
        ...
        objectUnderTest = MyViewModel(...)
    }

    @Test
    fun thatNavigatesToAddListScreenOnAddClicked(){
        //given

        //when
        objectUnderTest?.addNewList()

        //then
        verify(activityHandlerMock).navigateTo(classCaptor.capture(), booleanCaptor.capture())
        var clazz = classCaptor.value
        assertNotNull(clazz);
        assertFalse(booleanCaptor.value);
    }
}
当我运行测试时，会抛出以下异常：
java.lang.IllegalStateException: classCaptor.capture()不能为空
在Kotlin中是否可以使用参数捕获器？

========= 更新1：
Kotlin版本：1.0.0-beta-4584
Mockito版本：1.10.19
Robolectric版本：3.0

========= 更新2：
堆栈跟踪：

java.lang.IllegalStateException: classCaptor.capture() must not be null

at com.example.view.model.ShoplistsViewModelTest.thatNavigatesToAddListScreenOnAddClicked(ShoplistsViewModelTest.kt:92)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:606)
at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:26)
at org.robolectric.RobolectricTestRunner$2.evaluate(RobolectricTestRunner.java:251)
at org.robolectric.RobolectricTestRunner.runChild(RobolectricTestRunner.java:188)
at org.robolectric.RobolectricTestRunner.runChild(RobolectricTestRunner.java:54)
at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
at org.robolectric.RobolectricTestRunner$1.evaluate(RobolectricTestRunner.java:152)
at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
at org.junit.runner.JUnitCore.run(JUnitCore.java:137)
at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:69)
at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:234)
at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:74)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:57)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:606)
at com.intellij.rt.execution.application.AppMain.main(AppMain.java:144)
刚刚尝试了你的示例，它完美地运行了。你使用的Kotlin、Mockito和Roboelectric版本是什么？ - miensol
谢谢您的查看。我已经更新了问题。您尝试过哪些版本？ - Ramps
刚刚重新检查了Gist中的示例，并且它与你列出的版本完全可以正常工作。看起来你的代码必须有些不同。你能贴出一个堆栈跟踪吗？ - miensol
我已经添加了堆栈跟踪。不幸的是，它似乎并没有什么帮助。 - Ramps
2
是的，没错。我没有注意到navigateTo方法只接受非空值。当我将navigateTo方法的签名更改为这个：fun navigateTo(clazz: Class<out BaseActivity>?, closeCurrent: Boolean)，那么示例就可以正常工作了。如果您愿意，请回答这个问题，这样以后如果有人遇到同样的问题，他就可以找到解决方案。 - Ramps
显示剩余3条评论
9个回答
70

从这个博客开始

"在Kotlin中让匹配器正常工作可能会有问题。如果您有一个用Kotlin编写的方法，它不接受可空参数，那么我们无法使用Mockito.any()进行匹配。这是因为它可能返回void，而这不能赋值给非空参数。如果要匹配的方法是用Java编写的，则我认为它将起作用，因为所有Java对象都是隐式可空的。"

需要一个包装函数，返回ArgumentCaptor.capture()作为可空类型。

将以下内容添加为测试的帮助方法

fun <T> capture(argumentCaptor: ArgumentCaptor<T>): T = argumentCaptor.capture()

请查看Android Architecture repo中由Google提供的MockitoKotlinHelpers.kt作为参考。其中capture函数提供了一种方便的调用ArgumentCaptor.capture()的方法。
verify(activityHandlerMock).navigateTo(capture(classCaptor), capture(booleanCaptor))

更新：如果上述解决方案对您无效，请查看下面评论中Roberto Leinardi的解决方案。

1
谢谢，这对我很有效。GoogleSample关于UnitTest的部分非常值得学习！ - angryd
1
很高兴它对你有用，angryd。当然！每当我遇到困难时，我基本上都会参考他们的示例，而且文档也很完善。 - Ikechukwu Kalu
1
我认为这应该是被接受的答案。使用fun capture(captor: ArgumentCaptor<T>)帮助了我，而不必添加mockito-kotlin。 - Kaskasi
4
在添加了以下代码后，我仍然遇到相同的问题： fun <T> capture(argumentCaptor: ArgumentCaptor<T>): T = argumentCaptor.capture()在测试代码中： val userCacheCaptor = ArgumentCaptor.forClass(User::class.java) Mockito.verify(userCache, Mockito.times(1)).set(Mockito.anyString(), capture(userCacheCaptor))出现错误：java.lang.IllegalStateException: capture(userCacheCaptor) 不能为 null。 - vlio20
11
@IkechukwuKalu 我曾经遇到相同的问题，我使用注解 @Captor private lateinit var snackbarManagerArgumentCaptor: ArgumentCaptor<ShowSnackbarEvent> 以及帮助函数 verify(snackbarManager).show(capture(snackbarManagerArgumentCaptor)) 解决了它。 - Roberto Leinardi
显示剩余5条评论
46
classCaptor.capture()的返回值为null，但是IActivityHandler#navigateTo(Class, Boolean)的签名不允许null参数。

mockito-kotlin库提供了支持函数以解决这个问题。

代码应该是:

    @Captor
    lateinit var classCaptor: ArgumentCaptor<Class<BaseActivity>>

    @Captor
    lateinit var booleanCaptor: ArgumentCaptor<Boolean>

    ...

    @Test
    fun thatNavigatesToAddListScreenOnAddClicked(){
        //given

        //when
        objectUnderTest?.addNewList()

        //then
        verify(activityHandlerMock).navigateTo(
com.nhaarman.mockitokotlin2.capture<Class<BaseActivity>>(classCaptor.capture()), 
com.nhaarman.mockitokotlin2.capture<Boolean>(booleanCaptor.capture())
)
        var clazzValue = classCaptor.value
        assertNotNull(clazzValue);
        val booleanValue = booleanCaptor.value
        assertFalse(booleanValue);
    }

或者

var classCaptor = com.nhaarman.mockitokotlin2.argumentCaptor<Class<BaseActivity>>()
var booleanCaptor = com.nhaarman.mockitokotlin2.argumentCaptor<Boolean>()
...
 verify(activityHandlerMock).navigateTo(
classCaptor.capture(), 
booleanCaptor.capture()
)

同时在 build.gradle 文件中添加以下内容：

testImplementation "com.nhaarman.mockitokotlin2:mockito-kotlin:2.2.0"
44
仅为其他搜索此问题的人补充上面的答案：您需要使用com.nhaarman.mockito_kotlin.capture(classCaptor)而不是classCaptor.capture()。 - BhathiyaW
3
这是一个来自Google CodeLabs的测试示例，使用参数Captor。请点击此处以查看示例内容。 - nmu
4
我曾多次尝试使用com.nhaarman.mockito_kotlin.capture，但未能成功。请参见https://dev59.com/t1kT5IYBdhLWcg3wXuTP。该链接指向一个维基页面：https://github.com/nhaarman/mockito-kotlin/wiki/Mocking-and-verifying#argument-captors。因此，我尝试从导入中删除几个Mockito*库，将`verify`更改为com.nhaarman.mockito_kotlin.verify，这个问题就消失了。 - CoolMind
3
我必须明确指定 T 类型不应为 null：com.nhaarman.mockitokotlin2.capture<MyType>(argumentCaptor)。 - Achraf Amil
@CoolMind 非常有帮助，谢谢。对于其他人，请查看我的答案，其中明确说明了该怎么做。 - Sufian
谢谢这个...哎呀！尽管Kotlin有很多功能，但我开始不喜欢它了...它太难读懂了，代码基本上就像加密一样。 - xbmono
20

使用kotlin-mockitohttps://mvnrepository.com/artifact/com.nhaarman/mockito-kotlin/1.5.0作为依赖项，示例代码如下：

argumentCaptor<Hotel>().apply {
    verify(hotelSaveService).save(capture())

    assertThat(allValues.size).isEqualTo(1)
    assertThat(firstValue.name).isEqualTo("İstanbul Hotel")
    assertThat(firstValue.totalRoomCount).isEqualTo(10000L)
    assertThat(firstValue.freeRoomCount).isEqualTo(5000L)
}
7

正如评论中的CoolMind所述，您首先需要添加gradle导入Kotlin-Mockito，然后将所有导入都转换为使用此库。您的导入现在将如下所示：

import com.nhaarman.mockitokotlin2.argumentCaptor
import com.nhaarman.mockitokotlin2.any
import com.nhaarman.mockitokotlin2.eq
import com.nhaarman.mockitokotlin2.isNull
import com.nhaarman.mockitokotlin2.mock
import com.nhaarman.mockitokotlin2.verify

那么你的测试类将会是这样的：

val mArgumentCaptor = argumentCaptor<SignUpInteractor.Callback>()

@Test
fun signUp_success() {
    val customer = Customer().apply {
        name = "Test Name"
        email = "test@example.com"
        phone = "0123444456789"
        phoneDdi = "+92"
        phoneNumber = ""
        countryCode = "92"
        password = "123456"
    }
    mPresenter.signUp(customer)
    verify(mView).showProgress()
    verify(mInteractor).createAccount(any(), isNull(), mArgumentCaptor.capture())
}
6
根据这个解决方案，我的解决方案如下：
fun <T> uninitialized(): T = null as T

//open verificator
val verificator = verify(activityHandlerMock)

//capture (would be same with all matchers)
classCaptor.capture()
booleanCaptor.capture()

//hack
verificator.navigateTo(uninitialized(), uninitialized())
我不知道为什么，但这是迄今为止唯一有效的解决方案。尽管从技术上讲，其他解决方案也应该能够工作，因为它们似乎只是将 null 通用转换为 T。 - bompf
0

在使用kotlin-Mockito库无法解决问题后，我使用反射创建了一个解决方案。 这是一个函数，它提取先前提供给模拟对象的参数：

fun <T: Any, S> getTheArgOfUsedFunctionInMockObject(mockedObject: Any, function: (T) -> S, clsOfArgument: Class<T>): T{
    val argCaptor= ArgumentCaptor.forClass(clsOfArgument)
    val ver = verify(mockedObject)
    argCaptor.capture()
    ver.javaClass.methods.first { it.name == function.reflect()!!.name }.invoke(ver, uninitialized())
    return argCaptor.value
}
private fun <T> uninitialized(): T = null as T

用法： （假设我已经模拟了我的存储库并测试了一个viewModel。在使用MenuObject对象调用viewModel的“update()”方法后，我想确保MenuObject实际上调用了存储库的“updateMenuObject()”方法：）
viewModel.update(menuObjectToUpdate)
val arg = getTheArgOfUsedFunctionInMockObject(mockedRepo, mockedRepo::updateMenuObject, MenuObject::class.java)
assertEquals(menuObjectToUpdate, arg)
0
你可以编写一个封装 Argument Captor 的包装器。
class CaptorWrapper<T:Any>(private val captor:ArgumentCaptor<T>, private val obj:T){
    fun capture():T{
        captor.capture()
        return obj
    }

    fun captor():ArgumentCaptor<T>{
        return captor
    }
}
0

如果之前提供的解决方案都无法解决您的问题，这里还有一种尝试的方法。它基于Mockito-Kotlin。

[app/build.gradle]
dependencies {
    ...
    testImplementation 'org.mockito.kotlin:mockito-kotlin:3.2.0'
}

在你的测试文件中定义Rule和Mock。
@RunWith(AndroidJUnit4::class)
class MockitoTest {
    @get:Rule
    val mockitoRule: MockitoRule = MockitoJUnit.rule()

    @Mock
    private lateinit var mockList: MutableList<String>

这里是一个例子。

    @Test
    fun `argument captor`() {
        mockList.add("one")
        mockList.add("two")

        argumentCaptor<String>().apply {
            // Verify that "add()" is called twice, and capture the arguments.
            verify(mockList, times(2)).add(capture())

            assertEquals(2, allValues.size)
            assertEquals("one", firstValue)
            assertEquals("two", secondValue)
        }
    }
}

或者，您也可以使用@Captor。

@Captor
private lateinit var argumentCaptor: ArgumentCaptor<String>

@Test
fun `argument captor`() {
    mockList.add("one")
    mockList.add("two")

    verify(mockList, times(2)).add(capture(argumentCaptor))

    assertEquals(2, argumentCaptor.allValues.size)
    assertEquals("one", argumentCaptor.firstValue)
    assertEquals("two", argumentCaptor.secondValue)
}
0

另一种方法：

/**
 * Use instead of ArgumentMatcher.argThat(matcher: ArgumentMatcher<T>)
 */
fun <T> safeArgThat(matcher: ArgumentMatcher<T>): T {
    ThreadSafeMockingProgress.mockingProgress().argumentMatcherStorage
        .reportMatcher(matcher)
    return uninitialized()
}

@Suppress("UNCHECKED_CAST")
private fun <T> uninitialized(): T = null as T

使用方法：

verify(spiedElement, times(1)).method(
    safeArgThat(
        CustomMatcher()
    )
)
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接