此页面由 Cloud Translation API 翻译。

使用 Health Connect Testing 库创建单元测试

Health Connect 测试库 (androidx.health.connect:connect-testing) 简化了自动化测试的创建。您可以使用此库来验证应用的行为，并验证它是否对难以手动测试的异常情况做出了正确响应。

您可以使用该库创建本地单元测试，这些测试通常用于验证应用中与 Health Connect 客户端交互的类的行为。

如需开始使用该库，请将其添加为测试依赖项：

 testImplementation("androidx.health.connect:connect-testing:1.0.0-alpha01")

库的入口点是 FakeHealthConnectClient 类，用于在测试中替换 HealthConnectClient。FakeHealthConnectClient 具有以下功能：

记录的内存表示法，以便您插入、移除、删除和读取记录
更改令牌的生成和更改跟踪
记录和更改的分页
支持使用桩生成汇总回答
允许任何函数抛出异常
可用于模拟权限检查的 FakePermissionController

如需详细了解如何在测试中替换依赖项，请参阅 Android 中的依赖项注入。如果你想详细了解仿冒产品，请参阅在 Android 中使用测试替身。

例如，如果与客户端交互的类名为 HealthConnectManager，并且它将 HealthConnectClient 作为依赖项，则其内容将如下所示：

class HealthConnectManager(
    private val healthConnectClient: HealthConnectClient,
    ...
) { }

在测试中，您可以改为将虚假对象传递给被测类：

import androidx.health.connect.client.testing.ExperimentalTestingApi
import androidx.health.connect.client.testing.FakeHealthConnectClient
import kotlinx.coroutines.test.runTest

@OptIn(ExperimentalTestingApi::class)
class HealthConnectManagerTest {

    @Test
    fun readRecords_filterByActivity() = runTest {
        // Create a Fake with 2 running records.
        val fake = FakeHealthConnectClient()
        fake.insertRecords(listOf(fakeRunRecord1, fakeBikeRecord1))

        // Create a manager that depends on the fake.
        val manager = HealthConnectManager(fake)

        // Read running records only.
        val runningRecords = manager.fetchReport(activity = Running)

        // Verify that the records were filtered correctly.
        assertTrue(runningRecords.size == 1)
    }
}

此测试用于验证以下情况中的虚构 fetchReport 函数： HealthConnectManager 按活动正确过滤记录。

验证异常

几乎每次调用 HealthConnectClient 都会抛出异常。例如，insertRecords 的文档中提到了以下例外情况：

如果发生任何 IPC 传输失败，则为 @throws android.os.RemoteException。
对于具有未允许访问权限的请求，请使用 @throws SecurityException。
如果有任何磁盘 I/O 问题，则为 @throws java.io.IOException。

这些例外情况涵盖连接不佳或设备上没有可用空间等情况。这些运行时问题随时都可能发生，因此您的应用必须对这些问题做出正确响应。

import androidx.health.connect.client.testing.stubs.stub

@Test
fun addRecords_throwsRemoteException_errorIsExposed() {
    // Create Fake that throws a RemoteException
    // when insertRecords is called.
    val fake = FakeHealthConnectClient()
    fake.overrides.insertRecords = stub { throw RemoteException() }

    // Create a manager that depends on the fake.
    val manager = HealthConnectManager(fake)

    // Insert a record.
    manager.addRecords(fakeRunRecord1)

    // Verify that the manager is exposing an error.
    assertTrue(manager.errors.size == 1)
}

集合

聚合调用没有虚构实现。相反，聚合调用使用可通过编程实现特定行为的桩。您可以通过 FakeHealthConnectClient 的 overrides 属性访问桩。

例如，您可以对汇总函数进行编程，以返回特定结果：

import androidx.health.connect.client.testing.AggregationResult
import androidx.health.connect.client.records.HeartRateRecord
import androidx.health.connect.client.records.ExerciseSessionRecord
import java.time.Duration

@Test
fun aggregate() {
    // Create a fake result.
    val result =
        AggregationResult(metrics =
            buildMap {
                put(HeartRateRecord.BPM_AVG, 74.0)
                put(
                    ExerciseSessionRecord.EXERCISE_DURATION_TOTAL,
                    Duration.ofMinutes(30)
                )
            }
        )

    // Create a fake that always returns the fake
    // result when aggregate() is called.
    val fake = FakeHealthConnectClient()
    fake.overrides.aggregate = stub(result)

然后，您可以验证被测类（在本例中为 HealthConnectManager）是否正确处理了结果：

// Create a manager that depends on the fake.
val manager = HealthConnectManager(fake)
// Call the function that in turn calls aggregate on the client.
val report = manager.getHeartRateReport()

// Verify that the manager is exposing an error.
assertThat(report.bpmAverage).isEqualTo(74.0)

权限

测试库包含一个 FakePermissionController，可作为依赖项传递给 FakeHealthConnectClient。

受测对象可以使用 HealthConnectClient 接口的 permissionController 属性来检查权限。PermissionController—through此操作通常在每次调用客户端之前完成。

如需测试此功能，您可以使用 FakePermissionController：

import androidx.health.connect.client.testing.FakePermissionController

@Test
fun newRecords_noPermissions_errorIsExposed() {
    // Create a permission controller with no permissions.
    val permissionController = FakePermissionController(grantAll = false)

    // Create a fake client with the permission controller.
    val fake = FakeHealthConnectClient(permissionController = permissionController)

    // Create a manager that depends on the fake.
    val manager = HealthConnectManager(fake)

    // Call addRecords so that the permission check is made.
    manager.addRecords(fakeRunRecord1)

    // Verify that the manager is exposing an error.
    assertThat(manager.errors).hasSize(1)
}

分页

分页是导致 bug 的常见原因，因此 FakeHealthConnectClient 提供了一些机制来帮助您验证记录和更改的分页实现是否正常运行。

被测对象（在本例中为 HealthConnectManager）可以指定 ReadRecordsRequest 中的页面大小：

fun fetchRecordsReport(pageSize: Int = 1000) }
    val pagedRequest =
        ReadRecordsRequest(
            timeRangeFilter = ...,
            recordType = ...,
            pageToken = page1.pageToken,
            pageSize = pageSize,
        )
    val page = client.readRecords(pagedRequest)
    ...

将页面大小设置为较小的值（例如 2），即可轻松测试分页。例如，您可以插入 5 条记录，以便 readRecords 返回 3 个不同的页面：

@Test
fun readRecords_multiplePages() = runTest {

    // Create a Fake with 2 running records.
    val fake = FakeHealthConnectClient()
    fake.insertRecords(generateRunningRecords(5))

    // Create a manager that depends on the fake.
    val manager = HealthConnectManager(fake)

    // Read records with a page size of 2.
    val report = manager.generateReport(pageSize = 2)

    // Verify that all the pages were processed correctly.
    assertTrue(report.records.size == 5)
}

测试数据

该库尚不包含用于生成虚构数据的 API，但您可以在 Android 代码搜索中使用该库使用的相关数据和生成器。

桩

通过 FakeHealthConnectClient 的 overrides 属性，您可以编程（或打桩）其任何函数，以便它们在调用时抛出异常。聚合调用也可以返回任意数据，并且支持加入队列生成多份回答。如需了解详情，请参阅 Stub 和 MutableStub。

边缘情况摘要

验证在客户端抛出异常时应用的行为是否符合预期。查看每个函数的文档，了解您应检查哪些异常。
确保您对客户的每次调用都以正确的权限检查。
验证分页实现。
验证在提取多个网页但其中一个网页的令牌已过期时会出现什么情况。