Android Gradle प्लगिन में टेस्ट सुइट

Android Gradle प्लगिन (एजीपी) की मदद से, टेस्ट को नाम वाले टेस्ट सुइट में व्यवस्थित किया जा सकता है. इसके लिए, आपको अपने मॉड्यूल के testOptions ब्लॉक में जाना होगा. हर सुइट अपने सोर्स सेट, डिपेंडेंसी, JUnit प्लैटफ़ॉर्म टेस्ट इंजन, और टारगेट बिल्ड वैरिएंट तय करता है.

टेस्ट सुइट का इस्तेमाल क्यों करना चाहिए

डिफ़ॉल्ट रूप से, Android मॉड्यूल में लोकल यूनिट टेस्ट के लिए एक test सोर्स सेट और इंस्ट्रुमेंटेड टेस्ट के लिए एक androidTest सोर्स सेट होता है. टेस्ट सुइट, टेस्ट ऑर्गनाइज़ेशन को उन दो सोर्स सेट से अलग करते हैं, ताकि ये काम किए जा सकें:

  • मकसद के हिसाब से टेस्ट अलग-अलग करें: यूनिट, Robolectric, यूज़र इंटरफ़ेस (यूआई), स्क्रीनशॉट, और बैकअप टेस्ट को src/test/ या src/androidTest/ डायरेक्ट्री में मिलाने के बजाय, उन्हें अलग-अलग src/{suiteName}/ डायरेक्ट्री में रखें.
  • डिपेंडेंसी और इंजन को अलग करना: हर सुइट के क्लासपाथ और JUnit प्लैटफ़ॉर्म टेस्ट इंजन को कॉन्फ़िगर करें. इसके लिए, अपने ऐप्लिकेशन या testImplementation और androidTestImplementation कॉन्फ़िगरेशन में डिपेंडेंसी जोड़ने की ज़रूरत नहीं है.
  • खास वैरिएंट और डिवाइसों को टारगेट करना: हर सुइट के लिए, बिल्ड के वैरिएंट और डिवाइस चुनें, ताकि तेज़ी से होने वाली जांचें स्थानीय तौर पर चलें और लंबे सुइट, लगातार इंटिग्रेशन में चलें.

सुइट के टाइप

एजीपी में, खास वर्कफ़्लो के लिए पहले से मौजूद टेस्ट सुइट और कस्टम सुइट के लिए AgpTestSuite इंटरफ़ेस शामिल है. यहां दी गई टेबल में, उपलब्ध सुइट टाइप की सूची दी गई है:

सुइट का टाइप डीएसएल कंटेनर मकसद
यूनिट टेस्ट सुइट testOptions.customSuites hostJar ब्लॉक की मदद से, लोकल जेवीएम पर JUnit 5, JUnit 4 या Robolectric टेस्ट चलाएं.
इंस्ट्रुमेंटेड टेस्ट सुइट testOptions.customSuites testApk ब्लॉक और android-test-engine टेस्ट इंजन की मदद से, कनेक्ट किए गए या बिल्ड-मैनेज्ड डिवाइसों पर डिवाइस टेस्ट चलाएं.
टेस्ट सुइट की मदद से, स्क्रीनशॉट की जांच करना testOptions.screenshotTests होस्ट पर @PreviewTest Compose की झलक रेंडर करें और उनकी तुलना करें.
ऑटोमेटेड बैकअप और रीस्टोर टेस्टिंग testOptions.backupTests लोकल, क्लाउड, और एक डिवाइस से दूसरे डिवाइस पर ट्रांसफ़र किए गए ऐप्लिकेशन डेटा की पुष्टि करें.
Android Studio के लिए Journeys testOptions.customSuites कनेक्ट किए गए डिवाइसों पर, एआई की मदद से एक्सएमएल फ़ॉर्मैट में उपयोगकर्ता अनुभव चलाएं.
कस्टम ऐसेट या मिक्स सुइट testOptions.customSuites कस्टम इंजन की मदद से, स्टैटिक टेस्ट की परिभाषाएं चलाएं या hostJar, testApk, और assets ब्लॉक को एक सुइट में जोड़ें.

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

कस्टम टेस्ट सुइट इस्तेमाल करने के लिए, पक्का करें कि आपका प्रोजेक्ट इन ज़रूरी शर्तों को पूरा करता हो:

  • Android Studio Rabbit 3 Canary 3 या इसके बाद का वर्शन
  • AGP 9.6.0-alpha03 या इसके बाद का वर्शन
  • Gradle 9.7.1 या इसके बाद का वर्शन और JDK 17 या इसके बाद का वर्शन
  • com.android.application या com.android.library मॉड्यूल

टेस्ट सुइट, com.android.kotlin.multiplatform.library या com.android.test मॉड्यूल में काम नहीं करते. वर्शन की झलक मैच करने के बारे में ज़्यादा जानने के लिए, Android Gradle प्लगिन की झलक के साथ काम करने की सुविधा लेख पढ़ें.

कस्टम टेस्ट सुइट सेट अप करना

सेटअप करने के सिलसिलेवार निर्देशों के लिए, यूनिट टेस्ट सुइट और इंस्ट्रुमेंटेड टेस्ट सुइट देखें. अपना कस्टम सुइट तय करने के लिए, सबसे पहले अपने प्रोजेक्ट की gradle.properties फ़ाइल में टेस्ट सुइट चालू करें:

android.experimental.testSuiteSupport=true

इसके बाद, अपने मॉड्यूल की build.gradle.kts फ़ाइल के testOptions.customSuites ब्लॉक में सुइट का एलान करें. targetVariants प्रॉपर्टी, एक या उससे ज़्यादा सोर्स ब्लॉक, useJunitEngine ब्लॉक, और targets ब्लॉक में कम से कम एक टारगेट तय करें:

import com.android.build.api.dsl.AgpTestSuiteInputParameters

android {
    testOptions {
        customSuites {
            create("mySuite") {
                // Exact variant names to test, such as "debug" or "demoDebug".
                targetVariants += listOf("debug")

                // Add one or more blocks: hostJar {}, testApk {}, or assets {}.
                assets {}

                useJunitEngine {
                    includeEngines += listOf("my-custom-engine")
                    enginesDependencies.add(
                        "com.example:my-custom-junit-engine:1.0.0"
                    )
                    enginesDependencies.add(
                        "org.junit.platform:junit-platform-launcher:1.10.2"
                    )

                    // Request build and SDK artifacts read by your engine.
                    inputs += listOf(
                        AgpTestSuiteInputParameters.STATIC_FILES,
                        // Omit TESTED_APKS in com.android.library modules.
                        AgpTestSuiteInputParameters.TESTED_APKS,
                        AgpTestSuiteInputParameters.ADB_EXECUTABLE,
                    )
                }

                targets {
                    create("default")
                }
            }
        }
    }
}

कस्टम TestEngine लागू करने के लिए, TestSuiteExecutionClient.default प्रॉपर्टी का इस्तेमाल करें. इससे AgpTestSuiteInputParameters enum वैल्यू और स्टैंडर्ड TestEngineInputProperty कॉन्सटैंट, जैसे कि SERIAL_IDS और RESULTS_DIR को पढ़ा जा सकता है.

सोर्स सेट डायरेक्ट्री

हर सुइट की डायरेक्ट्री का लेआउट इस बात पर निर्भर करता है कि वह एक सोर्स ब्लॉक का एलान करता है या कई सोर्स ब्लॉक को जोड़ता है. यहां दी गई टेबल में, {module}/src/{suiteName}/ डायरेक्ट्री के डिफ़ॉल्ट पाथ की सूची दी गई है:

सोर्स ब्लॉक सिंगल-सोर्स सुइट मिक्स्ड सुइट
hostJar kotlin/, java/, resources/ test/kotlin/, test/java/, test/resources/
testApk kotlin/, java/, res/, assets/, AndroidManifest.xml androidTest/kotlin/, androidTest/java/, androidTest/res/, androidTest/assets/, androidTest/AndroidManifest.xml
assets सुइट की रूट डायरेक्ट्री assetsTest/

पहले से मौजूद सोर्स सेट, फ़्लेवर, बिल्ड टाइप या वैरिएंट के नामों का इस्तेमाल, सुइट के नाम के तौर पर न करें. जैसे, main, androidTest या debug.

हर वैरिएंट के लिए कंट्रोल टारगेट

किसी खास वैरिएंट के लिए, सुइट टारगेट को चालू या बंद करने के लिए, beforeVariants ब्लॉक में HasTestSuitesBuilder.suites प्रॉपर्टी की मदद से, TestSuiteTargetBuilder इंटरफ़ेस को कॉन्फ़िगर करें:

androidComponents {
    beforeVariants { variantBuilder ->
        if (variantBuilder.buildType == "release") {
            variantBuilder.suites["mySuite"]
                ?.targets
                ?.get("default")
                ?.enable = false
        }
    }
}

सूट चलाना और रिपोर्ट की जांच करना

एजीपी, वैरिएंट, सुइट, और टारगेट के हर कॉम्बिनेशन के लिए एक Gradle टास्क बनाता है. यहां दी गई टेबल में, टास्क के पैटर्न की सूची दी गई है:

टास्क किस तरह का है नाम रखने का पैटर्न निर्देश का उदाहरण
स्टैंडर्ड सुइट टारगेट test{Variant}{SuiteName}{Target}TestSuite ./gradlew :app:testDebugMySuiteDefaultTestSuite
targetDevices प्रॉपर्टी के साथ टारगेट करें test{Variant}{SuiteName}{Target}{Devices}TestSuite ./gradlew :app:testDebugAndroidSuiteManagedCiPhonesTestSuite
बेसलाइन अपडेट (requiresUpdateTask = true) update{Variant}{SuiteName}{Target}TestSuite ./gradlew :app:updateDebugScreenshotTestDefaultTestSuite
मॉड्यूल रिपोर्ट एग्रीगेशन testAllSuites ./gradlew :app:testAllSuites
मॉड्यूल और डिपेंडेंसी एग्रीगेशन testAllSuitesWithDependencies ./gradlew :app:testAllSuitesWithDependencies

test, connectedCheck, और check टास्क, कस्टम सुइट तब तक नहीं चलाते, जब तक उन्हें withTestTaskProviders तरीके से वायर न किया जाए. testAllSuites और testAllSuitesWithDependencies टास्क चालू करने के लिए, अपनी gradle.properties फ़ाइल में android.experimental.reportAggregationSupport=true प्रॉपर्टी सेट करें.

हर सुइट रन, आउटपुट को इन जगहों पर सेव करता है:

  • एचटीएमएल टेस्ट रिपोर्ट: {module}/build/reports/tests/{taskName}/index.html
  • JUnit XML के नतीजे: {module}/build/test-results/{taskName}/
  • कोड कवरेज रिपोर्ट: {module}/build/reports/coverage/{suiteName}/index.html
  • एग्रीगेट की गई रिपोर्ट: {module}/build/reports/{aggregationTask}/test-report/index.html और coverage-report/index.html

कोड कवरेज रिपोर्ट जनरेट करने के लिए, सुइट पर codeCoverage प्रॉपर्टी को true पर सेट करें. Compose स्क्रीनशॉट सुइट के लिए, testOptions.customSuites.named("{suiteName}") { codeCoverage = true } का इस्तेमाल करके अपनी build.gradle.kts फ़ाइल में सुइट को कॉन्फ़िगर करें.

आम तौर पर होने वाली समस्याएं और सीमाएं

टेस्ट सुइट की ये सीमाएं हैं:

  • आईडीई इंटिग्रेशन: Android Studio में, कस्टम टेस्ट सुइट के लिए सहायता उपलब्ध नहीं है. कोड एडिटर, सुइट की सोर्स फ़ाइलों में ऐसी गड़बड़ियां दिखा सकता है जिन्हें ठीक नहीं किया गया है. ऐसा तब भी हो सकता है, जब आपका बिल्ड सही तरीके से कॉन्फ़िगर किया गया हो. इसके बजाय, Gradle का इस्तेमाल करके कमांड लाइन से टेस्ट सुइट बनाएं और चलाएं.
  • टास्क कैश मेमोरी में सेव करना: टेस्ट सुइट के टास्क, शुरू किए जाने पर हमेशा फिर से चलते हैं. साथ ही, Gradle बिल्ड कैश मेमोरी से लोड नहीं होते. जिन सुइट में कोई टेस्ट फ़ाइल नहीं होती उन्हें NO-SOURCE स्टेटस के साथ स्किप कर दिया जाता है.