חבילות של בדיקות יחידה

חבילות של בדיקות יחידה מריצות בדיקות JVM מקומיות בקבוצות מקורות מבודדות של hostJar מחוץ לספריית ברירת המחדל src/test/ של המודול. מגדירים אותם באמצעות DSL של חבילות מקרים לבדיקה של הפלאגין של Android Gradle ‏(AGP) כדי לבודד בדיקות של 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

מידע נוסף על התאמה של גרסאות טרום-השקה (Preview) זמין במאמר תאימות לגרסאות טרום-השקה (Preview) של הפלאגין של Android Gradle.

הגדרת חבילת מקרים לבדיקת יחידה

כדי להוסיף חבילת מקרים לבדיקת יחידה למודול של אפליקציה או ספרייה:

הפעלת חבילות מקרים לבדיקה

בקובץ gradle.properties של הפרויקט, מפעילים תמיכה בחבילת מקרים לבדיקה:

android.experimental.testSuiteSupport=true

הגדרת החבילה

בקובץ build.gradle.kts של המודול, יוצרים חבילה בתוך הבלוק testOptions.customSuites עם הבלוקים hostJar ו-useJunitEngine:

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

כדי לגשת למשאבים, לנכסים, למניפסטים ולמחלקות R ממוזגים של Android, למשל לבדיקות Robolectric, מגדירים את המאפיין enableAndroidResources של הממשק TestSuiteHostJarSpec לערך 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")
                }
            }
        }
    }
}

התאמה אישית של משימות וכיסוי

מפעילים את הכיסוי של JaCoCo בחבילה באמצעות המאפיין codeCoverage. כדי להתאים אישית את האפשרויות של 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 על כל היעדים בחבילה, צריך להפעיל את ה-method‏ AgpTestSuite.configureTestTasks על החבילה.

הרצת בדיקות ועיון בדוחות

מריצים את חבילת הבדיקות משורת הפקודה באמצעות המשימה test{Variant}{SuiteName}{Target}TestSuite שנוצרה:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

כדי להריץ מחלקה או שיטה אחת של בדיקה, מעבירים את האפשרות --tests של Gradle:

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

אחרי שהרצת הבדיקה מסתיימת, AGP יוצר דוחות בנתיבים הבאים:

  • דוח בדיקה ב-HTML: {module}/build/reports/tests/{taskName}/index.html
  • תוצאות JUnit XML‏: {module}/build/test-results/{taskName}/
  • ‫דוח הכיסוי של JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html