
這是關(guān)于測(cè)試Kotlin中MVP應(yīng)用程序每一層的文章的第二部分。 在第一部分,我們討論了模型層(Model)和交互層(Interactor)的測(cè)試。 如果你錯(cuò)過(guò)了,你可以在這里查看。
在這部分中,我將向您展示如何使用RxJavaPlugins和依賴注入替代使用 test schedulers來(lái)測(cè)試presenter。 我們還將看到如何在我們的測(cè)試中控制schedulers的時(shí)間。
測(cè)試UserListPresenter
UserListPresenter的代碼很簡(jiǎn)單。 它只有兩個(gè)公共方法。
- getUsers - 從交互層請(qǐng)求用戶,并根據(jù)結(jié)果更新UI。
- onScrollChanged - 處理RecyclerView的滾動(dòng)變化。 如果我們到達(dá)列表中的特定元素,我們已經(jīng)開(kāi)始在后臺(tái)獲取下一頁(yè) 數(shù)據(jù),并且僅在用戶到達(dá)最后一個(gè)元素時(shí)顯示加載指示符,此時(shí)加載還未完成。
class UserListPresenter(
private val getUsers: GetUsers) : BasePresenter<UserListView>() {
private val offset = 5
private var page = 1
private var loading = false
fun getUsers(forced: Boolean = false) {
loading = true
val pageToRequest = if (forced) 1 else page
getUsers.execute(pageToRequest, forced)
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(
{ users -> handleSuccess(forced, users) },
{ handleError() })
}
private fun handleSuccess(forced: Boolean, users: List<UserViewModel>) {
loading = false
if (forced) {
page = 1
}
if (page == 1) {
view?.clearList()
view?.hideEmptyListError()
}
view?.addUsersToList(users)
view?.hideLoading()
page++
}
private fun handleError() {
loading = false
view?.hideLoading()
if (page == 1) {
view?.showEmptyListError()
} else {
view?.showToastError()
}
}
fun onScrollChanged(lastVisibleItemPosition: Int, totalItemCount: Int) {
val shouldGetNextPage = !loading && lastVisibleItemPosition >= totalItemCount - offset
if (shouldGetNextPage) {
getUsers()
}
if (loading && lastVisibleItemPosition >= totalItemCount) {
view?.showLoading()
}
}
}
UserListPresenter.kt hosted with ? by GitHub
使用即時(shí)調(diào)度器覆蓋默認(rèn)的RxJava調(diào)度器
首先,我們將看到如何使用一個(gè)可以在RxJavaPlugins的幫助下立即運(yùn)行命令的scheduler替換RxJava schedulers。
RxJavaPlugins是一個(gè)實(shí)用的類(lèi),它允許我們修改RxJava的默認(rèn)行為。 我們只需要更改默認(rèn)的scheduler,就可以改變關(guān)于RxJava如何工作的其他幾個(gè)方面。
首先讓我們?yōu)?code>UserListPresenter寫(xiě)一個(gè)簡(jiǎn)單的測(cè)試,看看會(huì)發(fā)生什么。
class UserListPresenterTest {
@Mock
lateinit var mockGetUsers: GetUsers
@Mock
lateinit var mockView: UserListView
lateinit var userListPresenter: UserListPresenter
@Before
fun setUp() {
MockitoAnnotations.initMocks(this)
userListPresenter = UserListPresenter(mockGetUsers)
}
@Test
fun testGetUsers_errorCase_showError() {
// Given
val error = "Test error"
val single: Single<List<UserViewModel>> = Single.create {
emitter ->
emitter.onError(Exception(error))
}
// When
whenever(mockGetUsers.execute(anyInt(), anyBoolean())).thenReturn(single)
userListPresenter.attachView(mockView)
userListPresenter.getUsers()
// Then
verify(mockView).hideLoading()
verify(mockView).showEmptyListError()
}
}
如果你已經(jīng)閱讀了第一部分,那這里應(yīng)該沒(méi)有什么新鮮事。 我們使用Mockito創(chuàng)建一些模擬對(duì)象,在UserListPresenter上調(diào)用一些方法,然后驗(yàn)證預(yù)期的行為。
但是,如果我們嘗試運(yùn)行此測(cè)試,我們將面臨以下錯(cuò)誤:
java.lang.ExceptionInInitializerError
...
Caused by: java.lang.RuntimeException: Method getMainLooper in android.os.Looper not mocked. See http://g.co/androidstudio/not-mocked for details.
at android.os.Looper.getMainLooper(Looper.java)
這是因?yàn)?code>AndroidSchecdulers.mainThread()和Android框架的依賴關(guān)系,然而我們正在創(chuàng)建本地?的單元測(cè)試。
在這里,我們可以使用RxJavaPlugins和RxAndroidPlugins這些類(lèi)來(lái)覆蓋默認(rèn)的scheduler。
首先我們?cè)跍y(cè)試類(lèi)中創(chuàng)建一個(gè)immediateScheduler字段。 我們必須從RxJava擴(kuò)展Scheduler類(lèi),并覆蓋createWorker方法以立即運(yùn)行操作。 然后在setUp方法中,我們調(diào)用RxJavaPlugins和RxAndroidPlugins的靜態(tài)方法來(lái)覆蓋調(diào)度器。 下面的代碼段實(shí)現(xiàn)了這一點(diǎn)。 我們還需要在tearDown方法中重置調(diào)度器。
class UserListPresenterTest {
private val immediateScheduler = object : Scheduler() {
override fun createWorker(): Worker {
return ExecutorScheduler.ExecutorWorker(Executor { it.run() })
}
}
...
@Before
fun setUp() {
...
RxJavaPlugins.setInitIoSchedulerHandler { immediateScheduler }
RxAndroidPlugins.setInitMainThreadSchedulerHandler { immediateScheduler }
...
}
@After
fun tearDown() {
RxJavaPlugins.reset()
RxAndroidPlugins.reset()
}
}
現(xiàn)在我們的測(cè)試將會(huì)通過(guò)。這里我們只覆蓋了兩個(gè)調(diào)度器,但是在RxJava中還有更多的調(diào)度器。 由于我們?cè)?code>UserListPresenter中只使用這兩個(gè),所以沒(méi)有必要重寫(xiě)其余的。
這很棒,但是如果我們有10個(gè)presenter,難道我們需要在所有的測(cè)試中去做這些? 當(dāng)然不是。 我們可以創(chuàng)建一個(gè)TestRule,在那里我們覆蓋scheduler,并將它應(yīng)用在我們需要的每個(gè)測(cè)試中。
class ImmediateSchedulerRule : TestRule {
private val immediate = object : Scheduler() {
override fun createWorker(): Worker {
return ExecutorScheduler.ExecutorWorker(Executor { it.run() })
}
}
override fun apply(base: Statement, d: Description): Statement {
return object : Statement() {
@Throws(Throwable::class)
override fun evaluate() {
RxJavaPlugins.setInitIoSchedulerHandler { immediate }
RxJavaPlugins.setInitComputationSchedulerHandler { immediate }
RxJavaPlugins.setInitNewThreadSchedulerHandler { immediate }
RxJavaPlugins.setInitSingleSchedulerHandler { immediate }
RxAndroidPlugins.setInitMainThreadSchedulerHandler { immediate }
try {
base.evaluate()
} finally {
RxJavaPlugins.reset()
RxAndroidPlugins.reset()
}
}
}
}
}
在 TestRule中,我們覆蓋每個(gè)scheduler,所以如果我們使用其他scheduler,我們可以在任何地方使用相同的TestRule。 如果我們從未在我們的應(yīng)用程序中使用特定的scheduler,我們可以將其從TestRule中排除。
要使用我們新創(chuàng)建的TestRule,我們需要將以下代碼添加到我們的測(cè)試類(lèi)中。
@Rule @JvmField
val immediateSchedulerRule = ImmediateSchedulerRule()
我們需要添加
@JvmField注釋?zhuān)驗(yàn)?code>@Rule注釋僅適用于字段和getter方法,但immediateSchedulerRule是Kotlin中的一個(gè)屬性。
就這樣,現(xiàn)在我們可以使用immediate scheduler來(lái)測(cè)試我們的presenter。 變更可以在此提交中找到(它還包含一些測(cè)試用例,這里沒(méi)有顯示):
https://github.com/kozmi55/Kotlin-MVP-Testing/commit/c885758f47f58a5a818d8c9ff070190cc2a26e26
使用TestScheduler來(lái)控制時(shí)間
在大多數(shù)情況下,immediate scheduler就足夠了。 但有時(shí)我們需要控制時(shí)間來(lái)測(cè)試某些功能。 看看UserListPresenter中的onScrollChanged方法, 你會(huì)怎樣測(cè)試? loading字段將始終為false,因?yàn)?code>getUsers會(huì)立即執(zhí)行。 我們可以將該字段設(shè)置為公共的,但僅因?yàn)闇y(cè)試就暴露一個(gè)字段是不好的做法。
RxJava為這些情況提供了一個(gè)名為TestScheduler類(lèi)。 這是一個(gè)特殊的scheduler,它允許我們手動(dòng)的將一個(gè)虛擬時(shí)間提前。 一個(gè)簡(jiǎn)單的例子:
@Test
fun testOnScrollChanged_offsetReachedAndLoading_dontRequestNextPage() {
// Given
val users = listOf(UserViewModel(1, "Name", 1000, ""))
val single: Single<List<UserViewModel>> = Single.create {
emitter ->
emitter.onSuccess(users)
}
val delayedSingle = single.delay(2, TimeUnit.SECONDS, testScheduler)
// When
whenever(mockGetUsers.execute(anyInt(), anyBoolean())).thenReturn(delayedSingle)
userListPresenter.attachView(mockView)
userListPresenter.getUsers()
testScheduler.advanceTimeBy(1, TimeUnit.SECONDS)
userListPresenter.onScrollChanged(5, 10)
// Then
verify(mockGetUsers, times(1))
.execute(ArgumentMatchers.anyInt(), ArgumentMatchers.anyBoolean())
}
使用delay方法,我們可以創(chuàng)建一個(gè)不能立即完成的Single。 該方法的第三個(gè)參數(shù)是Scheduler。 如果我們傳遞一個(gè)TestScheduler實(shí)例,那這2秒將是虛擬的。 現(xiàn)在我們可以使用TestScheduler的方法來(lái)改變這個(gè)虛擬時(shí)間。 這可以在示例的第18行中看到。
在我們的例子中,我們有一個(gè)需要2秒鐘的時(shí)間才能完成的Single,而我們提前了1秒鐘。 所以當(dāng)我們向下滾動(dòng)時(shí),mockGetUsers.execute不會(huì)再被調(diào)用一次,因?yàn)榈谝粋€(gè)調(diào)用仍然加載,因此我們應(yīng)該驗(yàn)證,該方法將被調(diào)用一次。
TestScheduler還有一個(gè)advanceTimeTo方法,它將時(shí)間移動(dòng)到特定的時(shí)刻。
注入TestScheduler
我們同樣可以用TestScheduler替換默認(rèn)的scheduler,這是我們前面使用的,但是由于某種原因,它給我一個(gè)奇怪的錯(cuò)誤。 當(dāng)我一次運(yùn)行整個(gè)測(cè)試類(lèi)時(shí),只有第一個(gè)測(cè)試通過(guò),其余的測(cè)試通常會(huì)失敗,因?yàn)闆](méi)有觸發(fā)動(dòng)作(我使用TestScheduler.triggerAction方法進(jìn)行更簡(jiǎn)單的測(cè)試,在那里我不需要控制時(shí)間)。 為了解決這個(gè)問(wèn)題,即使我們不需要控制時(shí)間,也需要使用advanceTimeBy方法來(lái)代替triggerAction。
雖然這個(gè)解決方案是有效的,但是這使我意識(shí)到,替換scheduler的方法還能更簡(jiǎn)潔,那就是依賴注入。
首先要做到這一點(diǎn),我們需要?jiǎng)?chuàng)建一個(gè)SchedulerProvider接口,并提供兩個(gè)實(shí)現(xiàn)。
-
AppSchedulerProvider- 這將為我們提供真正的調(diào)度器。 我們將把這個(gè)類(lèi)注入所有的presenter,這將為我們的Rx訂閱提供調(diào)度器。 -
TestSchedulerProvide- 這個(gè)類(lèi)將為我們提供一個(gè)TestScheduler而不是真正的scheduler。 當(dāng)我們?cè)跍y(cè)試中實(shí)例化我們的presenter時(shí),我們將使用它作為它的構(gòu)造函數(shù)參數(shù)。
interface SchedulerProvider {
fun uiScheduler() : Scheduler
fun ioScheduler() : Scheduler
}
class AppSchedulerProvider : SchedulerProvider {
override fun ioScheduler() = Schedulers.io()
override fun uiScheduler(): Scheduler = AndroidSchedulers.mainThread()
}
class TestSchedulerProvider() : SchedulerProvider {
val testScheduler: TestScheduler = TestScheduler()
override fun uiScheduler() = testScheduler
override fun ioScheduler() = testScheduler
}
為了簡(jiǎn)單起見(jiàn),我將這3個(gè)類(lèi)添加到同一個(gè)要點(diǎn),但在項(xiàng)目中它們是在一個(gè)單獨(dú)的文件中。
現(xiàn)在我們需要在UserListPresenter中添加SchedulerProvider作為構(gòu)造函數(shù)參數(shù),并將以下行
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
改為這些:
.subscribeOn(schedulerProvider.ioScheduler())
.observeOn(schedulerProvider.uiScheduler())
我們還需要在我們的ApplicationModule中添加一個(gè)provider方法,以提供SchedulerProvider依賴關(guān)系。
@Provides
@Singleton
fun provideSchedulerProvider() : SchedulerProvider = AppSchedulerProvider()
現(xiàn)在我們可以在我們的測(cè)試中使用TestSchedulerProvider,如下所示:
@Mock
lateinit var mockGetUsers: GetUsers
@Mock
lateinit var mockView: UserListView
lateinit var userListPresenter: UserListPresenter
lateinit var testSchedulerProvider: TestSchedulerProvider
@Before
fun setUp() {
MockitoAnnotations.initMocks(this)
testSchedulerProvider = TestSchedulerProvider()
userListPresenter = UserListPresenter(mockGetUsers, testSchedulerProvider)
}
...
// Test methods
}
如果我們要在測(cè)試中使用TestScheduler,我們需要得到提供者的這一屬性:testSchedulerProvider.testScheduler
就這些。 您可以在庫(kù)里找到更多關(guān)于如何處理時(shí)間的測(cè)試用例。 我創(chuàng)建了一些私有的工具方法來(lái)提取這些測(cè)試的常見(jiàn)部分,并使代碼更簡(jiǎn)潔。 您可以在此提交中找到它:
https://github.com/kozmi55/Kotlin-MVP-Testing/commit/eed5f3a938ac0fdc3a75ccfaede902c54810f56a
···
感謝您閱讀本系列的第二部分。 我們介紹了如何使用RxJava來(lái)測(cè)試presenter,并學(xué)習(xí)了在測(cè)試中處理RxJava scheduler的不同技巧。
在最后一部分,我們將看到如何使用Espresso進(jìn)行假數(shù)據(jù)的UI測(cè)試,以及如何處理Espresso測(cè)試中某些Kotlin的特定問(wèn)題。
Thanks for reading my article.