【譯】使用Kotlin和RxJava測試MVP架構的完整示例 - 第1部分

ditclear發表於2017-09-22
KotlinRxJavaMVP架構

原文連結：android.jlelse.eu/complete-ex…

最近我建立了一個playground專案來了解更多關於Kotlin和RxJava的資訊。 這是一個非常簡單的專案，但有一部分，我進行了一些嘗試：測試。

在kotlin的測試上可能會有一些陷阱，而且由於它是新出的，所以沒有太多的例子。 我認為分享我的經驗幫助你來避免踩坑是一個好主意。

關於架構

該應用程式遵循基本MVP架構。 它使用Dagger2進行依賴注入，RxJava2用於資料流。

這些庫根據不同的條件提供來自網路或本地儲存的資料。 我們使用Retrofit進行網路請求，以及Room作為本地資料庫。

我不會詳細講解架構和這些工具。 我想大多數人已經熟悉了他們。 您可以在此提交中檢視：

github.com/kozmi55/Kot…

我們將從測試資料庫開始，然後向上層測試。

測試資料庫

對於資料庫，我們使用Android架構元件中的Room Persistence Library。 它是SQLite上的抽象層，可以減少樣板程式碼。

這是最簡單的部分。 我們不需要對Kotlin或RxJava做任何具體的事情。 我們先來看看UserDao介面的程式碼，以決定我們應該測試什麼。

@Dao
interface UserDao {
    @Query("SELECT * FROM user ORDER BY reputation DESC LIMIT (:arg0 - 1) * 30, 30")
    fun getUsers(page: Int) : List<User>

    @Insert(onConflict = OnConflictStrategy.REPLACE)
    fun insertAll(users: List<User>)
}複製程式碼

getUsers函式根據頁碼從資料庫中請求下一個30個使用者。

insertAll插入列表中的所有使用者。

我們可以從這裡發現幾件事情，需要測試什麼：

  • 檢查插入的使用者是否與檢索到的使用者相同。
  • 檢查檢索使用者正確排序。
  • 檢查我們是否插入具有相同ID的使用者，它將替換舊的記錄。
  • 檢查是否查詢頁面，最多可以有30個使用者。
  • 檢查我們是否查詢第二頁，我們將獲得正確數量的元素。

下面的程式碼片段顯示了5例這樣的實現。

@RunWith(AndroidJUnit4::class)
class UserDaoTest {

    lateinit var userDao: UserDao
    lateinit var database: AppDatabase

    @Before
    fun setup() {
        val context = InstrumentationRegistry.getTargetContext()
        database = Room.inMemoryDatabaseBuilder(context, AppDatabase::class.java).build()
        userDao = database.userDao()
    }

    @After
    fun tearDown() {
        database.close()
    }

    @Test
    fun testInsertedAndRetrievedUsersMatch() {
        val users = listOf(User(1, "Name", 100, "url"), User())
        userDao.insertAll(users)

        val allUsers = userDao.getUsers(1)
        assertEquals(users, allUsers)
    }

    @Test
    fun testUsersOrderedByCorrectly() {
        val users = listOf(
                User(1, "Name", 100, "url"),
                User(2, "Name2", 500, "url"),
                User(3, "Name3", 300, "url"))
        userDao.insertAll(users)

        val allUsers = userDao.getUsers(1)
        val expectedUsers = users.sortedByDescending { it.reputation }
        assertEquals(expectedUsers, allUsers)
    }

    @Test
    fun testConflictingInsertsReplaceUsers() {
        val users = listOf(
                User(1, "Name", 100, "url"),
                User(2, "Name2", 500, "url"),
                User(3, "Name3", 300, "url"))

        val users2 = listOf(
                User(1, "Name", 1000, "url"),
                User(2, "Name2", 700, "url"),
                User(4, "Name3", 5500, "url"))
        userDao.insertAll(users)
        userDao.insertAll(users2)

        val allUsers = userDao.getUsers(1)
        val expectedUsers = listOf(
                User(4, "Name3", 5500, "url"),
                User(1, "Name", 1000, "url"),
                User(2, "Name2", 700, "url"),
                User(3, "Name3", 300, "url"))

        assertEquals(expectedUsers, allUsers)
    }

    @Test
    fun testLimitUsersPerPage_FirstPageOnly30Items() {
        val users = (1..40L).map { User(it, "Name $it", it *100, "url") }

        userDao.insertAll(users)

        val retrievedUsers = userDao.getUsers(1)
        assertEquals(30, retrievedUsers.size)
    }

    @Test
    fun testRequestSecondPage_LimitUsersPerPage_showOnlyRemainingItems() {
        val users = (1..40L).map { User(it, "Name $it", it *100, "url") }

        userDao.insertAll(users)

        val retrievedUsers = userDao.getUsers(2)
        assertEquals(10, retrievedUsers.size)
    }
}複製程式碼

在setup方法中，我們需要配置我們的資料庫。 在每次測試之前，我們使用Room的記憶體資料庫建立一個乾淨的資料庫。

測試在這裡非常簡單，不需要進一步解釋。 我們在每個測試中遵循的基本模式如
下所示：

  1. 將資料插入資料庫
  2. 從資料庫查詢資料
  3. 對所檢索的資料作出斷言

我們可以使用Kotlin Collections API中的函式來簡化測試資料的建立，就像這部分程式碼一樣：

val users = (1..40L).map { User(it, "Name $it", it *100, "url") }複製程式碼

我們建立了一個範圍，然後將其對映到使用者列表。 這裡有多個Kotlin概念：範圍，高階函式，字串模板。

Commit: github.com/kozmi55/Kot…

測試UserRepository

對於repository和interactor，我們將使用相同的工具。

  • 使用Mockit模擬類的依賴。
  • TestObserver用於測試Observables（在我們的例子中是Singles）

但首先我們需要啟用該選項來mock最終的類。 在kotlin裡，預設情況下每個class都是final的。 幸運的是，Mockito 2已經支援模擬 final class，但是我們需要啟用它。

我們需要在以下位置建立一個文字檔案：test / resources / mockito-extensions /，名稱為org.mockito.plugins.MockMaker，並附帶以下文字：mock-maker-inline

Place of the file in Project view
Place of the file in Project view

現在我們可以開始使用Mockito來編寫我們的測試。 首先，我們將新增最新版本的Mockito和JUnit。

testImplementation 'org.mockito:mockito-core:2.8.47'
testImplementation 'junit:junit:4.12'複製程式碼

UserRepository的程式碼如下：

class UserRepository(
        private val userService: UserService,
        private val userDao: UserDao,
        private val connectionHelper: ConnectionHelper,
        private val preferencesHelper: PreferencesHelper,
        private val calendarWrapper: CalendarWrapper) {

    private val LAST_UPDATE_KEY = "last_update_page_"

    fun getUsers(page: Int, forced: Boolean): Single<UserListModel> {
        return Single.create<UserListModel> { emitter: SingleEmitter<UserListModel> ->
            if (shouldUpdate(page, forced)) {
                loadUsersFromNetwork(page, emitter)
            } else {
                loadOfflineUsers(page, emitter)
            }
        }
    }

    private fun shouldUpdate(page: Int, forced: Boolean) = when {
        forced -> true
        !connectionHelper.isOnline() -> false
        else -> {
            val lastUpdate = preferencesHelper.loadLong(LAST_UPDATE_KEY + page)
            val currentTime = calendarWrapper.getCurrentTimeInMillis()
            lastUpdate + Constants.REFRESH_LIMIT < currentTime
        }
    }

    private fun loadUsersFromNetwork(page: Int, emitter: SingleEmitter<UserListModel>) {
        try {
            val users = userService.getUsers(page).execute().body()
            if (users != null) {
                userDao.insertAll(users.items)
                val currentTime = calendarWrapper.getCurrentTimeInMillis()
                preferencesHelper.saveLong(LAST_UPDATE_KEY + page, currentTime)
                emitter.onSuccess(users)
            } else {
                emitter.onError(Exception("No data received"))
            }
        } catch (exception: Exception) {
            emitter.onError(exception)
        }
    }

    private fun loadOfflineUsers(page: Int, emitter: SingleEmitter<UserListModel>) {
        val users = userDao.getUsers(page)
        if (!users.isEmpty()) {
            emitter.onSuccess(UserListModel(users))
        } else {
            emitter.onError(Exception("Device is offline"))
        }
    }
}複製程式碼

在getUsers方法中，我們建立一個Single，它會傳送users或一個error。 根據不同的條件，shouldUpdate方法決定使用者是否應該從網路載入或從本地資料庫載入。

還有一點需要注意的是CalendarWrapper欄位。 這是一個簡單的包裝器，有一個返回當前時間的方法。 在它幫助下，我們可以模擬我們測試的時間。

那麼我們應該在這裡測試什麼？ 在這裡最重要的測試是在shouldUpdate方法背後的邏輯。 讓我們為它做一些測試。

測試這個的方法是先呼叫getUsers方法，並在返回的Single去呼叫test方法。 test方法會建立一個TestObserver並將其訂閱到Single。

TestObserver是一種特殊型別的Observer，它記錄事件並允許對它們進行斷言。

我們還必須模擬UserRepository的依賴關係，並且儲存一些他們的方法來返回指定的資料。 我們可以像在Java中一樣使用Mockito，或者使用Niek Haarman的Mockito-Kotlin庫。 我們將在這個例子中使用Mockito，但如果您好奇，可以檢查Github資料庫。

如果我們要使用Mockito的when方法，我們需要把它放在反引號之間，因為它是Kotlin中的保留字。 為了使這看起來更好，我們可以使用as關鍵字引入具有不同名稱的when方法。

import org.mockito.Mockito.`when` as whenever複製程式碼

現在我們可以使用whenever方法進行stubbing。

class UserRepositoryTest {

    @Mock
    lateinit var mockUserService: UserService

    @Mock
    lateinit var mockUserDao: UserDao

    @Mock
    lateinit var mockConnectionHelper: ConnectionHelper

    @Mock
    lateinit var mockPreferencesHelper: PreferencesHelper

    @Mock
    lateinit var mockCalendarWrapper: CalendarWrapper

    @Mock
    lateinit var mockUserCall: Call<UserListModel>

    @Mock
    lateinit var mockUserResponse: Response<UserListModel>

    lateinit var userRepository: UserRepository

    @Before
    fun setup() {
        MockitoAnnotations.initMocks(this)
        userRepository = UserRepository(mockUserService, mockUserDao, 
                                        mockConnectionHelper, mockPreferencesHelper, 
                                        mockCalendarWrapper)
    }

    @Test
    fun testGetUsers_isOnlineReceivedOneItem_emitListWithOneItem() {
        val userListModel = UserListModel(listOf(User()))
        setUpStubbing(true, 1000 * 60 * 60 * 12 + 1, 0, modelFromUserService = userListModel)

        val testObserver = userRepository.getUsers(1, false).test()

        testObserver.assertNoErrors()
        testObserver.assertValue { userListModelResult: UserListModel -> 
                                  userListModelResult.items.size == 1 }
        verify(mockUserDao).insertAll(userListModel.items)
    }

    @Test
    fun testGetUsers_isOfflineOneItemInDatabase_emitListWithOneItem() {
        val modelFromDatabase = listOf(User())
        setUpStubbing(false, 1000 * 60 * 60 * 12 + 1, 0, modelFromDatabase = modelFromDatabase)

        val testObserver = userRepository.getUsers(1, false).test()

        testObserver.assertNoErrors()
        testObserver.assertValue { userListModelResult: UserListModel -> 
                                  userListModelResult.items.size == 1 }
    }

    private fun setUpStubbing(isOnline: Boolean, currentTime: Long, lastUpdateTime: Long,
                              modelFromUserService: UserListModel = UserListModel(emptyList()),
                              modelFromDatabase: List<User> = emptyList()) {
        whenever(mockConnectionHelper.isOnline()).thenReturn(isOnline)
        whenever(mockCalendarWrapper.getCurrentTimeInMillis()).thenReturn(currentTime)
        whenever(mockPreferencesHelper.loadLong("last_update_page_1")).thenReturn(lastUpdateTime)

        whenever(mockUserService.getUsers(1)).thenReturn(mockUserCall)
        whenever(mockUserCall.execute()).thenReturn(mockUserResponse)
        whenever(mockUserResponse.body()).thenReturn(modelFromUserService)
        whenever(mockUserDao.getUsers(1)).thenReturn(modelFromDatabase)
    }
}複製程式碼

以上我們可以看到UserRepositoryTest的程式碼。 我們在這個例子中使用Mockito註解來初始化mocks，但是可以用不同的方法來完成。 每個測試包括3個步驟：

  1. 指定stubbed方法返回什麼值。 我們使用setUpStubbing私有方法來避免我們的測試中的樣板程式碼。 我們可以在每個具有不同引數的測試用例中呼叫此方法，這取決於正在測試的狀態。 Kotlin的預設引數在這裡非常有用，因為有時我們不需要指定每個引數。
  2. 呼叫getUsers方法，並通過在返回的Single上呼叫test方法來獲取一個TestObserver。
  3. 在TestObserver或模擬物件上進行一些斷言以驗證預期的行為。 在這個例子中，我們使用assertNoErrors方法來驗證Single不會發出錯誤。 我們使用的另一種方法是assertValue。 有了它的幫助，我們可以斷言Single發出的值是不是正確。 執行此操作的方式是將lambda傳遞給assertValue方法，該方法返回一個布林值。 如果它返回true，則斷言將通過。 在這種情況下，我們驗證發出的列表包含1個元素。 有很多其他方法可以在TestObserver上做出斷言，這些可以在TestObserver的超類BaseTestConsumer的文件中找到。

在此提交中可以找到這些更改：

github.com/kozmi55/Kot…

測試 GetUsers interactor

測試GetUsers interactor的方法類似於我們用來測試UserRepository的方法。

GetUsers是一個非常簡單的類，它的目的是將data層中的資料轉換為presentation層中的資料。

class GetUsers(private val userRepository: UserRepository) {

    fun execute(page: Int, forced: Boolean) : Single<List<UserViewModel>> {
        val usersList = userRepository.getUsers(page, forced)
        return usersList.map { userListModel: UserListModel? ->
            val items = userListModel?.items ?: emptyList()
            items.map { UserViewModel(it.userId, it.displayName, it.reputation, it.profileImage) }
        }
    }
}複製程式碼

我們使用RxJava和Kotlin Collection API中的一些轉換來實現想要的結果。

來看看我們的測試長什麼樣：

class GetUsersTest {

    @Mock
    lateinit var mockUserRepository: UserRepository

    lateinit var getUsers: GetUsers

    @Before
    fun setup() {
        MockitoAnnotations.initMocks(this)
        getUsers = GetUsers(mockUserRepository)
    }

    @Test
    fun testExecute_userListModelWithOneItem_emitListWithOneViewModel() {
        val userListModel = UserListModel(listOf(User(1, "Name", 100, "Image url")))
        setUpStubbing(userListModel)

        val testObserver = getUsers.execute(1, false).test()

        testObserver.assertNoErrors()
        testObserver.assertValue { userViewModels: List<UserViewModel> -> userViewModels.size == 1 }
        testObserver.assertValue { userViewModels: List<UserViewModel> ->
            userViewModels.get(0) == UserViewModel(1, "Name", 100, "Image url") }
    }

    @Test
    fun testExecute_userListModelEmpty_emitEmptyList() {
        val userListModel = UserListModel(emptyList())
        setUpStubbing(userListModel)

        val testObserver = getUsers.execute(1, false).test()

        testObserver.assertNoErrors()
        testObserver.assertValue { userViewModels: List<UserViewModel> -> userViewModels.isEmpty() }
    }

    private fun setUpStubbing(userListModel: UserListModel) {
        val fakeSingle = Single.create { e: SingleEmitter<UserListModel>? ->
            e?.onSuccess(userListModel) }

        whenever(mockUserRepository.getUsers(1, false))
                .thenReturn(fakeSingle)
    }
}複製程式碼

唯一的區別在於，我們建立一個假的從getUsers方法返回的Single物件。 我們使用Single將UserListModel傳送給setUpStubbing方法，在這裡我們建立了假的Single，並將其設定為getUsers方法的返回值。

剩下的程式碼使用與UserRepositoryTest中相同的概念。

Commit在這：github.com/kozmi55/Kot…

這是第一部分。 我們學習瞭如何在Kotlin測試中使用RxJava來處理一些常見問題，如何利用一些Kotlin功能來編寫更簡單的測試，並且還可以看看如何測試Room資料庫。

在第二部分中，我將向您展示如何在TestScheduler的幫助下測試Presenter，以及如何使用Espresso和假資料來進行UI測試。 敬請關注。

Thanks for reading my article.

相關文章