Как создать PagedList объекта для тестов?

Я работал с архивами от Google, но одна вещь, которая затрудняла тестирование, - это работа с PagedList.

В этом примере я использую шаблон репозитория и возвращаю детали либо из API, либо из сети.

Итак, внутри ViewModel я вызываю этот метод интерфейса:

override fun getFoos(): Observable<PagedList<Foo>>

Затем репозиторий будет использовать RxPagedListBuilder для создания Observable типа PagedList:

 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)

Два вопроса:

  1. Это возможно?
  2. Как создать PagedList<Foo>?

Моя цель - проверить более сквозным способом (например, убедиться, что на экране отображается правильный список Foos). Фрагмент / действие / представление - это тот, который наблюдает за PagedList<Foo> из ViewModel.

Я считаю, что в вашем вопросе не хватает: какую проверку вы хотите провести в тестах?

arekolek 21.05.2018 10:58

@arekolek спасибо за отзыв ... Обновил вопрос тем, что пытаюсь проверить

isuPatches 21.05.2018 14:25

Есть новости о том, какую стратегию вы реализовали @isuPatches? Я работаю над написанием того же теста с Kotlin, JUnit 5 и MockK. Я буду рад поделиться своим решением здесь, как только получу подтверждение работоспособности концепции.

Adam Hurwitz 04.09.2019 02:51
20
3
8 442
3

Ответы 3

  1. Вы не можете преобразовать List в PagedList.
  2. Вы не можете создать PagedList напрямую, только через DataSource. Один из способов - создать FakeDataSource, возвращающий тестовые данные.

Если это сквозной тест, вы можете просто использовать базу данных в памяти. Добавьте свои тестовые данные перед его вызовом. Пример: https://medium.com/exploring-android/android-architecture-components-testing-your-room-dao-classes-e06e1c9a1535

Спасибо за понимание! У меня есть реализовано фиктивный PagedList, использующий MockK для локального теста JUnit 5.

Adam Hurwitz 08.09.2019 18:11

простой способ добиться этого - издеваться над PagedList. Эта игра "преобразует" список в PagedList (в этом случае мы не используем настоящий PagedList, а просто фиктивную версию, если вам нужно реализовать другие методы PagedList, добавьте их в эту забаву)

 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
 }

Не забудьте сначала добавить Mockito: testImplementation "org.mockito:mockito-core:2.25.0"

Paul Spiesberger 13.05.2019 15:43

Можете ли вы передать List на PagedList @bsobat?

Adam Hurwitz 04.09.2019 02:59

@bsobat, это должно возвращать PagedList с заполненными данными или пустой PagedList, чтобы тест не провалился? Если он пуст, он не будет полезен для тестирования того, как приложение обрабатывает данные PagedList.

Adam Hurwitz 04.09.2019 20:57

@ Гурвиц, нет, ты не можешь бросить

bsobat 05.09.2019 06:29

@bsobat, ознакомьтесь с приведенным выше решение, который использует MockK для реализации поведения использования PagedList при написании локальных тестов JUnit 5.

Adam Hurwitz 08.09.2019 18:08

Пейджинг 3

Библиотека Paging 3 предлагает метод построения PagingData.from(someList).

Пейджинг 2

Преобразование списка в PagedList с помощью Mock DataSource.Factory.

@ saied89 поделился этим решение в этой проблеме googlesamples / android-архитектура-компоненты. Я реализовал макет PagedList в Открытое приложение Coinverse, чтобы локально тестировать ViewModel с использованием библиотек Kotlin, JUnit 5, MockK и AssertJ.

Для наблюдения за LiveData из PagedList я использовал Хосе Альсеррекивыполнение из getOrAwaitValue из Пример приложения LiveDataSample в образцах компонентов архитектуры Android от Google.

Функция расширения 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

Это требуется для JUnit 5 при использовании LiveData, чтобы гарантировать, что Observer не находится в основном потоке. Ниже Йерун Молсвыполнение.

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

было бы похоже на подкачку 3 lib?

Raghunandan 06.07.2020 12:18

Отличный вопрос @Raghunandan! Я еще не тестировал библиотеку Paging 3. Пожалуйста, дополняйте публикацию комментариями / правками, если вы внедрите и найдете изменения.

Adam Hurwitz 06.07.2020 17:58

Другие вопросы по теме