단위 테스트 모음

단위 테스트 모음은 모듈의 기본 src/test/ 디렉터리 외부에 있는 격리된 hostJar 소스 세트에서 로컬 JVM 테스트를 실행합니다. Android Gradle 플러그인(AGP) 테스트 모음 DSL을 사용하여 변형별로 JUnit 5, JUnit 4 또는 Robolectric 테스트를 격리하도록 구성합니다.

요구사항

단위 테스트 모음을 사용하려면 프로젝트가 다음 요구사항을 충족해야 합니다.

  • Android 스튜디오 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 포함

병합된 Android 리소스, 애셋, 매니페스트, R 클래스(예: Robolectric 테스트용)에 액세스하려면 TestSuiteHostJarSpec 인터페이스의 enableAndroidResources 속성을 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")
                }
            }
        }
    }
}

작업 및 범위 맞춤설정

codeCoverage 속성을 사용하여 도구 모음에서 JaCoCo 적용 범위를 사용 설정합니다. 타겟별로 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

단일 테스트 클래스 또는 메서드를 실행하려면 Gradle의 --tests 옵션을 전달합니다.

./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