テスト用のオブジェクトのPagedListを作成するにはどうすればよいですか？
私はGoogleのArchライブラリを使用してきましたが、テストを難しくしている1つのことはPagedListを使用することです。
この例では、リポジトリパターンを使用して、APIまたはネットワークのいずれかから詳細を返しています。
したがって、ViewModel内で、このインターフェイスメソッドを呼び出します。
override fun getFoos(): Observable<PagedList<Foo>>
次に、リポジトリはRxPagedListBuilderを使用して、PagedListタイプのObservableを作成します。
override fun getFoos(): Observable<PagedList<Foo>> =
RxPagedListBuilder(database.fooDao().selectAll(), PAGED_LIST_CONFIG).buildObservable()
テストでPagedList<Foo>を返すこれらのメソッドからの戻りを設定できるようにしたい。に似たもの
when(repository.getFoos()).thenReturn(Observable.just(TEST_PAGED_LIST_OF_FOOS)
2つの質問：
- これは可能ですか？
PagedList<Foo>を作成するにはどうすればよいですか？
私の目標は、よりエンドツーエンドで確認することです（Foosの正しいリストが画面に表示されることを確認するなど）。 fragment/activity/viewは、ViewModelからPagedList<Foo>を監視するものです。
これを実現する簡単な方法は、PagedListをモックすることです。このFunはリストをPagedListに「変換」します（この場合、実際のPagedListではなくモックバージョンを使用していません。PagedListの他のメソッドを実装する必要がある場合は、このFunに追加してください）。
fun <T> mockPagedList(list: List<T>): PagedList<T> {
val pagedList = Mockito.mock(PagedList::class.Java) as PagedList<T>
Mockito.`when`(pagedList.get(ArgumentMatchers.anyInt())).then { invocation ->
val index = invocation.arguments.first() as Int
list[index]
}
Mockito.`when`(pagedList.size).thenReturn(list.size)
return pagedList
}
Mock DataSource.Factoryを使用してリストをPagedListに変換する
@ saied89 これを共有 solution これで googlesamples/Android-architecture-components の問題。 Kotlin、JUnit 5、MockK、およびAssertJライブラリを使用してViewModelをローカルユニットテストするために、モックしたPagedListを Coinverse Open App に実装しました。
私が使用したPagedListからのLiveDataを観察するために JoseAlcérreca'simplementation Googleの LiveDataSampleサンプルアプリ からのgetOrAwaitValueの= Androidアーキテクチャコンポーネントのサンプル。
asPagedList拡張関数は、以下のサンプルテストContentViewModelTest.ktに実装されています。
PagedListTestUtil.kt
import Android.database.Cursor
import androidx.paging.DataSource
import androidx.paging.LivePagedListBuilder
import androidx.paging.PagedList
import androidx.room.RoomDatabase
import androidx.room.RoomSQLiteQuery
import androidx.room.paging.LimitOffsetDataSource
import io.mockk.every
import io.mockk.mockk
fun <T> List<T>.asPagedList() = LivePagedListBuilder<Int, T>(createMockDataSourceFactory(this),
Config(enablePlaceholders = false,
prefetchDistance = 24,
pageSize = if (size == 0) 1 else size))
.build().getOrAwaitValue()
private fun <T> createMockDataSourceFactory(itemList: List<T>): DataSource.Factory<Int, T> =
object : DataSource.Factory<Int, T>() {
override fun create(): DataSource<Int, T> = MockLimitDataSource(itemList)
}
private val mockQuery = mockk<RoomSQLiteQuery> {
every { sql } returns ""
}
private val mockDb = mockk<RoomDatabase> {
every { invalidationTracker } returns mockk(relaxUnitFun = true)
}
class MockLimitDataSource<T>(private val itemList: List<T>) : LimitOffsetDataSource<T>(mockDb, mockQuery, false, null) {
override fun convertRows(cursor: Cursor?): MutableList<T> = itemList.toMutableList()
override fun countItems(): Int = itemList.count()
override fun isInvalid(): Boolean = false
override fun loadRange(params: LoadRangeParams, callback: LoadRangeCallback<T>) { /* Not implemented */ }
override fun loadRange(startPosition: Int, loadCount: Int) =
itemList.subList(startPosition, startPosition + loadCount).toMutableList()
override fun loadInitial(params: LoadInitialParams, callback: LoadInitialCallback<T>) {
callback.onResult(itemList, 0)
}
}
LiveDataTestUtil.kt
import androidx.lifecycle.LiveData
import androidx.lifecycle.Observer
import Java.util.concurrent.CountDownLatch
import Java.util.concurrent.TimeUnit
import Java.util.concurrent.TimeoutException
/**
* Gets the value of a [LiveData] or waits for it to have one, with a timeout.
*
* Use this extension from Host-side (JVM) tests. It's recommended to use it alongside
* `InstantTaskExecutorRule` or a similar mechanism to execute tasks synchronously.
*/
fun <T> LiveData<T>.getOrAwaitValue(
time: Long = 2,
timeUnit: TimeUnit = TimeUnit.SECONDS,
afterObserve: () -> Unit = {}
): T {
var data: T? = null
val latch = CountDownLatch(1)
val observer = object : Observer<T> {
override fun onChanged(o: T?) {
data = o
latch.countDown()
[email protected](this)
}
}
this.observeForever(observer)
afterObserve.invoke()
// Don't wait indefinitely if the LiveData is not set.
if (!latch.await(time, timeUnit)) {
this.removeObserver(observer)
throw TimeoutException("LiveData value was never set.")
}
@Suppress("UNCHECKED_CAST")
return data as T
}
ContentViewModelTest.kt
...
import androidx.paging.PagedList
import com.google.firebase.Timestamp
import io.mockk.*
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.AfterAll
import org.junit.jupiter.api.BeforeAll
import org.junit.jupiter.api.BeforeEach
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
@ExtendWith(InstantExecutorExtension::class)
class ContentViewModelTest {
val timestamp = getTimeframe(DAY)
@BeforeAll
fun beforeAll() {
mockkObject(ContentRepository)
}
@BeforeEach
fun beforeEach() {
clearAllMocks()
}
@AfterAll
fun afterAll() {
unmockkAll()
}
@Test
fun `Feed Load`() {
val content = Content("85", 0.0, Enums.ContentType.NONE, Timestamp.now(), "",
"", "", "", "", "", "", MAIN,
0, 0.0, 0.0, 0.0, 0.0,
0.0, 0.0, 0.0, 0.0)
every {
getMainFeedList(any(), any())
} returns liveData {
emit(Lce.Content(
ContentResult.PagedListResult(
pagedList = liveData {emit(listOf(content).asPagedList())},
errorMessage = ""))
}
val contentViewModel = ContentViewModel(ContentRepository)
contentViewModel.processEvent(ContentViewEvent.FeedLoad(MAIN, DAY, timestamp, false))
assertThat(contentViewModel.feedViewState.getOrAwaitValue().contentList.getOrAwaitValue()[0])
.isEqualTo(content)
assertThat(contentViewModel.feedViewState.getOrAwaitValue().toolbar).isEqualTo(
ToolbarState(
visibility = GONE,
titleRes = app_name,
isSupportActionBarEnabled = false))
verify {
getMainFeedList(any(), any())
}
confirmVerified(ContentRepository)
}
}
InstantExecutorExtension.kt
これは、オブザーバーがメインスレッド上にないことを確認するために、LiveDataを使用するJUnit 5で必要です。以下は Jeroen Mols 'implementation です。
import androidx.Arch.core.executor.ArchTaskExecutor
import androidx.Arch.core.executor.TaskExecutor
import org.junit.jupiter.api.extension.AfterEachCallback
import org.junit.jupiter.api.extension.BeforeEachCallback
import org.junit.jupiter.api.extension.ExtensionContext
class InstantExecutorExtension : BeforeEachCallback, AfterEachCallback {
override fun beforeEach(context: ExtensionContext?) {
ArchTaskExecutor.getInstance().setDelegate(object : TaskExecutor() {
override fun executeOnDiskIO(runnable: Runnable) = runnable.run()
override fun postToMainThread(runnable: Runnable) = runnable.run()
override fun isMainThread(): Boolean = true
})
}
override fun afterEach(context: ExtensionContext?) {
ArchTaskExecutor.getInstance().setDelegate(null)
}
}
- リストをPagedListにキャストすることはできません。
- DataSourceを介してのみ、PagedListを直接作成することはできません。 1つの方法は、テストデータを返すFakeDataSourceを作成することです。
エンドツーエンドのテストの場合は、メモリ内のdbを使用できます。呼び出す前にテストデータを追加します。例： https://medium.com/exploring-Android/android-architecture-components-testing-your-room-dao-classes-e06e1c9a1535