Unittest-Suites

Unit-Test-Suites führen lokale JVM-Tests in isolierten hostJar-Source-Sets außerhalb des Standardverzeichnisses src/test/ Ihres Moduls aus. Konfigurieren Sie sie mit der DSL für Test-Suites des Android-Gradle-Plug-ins (AGP), um JUnit 5-, JUnit 4- oder Robolectric-Tests pro Variante zu isolieren.

Voraussetzungen

Wenn Sie Unit-Test-Suites verwenden möchten, muss Ihr Projekt die folgenden Anforderungen erfüllen:

  • Android Studio Rabbit 3 Canary 3 oder höher
  • AGP 9.6.0-alpha03 oder höher
  • Gradle 9.7.1 oder höher und JDK 17 oder höher
  • Ein com.android.application- oder com.android.library-Modul

Weitere Informationen zum Abgleich von Vorabversionen finden Sie unter Kompatibilität mit Vorabversionen des Android-Gradle-Plug-ins.

Unittest-Suite einrichten

So fügen Sie einem App- oder Bibliotheksmodul eine Unit-Test-Suite hinzu:

Test-Suites aktivieren

Aktivieren Sie in der Datei gradle.properties Ihres Projekts die Unterstützung für die Test-Suite:

android.experimental.testSuiteSupport=true

Suite konfigurieren

Erstellen Sie in der build.gradle.kts-Datei Ihres Moduls eine Suite im testOptions.customSuites-Block mit den Blöcken hostJar und 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")
                }
            }
        }
    }
}

Ihre Suite greift automatisch auf die Klassen und Abhängigkeiten der Zielvariante zu, ohne Abhängigkeiten von der testImplementation-Konfiguration zu übernehmen.

Tests erstellen

Legen Sie Ihre Unittests im Verzeichnis {module}/src/{suiteName}/kotlin/ oder java/ und Java-Testressourcen im Verzeichnis {module}/src/{suiteName}/resources/ ab. Erstellen Sie beispielsweise die Datei 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-Ressourcen und Robolectric einbeziehen

Wenn Sie auf zusammengeführte Android-Ressourcen, Assets, Manifeste und R-Klassen zugreifen möchten, z. B. für Robolectric-Tests, setzen Sie das Attribut enableAndroidResources der Schnittstelle TestSuiteHostJarSpec auf 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")
                }
            }
        }
    }
}

Aufgaben und Abdeckung anpassen

Aktivieren Sie die JaCoCo-Abdeckung für eine Suite mit dem Attribut codeCoverage. Wenn Sie die Gradle-Test-Optionen pro Ziel anpassen möchten, übergeben Sie ein Konfigurations-Lambda an die Methode AgpTestSuiteTarget.configureTestTasks, die eine TestTaskContext-Instanz bereitstellt. Verwenden Sie die Methode withTestTaskProviders, um der Aufgabe check Schritte im Überprüfungsverfahren hinzuzufügen:

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

Wenn Sie die Task-Einstellungen für Test auf alle Ziele in einer Suite anwenden möchten, rufen Sie stattdessen die Methode AgpTestSuite.configureTestTasks für die Suite auf.

Tests ausführen und Berichte prüfen

Führen Sie die Suite über die Befehlszeile mit der generierten test{Variant}{SuiteName}{Target}TestSuite-Aufgabe aus:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

Wenn Sie eine einzelne Testklasse oder -methode ausführen möchten, übergeben Sie die --tests-Option von Gradle:

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

Nach Abschluss eines Testlaufs generiert das AGP Berichte unter den folgenden Pfaden:

  • HTML-Testbericht: {module}/build/reports/tests/{taskName}/index.html
  • JUnit-XML-Ergebnisse: {module}/build/test-results/{taskName}/
  • JaCoCo-Abdeckungsbericht: {module}/build/reports/coverage/{suiteName}/index.html