Android Gradle 플러그인(AGP)을 사용하면 모듈의 testOptions 블록에서 테스트를 이름이 지정된 테스트 모음으로 구성할 수 있습니다. 각 모음은 자체 소스 세트, 종속 항목, JUnit 플랫폼 테스트 엔진, 타겟 빌드 변형을 정의합니다.
테스트 모음을 사용하는 이유
기본적으로 Android 모듈은 로컬 단위 테스트를 위한 test 소스 세트 하나와 계측 테스트를 위한 androidTest 소스 세트 하나를 제공합니다. 테스트 모음은 테스트 조직을 두 소스 세트에서 분리하므로 다음을 실행할 수 있습니다.
- 목적별로 테스트 분리: 단위, Robolectric, UI, 스크린샷, 백업 테스트를
src/test/또는src/androidTest/디렉터리에 혼합하지 않고 전용src/{suiteName}/디렉터리에 보관합니다. - 종속 항목 및 엔진 격리: 앱 또는
testImplementation및androidTestImplementation구성에 종속 항목을 추가하지 않고 각 테스트 모음의 클래스 경로와 JUnit 플랫폼 테스트 엔진을 구성합니다. - 특정 변형 및 기기 타겟팅: 빠른 검사는 로컬에서 실행되고 더 긴 테스트 모음은 지속적 통합에서 실행되도록 테스트 모음별로 빌드 변형 및 기기를 선택합니다.
스위트룸 유형
AGP에는 특수 워크플로를 위한 기본 제공 테스트 모음과 맞춤 모음을 위한 AgpTestSuite 인터페이스가 포함되어 있습니다. 다음 표에는 사용 가능한 제품군 유형이 나와 있습니다.
| 스위트룸 유형 | DSL 컨테이너 | 목적 |
|---|---|---|
| 단위 테스트 모음 | testOptions.customSuites |
hostJar 블록을 사용하여 로컬 JVM에서 JUnit 5, JUnit 4 또는 Robolectric 테스트를 실행합니다. |
| 계측 테스트 모음 | testOptions.customSuites |
testApk 블록과 android-test-engine 테스트 엔진을 사용하여 연결된 기기 또는 빌드 관리 기기에서 기기 테스트를 실행합니다. |
| 테스트 모음을 사용한 스크린샷 테스트 | testOptions.screenshotTests |
호스트에서 @PreviewTest Compose 미리보기를 렌더링하고 비교합니다. |
| 자동 백업 및 복원 테스트 | testOptions.backupTests |
로컬, 클라우드, 기기 간 전송에서 앱 데이터를 확인합니다. |
| Android 스튜디오 여정 | testOptions.customSuites |
연결된 기기에서 AI 기반 XML 사용자 여정을 실행합니다. |
| 맞춤 확장 소재 또는 혼합 제품군 | testOptions.customSuites |
커스텀 엔진으로 정적 테스트 정의를 실행하거나 hostJar, testApk, assets 블록을 하나의 모음에 결합합니다. |
요구사항
커스텀 테스트 모음을 사용하려면 프로젝트가 다음 요구사항을 충족하는지 확인하세요.
- Android 스튜디오 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
그런 다음 모듈의 build.gradle.kts 파일에 있는 testOptions.customSuites 블록에서 모음을 선언합니다. 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 enum 값과 표준 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)을 모음 이름으로 재사용하지 마세요.
대안별 대조군 타겟
특정 변형의 모음 타겟을 사용 설정하거나 중지하려면 beforeVariants 블록의 HasTestSuitesBuilder.suites 속성을 통해 TestSuiteTargetBuilder 인터페이스를 구성합니다.
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 작업을 사용 설정하려면 gradle.properties 파일에서 android.experimental.reportAggregationSupport=true 속성을 설정합니다.
각 테스트 모음 실행은 다음 위치에 출력을 작성합니다.
- 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 스튜디오 지원은 제공되지 않습니다. 빌드가 올바르게 구성된 경우에도 코드 편집기에서 도구 모음 소스 파일에 해결되지 않은 참조 오류가 표시될 수 있습니다. 대신 Gradle을 사용하여 명령줄에서 테스트 모음을 빌드하고 실행합니다.
- 작업 캐싱: 테스트 모음 작업은 호출될 때 항상 다시 실행되며 Gradle 빌드 캐시에서 로드되지 않습니다. 테스트 파일이 없는 모음은
NO-SOURCE상태로 건너뜁니다.