Pacotes de testes de unidade

Os pacotes de testes de unidade executam testes locais da JVM em conjuntos de origem hostJar isolados fora do diretório src/test/ padrão do módulo. Configure-os com a DSL de pacotes de testes do Plug-in do Android para Gradle (AGP) para isolar testes do JUnit 5, JUnit 4 ou Robolectric por variante.

Requisitos

Para usar pacotes de testes de unidade, verifique se o projeto atende aos seguintes requisitos:

  • Android Studio Rabbit 3 Canary 3 ou mais recente
  • AGP 9.6.0-alpha03 ou mais recente
  • Gradle 9.7.1 ou mais recente e JDK 17 ou mais recente
  • Um módulo com.android.application ou com.android.library

Para mais informações sobre a correspondência de versões de pré-lançamento, consulte Compatibilidade com as prévias do Plug-in do Android para Gradle.

Configurar um pacote de testes de unidade

Para adicionar um pacote de testes de unidade a um módulo de app ou biblioteca, siga estas etapas:

Ativar pacotes de testes

No arquivo gradle.properties do projeto, ative o suporte ao pacote de testes:

android.experimental.testSuiteSupport=true

Configurar o pacote

No arquivo build.gradle.kts do módulo, crie um pacote dentro do bloco testOptions.customSuites com os blocos 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")
                }
            }
        }
    }
}

O pacote acessa as classes e dependências da variante de destino automaticamente, sem herdar dependências da configuração testImplementation.

Criar testes

Coloque os testes de unidade no diretório {module}/src/{suiteName}/kotlin/ ou java/ e os recursos de teste Java no diretório {module}/src/{suiteName}/resources/. Por exemplo, crie o arquivo 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)
    }
}

Incluir recursos do Android e o Robolectric

Para acessar recursos, recursos, manifestos e classes R mesclados do Android, como para testes do Robolectric, defina a propriedade enableAndroidResources da interface TestSuiteHostJarSpec como 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")
                }
            }
        }
    }
}

Personalizar tarefas e cobertura

Ative a cobertura do JaCoCo em um pacote com a propriedade codeCoverage. Para personalizar as opções do Gradle Test por destino, transmita uma lambda de configuração ao método AgpTestSuiteTarget.configureTestTasks, que fornece uma instância de TestTaskContext. Para anexar tarefas de verificação à tarefa check, use o 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 as configurações de tarefa Test em todos os destinos de um pacote, chame o método AgpTestSuite.configureTestTasks no pacote.

Executar testes e inspecionar relatórios

Execute o pacote na linha de comando com a tarefa test{Variant}{SuiteName}{Target}TestSuite gerada:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

Para executar uma única classe ou método de teste, transmita a opção --tests do Gradle:

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

Depois que uma execução de teste é concluída, o AGP gera relatórios nos seguintes caminhos:

  • Relatório de teste HTML: {module}/build/reports/tests/{taskName}/index.html
  • Resultados XML do JUnit: {module}/build/test-results/{taskName}/
  • Relatório de cobertura do JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html