مجموعه‌های آزمون واحد

مجموعه‌های آزمون واحد، آزمون‌های JVM محلی را در مجموعه‌های منبع hostJar مجزا خارج از دایرکتوری پیش‌فرض src/test/ پیمانه شما اجرا می‌کنند. آن‌ها را با DSL مجموعه آزمون افزایه Android Gradle (AGP) پیکربندی کنید تا آزمایش‌های JUnit 5،‏ JUnit 4، یا Robolectric را برای هر متغیر جدا کنید.

الزامات

برای استفاده از مجموعه آزمون‌های واحد، مطمئن شوید که پروژه‌تان الزامات زیر را برآورده می‌کند:

  • استودیو Android نسخه Rabbit 3 Canary 3 یا بالاتر
  • AGP نسخه 9.6.0-alpha03 یا بالاتر
  • ‫Gradle نسخه ۹.۷.۱ یا بالاتر و JDK نسخه ۱۷ یا بالاتر
  • واحد com.android.application یا com.android.library

برای اطلاعات بیشتر درباره مطابقت نسخه پیش‌نمایش، به سازگاری با پیش‌نمایش‌های افزایه 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 برای هر هدف، یک پیکربندی 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"

پس‌از تکمیل اجرای آزمایشی، AGP گزارش‌هایی را در مسیرهای زیر تولید می‌کند:

  • گزارش آزمایش HTML: {module}/build/reports/tests/{taskName}/index.html
  • نتایج JUnit XML: {module}/build/test-results/{taskName}/
  • گزارش پوشش JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html