测试 Compose 布局

测试应用的界面，以验证 Compose 代码的行为是否正确。这样一来，您就可以尽早发现错误并提高应用质量。

Compose 提供了一组测试 API，用于查找元素、验证其属性以及执行用户操作。这些 API 还包括时间控制等高级功能。使用这些 API 可创建可靠的测试来验证应用的行为。

View

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

具体来说，您可以先参阅自动化界面测试指南。其中介绍了如何自动执行在设备上运行的测试，包括使用视图时。

关键概念

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

  • 语义：语义为界面赋予意义，使测试能够与特定元素互动。
  • 测试 API：借助测试 API，您可以查找元素、验证其属性以及执行用户操作。
  • 同步：同步可验证测试是否在界面空闲时执行操作或做出断言。
  • 互操作性：借助互操作性，测试可以在同一应用中同时使用基于 Compose 和基于 View 的元素。

测试备忘单

如需概览有关在 Compose 中进行测试的所有关键主题，请参阅测试备忘单。

设置

设置应用，以便您测试 Compose 代码。

首先，将以下依赖项添加到包含界面测试的模块的 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 或 createAndroidComposeRule，如果您需要访问 activity）来构建规则。Compose 的典型界面测试如下所示：

// 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 旨在用于基于 View 的界面，但其知识仍有助于进行 Compose 测试的某些方面。

Codelab

如需了解详情，请参阅 Jetpack Compose 测试 Codelab。

示例