यूनिट टेस्ट सुइट

यूनिट टेस्ट सुइट, आपके मॉड्यूल की डिफ़ॉल्ट src/test/ डायरेक्ट्री के बाहर, अलग-अलग hostJar सोर्स सेट में लोकल जेवीएम टेस्ट चलाते हैं. Android Gradle प्लगिन (एजीपी) टेस्ट सुइट डीएसएल की मदद से उन्हें कॉन्फ़िगर करें, ताकि हर वैरिएंट के लिए JUnit 5, JUnit 4 या Robolectric टेस्ट को अलग किया जा सके.

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

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

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

वर्शन की झलक मैच करने के बारे में ज़्यादा जानने के लिए, Android Gradle प्लगिन की झलक के साथ काम करने की सुविधा लेख पढ़ें.

यूनिट टेस्ट सुइट सेट अप करना

किसी ऐप्लिकेशन या लाइब्रेरी मॉड्यूल में यूनिट टेस्ट सुइट जोड़ने के लिए, यह तरीका अपनाएं:

टेस्ट सुइट चालू करना

अपने प्रोजेक्ट की gradle.properties फ़ाइल में, टेस्ट सुइट की सुविधा चालू करें:

android.experimental.testSuiteSupport=true

सुइट को कॉन्फ़िगर करना

अपने मॉड्यूल की build.gradle.kts फ़ाइल में, hostJar और useJunitEngine ब्लॉक के साथ testOptions.customSuites ब्लॉक के अंदर एक सुइट बनाएं:

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

                hostJar {
                    dependencies {
                        // JUnit 5 API for @org.junit.jupiter.api.Test.
                        implementation(
                            "org.junit.jupiter:junit-jupiter-api:5.10.2"
                        )
                        // Optional: JUnit 4 API for @org.junit.Test.
                        implementation("junit:junit:4.13.2")
                    }
                }

                useJunitEngine {
                    // Add "junit-jupiter" (JUnit 5), "junit-vintage" (JUnit 4),
                    // or both.
                    includeEngines += listOf("junit-jupiter", "junit-vintage")
                    enginesDependencies.add(
                        "org.junit.jupiter:junit-jupiter-engine:5.10.2"
                    )
                    enginesDependencies.add(
                        "org.junit.vintage:junit-vintage-engine:5.10.2"
                    )
                    enginesDependencies.add(
                        "org.junit.platform:junit-platform-launcher:1.10.2"
                    )
                }

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

आपका सुइट, टारगेट वैरिएंट की क्लास और डिपेंडेंसी को अपने-आप ऐक्सेस करता है. इसके लिए, वह testImplementation कॉन्फ़िगरेशन से डिपेंडेंसी इनहेरिट नहीं करता.

टेस्ट बनाना

अपने यूनिट टेस्ट को {module}/src/{suiteName}/kotlin/ या java/ डायरेक्ट्री में और Java टेस्ट रिसॉर्स को {module}/src/{suiteName}/resources/ डायरेक्ट्री में रखें. उदाहरण के लिए, app/src/unitSuite/kotlin/com/example/myapp/CalculatorSuiteTest.kt फ़ाइल बनाएं:

package com.example.myapp

import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Test

class CalculatorSuiteTest {
    @Test
    fun addition_isCorrect() {
        assertEquals(4, 2 + 2)
    }
}

Android के संसाधन और Robolectric शामिल करना

मर्ज किए गए Android संसाधनों, ऐसेट, मेनिफ़ेस्ट, और R क्लास को ऐक्सेस करने के लिए, जैसे कि Robolectric टेस्ट के लिए, TestSuiteHostJarSpec इंटरफ़ेस की enableAndroidResources प्रॉपर्टी को true पर सेट करें:

android {
    testOptions {
        customSuites {
            create("roboSuite") {
                targetVariants += listOf("debug")

                hostJar {
                    enableAndroidResources = true
                    dependencies {
                        implementation("junit:junit:4.13.2")
                        implementation("org.robolectric:robolectric:4.14.1")
                        implementation("androidx.test:core-ktx:1.6.1")
                    }
                }

                useJunitEngine {
                    includeEngines += listOf("junit-vintage")
                    enginesDependencies.add(
                        "org.junit.vintage:junit-vintage-engine:5.10.2"
                    )
                    enginesDependencies.add(
                        "org.junit.platform:junit-platform-launcher:1.10.2"
                    )
                }

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

टास्क और कवरेज को पसंद के मुताबिक बनाना

codeCoverage प्रॉपर्टी की मदद से, किसी सुइट पर JaCoCo कवरेज चालू करें. हर टारगेट के लिए Gradle Test के विकल्पों को पसंद के मुताबिक बनाने के लिए, AgpTestSuiteTarget.configureTestTasks तरीके में कॉन्फ़िगरेशन लैम्ब्डा पास करें. इससे TestTaskContext इंस्टेंस मिलता है. check टास्क में पुष्टि की प्रोसेस टास्क अटैच करने के लिए, withTestTaskProviders तरीके का इस्तेमाल करें:

android {
    testOptions {
        customSuites {
            named("unitSuite") {
                // Generates JaCoCo HTML and XML coverage reports.
                codeCoverage = true

                targets.named("default") {
                    configureTestTasks { context ->
                        systemProperty("suite.variant", context.targetedVariant)
                        maxParallelForks = 2
                    }
                }

                withTestTaskProviders { context ->
                    if (!context.isUpdateTask) {
                        tasks.named("check") {
                            dependsOn(this@withTestTaskProviders)
                        }
                    }
                }
            }
        }
    }
}

किसी सुइट में मौजूद हर टारगेट पर Test टास्क मोड की सेटिंग लागू करने के लिए, सुइट पर AgpTestSuite.configureTestTasks तरीके को कॉल करें.

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

जनरेट किए गए test{Variant}{SuiteName}{Target}TestSuite टास्क की मदद से, कमांड लाइन से अपना सुइट चलाएं:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

किसी एक टेस्ट क्लास या तरीके को चलाने के लिए, Gradle का --tests विकल्प पास करें:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite \
    --tests "com.example.myapp.CalculatorSuiteTest.addition_isCorrect"

टेस्ट रन पूरा होने के बाद, एजीपी इन पाथ पर रिपोर्ट जनरेट करता है:

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