Плагин Android Gradle (AGP) позволяет объединять тесты в именованные наборы тестов в блоке testOptions модуля. В каждом наборе определяются собственные наборы исходных файлов, зависимости, тестовые движки JUnit Platform и целевые варианты сборки.
Зачем использовать наборы тестов
По умолчанию модуль Android предоставляет один набор исходных файлов test для локальных модульных тестов и один набор исходных файлов androidTest для инструментальных тестов. Наборы тестов позволяют отделить организацию тестов от этих двух наборов исходных файлов, чтобы вы могли:
- Разделяйте тесты по назначению. Храните модульные тесты, тесты Robolectric, тесты интерфейса, скриншотов и резервного копирования в отдельных каталогах
src/{suiteName}/, а не смешивайте их в каталогахsrc/test/илиsrc/androidTest/. - Изолируйте зависимости и движки. Настройте путь к классам и движок JUnit Platform для каждого набора, не добавляя зависимости в приложение или конфигурации
testImplementationиandroidTestImplementation. - Таргетинг на определенные варианты и устройства. Выберите варианты сборки и устройства для каждого набора, чтобы быстрые проверки выполнялись локально, а более длительные – в непрерывной интеграции.
Типы люксов
В AGP есть встроенные наборы тестов для специализированных рабочих процессов и интерфейс AgpTestSuite для пользовательских наборов. В таблице ниже перечислены доступные типы пакетов.
| Тип пакета | Контейнер DSL | Назначение |
|---|---|---|
| Наборы модульных тестов | testOptions.customSuites |
Запускайте тесты JUnit 5, JUnit 4 или Robolectric на локальной JVM с помощью блока hostJar. |
| Наборы инструментированных тестов | testOptions.customSuites |
Запускайте тесты на подключенных устройствах или устройствах, управляемых сборкой, с помощью блока testApk и тестового движка android-test-engine. |
| Тестирование скриншотов с помощью наборов тестов | testOptions.screenshotTests |
Отрисовывайте и сравнивайте @PreviewTest предварительных версий Compose на хосте. |
| Автоматическое тестирование резервного копирования и восстановления | testOptions.backupTests |
Проверьте данные приложения, переданные локально, через облако и напрямую с устройства на устройство. |
| Journeys для Android Studio | testOptions.customSuites |
Запускайте на подключенных устройствах пути пользователей XML на основе ИИ. |
| Специальные объекты или смешанные наборы | testOptions.customSuites |
Запускайте статические определения тестов с помощью пользовательского движка или объединяйте блоки hostJar, testApk и assets в один набор. |
Требования
Чтобы использовать собственные наборы тестов, убедитесь, что ваш проект соответствует следующим требованиям:
- Android Studio Rabbit 3 Canary 3 или более поздней версии.
- AGP 9.6.0-alpha03 или более поздней версии;
- Gradle 9.7.1 или более поздней версии и JDK 17 или более поздней версии.
- Модуль
com.android.applicationилиcom.android.library
Наборы тестов не поддерживаются в модулях com.android.kotlin.multiplatform.library и com.android.test. Подробнее о совместимости с предварительными версиями плагина Android Gradle…
Как настроить собственный набор тестов
Пошаговые инструкции по настройке можно найти в статьях Наборы модульных тестов и Наборы инструментальных тестов. Чтобы определить собственный набор тестов, сначала включите наборы тестов в файле gradle.properties проекта:
android.experimental.testSuiteSupport=true
Затем объявите набор в блоке testOptions.customSuites файла build.gradle.kts модуля. Укажите свойство targetVariants, один или несколько исходных блоков, блок useJunitEngine и хотя бы одну цель в блоке targets:
import com.android.build.api.dsl.AgpTestSuiteInputParameters
android {
testOptions {
customSuites {
create("mySuite") {
// Exact variant names to test, such as "debug" or "demoDebug".
targetVariants += listOf("debug")
// Add one or more blocks: hostJar {}, testApk {}, or assets {}.
assets {}
useJunitEngine {
includeEngines += listOf("my-custom-engine")
enginesDependencies.add(
"com.example:my-custom-junit-engine:1.0.0"
)
enginesDependencies.add(
"org.junit.platform:junit-platform-launcher:1.10.2"
)
// Request build and SDK artifacts read by your engine.
inputs += listOf(
AgpTestSuiteInputParameters.STATIC_FILES,
// Omit TESTED_APKS in com.android.library modules.
AgpTestSuiteInputParameters.TESTED_APKS,
AgpTestSuiteInputParameters.ADB_EXECUTABLE,
)
}
targets {
create("default")
}
}
}
}
}
В пользовательской реализации TestEngine используйте свойство TestSuiteExecutionClient.default, чтобы считывать значения перечисления AgpTestSuiteInputParameters и стандартные константы TestEngineInputProperty, такие как SERIAL_IDS и RESULTS_DIR.
Каталоги наборов исходных файлов
Структура каталога каждого набора зависит от того, объявляет ли он один блок исходного кода или объединяет несколько блоков исходного кода. В таблице ниже перечислены пути по умолчанию в каталоге {module}/src/{suiteName}/.
| Блок источника | Пакет от одного поставщика | Смешанный набор |
|---|---|---|
hostJar |
kotlin/, java/, resources/ |
test/kotlin/, test/java/,
test/resources/ |
testApk |
kotlin/, java/, res/,
assets/, AndroidManifest.xml |
androidTest/kotlin/, androidTest/java/,
androidTest/res/, androidTest/assets/,
androidTest/AndroidManifest.xml |
assets |
Корневой каталог набора | assetsTest/ |
Не используйте в качестве названия набора встроенные названия наборов исходных файлов, вариантов, типов сборки или разновидностей, например main, androidTest или debug.
Цели контрольной группы для каждого варианта
Чтобы включить или отключить целевой набор для определенных вариантов, настройте интерфейс TestSuiteTargetBuilder с помощью свойства HasTestSuitesBuilder.suites в блоке beforeVariants:
androidComponents {
beforeVariants { variantBuilder ->
if (variantBuilder.buildType == "release") {
variantBuilder.suites["mySuite"]
?.targets
?.get("default")
?.enable = false
}
}
}
Запуск наборов тестов и проверка отчетов
AGP создает задачу Gradle для каждой комбинации варианта, набора и цели. В таблице ниже перечислены шаблоны задач.
| Тип задачи | Шаблон названия | Пример команды |
|---|---|---|
| Стандартная цель для пакета | test{Variant}{SuiteName}{Target}TestSuite |
./gradlew :app:testDebugMySuiteDefaultTestSuite |
Таргетинг с помощью свойства targetDevices |
test{Variant}{SuiteName}{Target}{Devices}TestSuite |
./gradlew :app:testDebugAndroidSuiteManagedCiPhonesTestSuite |
Обновление контрольного показателя (requiresUpdateTask = true) |
update{Variant}{SuiteName}{Target}TestSuite |
./gradlew :app:updateDebugScreenshotTestDefaultTestSuite |
| Агрегирование отчетов по модулям | testAllSuites |
./gradlew :app:testAllSuites |
| Агрегирование модулей и зависимостей | testAllSuitesWithDependencies |
./gradlew :app:testAllSuitesWithDependencies |
Задачи test, connectedCheck и check не запускают специальные наборы, если вы не свяжете их с помощью метода withTestTaskProviders. Чтобы включить задачи testAllSuites и testAllSuitesWithDependencies, задайте свойство android.experimental.reportAggregationSupport=true в файле gradle.properties.
Каждый запуск набора записывает выходные данные в следующие места:
- Отчет о тестировании HTML:
{module}/build/reports/tests/{taskName}/index.html - Результаты JUnit XML:
{module}/build/test-results/{taskName}/ - Отчет о покрытии кода:
{module}/build/reports/coverage/{suiteName}/index.html - Сводные отчеты:
{module}/build/reports/{aggregationTask}/test-report/index.htmlиcoverage-report/index.html
Чтобы создать отчеты о покрытии кода, задайте для свойства codeCoverage значение true в наборе. Для наборов скриншотов Compose настройте набор в файле build.gradle.kts с помощью testOptions.customSuites.named("{suiteName}") { codeCoverage = true }.
Известные проблемы и ограничения
Для наборов тестов действуют следующие ограничения:
- Интеграция с IDE. Android Studio не поддерживает собственные наборы тестов. Редактор кода может показывать ошибки неразрешенных ссылок в исходных файлах набора, даже если сборка настроена правильно. Вместо этого создавайте и запускайте наборы тестов из командной строки с помощью Gradle.
- Кеширование задач. Задачи набора тестов всегда перезапускаются при вызове и не загружаются из кеша сборки Gradle. Наборы без тестовых файлов пропускаются со статусом
NO-SOURCE.