使用 Glance 进行单元测试

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

此 API 轻量级且设置简单,因此您可以在开发部件的各个部分时执行测试驱动开发,并将其组织起来以提高代码重用率。

设置

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

// Other Glance and Compose runtime dependencies.
...
testImplementation 'androidx.glance:glance-testing:1.1.0'
testImplementation 'androidx.glance:glance-AppWidget-testing:1.1.0'
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() 方法读取上下文,则必须使用 LocalContext.current() 方法设置上下文。否则,此步骤是可选的。

您可以使用任何基于 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 的参考文档。