RxJava 和 Retrofit 的单元测试

Question

我有这个调用 Rest API 并将结果作为 Observable (Single) 返回的方法：

fun resetPassword(email: String): Single<ResetPassword> {
    return Single.create { emitter ->

        val subscription = mApiInterfacePanda.resetPassword(email)
            .observeOn(AndroidSchedulers.mainThread())
            .subscribeOn(Schedulers.io())
            .subscribe({ resetPasswordResponse ->
                when(resetPasswordResponse.code()) {
                    200 ->  {
                        resetPasswordResponse?.body()?.let { resetPassword ->
                            emitter.onSuccess(resetPassword)
                        }
                    }
                    else -> emitter.onError(Exception("Server Error"))
                }
            }, { throwable ->
                    emitter.onError(throwable)
            })

        mCompositeDisposable.add(subscription)

    }
}

单元测试：

@Test
fun resetPassword_200() {
    val response = Response.success(200, sMockResetPasswordResponse)
    Mockito.`when`(mApiInterfacePanda.resetPassword(Mockito.anyString()))
        .thenReturn(Single.just(response))

    mTokenRepository.resetPassword(MOCK_EMAIL)

    val observer = mApiInterfacePanda.resetPassword(MOCK_EMAIL)
    val testObserver = TestObserver.create<Response<ResetPassword>>()
    observer.subscribe(testObserver)

    testObserver.assertSubscribed()
    testObserver.awaitCount(1)
    testObserver.assertComplete()
    testObserver.assertResult(response)
}

我的问题是只有这一行被覆盖，其他行不会运行，这对我的总测试覆盖率有很大影响：

return Single.create { emitter ->

Answer 1

如果我没记错的话，这里发生的事情不止一件事。让我们把它分成几个部分。

首先，你的“内部”观察者：

mApiInterfacePanda.resetPassword(email)
        .observeOn(AndroidSchedulers.mainThread())
        .subscribeOn(Schedulers.io())
        .subscribe({ resetPasswordResponse -> ... })

在 android 主线程上观察并在后台线程上执行。据我所知，在大多数情况下，测试线程将在您mApiInterfacePanda .resetPassword有机会完成并运行之前结束。您并没有真正发布测试设置，所以我不确定这是否是一个实际问题，但无论如何它都值得一提。有两种方法可以解决此问题：

RxJavaPlugins 和 RxAndroidPlugins

RxJava 已经提供了一种更改所提供的调度程序的方法。一个例子是RxAndroidPlugins.setMainThreadSchedulerHandler。它可以提供以下帮助：

@Before
fun setUp() {
   RxAndroidPlugins.setInitMainThreadSchedulerHandler { Schedulers.trampoline() }
   RxJavaPlugins.setInitIoSchedulerHandler { Schedulers.trampoline() }
}

上述方法可确保您在任何地方使用主线程调度程序和 io 调度程序，它都会返回trampoline调度程序。这是一个调度程序，可保证代码在先前执行的同一线程中执行。换句话说，它将确保您在单元测试主线程上运行它。

您将必须撤消这些：

@After
fun tearDown() {
   RxAndroidPlugins.reset()
   RxJavaPlugins.reset()
}

您还可以更改其他调度程序。

注入调度程序

您可以使用 kotlin 的默认参数来帮助注入调度程序：

fun resetPassword(
  email: String, 
  obsScheduler: Scheduler = AndroidSchedulers.mainThread(),
  subScheduler: Scheduler = Schedulers.io()
): Single<ResetPassword> {
   return Single.create { emitter ->

     val subscription = mApiInterfacePanda.resetPassword(email)
        .observeOn(obsScheduler)
        .subscribeOn(subScheduler)
        .subscribe({ resetPasswordResponse ->
            when(resetPasswordResponse.code()) {
                200 ->  {
                    resetPasswordResponse?.body()?.let { resetPassword ->
                        emitter.onSuccess(resetPassword)
                    }
                }
                else -> emitter.onError(Exception("Server Error"))
            }
        }, { throwable ->
                emitter.onError(throwable)
        })

    mCompositeDisposable.add(subscription)
  }
}

在测试时，您可以像这样调用它resetPassword("foo@bar.com", Schedulers.trampoline(), Schedulers.trampoline()，对于应用程序，只需传递电子邮件即可。

我在这里看到的另一件事可能与该问题无关，但我认为了解这一点仍然很好。首先，您要创建一个单曲，但您不需要这样做。

Single.create通常在没有反应式代码时使用。然而，mApiInterfacePanda.resetPassword(email)已经返回了一个反应组件，虽然我不确定，但我们假设它是一个。如果没有，将其转换为其他东西应该相当简单。

你还拿着一次性用品，据我所知，这应该是没有必要的。

最后，您根据标签使用改造，因此除非非常必要，否则不需要使调用返回原始响应。onError这是真的，因为 Retrofit 会为您检查状态代码，并会通过 http 异常传递内部错误。这是 Rx 处理错误的方式。

考虑到所有这些，我将重写整个方法，如下所示：

fun resetPassword(email: String) = mApiInterfacePanda.resetPassword(email)

（请注意，resetPassword不得返回原始响应，但Single<ResetPassword>

它实际上不应该需要任何其他东西。改造将确保事情最终以 或onSuccess的方式结束onError。您不需要在这里订阅 api 的结果并处理一次性事件 - 让调用此代码的人来处理它。

您可能还注意到，如果是这种情况，则不需要调度程序的解决方案。我想在这种情况下确实如此，只需记住一些运算符在某些默认调度程序中运行，在某些情况下您可能需要覆盖它们。

那么我该如何测试上述方法呢？

就我个人而言，我只是检查该方法是否使用正确的参数调用 api：

@Test
fun resetPassword() {
   mTokenRepository.resetPassword(MOCK_EMAIL)

   verify(mApiInterfacePanda).resetPassword(MOCK_EMAIL)
}

我认为这里不需要更多。在重写的方法中我看不到更多的逻辑。