Наборы модульных тестов

Наборы модульных тестов запускают локальные тесты JVM в изолированных наборах исходных файлов hostJar за пределами каталога src/test/, который используется в модуле по умолчанию. Настройте их с помощью DSL наборов тестов плагина Android Gradle (AGP), чтобы изолировать тесты JUnit 5, JUnit 4 или Robolectric для каждого варианта.

Требования

Чтобы использовать наборы модульных тестов, убедитесь, что ваш проект соответствует следующим требованиям:

  • Android Studio Rabbit 3 Canary 3 или более поздней версии.
  • AGP 9.6.0-alpha03 или более поздней версии;
  • Gradle 9.7.1 или более поздней версии и JDK 17 или более поздней версии.
  • Модуль com.android.application или com.android.library

Подробнее о совместимости с предварительными версиями плагина Android Gradle…

Как настроить набор модульных тестов

Чтобы добавить набор модульных тестов в приложение или модуль библиотеки, выполните следующие действия:

Включить наборы тестов

В файле gradle.properties проекта включите поддержку набора тестов:

android.experimental.testSuiteSupport=true

Настройте набор

В файле build.gradle.kts модуля создайте набор в блоке testOptions.customSuites с блоками hostJar и 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")
                }
            }
        }
    }
}

Набор тестов автоматически получает доступ к классам и зависимостям целевого варианта, не наследуя зависимости из конфигурации testImplementation.

Создание тестов

Поместите модульные тесты в каталог {module}/src/{suiteName}/kotlin/ или java/, а тестовые ресурсы Java – в каталог {module}/src/{suiteName}/resources/. Например, создайте файл 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 и Robolectric

Чтобы получить доступ к объединенным ресурсам, объектам, манифестам и классам R Android, например для тестов Robolectric, задайте для свойства enableAndroidResources интерфейса TestSuiteHostJarSpec значение 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")
                }
            }
        }
    }
}

Настройка задач и охвата

Включите покрытие JaCoCo в наборе с помощью свойства codeCoverage. Чтобы настроить параметры Gradle Test для каждой цели, передайте лямбда-выражение конфигурации в метод AgpTestSuiteTarget.configureTestTasks, который предоставляет экземпляр TestTaskContext. Чтобы прикрепить задачи по проверке к задаче check, используйте метод 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)
                        }
                    }
                }
            }
        }
    }
}

Чтобы применить настройки задачи Test ко всем целевым объектам в наборе, вызовите метод AgpTestSuite.configureTestTasks.

Как проводить тесты и анализировать отчеты

Запустите набор тестов из командной строки с помощью сгенерированной задачи test{Variant}{SuiteName}{Target}TestSuite:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

Чтобы запустить один тестовый класс или метод, передайте параметр --tests Gradle:

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

После завершения тестового запуска AGP генерирует отчеты по следующим путям:

  • Отчет о тестировании HTML: {module}/build/reports/tests/{taskName}/index.html
  • Результаты JUnit XML: {module}/build/test-results/{taskName}/
  • Отчет о покрытии JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html