Bu sayfa, Cloud Translation API ile çevrilmiştir.

Önizleme Ekran Görüntüsü Testi Oluşturma

Ekran görüntüsü testi, kullanıcı arayüzünüzün kullanıcılara nasıl göründüğünü doğrulamanın etkili bir yoludur. Compose Preview Screenshot Testing aracı, composable önizlemelerin basitliğini ve özelliklerini, ana makine tarafında ekran görüntüsü testleri çalıştırmanın verimlilik avantajlarıyla birleştirir. Oluşturma Önizlemesi Ekran görüntüsü testi, oluşturulabilir önizlemeler kadar kolay kullanılacak şekilde tasarlanmıştır.

Ekran görüntüsü testi, bir kullanıcı arayüzünün ekran görüntüsünü alan ve ardından bunu daha önce onaylanmış bir referans resimle karşılaştıran otomatik bir testtir. Resimler eşleşmezse test başarısız olur ve farklılıkları karşılaştırıp bulmanıza yardımcı olacak bir HTML raporu oluşturulur.

Compose Preview Screenshot Testing aracıyla şunları yapabilirsiniz:

Mevcut veya yeni composable önizlemeler için ekran görüntüsü testleri oluşturmak üzere @PreviewTest simgesini kullanın.
Bu birleştirilebilir önizlemelerden referans resimler oluşturun.
Kod değişiklikleri yaptıktan sonra bu önizlemelerde yapılan değişiklikleri belirleyen bir HTML raporu oluşturun.
Testlerinizi ölçeklendirmenize yardımcı olması için @Preview veya fontScale gibi @Preview parametrelerini ve çoklu önizlemeleri kullanın.uiMode
Yeni screenshotTest kaynak grubuyla testlerinizi modüler hale getirin.

Şartlar

Yazma Önizlemesi Ekran Görüntüsü Testi'ni kullanmak için aşağıdakilere ihtiyacınız vardır:

Android Gradle eklentisi 8.5.0-beta01 veya sonraki sürümler.
Kotlin 1.9.20 veya sonraki sürümler. Compose Compiler Gradle eklentisini kullanabilmek için Kotlin 2.0 veya daha yeni bir sürümü kullanmanızı öneririz.
JDK 23 veya önceki sürümler. Bu araç, daha yeni JDK sürümlerinde kaldırılan Java Security Manager'a bağımlı olduğundan JDK 24 veya sonraki sürümlerle uyumlu değildir.
Projeniz için Oluşturma'nın etkinleştirilmesi gerekir. Compose Compiler Gradle eklentisini kullanarak Compose'u etkinleştirmenizi öneririz.

Not: Compose Compiler Gradle eklentisini kullanamıyorsanız doğrudan Compose Compiler'a bağımlılık bildirerek Compose'u etkinleştirebilirsiniz. kotlinCompilerExtensionVersion 1.5.4 veya sonraki bir sürümü kullandığınızdan emin olun.

Kurulum

Aracı etkinleştirmek için aşağıdaki adımları uygulayın:

Projenize com.android.compose.screenshot eklentisini, sürüm 0.0.1-alpha10 ekleyin.

Eklentiyi sürüm katalogları dosyanıza ekleyin:

[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"}

Modül düzeyindeki build.gradle.kts dosyanızda, eklentiyi plugins {} bloğuna ekleyin:
```
plugins {
    alias(libs.plugins.screenshot)
}
```

Projenizin gradle.properties dosyasında deneysel özelliği etkinleştirin.
```
android.experimental.enableScreenshotTest=true
```
Modül düzeyindeki android {} build.gradle.kts dosyanızın android {} bloğunda, screenshotTest kaynak kümesini kullanmak için deneysel işareti etkinleştirin.
```
android {
    experimentalProperties["android.experimental.enableScreenshotTest"] = true
}
```

screenshot-validation-api ve ui-tooling bağımlılıklarını ekleyin.

Bunları sürüm kataloglarınıza ekleyin:

[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"}

Bunları modül düzeyindeki build.gradle.kts dosyanıza ekleyin:

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

Ekran görüntüsü testlerinde kullanılacak birleştirilebilir önizlemeler belirleme

Ekran görüntüsü testlerinde kullanmak istediğiniz composable önizlemeleri belirtmek için önizlemeleri @PreviewTest ek açıklamasıyla işaretleyin. Önizlemeler, yeni screenshotTest kaynak kümesinde bulunmalıdır. Örneğin, app/src/screenshotTest/kotlin/com/example/yourapp/ExamplePreviewScreenshotTest.kt.

Bu dosyaya veya aynı kaynak grubunda oluşturulan diğer dosyalara çoklu önizlemeler de dahil olmak üzere daha fazla composable ve/veya önizleme ekleyebilirsiniz.

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!")
    }
}

Referans resimler oluşturma

Test sınıfı oluşturduktan sonra her önizleme için referans resimler oluşturmanız gerekir. Bu referans resimler, kod değişiklikleri yaptıktan sonra değişiklikleri belirlemek için kullanılır. Composable önizleme ekran görüntüsü testleriniz için referans resimler oluşturmak üzere aşağıdaki Gradle görevini çalıştırın:

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

Görev tamamlandıktan sonra referans resimleri app/src/screenshotTestDebug/reference({module}/src/screenshotTest{Variant}/reference) içinde bulabilirsiniz.

Test raporu oluşturma

Referans resimler oluşturulduktan sonra yeni bir ekran görüntüsü almak ve bunu referans resimle karşılaştırmak için doğrulama görevini çalıştırın:

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

Doğrulama görevi, {module}/build/reports/screenshotTest/preview/{variant}/index.html adresinde bir HTML raporu oluşturur.

Bilinen sorunlar

Bilinen sorunların güncel listesini aracın sorun izleyici bileşeninde bulabilirsiniz. Diğer geri bildirimleri ve sorunları sorun izleyici aracılığıyla bildirin.

Yayın güncellemeleri

Devam eden sürümlerle ilgili sürüm notları ve değişiklikler.

0.0.1-alpha10

Bu sürümde sunulanlar:

Bu sürümden itibaren, tüm önizleme işlevlerinizi @PreviewTest ek açıklamasıyla işaretlemeniz gerekir. Açıklama içermeyen önizlemeler yürütülmez.
Referans resim dizini {module}/src/{variant}/screenshotTest/reference olarak değiştirildi.{module}/src/screenshotTest{Variant}/reference Bunun nedeni, oluşturulan referans resimlerin üretim kodunun bir parçası olmamasını sağlamak ve diğer test türlerinin dizin yapısıyla uyumlu olmaktır.
{variant}PreviewScreenshotRender görevi kaldırılır. Görüntü oluşturma, JUnit Test Engine'e taşındı.
update{Variant}ScreenshotTest görevi, güncellemeden önce yeni oluşturma resimlerini referans resimlerle karşılaştırır. Yalnızca belirtilen eşiğin üzerinde farklılıklar içeren resimleri günceller. --updateFilter komut satırı işareti kaldırıldı.

0.0.1-alpha06

Bu sürümde sunulanlar:

Resim Farkı Eşiği: Bu yeni genel eşik ayarı, ekran görüntüsü karşılaştırmaları üzerinde daha hassas kontrol elde etmenizi sağlar. Yapılandırmak için modülünüzün build.gradle.kts dosyasını güncelleyin:

android {
    testOptions {
        screenshotTests {
            imageDifferenceThreshold = 0.0001f // 0.01%
        }
    }
}

Bu eşik, modülde tanımlanan tüm ekran görüntüsü testlerine uygulanır.

Hata düzeltmeleri: Bazı Compose Renderer hataları ve boş Compose desteği eklendi
Performans iyileştirmeleri: Resim karşılaştırma algoritması daha hızlı olacak şekilde güncellendi.