حِزم اختبارات الوحدات

تُشغِّل حزم اختبارات الوحدات اختبارات JVM المحلية في مجموعات رموز المصدر hostJar المعزولة خارج دليل src/test/ التلقائي للوحدة. ويمكنك ضبطها باستخدام الحِزم الاختبارية في المكوّن الإضافي لنظام Gradle المتوافق مع Android ‏(AGP) من خلال لغة DSL لعزل اختبارات JUnit 5 أو JUnit 4 أو Robolectric لكل صيغة.

المتطلبات

لاستخدام حِزم اختبارات الوحدات، تأكَّد من أنّ مشروعك يستوفي المتطلبات التالية:

  • الإصدار Rabbit 3 Canary 3 من استوديو Android أو إصدار أحدث
  • الإصدار 9.6.0-alpha03 من "المكوّن الإضافي لنظام Gradle المتوافق مع Android" أو إصدار أحدث
  • الإصدار 9.7.1 من Gradle أو إصدار أحدث والإصدار 17 من JDK أو إصدار أحدث
  • وحدة com.android.application أو com.android.library

لمزيد من المعلومات حول مطابقة الإصدار المبكر الحصري، يُرجى الاطّلاع على التوافق مع الإصدارات المبكرة الحصرية للمكوّن الإضافي لنظام Gradle المتوافق مع Android.

إعداد حزمة اختبارية للوحدة

لإضافة حزمة اختبارات وحدة إلى تطبيق أو وحدة مكتبة، أكمِل الخطوات التالية:

تفعيل الحزم الاختبارية

في ملف 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

للوصول إلى موارد Android ومواد العرض والبيانات وفئات R المدمجة، مثل اختبارات 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 لكل هدف، مرِّر دالة lambda للإعداد إلى طريقة 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

لتشغيل فئة أو طريقة اختبار واحدة، يمكنك تمرير خيار --tests في Gradle:

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

بعد اكتمال عملية التشغيل التجريبي، ينشئ مكوّن Android Gradle الإضافي تقارير في المسارات التالية:

  • تقرير اختبار HTML: {module}/build/reports/tests/{taskName}/index.html
  • نتائج JUnit XML: {module}/build/test-results/{taskName}/
  • تقرير تغطية JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html