Việc triển khai thư viện Paging trong ứng dụng của bạn nên được kết hợp với một chiến lược kiểm thử mạnh mẽ. Bạn nên kiểm thử các thành phần tải dữ liệu, như PagingSource và RemoteMediator để đảm bảo các thành phần này hoạt động như mong đợi. Bạn cũng nên viết mã kiểm thử toàn diện để xác minh rằng tất cả các thành phần trong quá trình triển khai Paging (Phân trang) hoạt động đúng cách cùng nhau mà không có ảnh hưởng bất lợi ngoài dự kiến nào.
Hướng dẫn này giải thích cách kiểm thử thư viện Paging trong các lớp cấu trúc khác nhau của ứng dụng cũng như cách viết mã kiểm thử toàn diện cho toàn bộ quá trình triển khai Paging.
Kiểm thử lớp giao diện người dùng
Vì Compose sử dụng dữ liệu Paging một cách khai báo thông qua
collectAsLazyPagingItems, nên các chương trình kiểm thử lớp giao diện người dùng có thể tập trung hoàn toàn vào
Flow<PagingData<Value>> do ViewModel phát ra. Để viết mã kiểm thử nhằm xác minh dữ liệu trong giao diện người dùng đúng như bạn mong đợi, hãy thêm phần phụ thuộc paging-testing. Phần phụ thuộc này
chứa hàm mở rộng asSnapshot trên Flow<PagingData<Value>>. Đồng thời cũng cung cấp các API trong trình thu nhận lambda của chính nó, cho phép mô phỏng hoạt động tương tác cuộn. Phần phụ thuộc này còn trả về một List<Value> tiêu chuẩn do các hoạt động mô phỏng tương tác cuộn tạo ra.
Điều này cho phép bạn xác nhận rằng dữ liệu đang được phân trang chứa các phần tử dự kiến được tạo bởi các hoạt động tương tác đó. Điều này được minh hoạ trong đoạn mã sau:
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
)
}
Ngoài ra, bạn có thể cuộn cho đến khi một vị từ (predicate) nhất định được đáp ứng như trong đoạn mã dưới đây:
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" }
}
Kiểm thử các phép biến đổi
Bạn cũng nên viết mã kiểm thử đơn vị bao gồm mọi phép biến đổi mà bạn áp dụng cho luồng PagingData. Sử dụng hàm mở rộng asPagingSourceFactory Hàm này dùng được với các kiểu dữ liệu sau:
List<Value>.Flow<List<Value>>.
Việc lựa chọn sử dụng hàm mở rộng nào phụ thuộc vào nội dung bạn đang cố gắng kiểm thử. Sử dụng:
List<Value>.asPagingSourceFactory(): Nếu bạn muốn kiểm thử các phép biến đổi tĩnh nhưmap()vàinsertSeparators()trên dữ liệu.Flow<List<Value>>.asPagingSourceFactory(): Nếu bạn muốn kiểm thử mức độ ảnh hưởng của các nội dung cập nhật về dữ liệu (ví dụ: ghi vào nguồn dữ liệu hỗ trợ) đến quy trình phân trang.
Để sử dụng một trong các hàm mở rộng này, hãy thực hiện theo mẫu sau:
- Tạo
PagingSourceFactorybằng cách sử dụng hàm mở rộng thích hợp theo nhu cầu của bạn. - Sử dụng
PagingSourceFactoryđược trả về dưới dạng một giao diện giả choRepository. - Truyền
Repositoryđó đếnViewModelcủa bạn.
Sau đó, bạn có thể kiểm thử ViewModel như đã đề cập trong phần trước.
Cân nhắc ViewModel sau đây:
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
}
}
}
Để kiểm thử phép biến đổi trong MyViewModel, hãy cung cấp một thực thể giả của MyRepository và uỷ quyền cho một List tĩnh. Mã này giúp trình bày dữ liệu cần được biến đổi như minh hoạ trong đoạn mã sau:
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()
}
Sau đó, bạn có thể viết mã kiểm thử cho logic của dòng phân cách như trong đoạn mã sau:
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.
}
Kiểm thử lớp dữ liệu
Viết mã kiểm thử đơn vị cho các thành phần trong lớp dữ liệu của bạn để đảm bảo chúng tải dữ liệu từ các nguồn dữ liệu của bạn một cách thích hợp. Cung cấp
phiên bản giả của các phần phụ thuộc để bảo đảm các thành phần đang được kiểm thử hoạt động đúng cách khi
tách biệt. Thành phần chính bạn cần kiểm thử trong lớp lưu trữ là PagingSource và RemoteMediator.
Kiểm thử PagingSource
Các chương trình kiểm thử đơn vị để triển khai PagingSource liên quan đến việc thiết lập thực thể PagingSource và tải dữ liệu từ thực thể đó bằng TestPager.
Để thiết lập thực thể PagingSource cho việc kiểm thử, hãy cung cấp dữ liệu giả cho hàm khởi tạo. Thao tác này cho phép bạn kiểm soát dữ liệu trong các bài kiểm thử của mình.
Trong ví dụ sau, RedditApi
tham số là giao diện Retrofit
xác định các yêu cầu máy chủ và các lớp (class) phản hồi.
Phiên bản giả có thể triển khai giao diện, ghi đè mọi hàm bắt buộc và cung cấp các phương thức thuận tiện để định cấu hình cách đối tượng giả sẽ phản hồi trong các lần kiểm thử.
Sau khi các lớp giả được đưa ra, hãy thiết lập các phần phụ thuộc và khởi chạy đối tượng PagingSource trong chương trình kiểm thử. Ví dụ sau minh hoạ việc khởi chạy đối tượng FakeRedditApi bằng một danh sách các bài đăng kiểm thử và kiểm thử thực thể 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 cũng cho phép bạn làm những việc sau:
- Kiểm thử tải liên tục từ
PagingSource:
@Test
fun test_consecutive_loads() = runTest {
val page = with(pager) {
refresh()
append()
append()
} as LoadResult.Page
assertThat(page.data)
.containsExactlyElementsIn(testPosts)
.inOrder()
}
- Kiểm thử các trường hợp lỗi trong
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()
}
}
Kiểm thử RemoteMediator
Mục tiêu của kiểm thử đơn vị RemoteMediator là nhằm xác minh rằng hàm load()
trả về đúng
MediatorResult.
Các loại hình kiểm thử về tác dụng phụ, chẳng hạn như dữ liệu bị chèn vào cơ sở dữ liệu, là lựa chọn phù hợp hơn cho kiểm thử tích hợp.
Bước đầu tiên là xác định những phần phụ thuộc cần cho quá trình triển khai RemoteMediator của bạn. Ví dụ sau minh hoạ quá trình triển khai RemoteMediator. Quá trình này yêu cầu cơ sở dữ liệu Room, giao diện Retrofit và cụm từ tìm kiếm:
@OptIn(ExperimentalPagingApi::class)
class PageKeyedRemoteMediator(
private val db: RedditDb,
private val redditApi: RedditApi,
private val subredditName: String
) : RemoteMediator<Int, RedditPost>() {
...
}
Bạn có thể cung cấp giao diện Retrofit và cụm từ tìm kiếm như minh hoạ trong
mục kiểm thử PagingSource. Việc cung cấp một phiên bản mô phỏng của cơ sở dữ liệu Room rất quan trọng. Vì vậy, việc cung cấp cách triển khai trong bộ nhớ của cơ sở dữ liệu có thể dễ dàng hơn là một phiên bản mô phỏng đầy đủ. Vì việc tạo cơ sở dữ liệu Room yêu cầu phải có đối tượng Context, bạn phải đặt loại hình kiểm thử RemoteMediator này vào thư mục androidTest và thực thi bằng đối tượng trình chạy kiểm thử AndroidJUnit4 để có quyền truy cập vào ngữ cảnh của ứng dụng kiểm thử. Để biết thêm thông tin về loại hình kiểm thử được đo lường,
hãy xem phần Tạo loại hình kiểm thử đơn vị được đo lường.
Xác định các hàm phân giải để đảm bảo rằng trạng thái đó không bị rò rỉ giữa các hàm kiểm thử. Điều này đảm bảo kết quả nhất quán giữa các lần chạy kiểm thử.
@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()
}
}
Bước tiếp theo là kiểm thử hàm load(). Trong ví dụ này, có ba trường hợp cần kiểm thử:
- Trường hợp đầu tiên là
mockApitrả về dữ liệu hợp lệ. Hàmload()cần trả vềMediatorResult.Successvà thuộc tínhendOfPaginationReachedphải làfalse. - Trường hợp thứ hai là
mockApitrả về một phản hồi thành công, nhưng dữ liệu trả về bị trống. Hàmload()cần trả vềMediatorResult.Successvà thuộc tínhendOfPaginationReachedphải làtrue. - Trường hợp thứ ba là
mockApigửi một ngoại lệ khi tìm nạp dữ liệu. Hàmload()cần trả vềMediatorResult.Error.
Hãy thực hiện theo các bước sau để kiểm thử trường hợp đầu tiên:
- Thiết lập
mockApivới dữ liệu bài đăng cần trả về. - Khởi động đối tượng
RemoteMediator. - Kiểm tra hàm
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 }
}
Trường hợp kiểm thử thứ hai yêu cầu mockApi trả về kết quả trống. Vì bạn xoá dữ liệu khỏi mockApi sau mỗi lần chạy kiểm thử nên kết quả trả về sẽ trống theo mặc định.
@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 }
}
Trường hợp kiểm thử cuối cùng yêu cầu mockApi gửi một ngoại lệ để quá trình kiểm thử có thể xác minh rằng hàm load() trả về chính xác 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 }
}
Kiểm thử toàn diện
Loại hình kiểm thử đơn vị nhằm đảm bảo rằng các thành phần Paging riêng lẻ hoạt động tách biệt, nhưng loại hình kiểm thử toàn diện đảm bảo rằng ứng dụng hoạt động như một thể thống nhất. Các chương trình kiểm thử này giúp xác minh rằng lớp dữ liệu (PagingSource hoặc RemoteMediator), ViewModel và giao diện người dùng Compose tích hợp liền mạch mà không có ảnh hưởng bất lợi ngoài dự kiến nào. Các loại hình kiểm thử này vẫn cần một số phần phụ thuộc mô phỏng, nhưng thường sẽ có hầu hết mã trong ứng dụng của bạn.
Ví dụ trong mục này sử dụng phần phụ thuộc API mô phỏng để tránh sử dụng mạng trong quá trình kiểm thử. API mô phỏng được định cấu hình để trả về một tập dữ liệu kiểm thử nhất quán, giúp các lần kiểm thử có thể lặp lại. Đối với các chương trình kiểm thử toàn diện, bạn thường hoán đổi API mạng thực cho một API giả, nhưng bạn vẫn cho phép thư viện Paging xử lý việc tìm nạp thực tế và bộ nhớ đệm cơ sở dữ liệu cục bộ (nếu sử dụng RemoteMediator) để duy trì độ trung thực của các chương trình kiểm thử.
Viết mã của bạn theo cách dễ dàng cho phép hoán đổi trong các phiên bản mô phỏng của các phần phụ thuộc. Ví dụ sau đây sử dụng một quy trình triển khai bộ định vị dịch vụ cơ bản và thiết lập một chương trình kiểm thử bằng API mô phỏng để xác minh rằng màn hình Compose sử dụng và hiển thị đúng dữ liệu được phân trang. Trong các ứng dụng lớn hơn, việc sử dụng một thư viện chèn phần phụ thuộc như Hilt có thể giúp quản lý các biểu đồ phần phụ thuộc phức tạp hơn.
Sau khi bạn thiết lập cấu trúc kiểm thử, bước tiếp theo là xác minh rằng dữ liệu mà hoạt động triển khai Pager trả về là chính xác. Một chương trình kiểm thử phải xác minh rằng giao diện người dùng Compose điền các mục chính xác khi màn hình tải lần đầu tiên và một chương trình kiểm thử khác phải xác minh rằng giao diện người dùng tải đúng dữ liệu bổ sung dựa trên lượt tương tác của người dùng.
Trong ví dụ sau, chương trình kiểm thử xác minh rằng giao diện người dùng hiển thị dữ liệu được phân trang dự kiến.
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()
}
}
Vì Flow<PagingData> tải dữ liệu không đồng bộ, nên bạn phải cho thư viện Paging
thời gian để tìm nạp lượt tải ban đầu và phát ra
collectAsLazyPagingItems trước khi đưa ra các xác nhận. Để thực hiện việc này, hãy sử dụng composeTestRule.waitUntil hoặc waitUntilExactlyOneExists, như minh hoạ trong ví dụ trước.
Sau khi dữ liệu được tải, bạn có thể xác nhận trực tiếp với cây ngữ nghĩa Compose bằng onNodeWithText để xác minh rằng các mục thực sự được kết xuất trong LazyColumn.
Tài nguyên khác
Nội dung về Chế độ xem
Đề xuất cho bạn
- Lưu ý: văn bản liên kết sẽ hiện khi JavaScript tắt
- Phân trang qua mạng và cơ sở dữ liệu
- Di chuyển sang Paging 3
- Tải và hiện dữ liệu được phân trang