RxJava 和 Retrofit 的单元测试



我有 这个方法调用 Rest API 并将结果作为可观察量(单个(返回:

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 ->

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

首先,您的"内部"观察者:

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

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

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)已经返回了一个反应式组件,虽然我不确定,但让我们假设它是一个单一的。如果没有,将其转换为其他内容应该相当简单。

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

最后,您根据标签使用改造,因此除非非常必要,否则无需使调用返回原始响应。这是真的,因为 retrofit 会为您检查状态代码,并将在onError内部传递错误,并显示 http 异常。这是处理错误的 Rx 方法。

考虑到所有这些,我将像这样重写整个方法:

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

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

它实际上不需要其他任何东西。改造将确保事情最终onSuccessonError。你不需要在这里订阅 api 的结果并处理一次性物品 - 让调用此代码的人来处理它。

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


那么我将如何测试上述方法呢?

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

@Test
fun resetPassword() {
mTokenRepository.resetPassword(MOCK_EMAIL)
verify(mApiInterfacePanda).resetPassword(MOCK_EMAIL)
}

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

最新更新