测试您的 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 以及一个名为 AndroidComposeTestRule 的 Android 实现。通过此规则，您可以设置 Compose 内容或访问 activity。您可以使用工厂函数构造规则，即 createComposeRule，或者如果您需要访问 activity，则使用 createAndroidComposeTestRule。一个典型的 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，但其知识对于 Compose 测试的某些方面仍然有帮助。

Codelab

要了解更多信息，请尝试 Jetpack Compose 测试 Codelab。

示例