इस पेज का अनुवाद Cloud Translation API से किया गया है.

झलक दिखाने वाले स्क्रीनशॉट की टेस्टिंग कंपोज़ करें
संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.

स्क्रीनशॉट टेस्टिंग, यह पुष्टि करने का एक असरदार तरीका है कि उपयोगकर्ताओं को आपका यूज़र इंटरफ़ेस कैसा दिखता है. Compose Preview Screenshot Testing टूल, कंपोज़ की जा सकने वाली झलक की आसानी और सुविधाओं को, होस्ट-साइड स्क्रीनशॉट टेस्ट चलाने से होने वाली परफ़ॉर्मेंस में बढ़ोतरी के साथ जोड़ता है. झलक कंपोज़ करें स्क्रीनशॉट टेस्टिंग को, कंपोज़ किए जा सकने वाले झलक की तरह ही आसान बनाया गया है.

स्क्रीनशॉट टेस्ट एक ऑटोमेटेड टेस्ट है. यह यूज़र इंटरफ़ेस (यूआई) के किसी हिस्से का स्क्रीनशॉट लेता है और फिर उसकी तुलना, पहले से मंज़ूरी पा चुकी रेफ़रंस इमेज से करता है. अगर इमेज मेल नहीं खाती हैं, तो जांच पूरी नहीं होती और एचटीएमएल रिपोर्ट जनरेट होती है. इससे आपको तुलना करने और अंतरों का पता लगाने में मदद मिलती है.

'कॉम्पोज़ की झलक' स्क्रीनशॉट टेस्टिंग टूल की मदद से, ये काम किए जा सकते हैं:

मौजूदा या नए कॉम्पोज़ेबल स्क्रीनशॉट के लिए, स्क्रीनशॉट टेस्ट बनाने के लिए @PreviewTest का इस्तेमाल करें.
उन कॉम्पोज़ेबल झलक से रेफ़रंस इमेज जनरेट करें.
एचटीएमएल रिपोर्ट जनरेट करें, जो कोड में बदलाव करने के बाद, उन झलकों में हुए बदलावों की पहचान करती है.
अपने टेस्ट को बड़े पैमाने पर चलाने के लिए, @Preview पैरामीटर, जैसे कि uiMode या fontScale का इस्तेमाल करें. साथ ही, एक से ज़्यादा झलक देखें.
नए screenshotTest सोर्स सेट की मदद से, अपने टेस्ट को मॉड्यूलर बनाएं.

**पहली इमेज.** एचटीएमएल रिपोर्ट का उदाहरण.

ज़रूरी शर्तें

कॉम्पोज़ की झलक के स्क्रीनशॉट की जांच करने की सुविधा का इस्तेमाल करने के लिए, आपके पास ये चीज़ें होनी चाहिए:

Android Gradle प्लग इन 8.5.0-beta01 या इसके बाद का वर्शन.
Kotlin 1.9.20 या इसके बाद का वर्शन. हमारा सुझाव है कि Kotlin 2.0 या इसके बाद के वर्शन का इस्तेमाल करें, ताकि आप Compose Compiler Gradle प्लग इन का इस्तेमाल कर सकें.
आपके प्रोजेक्ट के लिए, कॉम्पोज़ करने की सुविधा चालू हो. हमारा सुझाव है कि Compose Compiler Gradle प्लग इन का इस्तेमाल करके, Compose को चालू करें.

ध्यान दें: अगर Compose Compiler Gradle प्लग इन का इस्तेमाल नहीं किया जा सकता, तो Compose Compiler पर सीधे तौर पर डिपेंडेंसी का एलान करके Compose को चालू किया जा सकता है. पक्का करें कि आपने kotlinCompilerExtensionVersion 1.5.4 या इसके बाद का वर्शन इस्तेमाल किया हो.

सेटअप

टूल को चालू करने के लिए, यह तरीका अपनाएं:

अपने प्रोजेक्ट में com.android.compose.screenshot प्लग इन, वर्शन 0.0.1-alpha10 जोड़ें.

प्लग इन को अपने वर्शन कैटलॉग फ़ाइल में जोड़ें:

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

मॉड्यूल-लेवल की build.gradle.kts फ़ाइल में, प्लग इन को plugins {} ब्लॉक में जोड़ें:
```
plugins {
    alias(libs.plugins.screenshot)
}
```

अपने प्रोजेक्ट की gradle.properties फ़ाइल में, एक्सपेरिमेंटल प्रॉपर्टी चालू करें.
```
android.experimental.enableScreenshotTest=true
```
अपने मॉड्यूल-लेवल की build.gradle.kts फ़ाइल के android {} ब्लॉक में, screenshotTest सोर्स सेट का इस्तेमाल करने के लिए, एक्सपेरिमेंट के तौर पर उपलब्ध फ़्लैग को चालू करें.
```
android {
    experimentalProperties["android.experimental.enableScreenshotTest"] = true
}
```

screenshot-validation-api और ui-tooling डिपेंडेंसी जोड़ें.

उन्हें अपने वर्शन कैटलॉग में जोड़ें:

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

उन्हें अपने मॉड्यूल-लेवल की build.gradle.kts फ़ाइल में जोड़ें:

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

स्क्रीनशॉट टेस्ट के लिए इस्तेमाल करने के लिए, कॉम्पोज़ेबल झलक तय करना

जिन कॉम्पोज़ेबल झलकों का इस्तेमाल आपको स्क्रीनशॉट टेस्ट के लिए करना है उन्हें चुनने के लिए, @PreviewTest एनोटेशन के साथ झलकों को मार्क करें. झलकें, नए screenshotTest सोर्स सेट में होनी चाहिए. उदाहरण के लिए, app/src/screenshotTest/kotlin/com/example/yourapp/ExamplePreviewScreenshotTest.kt.

इस फ़ाइल या एक ही सोर्स सेट में बनाई गई अन्य फ़ाइलों में, ज़्यादा कॉम्पोज़ेबल और/या झलकें जोड़ी जा सकती हैं. इनमें एक से ज़्यादा झलकें भी शामिल हैं.

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

रेफ़रंस इमेज जनरेट करना

टेस्ट क्लास सेट अप करने के बाद, आपको हर झलक के लिए रेफ़रंस इमेज जनरेट करनी होंगी. कोड में बदलाव करने के बाद, इन रेफ़रंस इमेज का इस्तेमाल करके, बदलावों की पहचान की जाती है. अपने कॉम्पोज़ेबल के झलक वाले स्क्रीनशॉट के टेस्ट के लिए रेफ़रंस इमेज जनरेट करने के लिए, यह Gradle टास्क चलाएं:

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

टास्क पूरा होने के बाद, रेफ़रंस इमेज app/src/screenshotTestDebug/reference ({module}/src/screenshotTest{Variant}/reference) में देखें.

टेस्ट रिपोर्ट जनरेट करना

रेफ़रंस इमेज मौजूद होने के बाद, नया स्क्रीनशॉट लेने और उसकी तुलना रेफ़रंस इमेज से करने के लिए, 'पुष्टि करें' टास्क चलाएं:

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

पुष्टि करने वाला टास्क, {module}/build/reports/screenshotTest/preview/{variant}/index.html पर एक एचटीएमएल रिपोर्ट बनाता है.

पहले से मालूम समस्याएं

टूल के समस्या ट्रैकर कॉम्पोनेंट में, आपको उन समस्याओं की मौजूदा सूची दिखेगी जिनके बारे में पहले से पता है. समस्या ट्रैकर की मदद से, सुझाव/राय, शिकायत या किसी और समस्या की शिकायत करें.

रिलीज़ से जुड़े अपडेट

मौजूदा वर्शन के लिए रिलीज़ नोट और बदलाव.

0.0.1-alpha10

इस रिलीज़ में ये सुविधाएं शामिल हैं:

इस वर्शन में, आपको झलक दिखाने वाले सभी फ़ंक्शन को @PreviewTest एनोटेशन से मार्क करना होगा. एनोटेशन के बिना झलकें नहीं दिखाई जाएंगी.
रेफ़रंस इमेज डायरेक्ट्री को {module}/src/{variant}/screenshotTest/reference से बदलकर {module}/src/screenshotTest{Variant}/reference कर दिया गया है. इससे यह पक्का किया जा सकता है कि जनरेट की गई रेफ़रंस इमेज, प्रोडक्शन कोड का हिस्सा नहीं होंगी. साथ ही, इन्हें दूसरे तरह के टेस्ट के डायरेक्ट्री स्ट्रक्चर के साथ अलाइन किया जा सकता है.
{variant}PreviewScreenshotRender टास्क हटा दिया गया है. इमेज रेंडरिंग को JUnit टेस्ट इंजन में माइग्रेट कर दिया गया है.
update{Variant}ScreenshotTest टास्क, अपडेट करने से पहले रेंडरिंग की नई इमेज की तुलना, रेफ़रंस इमेज से करेगा. यह सिर्फ़ उन इमेज को अपडेट करेगा जिनमें तय थ्रेशोल्ड से ज़्यादा अंतर है. --updateFilter कमांडलाइन वाला फ़्लैग हटा दिया गया.

0.0.1-alpha06

इस रिलीज़ में ये सुविधाएं शामिल हैं:

इमेज में अंतर का थ्रेशोल्ड: इस नई ग्लोबल थ्रेशोल्ड सेटिंग की मदद से, स्क्रीनशॉट की तुलना पर बेहतर तरीके से कंट्रोल किया जा सकता है. कॉन्फ़िगर करने के लिए, अपने मॉड्यूल के build.gradle.kts को अपडेट करें:

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

यह थ्रेशोल्ड, मॉड्यूल में तय किए गए सभी स्क्रीनशॉट टेस्ट पर लागू होगा.

गड़बड़ियां ठीक की गईं: Compose रेंडरर की कुछ गड़बड़ियां ठीक की गईं. साथ ही, खाली Compose के लिए सहायता जोड़ी गई
परफ़ॉर्मेंस को बेहतर बनाया गया: इमेज के अंतर का पता लगाने वाले एल्गोरिदम को तेज़ करने के लिए अपडेट किया गया