חבילות מקרים לבדיקה עם אינסטרומנטציה אורזות בדיקות של מכשירים בחבילות APK מבודדות של testApk מחוץ לספריית ברירת המחדל src/androidTest/ של המודול. מגדירים אותם באמצעות DSL של חבילות מקרים לבדיקה של הפלאגין של 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) או הגדרה של מכשיר מנוהל-build
מידע נוסף על התאמה של גרסאות טרום-השקה (Preview) זמין במאמר תאימות לגרסאות טרום-השקה (Preview) של הפלאגין של Android Gradle.
הגדרה של חבילת מקרים לבדיקה עם אינסטרומנטציה
כדי להוסיף חבילת מקרים לבדיקה עם כלים למודול של אפליקציה או ספרייה:
הפעלת חבילות מקרים לבדיקה
בקובץ gradle.properties של הפרויקט, מפעילים תמיכה בחבילת מקרים לבדיקה:
android.experimental.testSuiteSupport=true
הגדרת החבילה
בקובץ build.gradle.kts של המודול, יוצרים חבילה בתוך הבלוק testOptions.customSuites עם הבלוקים testApk ו-useJunitEngine וערכי ה-enum AgpTestSuiteInputParameters:
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")
}
}
}
}
}
}
AGP מגדיר את מזהי החבילות ואת מריץ הבדיקות של AndroidJUnitRunner באופן אוטומטי, בלי לרשת יחסי תלות מההגדרות של androidTestImplementation. כדי להשתמש ב-runner בהתאמה אישית, מגדירים את המאפיין android:name ברכיב instrumentation בקובץ src/{suiteName}/AndroidManifest.xml.
יצירת בדיקות
ממקמים את בדיקות האינסטרומנטציה בספרייה {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)
}
}
שילוב של בדיקות יחידה ובדיקות אינסטרומנטציה
כדי להריץ בדיקות JVM מקומיות ובדיקות מכשירים עם כלים במשימת 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 כדי להריץ חבילות עם אינסטרומנטציה, לסנן מקרי בדיקה וליצור דוחות כיסוי.
הפעלה במכשירים מחוברים או במכשירים שמנוהלים על ידי גרסת build
מריצים יעד מחובר בכל מכשיר adb אונליין, או מריצים יעד שמוגדר עם המאפיין targetDevices:
# Run on connected adb devices. ./gradlew :app:testDebugAndroidSuiteDefaultTestSuite# Run on the ciPhones build-managed device group. ./gradlew :app:testDebugAndroidSuiteManagedCiPhonesTestSuite
סינון בדיקות אינסטרומנטציה
מסננים בדיקות באמצעות האפשרות --tests של Gradle או הארגומנטים של AndroidJUnitRunner:
./gradlew :app:testDebugAndroidSuiteDefaultTestSuite \
--tests "com.example.myapp.AppContextSuiteTest.useAppContext"אפשר גם להעביר ארגומנטים של AndroidJUnitRunner בשורת הפקודה עם מאפיין של פרויקט, כמו -Pandroid.testInstrumentationRunnerArguments.size=small. כדי להגדיר ארגומנטים של ברירת מחדל ל-runner בבלוק useJunitEngine, צריך להפעיל את ה-method addInputProperty, למשל addInputProperty("android-test.instrumentation-args", "size=small").
איסוף נתונים על רמת הכיסוי של הקוד במכשיר
כדי להשתמש ברמת הכיסוי של הקוד במכשיר, צריך גרסה שניתן לבצע בה ניפוי באגים ומכשיר עם Android 9 (רמת API 28) ומעלה. כדי לאסוף נתוני כיסוי של חבילת בדיקות עם אינסטרומנטציה או חבילה משולבת, מבצעים את השלבים הבאים:
- מגדירים את המאפיין
android.experimental.androidTest.coverage.useOnDeviceAgent=trueבקובץgradle.properties. - מגדירים את המאפיין
codeCoverageלערךtrueבחבילה. - אם מחוברים כמה מכשירים, צריך לבחור מכשיר אחד באמצעות משתנה הסביבה
ANDROID_SERIAL.
מידע נוסף על הדרישות של הסוכן זמין במאמר הצגת דוחות על רמת הכיסוי של הקוד (עם סוכן במכשיר).
בדיקת דוחות
אחרי שהרצת הבדיקה מסתיימת, AGP יוצר פלטים בנתיבים הבאים:
- דוח בדיקה ב-HTML:
{module}/build/reports/tests/{taskName}/index.html - תוצאות JUnit XML:
{module}/build/test-results/{taskName}/ - קובץ XML ו-logcat לכל מכשיר:
{module}/build/intermediates/{variant}/{taskName}/results/ - דוח רמת הכיסוי של הקוד:
{module}/build/reports/coverage/{suiteName}/index.html