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

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

此测试验证 HealthConnectManager 中的虚构 fetchReport 函数是否按预期按活动筛选记录。

验证异常

几乎每次调用 HealthConnectClient 都会引发异常。例如，insertRecords 的文档提到了以下异常

@throws android.os.RemoteException 用于任何 IPC 传输故障。
@throws SecurityException 用于权限不足的请求。
@throws java.io.IOException 用于任何磁盘 I/O 问题。

这些异常涵盖了连接不良或设备空间不足等情况。您的应用程序必须对这些运行时问题做出正确的反应，因为它们可能随时发生。

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。

您正在测试的主题可以使用 PermissionController—通过 HealthConnectClient 接口的 permissionController 属性—来检查权限。这通常在每次调用客户端之前完成。

要测试此功能，您可以使用 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)
}

分页

分页是错误的常见来源，因此 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。

边缘情况摘要

验证您的应用在客户端抛出异常时是否按预期工作。查看每个函数的文档以确定您应该检查哪些异常。
验证您对客户端的每次调用之前都进行了正确的权限检查。
验证您的分页实现。
验证当您获取多个页面但其中一个页面令牌已过期时会发生什么情况。