Android Studio kotlinでJunitテスト、Argument(s) are different! Wantedを解決できない

Question

#前提・実現したいこと

Androidアプリ開発でkotlinでJunitテストを取り入れてみました。
下記のfun autoLoginTest()のverifyはpassすると思っていましたが、Coroutine周りで怒られているようです。
error内容について調べましたが、Coroutineについての理解が浅く解決できません。

なぜエラーになるのか、どうしたら解決できるのか教えていただきたいです。
よろしくお願いします。

###前提
presenterのautoLogin()についてのテストです
コード中のuserRepository.getUserProfile()はsuspend functionです。

architecture sampleのtodoアプリのtodo-mvp-coroutineを参考にしています
https://github.com/dmytrodanylyk/android-architecture/tree/todo-mvp-kotlin-coroutines

#発生している問題・エラーメッセージ

Argument(s) are different! Wanted:
userRepository.getUserProfile(
    Continuation at com.example.gotcha2.autoLogin.AutoLoginPresenterTest$testAutoLogin$1.invokeSuspend(AutoLoginPresenterTest.kt:68)
);
-> at com.example.gotcha2.data.source.repository.UserRepository.getUserProfile(UserRepository.kt:16)
Actual invocation has different arguments:
userRepository.getUserProfile(
    Continuation at com.example.gotcha2.autoLogin.AutoLoginPresenter$autoLogin$1.invokeSuspend(AutoLoginPresenter.kt:33)
);
-> at com.example.gotcha2.autoLogin.AutoLoginPresenter$autoLogin$1.invokeSuspend(AutoLoginPresenter.kt:33)

Comparison Failure: 
<Click to see difference>

#該当のソースコード
##コード
AutoLoginPresenter

class AutoLoginPresenter(private val userRepository: UserRepository,
                         private val autoLoginView: AutoLoginContract.View,
                         private val uiContext: CoroutineContext =
Dispatchers.Main
                        )
    : AutoLoginContract.Presenter{
    init {
        autoLoginView.presenter = this
    }

    override fun start() {
        autoLogin()
    }

    private fun autoLogin() = launchSilent(uiContext){

        //realmからprofileを取ってきて、そのあとログイン処理を行う

        val profileResult = userRepository.getUserProfile()

//        println(profileResult.toString())
        if (profileResult is Result.Success){

            val loginResult = userRepository.login(profileResult.data)
            if(loginResult is Result.Success<UserProfile>){
                autoLoginView.transitionOriginFriend()
            }else{
                autoLoginView.transitionLogin()
            }
        }
        //アカウントがLocalに存在しない
        else if(profileResult is Result.Error){
            autoLoginView.transitionCreateAccount()
        }else{

        }
    }
}

CoroutineExt.kt

fun launchSilent(
    context: CoroutineContext = Dispatchers.Main,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
) {
    GlobalScope.launch(context, start, block)
}

/**
 * Equivalent to [runBlocking] but return [Unit] instead of [T].
 *
 * Mainly for usage when you want to lift [runBlocking] to return. Example:
 *
 * ```
 * override fun loadData() = runBlockingSilent {
 *     // code
 * }
 * ```
 */
fun <T> runBlockingSilent(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T) {
    runBlocking(context, block)
}

##テストコード

class AutoLoginPresenterTest {

    @Mock private lateinit var userRepository: UserRepository

    @Mock private lateinit var autoLoginView: AutoLoginContract.View

    private lateinit var autoLoginPresenter: AutoLoginPresenter

    private val EMAIL = "email"

    private val PASSWORD = "password"

    private val UID = "uid"

    private val CREATED_AT: Timestamp = Timestamp.now()

    private val USER_PROFILE = UserProfile(UID,CREATED_AT,EMAIL,PASSWORD)


    @Before
    fun setup(){
//        Dispatchers.setMain(Dispatchers.Unconfined)
        MockitoAnnotations.initMocks(this)


        `when`(autoLoginView.isActive).thenReturn(true)
    }


    @Test
    fun testAutoLogin() = runBlockingSilent {
        `when`(userRepository.getUserProfile()).thenReturn(Result.Success(USER_PROFILE))
        `when`(userRepository.login(USER_PROFILE)).thenReturn(Result.Success(USER_PROFILE))

        autoLoginPresenter = AutoLoginPresenter(userRepository, autoLoginView, Unconfined).apply { start() }
        //今回の問題
        verify(userRepository).getUserProfile()

    }

}

#試したこと
#使っているツールのバージョンなど補足情報

Comments

[kakajika]

coroutinesやmockitoのバージョンはいくつですか？

[kotatsu828]

implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.4'
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.4'

testImplementation "com.nhaarman:mockito-kotlin:1.5.0"
testImplementation 'org.mockito:mockito-inline:2.21.0'
testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.2.1'

androidTestImplementation("org.mockito:mockito-android:2.24.5")

以上です。よろしくお願いします。

Answer 1

mockitoのバージョンが古いために、coroutines@1.0.0以降のパッケージ名の変更への対応が適用されていないのだと思います。こちらのPRによればmockito@2.23.0のリリースに含まれているとのことなので、それ以上のバージョンに上げて試してみてください。

---

一応エラーの原因を解説しておくと、

suspend関数は実際には引数の最後にContinuationを追加した通常の関数に変換されるのですが、このContinuationの値はコルーチン毎に別のものとなります。ご質問のコードの場合はautoLogin()の中でlaunchを呼んで新たなコルーチンを生成しているので、その中で呼び出されたgetUserProfile()にはlaunchの外とは別のContinuationが渡されるわけです。これにより引数のContinuationが一致しないよ!というエラーが出ています。
これを避けるために、mockitoでは引数の最後にContinuationがある関数（つまりsuspend関数）についてはContinuationを除外した引数を比較するように実装されています。

Comments

[kotatsu828]

passしました！丁寧な解説もつけてくださり、ありがとうございます！