इंस्ट्रुमेंटेड टेस्ट सुइट, डिवाइस टेस्ट को आपके मॉड्यूल की डिफ़ॉल्ट src/androidTest/ डायरेक्ट्री के बाहर, अलग-अलग testApk APK में पैकेज करते हैं. Android Gradle प्लगिन (AGP) टेस्ट सुइट डीएसएल की मदद से उन्हें कॉन्फ़िगर करें, ताकि यूज़र इंटरफ़ेस (यूआई), इंटिग्रेशन या एंड-टू-एंड जांच को अलग-अलग किया जा सके. इसके लिए, खास डिपेंडेंसी, वैरिएंट, और डिवाइस टारगेट का इस्तेमाल करें.
ज़रूरी शर्तें
इंस्ट्रुमेंटेड टेस्ट सुइट इस्तेमाल करने के लिए, पक्का करें कि आपका प्रोजेक्ट इन ज़रूरी शर्तों को पूरा करता हो:
- Android Studio Rabbit 3 Canary 3 या इसके बाद का वर्शन
- AGP 9.6.0-alpha03 या इसके बाद का वर्शन
- Gradle 9.7.1 या इसके बाद का वर्शन और JDK 17 या इसके बाद का वर्शन
com.android.applicationयाcom.android.libraryमॉड्यूल- Android डीबग ब्रिज (adb) या बिल्ड-मैनेज्ड डिवाइस की परिभाषा के ज़रिए कनेक्ट किया गया डिवाइस या एम्युलेटर
वर्शन की झलक मैच करने के बारे में ज़्यादा जानने के लिए, Android Gradle प्लगिन की झलक के साथ काम करने की सुविधा लेख पढ़ें.
इंस्ट्रुमेंटेड टेस्ट सुइट सेट अप करना
किसी ऐप्लिकेशन या लाइब्रेरी मॉड्यूल में इंस्ट्रुमेंटेड टेस्ट सुइट जोड़ने के लिए, यह तरीका अपनाएं:
टेस्ट सुइट चालू करना
अपने प्रोजेक्ट की gradle.properties फ़ाइल में, टेस्ट सुइट की सुविधा चालू करें:
android.experimental.testSuiteSupport=true
सुइट को कॉन्फ़िगर करना
अपने मॉड्यूल की build.gradle.kts फ़ाइल में, testOptions.customSuites ब्लॉक के अंदर एक सुइट बनाएं. इसमें testApk और useJunitEngine ब्लॉक और AgpTestSuiteInputParameters enum वैल्यू शामिल करें:
import com.android.build.api.dsl.AgpTestSuiteInputParameters
android {
testOptions {
// Optional: define build-managed virtual devices and device groups.
managedDevices {
localDevices {
create("api34Atd") {
// Use a device profile from Android Studio.
device = "Pixel 6"
apiLevel = 34
systemImageSource = "aosp-atd"
}
}
groups {
create("ciPhones") {
targetDevices.add(allDevices.getByName("api34Atd"))
}
}
}
customSuites {
create("androidSuite") {
targetVariants += listOf("debug")
testApk {
dependencies {
implementation("junit:junit:4.13.2")
implementation("androidx.test.ext:junit:1.2.1")
implementation("androidx.test:runner:1.6.2")
}
}
useJunitEngine {
includeEngines += listOf("android-test-engine")
// Match the engine and listener versions to your AGP
// version.
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine:9.6.0-alpha03"
)
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine-result-listener:9.6.0-alpha03"
)
enginesDependencies.add(
"org.junit.platform:junit-platform-launcher:1.10.2"
)
inputs += listOf(
// Omit TESTED_APKS in com.android.library modules.
AgpTestSuiteInputParameters.TESTED_APKS,
AgpTestSuiteInputParameters.TEST_APKS,
AgpTestSuiteInputParameters.ADB_EXECUTABLE,
AgpTestSuiteInputParameters.AAPT2_EXECUTABLE,
)
}
targets {
// Runs on connected adb devices.
create("default")
// Optional: runs on build-managed devices or groups in
// targetDevices.
create("managed") {
targetDevices += listOf("ciPhones")
}
}
}
}
}
}
एजीपी, AndroidJUnitRunner टेस्ट रनर और पैकेज आईडी को अपने-आप कॉन्फ़िगर करता है. इसके लिए, वह androidTestImplementation कॉन्फ़िगरेशन से डिपेंडेंसी इनहेरिट नहीं करता. कस्टम रनर का इस्तेमाल करने के लिए, अपनी src/{suiteName}/AndroidManifest.xml फ़ाइल में instrumentation एलिमेंट पर android:name एट्रिब्यूट सेट करें.
टेस्ट बनाना
अपने इंस्ट्रुमेंटेड टेस्ट को {module}/src/{suiteName}/kotlin/ या java/ डायरेक्ट्री में रखें. साथ ही, कोई वैकल्पिक res/ या assets/ डायरेक्ट्री या AndroidManifest.xml फ़ाइल भी रखें. उदाहरण के लिए, app/src/androidSuite/kotlin/com/example/myapp/AppContextSuiteTest.kt फ़ाइल बनाएं:
package com.example.myapp
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.Assert.assertEquals
import org.junit.Test
import org.junit.runner.RunWith
@RunWith(AndroidJUnit4::class)
class AppContextSuiteTest {
@Test
fun useAppContext() {
val appContext =
InstrumentationRegistry.getInstrumentation().targetContext
assertEquals("com.example.myapp", appContext.packageName)
}
}
यूनिट और इंस्ट्रुमेंटेड टेस्ट को जोड़ना
एक ही Gradle टास्क में लोकल जेवीएम टेस्ट और इंस्ट्रुमेंटेड डिवाइस टेस्ट चलाने के लिए, एक ही सुइट में hostJar और testApk, दोनों ब्लॉक का एलान करें. होस्ट टेस्ट को src/{suiteName}/test/ डायरेक्ट्री में और डिवाइस टेस्ट को src/{suiteName}/androidTest/ डायरेक्ट्री में रखें:
import com.android.build.api.dsl.AgpTestSuiteInputParameters
android {
testOptions {
customSuites {
create("combinedSuite") {
targetVariants += listOf("debug")
hostJar {
dependencies {
implementation(
"org.junit.jupiter:junit-jupiter-api:5.10.2"
)
}
}
testApk {
dependencies {
implementation("junit:junit:4.13.2")
implementation("androidx.test.ext:junit:1.2.1")
implementation("androidx.test:runner:1.6.2")
}
}
useJunitEngine {
includeEngines += listOf(
"junit-jupiter",
"android-test-engine",
)
enginesDependencies.add(
"org.junit.jupiter:junit-jupiter-engine:5.10.2"
)
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine:9.6.0-alpha03"
)
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine-result-listener:9.6.0-alpha03"
)
enginesDependencies.add(
"org.junit.platform:junit-platform-launcher:1.10.2"
)
inputs += listOf(
// Omit TESTED_APKS in com.android.library modules.
AgpTestSuiteInputParameters.TESTED_APKS,
AgpTestSuiteInputParameters.TEST_APKS,
AgpTestSuiteInputParameters.ADB_EXECUTABLE,
AgpTestSuiteInputParameters.AAPT2_EXECUTABLE,
)
}
targets {
create("default")
}
}
}
}
}
टेस्ट चलाएं और कवरेज इकट्ठा करें
इंस्ट्रुमेंटेड सुइट चलाने, टेस्ट केस फ़िल्टर करने, और कवरेज रिपोर्ट जनरेट करने के लिए, Gradle का इस्तेमाल करें.
कनेक्ट किए गए या बिल्ड-मैनेज्ड डिवाइसों पर चलाएं
ऑनलाइन मौजूद हर adb डिवाइस पर, कनेक्ट किए गए टारगेट को चलाएं या targetDevices प्रॉपर्टी के साथ कॉन्फ़िगर किए गए टारगेट को चलाएं:
# Run on connected adb devices. ./gradlew :app:testDebugAndroidSuiteDefaultTestSuite# Run on the ciPhones build-managed device group. ./gradlew :app:testDebugAndroidSuiteManagedCiPhonesTestSuite
इंस्ट्रुमेंटेड टेस्ट फ़िल्टर करना
Gradle के --tests विकल्प या AndroidJUnitRunner आर्ग्युमेंट की मदद से, टेस्ट फ़िल्टर करें:
./gradlew :app:testDebugAndroidSuiteDefaultTestSuite \
--tests "com.example.myapp.AppContextSuiteTest.useAppContext"-Pandroid.testInstrumentationRunnerArguments.size=small जैसी प्रोजेक्ट प्रॉपर्टी के साथ, कमांड लाइन पर AndroidJUnitRunner आर्ग्युमेंट भी पास किए जा सकते हैं. useJunitEngine ब्लॉक में डिफ़ॉल्ट रनर आर्ग्युमेंट सेट करने के लिए, addInputProperty मेथड को कॉल करें, जैसे कि addInputProperty("android-test.instrumentation-args", "size=small").
डिवाइस पर कोड कवरेज इकट्ठा करना
उपयोगकर्ता के डिवाइस पर कोड कवरेज के लिए, डीबग करने लायक बिल्ड और Android 9 (एपीआई लेवल 28) या इसके बाद के वर्शन पर चलने वाले डिवाइस की ज़रूरत होती है. इंस्ट्रुमेंटेड या मिक्स किए गए सुइट के लिए कवरेज इकट्ठा करने के लिए, यह तरीका अपनाएं:
- अपनी
gradle.propertiesफ़ाइल मेंandroid.experimental.androidTest.coverage.useOnDeviceAgent=trueप्रॉपर्टी सेट करें. - सूट पर,
codeCoverageप्रॉपर्टी कोtrueपर सेट करें. - अगर एक से ज़्यादा डिवाइस कनेक्ट हैं, तो
ANDROID_SERIALएनवायरमेंट वैरिएबल की मदद से किसी एक डिवाइस को टारगेट करें.
एजेंट से जुड़ी ज़रूरी शर्तों के बारे में ज़्यादा जानने के लिए, कोड कवरेज की रिपोर्ट देखें (उपयोगकर्ता के डिवाइस पर मौजूद एजेंट के साथ) लेख पढ़ें.
रिपोर्ट की जांच करना
टेस्ट रन पूरा होने के बाद, एजीपी इन पाथ पर आउटपुट जनरेट करता है:
- एचटीएमएल टेस्ट रिपोर्ट:
{module}/build/reports/tests/{taskName}/index.html - JUnit XML के नतीजे:
{module}/build/test-results/{taskName}/ - हर डिवाइस के लिए एक्सएमएल और logcat:
{module}/build/intermediates/{variant}/{taskName}/results/ - कोड कवरेज रिपोर्ट:
{module}/build/reports/coverage/{suiteName}/index.html