Zestawy testów jednostkowych

Zestawy testów jednostkowych uruchamiają lokalne testy JVM w odizolowanych zbiorach źródeł hostJar poza domyślnym katalogiem src/test/ modułu. Skonfiguruj je za pomocą zestawów testów wtyczki Androida do obsługi Gradle (AGP) DSL, aby odizolować testy JUnit 5, JUnit 4 lub Robolectric według wariantu.

Wymagania

Aby korzystać z zestawów testów jednostkowych, upewnij się, że Twój projekt spełnia te wymagania:

  • Android Studio Rabbit 3 Canary 3 lub nowszy,
  • AGP w wersji 9.6.0-alpha03 lub nowszej,
  • Gradle 9.7.1 lub nowszy i JDK 17 lub nowszy
  • moduł com.android.application lub com.android.library,

Więcej informacji o dopasowywaniu wersji testowych znajdziesz w artykule o zgodności z wersjami testowymi wtyczki Androida do obsługi Gradle.

Konfigurowanie zestawu testów jednostkowych

Aby dodać zestaw testów jednostkowych do modułu aplikacji lub biblioteki, wykonaj te czynności:

Włączanie zestawów testów

W pliku gradle.properties projektu włącz obsługę zestawu testów:

android.experimental.testSuiteSupport=true

Konfigurowanie pakietu

W pliku build.gradle.kts modułu utwórz pakiet w bloku testOptions.customSuites z blokami hostJar i 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")
                }
            }
        }
    }
}

Pakiet automatycznie uzyskuje dostęp do klas i zależności wariantu docelowego bez dziedziczenia zależności z konfiguracji testImplementation.

Tworzenie testów

Umieść testy jednostkowe w katalogu {module}/src/{suiteName}/kotlin/ lub java/, a zasoby testowe Javy w katalogu {module}/src/{suiteName}/resources/. Na przykład utwórz plik 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)
    }
}

Uwzględnianie zasobów Androida i Robolectric

Aby uzyskać dostęp do scalonych zasobów, zasobów, plików manifestu i klas R Androida, np. na potrzeby testów Robolectric, ustaw właściwość enableAndroidResources interfejsu TestSuiteHostJarSpec na 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")
                }
            }
        }
    }
}

Dostosowywanie zadań i zakresu

Włącz pokrycie JaCoCo w pakiecie za pomocą właściwości codeCoverage. Aby dostosować opcje Gradle Test dla poszczególnych środowisk docelowych, przekaż lambdę konfiguracji do metody AgpTestSuiteTarget.configureTestTasks, która udostępnia instancję TestTaskContext. Aby dołączyć zadania związane z weryfikacją do zadania check, użyj metody 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)
                        }
                    }
                }
            }
        }
    }
}

Aby zastosować ustawienia trybu zadań Test do wszystkich celów w pakiecie, wywołaj metodę AgpTestSuite.configureTestTasks w pakiecie.

Przeprowadzanie testów i sprawdzanie raportów

Uruchom pakiet z wiersza poleceń za pomocą wygenerowanego zadania test{Variant}{SuiteName}{Target}TestSuite:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

Aby uruchomić pojedynczą klasę lub metodę testową, przekaż opcję --tests Gradle:

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

Po zakończeniu uruchomienia testowego AGP generuje raporty w tych ścieżkach:

  • Raport z testu w formacie HTML: {module}/build/reports/tests/{taskName}/index.html
  • Wyniki JUnit XML: {module}/build/test-results/{taskName}/
  • Raport pokrycia JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html