پیادهسازی کتابخانه «صفحهبندی» در برنامهتان باید با استراتژی آزمایش قوی
همراه باشد. باید مؤلفههای بار کردن داده مثل
PagingSource و
RemoteMediator
را آزمایش کنید تا مطمئن شوید طبق انتظار کار میکنند. همچنین باید آزمایشهای سرتاسری بنویسید تا
تأیید کنید که همه مؤلفهها در پیادهسازی «صفحهبندی» شما بهدرستی
باهم کار میکنند و عوارض جانبی غیرمنتظرهای ندارند.
این راهنما توضیح میدهد که چگونه کتابخانه Paging را در لایههای معماری مختلف برنامه خود آزمایش کنید و همچنین چگونه آزمایشهای سرتاسری برای کل پیادهسازی Paging خود بنویسید.
آزمایشهای لایه میانای کاربر
چون Compose دادههای «صفحهبندی» را بهصورت اعلانی ازطریق
collectAsLazyPagingItems مصرف میکند، آزمونهای لایه واسط کاربر شما میتوانند عمدتاً روی
Flow<PagingData<Value>> منتشرشده توسط ViewModel شما تمرکز کنند. برای نوشتن آزمایشهایی برای درستیسنجی
دادهها در UI همانطور که انتظار دارید، وابستگی paging-testing را اضافه کنید. این
حاوی افزونه asSnapshot در Flow<PagingData<Value>> است. این ابزار
میاناهای برنامهسازی کاربردی را در گیرنده لامبدا ارائه میدهد که امکان شبیهسازی تعاملات پیمایش را فراهم میکند. این تابع
یک List<Value> استاندارد را که توسط تعاملهای پیمایش شبیهسازیشده تولید شده است برمیگرداند.
این به شما امکان میدهد ادعا کنید که دادههای ورقزدهشده حاوی عناصر موردانتظار تولیدشده توسط آن تعاملات است. این موضوع در قطعه کد زیر نشان داده شده است:
fun test_items_contain_one_to_ten() = runTest {
// Get the Flow of PagingData from the ViewModel under test
val items: Flow<PagingData<String>> = viewModel.items
val itemsSnapshot: List<String> = items.asSnapshot {
// Scroll to the 50th item in the list. This will also suspend till
// the prefetch requirement is met if there's one.
// It also suspends until all loading is complete.
scrollTo(index = 50)
}
// With the asSnapshot complete, you can now verify that the snapshot
// has the expected values
assertEquals(
expected = (0..50).map(Int::toString),
actual = itemsSnapshot
)
}
یا میتوانید تا زمانیکه گزاره خاصی برآورده شود پیمایش کنید، همانطور که در قطعه کد زیر نشان داده شده است:
fun test_footer_is_visible() = runTest {
// Get the Flow of PagingData from the ViewModel under test
val items: Flow<PagingData<String>> = viewModel.items
val itemsSnapshot: List<String> = items.asSnapshot {
// Scroll till the footer is visible
appendScrollWhile { item: String -> item != "Footer" }
}
آزمایش کردن تحولات
همچنین باید تستهای واحدی بنویسید که هرگونه تبدیلی را که در جاریسازی PagingData اعمال میکنید پوشش دهد. از افزونه asPagingSourceFactory
استفاده کنید. این افزونه برای انواع دادههای زیر دردسترس است:
List<Value>.Flow<List<Value>>.
انتخاب افزونهای که باید استفاده شود به چیزی که میخواهید آزمایش کنید بستگی دارد. استفاده:
List<Value>.asPagingSourceFactory(): اگر میخواهید تبدیلهای ایستا مثلmap()وinsertSeparators()را روی دادهها آزمایش کنید.Flow<List<Value>>.asPagingSourceFactory(): اگر میخواهید آزمایش کنید که بهروزرسانیهای دادههایتان، مانند نوشتن در منبع داده پشتیبان، چگونه بر خط لوله صفحهبندی شما تأثیر میگذارد.
برای استفاده از هرکدام از این افزونهها، الگوی زیر را دنبال کنید:
PagingSourceFactoryرا بااستفاده از افزونه مناسب برای نیازهایتان ایجاد کنید.- از
PagingSourceFactoryبرگرداندهشده در جعلی برایRepositoryاستفاده کنید. - آن
Repositoryرا بهViewModelخود منتقل کنید.
سپس میتوان ViewModel را همانطور که در بخش قبلی توضیح داده شد آزمایش کرد.
ViewModel زیر را درنظر بگیرید:
class MyViewModel(
myRepository: myRepository
) {
val items = Pager(
config: PagingConfig,
initialKey = null,
pagingSourceFactory = { myRepository.pagingSource() }
)
.flow
.map { pagingData ->
pagingData.insertSeparators<String, String> { before, _ ->
when {
// Add a dashed String separator if the prior item is a multiple of 10
before.last() == '0' -> "---------"
// Return null to avoid adding a separator between two items.
else -> null
}
}
}
برای آزمایش تبدیل در MyViewModel، یک نمونه جعلی از
MyRepository ارائه دهید که به یک List ثابت واگذار میشود که دادههای موردنظر را برای
تبدیل نشان میدهد، همانطور که در قطعه کد زیر نشان داده شده است:
class FakeMyRepository() : MyRepository {
private val items = (0..100).map(Any::toString)
private val pagingSourceFactory = items.asPagingSourceFactory()
// Expose as a function so a new PagingSource instance is
// created each time it is called by the Pager
fun pagingSource() = pagingSourceFactory()
}
سپس میتوانید آزمایشی برای منطق جداکننده بنویسید، مانند قطعه کد زیر:
fun test_separators_are_added_every_10_items() = runTest {
// Create your ViewModel
val viewModel = MyViewModel(
myRepository = FakeMyRepository()
)
// Get the Flow of PagingData from the ViewModel with the separator transformations applied
val items: Flow<PagingData<String>> = viewModel.items
val snapshot: List<String> = items.asSnapshot()
// With the asSnapshot complete, you can now verify that the snapshot
// has the expected separators.
}
آزمایش کردن وضعیتهای بار کردن Compose
برای آزمایش اینکه مؤلفههای واسط کاربر Compose شما چگونه به حالتهای بارگذاری مختلف (مانند
LoadState.Loading یا LoadState.Error) بهصورت مجزا واکنش نشان میدهند، عکسهای آنی
PagingData ایستا را با LoadStates صریح بااستفاده از
PagingData.empty و PagingData.from ازطریق MutableStateFlow منتشر کنید:
@get:Rule
val composeTestRule = createComposeRule()
@Test
fun userListScreen_displaysLoadingDataAndErrorStates() {
val idle = LoadState.NotLoading(endOfPaginationReached = false)
// Emit static PagingData snapshots to test UI state transitions without a
// Pager or ViewModel.
val pagingDataFlow = MutableStateFlow(PagingData.empty<User>())
composeTestRule.setContent {
val lazyPagingItems = pagingDataFlow.collectAsLazyPagingItems()
UserListScreen(lazyPagingItems = lazyPagingItems)
}
// Verify the initial loading UI before any items arrive.
pagingDataFlow.value = PagingData.empty(
sourceLoadStates = LoadStates(
refresh = LoadState.Loading,
prepend = idle,
append = idle
)
)
composeTestRule.onNodeWithTag("LoadingSpinner").assertIsDisplayed()
// Verify that loaded items replace the loading indicator.
pagingDataFlow.value = PagingData.from(
data = listOf(User(id = "1", label = "User A")),
sourceLoadStates = LoadStates(
refresh = idle,
prepend = idle,
append = idle
)
)
composeTestRule.onNodeWithTag("LoadingSpinner").assertIsNotDisplayed()
composeTestRule.onNodeWithText("User A").assertIsDisplayed()
// Verify that a refresh failure surfaces the error message in the UI.
pagingDataFlow.value = PagingData.empty(
sourceLoadStates = LoadStates(
refresh = LoadState.Error(IOException("Network unavailable")),
prepend = idle,
append = idle
)
)
composeTestRule.onNodeWithText("Network unavailable").assertIsDisplayed()
}
آزمایشهای لایه داده
برای مؤلفههای لایه دادهتان آزمونهای واحد بنویسید تا مطمئن شوید که دادهها را بهدرستی از منابع دادهتان بار میکنند. نسخههای جعلی از وابستگیها را ارائه دهید تا تأیید کنید که مؤلفههای مورد آزمایش بهدرستی و بهصورت مجزا عمل میکنند. مؤلفههای اصلی که باید در لایه مخزن آزمایش کنید عبارتاند از
PagingSource و RemoteMediator.
PagingSource آزمایش
آزمایشهای واحد برای پیادهسازی PagingSource شامل راهاندازی نمونه PagingSource و بار کردن دادهها از آن با TestPager است.
برای راهاندازی نمونه PagingSource برای آزمایش، دادههای ساختگی را به سازنده ارائه دهید. این کار به شما امکان میدهد دادههای موجود در آزمایشهایتان را کنترل کنید. در
مثال زیر، پارامتر RedditApi یک میانای Retrofit است که
درخواستهای سرور و کلاسهای پاسخ را تعریف میکند. نسخه جعلی میتواند
میانجی را پیادهسازی کند، هر تابع لازم را لغو کند، و
روشهای راحتی را برای پیکربندی نحوه واکنش شیء جعلی در آزمایشها ارائه دهد.
پساز قرار دادن موارد جعلی، وابستگیها را راهاندازی کنید و شیء PagingSource را در آزمایش مقداردهی اولیه کنید. مثال زیر مقداردهی اولیه شیء FakeRedditApi را با فهرستی از پستهای آزمایشی و آزمایش نمونه RedditPagingSource نشان میدهد:
class SubredditPagingSourceTest {
private val mockPosts = listOf(
postFactory.createRedditPost(DEFAULT_SUBREDDIT),
postFactory.createRedditPost(DEFAULT_SUBREDDIT),
postFactory.createRedditPost(DEFAULT_SUBREDDIT)
)
private val fakeApi = FakeRedditApi().apply {
mockPosts.forEach { post -> addPost(post) }
}
@Test
fun loadReturnsPageWhenOnSuccessfulLoadOfItemKeyedData() = runTest {
val pagingSource = RedditPagingSource(
fakeApi,
DEFAULT_SUBREDDIT
)
val pager = TestPager(CONFIG, pagingSource)
val result = pager.refresh() as LoadResult.Page
// Write assertions against the loaded data
assertThat(result.data)
.containsExactlyElementsIn(mockPosts)
.inOrder()
}
}
TestPager همچنین به شما امکان میدهد کارهای زیر را انجام دهید:
- آزمایش بارگیریهای متوالی از
PagingSource:
@Test
fun test_consecutive_loads() = runTest {
val page = with(pager) {
refresh()
append()
append()
} as LoadResult.Page
assertThat(page.data)
.containsExactlyElementsIn(testPosts)
.inOrder()
}
- سناریوهای خطا را در
PagingSourceخود آزمایش کنید:
@Test
fun refresh_returnError() {
val pagingSource = RedditPagingSource(
fakeApi,
DEFAULT_SUBREDDIT
)
// Configure your fake to return errors
fakeApi.setReturnsError()
val pager = TestPager(CONFIG, source)
runTest {
source.errorNextLoad = true
val result = pager.refresh()
assertTrue(result is LoadResult.Error)
val page = pager.getLastLoadedPage()
assertThat(page).isNull()
}
}
RemoteMediator آزمایش
هدف از آزمایشهای واحد RemoteMediator این است که تأیید شود تابع load() مقدار صحیح MediatorResult را برمیگرداند.
آزمایشهای مربوط به عوارض جانبی، مثل درج دادهها در پایگاه داده،
برای آزمایشهای همگرایی مناسبتر هستند.
اولین قدم این است که تعیین کنید پیادهسازی RemoteMediator شما به چه وابستگیهایی نیاز دارد. مثال زیر پیادهسازی RemoteMediator را نشان میدهد که به پایگاه داده Room، میانای Retrofit، و رشته جستجو نیاز دارد:
@OptIn(ExperimentalPagingApi::class)
class PageKeyedRemoteMediator(
private val db: RedditDb,
private val redditApi: RedditApi,
private val subredditName: String
) : RemoteMediator<Int, RedditPost>() {
...
}
میتوانید میانای Retrofit و رشته جستجو را همانطور که در بخش آزمایشهای PagingSource نشان داده شده است ارائه دهید. ارائه نسخه ساختگی
پایگاه داده Room بسیار پیچیده است، بنابراین ارائه
پیادهسازی درونحافظهای
پایگاه داده بهجای نسخه ساختگی کامل میتواند آسانتر باشد. ازآنجاییکه ایجاد پایگاه داده Room
به شیء Context نیاز دارد، باید
این آزمایش RemoteMediator را در فهرست راهنمای androidTest قرار دهید و آن را
با اجراکننده آزمایش AndroidJUnit4 اجرا کنید تا به بافت برنامه آزمایشی
دسترسی داشته باشد. برای اطلاعات بیشتر درباره آزمایشهای ابزاردار، به ساختن آزمایشهای واحد ابزاردار مراجعه کنید.
توابع tear-down را تعریف کنید تا مطمئن شوید که وضعیت بین توابع آزمایشی نشت نمیکند. این کار باعث میشود نتایج بین اجراهای آزمایشی یکسان باشد.
@ExperimentalPagingApi
@OptIn(ExperimentalCoroutinesApi::class)
@RunWith(AndroidJUnit4::class)
class PageKeyedRemoteMediatorTest {
private val postFactory = PostFactory()
private val mockPosts = listOf(
postFactory.createRedditPost(SubRedditViewModel.DEFAULT_SUBREDDIT),
postFactory.createRedditPost(SubRedditViewModel.DEFAULT_SUBREDDIT),
postFactory.createRedditPost(SubRedditViewModel.DEFAULT_SUBREDDIT)
)
private val mockApi = mockRedditApi()
private val mockDb = RedditDb.create(
ApplicationProvider.getApplicationContext(),
useInMemory = true
)
@After
fun tearDown() {
mockDb.clearAllTables()
// Clear out failure message to default to the successful response.
mockApi.failureMsg = null
// Clear out posts after each test run.
mockApi.clearPosts()
}
}
مرحله بعدی آزمایش کردن تابع load() است. در این مثال، سه
مورد برای آزمایش وجود دارد:
- مورد اول زمانی است که
mockApiدادههای معتبر برمیگرداند. تابعload()بایدMediatorResult.Successرا برگرداند و ویژگیendOfPaginationReachedبایدfalseباشد. - مورد دوم زمانی است که
mockApiپاسخ موفقیتآمیز برمیگرداند، اما دادههای برگرداندهشده خالی است. تابعload()بایدMediatorResult.Successرا برگرداند و ویژگیendOfPaginationReachedبایدtrueباشد. - مورد سوم زمانی است که
mockApiهنگام واکشی دادهها استثنا قائل میشود. تابعload()بایدMediatorResult.Errorرا برگرداند.
برای آزمایش کردن مورد اول، این مراحل را دنبال کنید:
mockApiرا با دادههای پست برای برگرداندن تنظیم کنید.- مقداردهی اولیه شیء
RemoteMediator. - تابع
load()را آزمایش کنید.
@Test
fun refreshLoadReturnsSuccessResultWhenMoreDataIsPresent() = runTest {
// Add mock results for the API to return.
mockPosts.forEach { post -> mockApi.addPost(post) }
val remoteMediator = PageKeyedRemoteMediator(
mockDb,
mockApi,
SubRedditViewModel.DEFAULT_SUBREDDIT
)
val pagingState = PagingState<Int, RedditPost>(
listOf(),
null,
PagingConfig(10),
10
)
val result = remoteMediator.load(LoadType.REFRESH, pagingState)
assertTrue { result is MediatorResult.Success }
assertFalse { (result as MediatorResult.Success).endOfPaginationReached }
}
آزمایش دوم مستلزم این است که mockApi نتیجه خالی برگرداند. چون پساز هر اجرای آزمایشی، دادهها را از mockApi پاک میکنید، بهطور پیشفرض نتیجه خالی برمیگرداند.
@Test
fun refreshLoadSuccessAndEndOfPaginationWhenNoMoreData() = runTest {
// To test endOfPaginationReached, don't set up the mockApi to return post
// data here.
val remoteMediator = PageKeyedRemoteMediator(
mockDb,
mockApi,
SubRedditViewModel.DEFAULT_SUBREDDIT
)
val pagingState = PagingState<Int, RedditPost>(
listOf(),
null,
PagingConfig(10),
10
)
val result = remoteMediator.load(LoadType.REFRESH, pagingState)
assertTrue { result is MediatorResult.Success }
assertTrue { (result as MediatorResult.Success).endOfPaginationReached }
}
آزمایش نهایی به mockApi نیاز دارد تا استثنایی را ایجاد کند تا آزمایش بتواند تأیید کند که تابع load() بهدرستی MediatorResult.Error را برمیگرداند.
@Test
fun refreshLoadReturnsErrorResultWhenErrorOccurs() = runTest {
// Set up failure message to throw exception from the mock API.
mockApi.failureMsg = "Throw test failure"
val remoteMediator = PageKeyedRemoteMediator(
mockDb,
mockApi,
SubRedditViewModel.DEFAULT_SUBREDDIT
)
val pagingState = PagingState<Int, RedditPost>(
listOf(),
null,
PagingConfig(10),
10
)
val result = remoteMediator.load(LoadType.REFRESH, pagingState)
assertTrue {result is MediatorResult.Error }
}
آزمایشهای سرتاسر
آزمایشهای واحد اطمینان میدهند که مؤلفههای صفحهبندی بهصورت جداگانه بهدرستی کار میکنند، اما آزمایشهای سرتاسر اطمینان بیشتری میدهند که برنامه بهطور کلی بهدرستی کار میکند. این آزمایشها به تأیید اینکه لایه داده شما
(PagingSource یا RemoteMediator)، ViewModel، و Compose UI بهطور یکپارچه و بدون عوارض جانبی غیرمنتظره ادغام میشوند کمک میکند. آزمایشها همچنان به برخی وابستگیهای ساختگی نیاز دارند، اما بهطور کلی بیشتر کد برنامه شما را پوشش میدهند.
مثال این بخش از وابستگی API ساختگی استفاده میکند تا از شبکه در آزمایشها استفاده نشود. میانای برنامهسازی کاربردی شبیهسازیشده بهگونهای پیکربندی شده است که مجموعه ثابتی از دادههای آزمایشی را برگرداند، که منجر به آزمایشهای تکرارپذیر میشود. برای آزمایشهای سرتاسر، معمولاً میانای برنامهسازی کاربردی شبکه واقعیتان را با یک میانای برنامهسازی کاربردی جعلی عوض میکنید، اما همچنان به کتابخانه «صفحهبندی» اجازه میدهید واکشی واقعی و ذخیره موقت پایگاه داده محلی را (درصورت استفاده از RemoteMediator) برای حفظ وفاداری آزمایشهایتان مدیریت کند.
کدتان را بهگونهای بنویسید که بتوانید بهراحتی نسخههای شبیهسازیشده وابستگیهایتان را جایگزین کنید. مثال زیر از یک پیادهسازی مکانیاب سرویس پایه استفاده میکند و آزمایشی را با یک API ساختگی راهاندازی میکند تا تأیید کند که صفحه Compose بهدرستی دادههای صفحهبندیشده را مصرف و نمایش میدهد. در برنامههای بزرگتر، استفاده از کتابخانه تزریق وابستگی مانند Hilt میتواند به مدیریت نمودارهای وابستگی پیچیدهتر کمک کند.
پساز راهاندازی ساختار آزمایشی، مرحله بعدی این است که درستیسنجی کنید دادههای
برگرداندهشده توسط پیادهسازی Pager درست باشد. یک آزمایش باید تأیید کند که
رابط کاربری Compose هنگام بارگیری اولیه صفحه با موارد صحیح پر میشود، و
آزمایش دیگر باید تأیید کند که رابط کاربری دادههای اضافی را بهدرستی براساس
تعامل کاربر بارگیری میکند.
در مثال زیر، آزمایش درستیسنجی میکند که واسط کاربر دادههای صفحهبندیشده موردانتظار را نمایش میدهد.
import androidx.compose.ui.test.assertIsDisplayed
import androidx.compose.ui.test.assertDoesNotExist
import androidx.compose.ui.test.hasText
import androidx.compose.ui.test.junit4.createComposeRule
import androidx.compose.ui.test.onNodeWithTag
import androidx.compose.ui.test.onNodeWithText
import androidx.compose.ui.test.performClick
import androidx.compose.ui.test.performTextClearance
import androidx.compose.ui.test.performTextInput
import androidx.test.ext.junit.runners.AndroidJUnit4
import kotlinx.coroutines.test.runTest
import org.junit.Before
import org.junit.Rule
import org.junit.Test
import org.junit.runner.RunWith
@RunWith(AndroidJUnit4::class)
class RedditScreenTest {
@get:Rule
val composeTestRule = createComposeRule()
private val postFactory = PostFactory()
private val mockApi = MockRedditApi()
@Before
fun setup() {
// Pre-populate the mock API with test data for the default subreddit
mockApi.addPost(postFactory.createRedditPost(subreddit = "androiddev", title = "Jetpack Compose Paging"))
// Swap your real dependency injection module/Service Locator with the mock API
ServiceLocator.swap(
object : DefaultServiceLocator(useInMemoryDb = true) {
override fun getRedditApi(): RedditApi = mockApi
}
)
}
@Test
fun loadsTheDefaultResults() = runTest {
// 1. Set the Compose UI content
composeTestRule.setContent {
MyTheme {
// Assume that this composable uses `collectAsLazyPagingItems()` internally
RedditScreen(initialSubreddit = "androiddev")
}
}
// 2. Wait for the asynchronous Paging loads to complete
composeTestRule.waitUntilExactlyOneExists(
matcher = hasText("Jetpack Compose Paging"),
timeoutMillis = 5000
)
// 3. Assert that the loaded paged items are displayed correctly on screen
composeTestRule.onNodeWithText("Jetpack Compose Paging").assertIsDisplayed()
}
@Test
fun loadsNewDataBasedOnUserInput() = runTest {
// Add data for a different subreddit to the mock API
mockApi.addPost(postFactory.createRedditPost(subreddit = "compose", title = "Compose Testing"))
composeTestRule.setContent {
MyTheme {
RedditScreen(initialSubreddit = "androiddev")
}
}
// Wait for the initial load to finish
composeTestRule.waitUntilExactlyOneExists(hasText("Jetpack Compose Paging"))
// Simulate user entering a new subreddit in a text field and clicking search
composeTestRule.onNodeWithTag("SubredditInput").performTextClearance()
composeTestRule.onNodeWithTag("SubredditInput").performTextInput("compose")
composeTestRule.onNodeWithTag("SearchButton").performClick()
// Wait for the new paged data to load
composeTestRule.waitUntilExactlyOneExists(
matcher = hasText("Compose Testing"),
timeoutMillis = 5000
)
// Assert the old data is gone and the new data is displayed
composeTestRule.onNodeWithText("Jetpack Compose Paging").assertDoesNotExist()
composeTestRule.onNodeWithText("Compose Testing").assertIsDisplayed()
}
}
چون Flow<PagingData> دادهها را بهصورت ناهمگام بار میکند، باید به کتابخانه «صفحهبندی»
زمان بدهید تا بار اولیه را واکشی کند و آن را به
collectAsLazyPagingItems ارسال کند و سپس ادعاها را مطرح کنید. برای این کار، از
composeTestRule.waitUntil یا waitUntilExactlyOneExists استفاده کنید، همانطور که در
مثال قبلی نشان داده شده است.
پساز بار شدن دادهها، میتوانید مستقیماً بااستفاده از onNodeWithText دربرابر درخت معنایی Compose ادعا کنید تا تأیید کنید که موارد واقعاً در LazyColumn شما ارائه شدهاند.
منابع بیشتر
محتوا را مشاهده میکند
توصیهشده برای شما
- توجه: وقتی جاوا اسکریپت خاموش باشد، نوشتار پیوند نمایش داده میشود
- صفحه از شبکه و پایگاه داده
- انتقال به Paging 3
- بار کردن و نمایش دادن دادههای صفحهبندیشده