使用 Glance 进行单元测试

Glance 单元测试 API 允许您在不膨胀视图或不需要 UI 自动化器的情况下测试您的 Glance 代码。例如,单元测试 API 允许您使用匹配器(如 hasContentDescriptionEqualToisChecked)来验证条件,例如元素是否在列表中或复选框是否已选中。

此 API 轻量且所需设置较少,因此您可以在开发微件的各个部分并进行组织以提高代码复用性时,执行测试驱动开发。

设置

使用单元测试库所需的依赖项显示在以下示例中

// Other Glance and Compose runtime dependencies.
...
testImplementation 'androidx.glance:glance-testing:1.1.1'
testImplementation 'androidx.glance:glance-appwidget-testing:1.1.1'
testImplementation 'org.robolectric:robolectric:4.11.1'
...
// You may include additional dependencies, such as Robolectric, if your test
// needs to set a LocalContext.

测试结构

将可组合函数组织在 GlanceAppWidget 类之外,以实现代码复用和单元测试。尽可能降低被测单元的复杂性。

class MyGlanceComposableTest {
    @Test
    fun myNewsItemComposable_largeSize_hasAuthorAsSubtitle() = runGlanceAppWidgetUnitTest {
        // Prepare inputs and state
        setAppWidgetSize(100.dp, 100.dp)

        // Set the composable under test
        provideComposable {
            MyNewsItemComposable(TEST_NEWS_ITEM)
        }

        // Perform assertions
        onNode(hasTestTag("subTitle"))
            .assertHasText(TEST_NEWS_ITEM.authorName)
    }
}

为测试设置上下文和大小

如果您的可组合函数使用 LocalContext.current() 方法读取上下文,则必须使用 setContext() 设置上下文。否则,此步骤是可选的。

您可以使用任何基于 JVM 的 Android 单元测试框架(例如 Roboletric)来提供上下文。

如果您的可组合函数访问 LocalSize,请在测试中提供可组合项之前为测试设置预期大小。默认大小为 349.dp x 455.dp,相当于在纵向模式下在 Pixel 4 设备上显示的 5x4 微件。

  • 如果您的 AppWidget 使用 sizeMode == Single,您可以将其设置为微件 info.xml 文件中的 minWidthminHeight
  • 如果您的 AppWidget 使用 sizeMode == Exact,您可以通过与确定微件大小类似的方式识别要测试的大小,并识别您的微件可能出现的横向和纵向大小并进行测试。
  • 如果您的 AppWidget 使用 sizeMode == Responsive,您可以将其设置为在指定 sizeMode 时提供的列表中的其中一个大小。

测试超时的默认持续时间为 1 秒,但如果您的测试基础架构强制执行不同的超时时间,您可以将自定义持续时间作为参数传递给 runGlanceAppWidgetUnitTest 方法。

如需了解更多信息和代码示例,请参阅 runGlanceAppWidgetUnitTest 的参考文档。