Diese Seite wurde von der Cloud Translation API übersetzt.

Test zum Erstellen eines Screenshots mit der Vorschau

Mit Screenshot-Tests lässt sich effektiv überprüfen, wie die Benutzeroberfläche für Nutzer aussieht. Das Tool „Compose Preview Screenshot Testing“ kombiniert die Einfachheit und die Funktionen von Composable-Vorschauen mit den Produktivitätsvorteilen von Screenshot-Tests auf Hostseite. Vorschau für die Erstellung Screenshot-Tests sind so einfach zu verwenden wie zusammensetzbare Vorschauen.

Ein Screenshot-Test ist ein automatisierter Test, bei dem ein Screenshot eines Teils der Benutzeroberfläche erstellt und dann mit einem zuvor genehmigten Referenzbild verglichen wird. Wenn die Bilder nicht übereinstimmen, schlägt der Test fehl und es wird ein HTML-Bericht erstellt, mit dem Sie die Unterschiede vergleichen und finden können.

Mit dem Tool zum Testen von Screenshots für die Vorschau von Compose haben Sie folgende Möglichkeiten:

Mit @PreviewTest können Sie Screenshot-Tests für vorhandene oder neue zusammensetzbare Vorschauen erstellen.
Referenzbilder aus diesen zusammensetzbaren Vorschauen generieren.
Generieren Sie einen HTML-Bericht, in dem Änderungen an diesen Vorschauen nach der Vornahme von Codeänderungen aufgeführt werden.
Verwenden Sie @Preview-Parameter wie uiMode oder fontScale und mehrere Vorschauen, um Ihre Tests zu skalieren.
Mit dem neuen Quellsatz screenshotTest können Sie Ihre Tests modularisieren.

**Abbildung 1.** Beispiel für einen HTML-Bericht.

Voraussetzungen

Für Compose Preview Screenshot Testing benötigen Sie Folgendes:

Android-Gradle-Plug-in 8.5.0-beta01 oder höher
Kotlin 1.9.20 oder höher Wir empfehlen die Verwendung von Kotlin 2.0 oder höher, damit Sie das Compose Compiler-Gradle-Plug-in verwenden können.
JDK 23 oder niedriger. Dieses Tool ist aufgrund einer Abhängigkeit vom Java Security Manager, der in neueren JDK-Versionen entfernt wurde, nicht mit JDK 24 oder höher kompatibel.
Compose ist für Ihr Projekt aktiviert. Wir empfehlen, Compose mit dem Compose Compiler Gradle-Plug-in zu aktivieren.

Hinweis :Wenn Sie das Compose Compiler Gradle-Plugin nicht verwenden können, können Sie Compose aktivieren, indem Sie direkt eine Abhängigkeit vom Compose Compiler deklarieren. Verwenden Sie kotlinCompilerExtensionVersion Version 1.5.4 oder höher.

Einrichten

So aktivieren Sie das Tool:

Fügen Sie Ihrem Projekt das com.android.compose.screenshot-Plug-in in der Version 0.0.1-alpha10 hinzu.

Fügen Sie das Plug-in Ihrer Versionskatalogdatei hinzu:

[versions]
agp = "8.11.0-alpha06"
kotlin = "2.1.20"
screenshot = "0.0.1-alpha10"

[plugins]
screenshot = { id = "com.android.compose.screenshot", version.ref = "screenshot"}

Fügen Sie das Plug-in in der Datei build.gradle.kts auf Modulebene im Block plugins {} hinzu:
```
plugins {
    alias(libs.plugins.screenshot)
}
```

Aktivieren Sie die experimentelle Eigenschaft in der gradle.properties-Datei Ihres Projekts.
```
android.experimental.enableScreenshotTest=true
```
Aktivieren Sie im Block android {} der Datei build.gradle.kts auf Modulebene das experimentelle Flag, um die Quelle screenshotTest zu verwenden.
```
android {
    experimentalProperties["android.experimental.enableScreenshotTest"] = true
}
```

Fügen Sie die Abhängigkeiten screenshot-validation-api und ui-tooling hinzu.

Fügen Sie sie Ihren Versionskatalogen hinzu:

[libraries]
screenshot-validation-api = { group = "com.android.tools.screenshot", name = "screenshot-validation-api", version.ref = "screenshot"}
androidx-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling"}

Fügen Sie sie der Datei build.gradle.kts auf Modulebene hinzu:

dependencies {
  screenshotTestImplementation(libs.screenshot.validation.api)
  screenshotTestImplementation(libs.androidx.ui.tooling)
}

Composable-Vorschauen für Screenshot-Tests festlegen

Wenn Sie die Composables-Vorschauen angeben möchten, die für Screenshot-Tests verwendet werden sollen, markieren Sie die Vorschauen mit der Annotation @PreviewTest. Die Vorschaubilder müssen sich im neuen Quellsatz screenshotTest befinden, z. B. app/src/screenshotTest/kotlin/com/example/yourapp/ExamplePreviewScreenshotTest.kt.

Sie können dieser Datei oder anderen Dateien, die im selben Quellsatz erstellt wurden, weitere Composables und/oder Vorschauen hinzufügen, einschließlich Multi-Previews.

package com.example.yourapp

import androidx.compose.runtime.Composable
import androidx.compose.ui.tooling.preview.Preview
import com.android.tools.screenshot.PreviewTest
import com.example.yourapp.ui.theme.MyApplicationTheme

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

Referenzbilder generieren

Nachdem Sie eine Testklasse eingerichtet haben, müssen Sie für jede Vorschau Referenzbilder generieren. Diese Referenzbilder werden verwendet, um später Änderungen zu erkennen, nachdem Sie Codeänderungen vorgenommen haben. Führen Sie die folgende Gradle-Aufgabe aus, um Referenzbilder für die Screenshot-Tests für zusammensetzbare Vorschau zu generieren:

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

Nach Abschluss der Aufgabe finden Sie die Referenzbilder unter app/src/screenshotTestDebug/reference ({module}/src/screenshotTest{Variant}/reference).

Testbericht erstellen

Sobald die Referenzbilder vorhanden sind, führen Sie die Aufgabe „validate“ aus, um einen neuen Screenshot zu erstellen und ihn mit dem Referenzbild zu vergleichen:

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

Bei der Überprüfung wird ein HTML-Bericht unter {module}/build/reports/screenshotTest/preview/{variant}/index.html erstellt.

Bekannte Probleme

Die aktuelle Liste bekannter Probleme finden Sie in der Problemverfolgungskomponente des Tools. Anderes Feedback und Probleme können Sie über den Issue Tracker melden.

Versionsupdates

Versionshinweise und Änderungen für laufende Versionen.

0.0.1-alpha10

In dieser Version wird Folgendes eingeführt:

Ab dieser Version müssen Sie alle Ihre Preview-Funktionen mit der Annotation @PreviewTest kennzeichnen. Vorschaubilder ohne die Anmerkung werden nicht ausgeführt.
Das Verzeichnis für Referenzbilder wurde von {module}/src/{variant}/screenshotTest/reference in {module}/src/screenshotTest{Variant}/reference geändert. So wird sichergestellt, dass die generierten Referenzbilder nicht Teil des Produktionscodes sind, und die Verzeichnisstruktur anderer Testtypen wird eingehalten.
Die Aufgabe {variant}PreviewScreenshotRender wird entfernt. Das Bildrendering wird in die JUnit Test Engine migriert.
Bei der Aufgabe update{Variant}ScreenshotTest werden neue Rendering-Bilder mit Referenzbildern verglichen, bevor sie aktualisiert werden. Es werden nur Bilder aktualisiert, die Unterschiede aufweisen, die einen bestimmten Schwellenwert überschreiten. Der --updateFilter-Befehlszeilenparameter wurde entfernt.

0.0.1-alpha06