Le suite di test delle unità eseguono test JVM locali in set di risorse hostJar isolati al di fuori della directory src/test/ predefinita del modulo. Configurale con il DSL delle suite di test del plug-in Android per Gradle (AGP) per isolare i test JUnit 5, JUnit 4 o Robolectric per variante.
Requisiti
Per utilizzare le suite di test delle unità, assicurati che il tuo progetto soddisfi i seguenti requisiti:
- Android Studio Rabbit 3 Canary 3 o versioni successive
- AGP 9.6.0-alpha03 o versioni successive
- Gradle 9.7.1 o versioni successive e JDK 17 o versioni successive
- Un modulo
com.android.applicationocom.android.library
Per saperne di più sulla corrispondenza delle versioni di anteprima, consulta Compatibilità con le anteprime del plug-in Android per Gradle.
Configura una suite di test delle unità
Per aggiungere una suite di test delle unità a un modulo di app o libreria, completa i seguenti passaggi:
Abilita le suite di test
Nel file gradle.properties del progetto, attiva il supporto della suite di test:
android.experimental.testSuiteSupport=true
Configura la suite
Nel file build.gradle.kts del modulo, crea una suite all'interno del blocco testOptions.customSuites con i blocchi hostJar e 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")
}
}
}
}
}
La suite accede automaticamente alle classi e alle dipendenze della variante di destinazione senza ereditare le dipendenze dalla configurazione testImplementation.
Crea test
Inserisci i test delle unità nella directory {module}/src/{suiteName}/kotlin/ o java/ e le risorse di test Java nella directory {module}/src/{suiteName}/resources/. Ad esempio, crea il file 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)
}
}
Includi risorse Android e Robolectric
Per accedere a risorse, asset, manifest e classi R Android uniti, ad esempio per i test Robolectric, imposta la proprietà enableAndroidResources dell'interfaccia TestSuiteHostJarSpec su 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")
}
}
}
}
}
Personalizza le attività e la copertura
Attiva la copertura JaCoCo su una suite con la proprietà codeCoverage. Per personalizzare le opzioni di Gradle Test per target, passa una lambda di configurazione al metodo AgpTestSuiteTarget.configureTestTasks, che fornisce un'istanza TestTaskContext. Per
collegare le attività di verifica all'attività check, utilizza il
metodo 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)
}
}
}
}
}
}
}
Per applicare le impostazioni delle attività Test a ogni target di una suite, chiama invece il metodo AgpTestSuite.configureTestTasks sulla suite.
Esegui i test e controlla i report
Esegui la suite dalla riga di comando con l'attività test{Variant}{SuiteName}{Target}TestSuite generata:
./gradlew :app:testDebugUnitSuiteDefaultTestSuitePer eseguire una singola classe o un singolo metodo di test, passa l'opzione --tests di Gradle:
./gradlew :app:testDebugUnitSuiteDefaultTestSuite \
--tests "com.example.myapp.CalculatorSuiteTest.addition_isCorrect"Al termine di un'esecuzione di test, AGP genera report nei seguenti percorsi:
- Report di test HTML:
{module}/build/reports/tests/{taskName}/index.html - Risultati XML JUnit:
{module}/build/test-results/{taskName}/ - Report sulla copertura JaCoCo:
{module}/build/reports/coverage/{suiteName}/index.html