测试您的 Compose 布局

测试您的应用的 UI 以验证您的 Compose 代码的行为是否正确。这可以让您尽早发现错误并提高应用的质量。

Compose 提供了一套测试 API 用于查找元素,验证其属性,以及执行用户操作。这些 API 还包括时间操作等高级功能。使用这些 API 创建稳健的测试,验证应用的行为。

视图

如果您使用的是视图而不是 Compose,请参阅通用 在 Android 上测试应用 部分。

特别是,一个好的起点是 自动化 UI 测试 指南。它概述了如何自动化在设备上运行的测试,包括使用视图时的测试。

关键概念

以下是一些测试 Compose 代码的关键概念。

  • 语义:Compose 测试使用语义与 UI 交互,语义赋予 UI 部分意义,并在 UI 层级结构旁边生成。
  • 测试 API:Compose 提供测试 API 用于查找元素,对元素的状态和属性进行断言,以及执行操作来模拟用户交互。
  • 同步:默认情况下,Compose 测试会自动与 UI 同步,等待 UI 处于空闲状态后才进行断言或执行操作。
  • 互操作性:在混合应用中,测试可以无缝地与 Compose 和基于视图的元素交互,并与其他测试框架集成。

测试备忘单

请参阅 测试备忘单,了解有关 Compose 中测试的所有关键主题的概述。

设置

设置您的应用,以便您可以测试 Compose 代码。

首先,将以下依赖项添加到包含 UI 测试的模块的 build.gradle 文件中

// Test rules and transitive dependencies:
androidTestImplementation("androidx.compose.ui:ui-test-junit4:$compose_version")
// Needed for createComposeRule(), but not for createAndroidComposeRule<YourActivity>():
debugImplementation("androidx.compose.ui:ui-test-manifest:$compose_version")

此模块包含一个 ComposeTestRule 和一个针对 Android 的实现,名为 AndroidComposeTestRule。通过此规则,您可以设置 Compose 内容或访问 Activity。您可以使用工厂函数构造规则,即 createComposeRule 或,如果您需要访问 Activity,则使用 createAndroidComposeRule。典型的 Compose UI 测试如下所示

// file: app/src/androidTest/java/com/package/MyComposeTest.kt

class MyComposeTest {

    @get:Rule val composeTestRule = createComposeRule()
    // use createAndroidComposeRule<YourActivity>() if you need access to
    // an activity

    @Test
    fun myTest() {
        // Start the app
        composeTestRule.setContent {
            MyAppTheme {
                MainScreen(uiState = fakeUiState, /*...*/)
            }
        }

        composeTestRule.onNodeWithText("Continue").performClick()

        composeTestRule.onNodeWithText("Welcome").assertIsDisplayed()
    }
}

其他资源

  • 在 Android 上测试应用:主要的 Android 测试着陆页提供了关于测试基础知识和技术的更广泛的视图。
  • 测试基础知识: 了解有关测试 Android 应用的核心概念的更多信息。
  • 本地测试: 您可以在自己的工作站上本地运行一些测试。
  • 设备测试: 这是一个好习惯,也应该运行设备测试。也就是说,直接在设备上运行的测试。
  • 持续集成: 持续集成允许您将测试集成到您的部署管道中。
  • 测试不同的屏幕尺寸: 由于用户可以使用的设备种类繁多,因此您应该测试不同的屏幕尺寸。
  • Espresso:虽然 Espresso 的目标是基于视图的 UI,但 Espresso 的知识对于 Compose 测试的某些方面仍然很有用。

Codelab

要了解更多信息,请尝试 Jetpack Compose 测试 Codelab.

示例