Compose 預覽螢幕截圖測試

螢幕截圖測試能有效驗證使用者看到的 UI 外觀。 Compose 預覽螢幕截圖測試工具結合了 可組合項預覽 提升工作效率。Compose 預覽 螢幕截圖測試能夠像可組合函式的預覽畫面一樣輕鬆使用。

螢幕截圖測試是自動測試，會擷取 UI 畫面的螢幕截圖 然後與先前核准的參考圖片比較。如果 兩張圖像不相符，測試失敗並產生 HTML 報告，協助您 進行比較

使用 Compose 預覽螢幕截圖測試工具，您可以：

• 找出要使用的現有或新的可組合項預覽 擷取螢幕截圖測試
• 從這些可組合項預覽產生參考圖片。
• 產生 HTML 報表，在預覽之後查看預覽畫面 變更程式碼。
• 使用 @Preview 參數 (例如 uiMode 或 fontScale) 和多重預覽 來擴大測試規模
• 使用新的 screenshotTest 來源集模組化測試。

需求條件

如要使用 Compose 預覽螢幕截圖測試，您需要下列項目：

• Android Gradle 8.5.0-beta01 以上版本。
• Kotlin 1.9.20 以上版本。

設定

如要啟用這個工具，請按照下列步驟操作：

1. 新增 com.android.compose.screenshot 外掛程式版本 0.0.1-alpha01至您的專案。
1. 將外掛程式新增至版本目錄檔案：

   [versions]
   agp = "8.5.0-beta01"
   kotlin = "1.9.20"
   ...
   screenshot = "0.0.1-alpha01"
   
   [plugins]
   ...
   screenshot = { id = "com.android.compose.screenshot", version.ref = "screenshot"}
   

2. 在模組層級 build.gradle.kts 檔案中，將外掛程式新增至 plugins {} 區塊：

   plugins {
       ...
       alias(libs.plugins.screenshot)
   }
   

2. 在專案的 gradle.properties 檔案。

   android.experimental.enableScreenshotTest=true
   

3. 在模組層級的 android {} 區塊中 build.gradle.kts 檔案中，啟用實驗性旗標以使用 screenshotTest 來源集，並確認 kotlinCompilerExtensionVersion 設為 1.5.4 以上。

   android {
       ...
       composeOptions {
           kotlinCompilerExtensionVersion = "1.5.4"
       }
       experimentalProperties["android.experimental.enableScreenshotTest"] = true
   }
   

4. 請確認您已新增 ui-tooling敬上 依附元件
   1. 將版本新增至版本目錄：

      [libraries]
      androidx-compose-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling"}
      

   2. 將其新增至模組層級 build.gradle.kts 檔案：

      dependencies {
        screenshotTestImplementation(libs.androidx.compose.ui.tooling)
      }
      

指定用於螢幕截圖測試的可組合項預覽

如要指定要用於螢幕截圖測試的可組合函式預覽畫面，請將 測試類別中預覽的功能測試類別檔案必須位於新的 screenshotTest 來源集，例如 app/src/screenshotTest/kotlin/com/google/yourapp/ExamplePreviewScreenshots.kt ({module}/src/screenshotTest/{kotlin|java}/com/your/package)。

您可在以下版本新增更多可組合項和/或預覽 (包括多重預覽) 這個檔案或同一個來源集中建立的其他檔案

package com.google.yourapp

import androidx.compose.runtime.Composable
import androidx.compose.ui.tooling.preview.Preview
import com.google.yourapp.ui.theme.MyApplicationTheme

class ExamplePreviewsScreenshots {

    @Preview(showBackground = true)
    @Composable
    fun GreetingPreview() {
        MyApplicationTheme {
            Greeting("Android!")
        }
    }
}

產生參考圖片

設定測試類別後，您需要為每個測試類別產生參考圖片 預覽。這些參考圖片將用於在您之後識別變更 變更程式碼。為可組合項預覽產生參考圖片 螢幕截圖測試，請執行下列 Gradle 工作：

• Linux 和 macOS：./gradlew updateDebugScreenshotTest (./gradlew {:module:}update{Variant}ScreenshotTest)
• Windows：gradlew updateDebugScreenshotTest (gradlew {:module:}update{Variant}ScreenshotTest)

工作完成後，請在 app/src/debug/screenshotTest/reference ({module}/src/{variant}/screenshotTest/reference)。

產生測試報告

找到的參考圖片後，執行驗證工作，擷取新的螢幕截圖 並與參考圖片比較：

• Linux 和 macOS：./gradlew validateDebugScreenshotTest (./gradlew {:module:}validate{Variant}ScreenshotTest)
• Windows：gradlew validateDebugScreenshotTest (gradlew {:module:}validate{Variant}ScreenshotTest)

驗證工作會在下列位置建立 HTML 報告： {module}/build/reports/screenshotTest/preview/{variant}/index.html。

已知問題

您可以在這項工具的 Issue Tracker 元件：回報其他意見回饋和問題 Issue Tracker。