測試 Compose 版面配置

測試應用程式的 UI，確認 Compose 程式碼的行為是否正確。這可讓您及早發現錯誤，並提升應用程式品質。

Compose 提供一組測試 API，可用於找出元素、驗證其屬性，以及執行使用者動作。這些 API 也包含時間操作等進階功能。使用這些 API 建立可靠的測試，驗證應用程式的行為。

View

如果您使用的是 View 而非 Compose，請參閱一般性的「在 Android 上測試應用程式」一節。

特別是，您可以參考「自動化 UI 測試」指南，說明如何自動執行裝置端測試，包括使用檢視畫面時。

核心概念

以下是測試 Compose 程式碼的幾個重要概念。

  • 語意：Compose 測試會使用語意與 UI 互動，為 UI 的各個部分賦予意義，並與 UI 階層一同產生。
  • 測試 API：Compose 提供測試 API，可用於找出元素、對其狀態和屬性做出斷言，以及執行動作來模擬使用者互動。
  • 同步處理：根據預設，Compose 測試會自動與 UI 同步處理，並等待 UI 閒置，再進行斷言或執行動作。
  • 互通性：在混合式應用程式中，測試可以與 Compose 和 View 元素完美互動，並整合其他測試架構。

測試一覽表

請參閱測試一覽表，瞭解您應學習的所有關鍵主題，以便在 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 實作。透過這項規則，您可以設定撰寫內容或存取活動。您可以使用工廠函式建立規則，包括 createComposeRule，如果需要存取活動，則為 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 是為以 View 為基礎的 UI 而設計，但對於 Compose 測試的某些方面，Espresso 知識仍相當實用。

程式碼實驗室

如要進一步瞭解，請嘗試使用 Jetpack Compose Testing 程式碼研究室。

範例