Birim testi paketleri

Birim testi paketleri, modülünüzün varsayılan src/test/ dizini dışındaki izole hostJar kaynak gruplarında yerel JVM testleri çalıştırır. JUnit 5, JUnit 4 veya Robolectric testlerini varyantlara göre ayırmak için Android Gradle eklentisi (AGP) test paketleri DSL ile yapılandırın.

Şartlar

Birim testi paketlerini kullanmak için projenizin aşağıdaki koşulları karşıladığından emin olun:

  • Android Studio Rabbit 3 Canary 3 veya sonraki sürümler
  • AGP 9.6.0-alpha03 veya sonraki sürümler
  • Gradle 9.7.1 veya sonraki sürümler ve JDK 17 veya sonraki sürümler
  • com.android.application veya com.android.library modülü

Önizleme sürümü eşleştirme hakkında daha fazla bilgi için Android Gradle eklentisi önizlemeleriyle uyumluluk bölümüne bakın.

Birim testi paketi oluşturma

Bir uygulama veya kitaplık modülüne birim testi paketi eklemek için aşağıdaki adımları uygulayın:

Test paketlerini etkinleştirme

Projenizin gradle.properties dosyasında test paketi desteğini etkinleştirin:

android.experimental.testSuiteSupport=true

Paketi yapılandırma

Modülünüzün build.gradle.kts dosyasında, hostJar ve useJunitEngine bloklarıyla testOptions.customSuites bloğunun içinde bir paket oluşturun:

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")
                }
            }
        }
    }
}

Paketiniz, testImplementation yapılandırmasından bağımlılıkları devralmadan hedef varyantın sınıflarına ve bağımlılıklarına otomatik olarak erişir.

Test oluşturma

Birim testlerinizi {module}/src/{suiteName}/kotlin/ veya java/ dizinine, Java test kaynaklarını ise {module}/src/{suiteName}/resources/ dizinine yerleştirin. Örneğin, app/src/unitSuite/kotlin/com/example/myapp/CalculatorSuiteTest.kt dosyasını oluşturun:

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 kaynaklarını ve Robolectric'i dahil etme

Birleştirilmiş Android kaynaklarına, öğelerine, manifest dosyalarına ve R sınıflarına (ör. Robolectric testleri için) erişmek istiyorsanız TestSuiteHostJarSpec arayüzünün enableAndroidResources özelliğini true olarak ayarlayın:

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")
                }
            }
        }
    }
}

Görevleri ve kapsamı özelleştirme

codeCoverage özelliğiyle bir pakette JaCoCo kapsamını etkinleştirin. Gradle Test seçeneklerini her hedef için özelleştirmek istiyorsanız AgpTestSuiteTarget.configureTestTasks yöntemine bir yapılandırma lambda'sı iletin. Bu yöntem, TestTaskContext örneği sağlar. Doğrulama görevlerini check görevine eklemek için withTestTaskProviders yöntemini kullanın:

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 görev ayarlarını bir paketteki her hedefe uygulamak için pakette AgpTestSuite.configureTestTasks yöntemini çağırın.

Testleri çalıştırma ve raporları inceleme

Oluşturulan test{Variant}{SuiteName}{Target}TestSuite göreviyle paketinizi komut satırından çalıştırın:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

Tek bir test sınıfı veya yöntemi çalıştırmak için Gradle'ın --tests seçeneğini kullanın:

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

Test çalıştırması tamamlandıktan sonra AGP, aşağıdaki yollarda raporlar oluşturur:

  • HTML test raporu: {module}/build/reports/tests/{taskName}/index.html
  • JUnit XML sonuçları: {module}/build/test-results/{taskName}/
  • JaCoCo kapsam raporu: {module}/build/reports/coverage/{suiteName}/index.html