Paquetes de pruebas de unidades

Los paquetes de pruebas de unidades ejecutan pruebas de JVM locales en conjuntos de orígenes hostJar aislados fuera del directorio src/test/ predeterminado de tu módulo. Configúralas con el DSL de paquetes de pruebas del complemento de Android para Gradle (AGP) para aislar las pruebas de JUnit 5, JUnit 4 o Robolectric por variante.

Requisitos

Para usar paquetes de pruebas de unidades, asegúrate de que tu proyecto cumpla con los siguientes requisitos:

  • Android Studio Rabbit 3 Canary 3 o una versión posterior
  • AGP 9.6.0-alpha03 o una versión posterior
  • Gradle 9.7.1 o una versión posterior, y JDK 17 o una versión posterior
  • Un módulo com.android.application o com.android.library

Para obtener más información sobre la coincidencia de versiones preliminares, consulta Compatibilidad con las versiones preliminares del complemento de Android para Gradle.

Configura un paquete de pruebas de unidades

Para agregar un paquete de pruebas de unidades a un módulo de app o biblioteca, completa los siguientes pasos:

Habilita los paquetes de pruebas

En el archivo gradle.properties de tu proyecto, habilita la compatibilidad con el paquete de pruebas:

android.experimental.testSuiteSupport=true

Configura el paquete

En el archivo build.gradle.kts de tu módulo, crea un paquete dentro del bloque testOptions.customSuites con los bloques hostJar y 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")
                }
            }
        }
    }
}

Tu paquete accede automáticamente a las clases y dependencias de la variante de destino sin heredar dependencias de la configuración de testImplementation.

Cómo crear pruebas

Coloca tus pruebas de unidades en el directorio {module}/src/{suiteName}/kotlin/ o java/, y los recursos de prueba de Java en el directorio {module}/src/{suiteName}/resources/. Por ejemplo, crea el archivo 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)
    }
}

Incluye recursos de Android y Robolectric

Para acceder a recursos, recursos, manifiestos y clases R combinados de Android, como para las pruebas de Robolectric, establece la propiedad enableAndroidResources de la interfaz TestSuiteHostJarSpec en 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")
                }
            }
        }
    }
}

Personaliza las tareas y la cobertura

Habilita la cobertura de JaCoCo en un paquete con la propiedad codeCoverage. Para personalizar las opciones de Test de Gradle por destino, pasa una lambda de configuración al método AgpTestSuiteTarget.configureTestTasks, que proporciona una instancia de TestTaskContext. Para adjuntar tareas de verificación a la tarea check, usa el método 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)
                        }
                    }
                }
            }
        }
    }
}

Para aplicar la configuración del modo Tarea de Test en todos los destinos de un paquete, llama al método AgpTestSuite.configureTestTasks en el paquete.

Ejecuta pruebas y, luego, inspecciona los informes

Ejecuta tu paquete desde la línea de comandos con la tarea test{Variant}{SuiteName}{Target}TestSuite generada:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

Para ejecutar una sola clase o método de prueba, pasa la opción --tests de Gradle:

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

Una vez que se completa una ejecución de prueba, el AGP genera informes en las siguientes rutas de acceso:

  • Informe de prueba HTML: {module}/build/reports/tests/{taskName}/index.html
  • Resultados XML de JUnit: {module}/build/test-results/{taskName}/
  • Informe de cobertura de JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html