単体テストスイート

単体テストスイートは、モジュールのデフォルトの src/test/ ディレクトリの外にある、分離された hostJar ソースセットでローカル JVM テストを実行します。Android Gradle プラグイン(AGP)のテストスイート DSL を使用して、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 ファイルで、hostJar ブロックと useJunitEngine ブロックを使用して、testOptions.customSuites ブロック内にスイートを作成します。

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 を含める

Robolectric テストなどのために、統合された Android リソース、アセット、マニフェスト、R クラスにアクセスするには、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 Task 設定を適用するには、代わりにスイートで AgpTestSuite.configureTestTasks メソッドを呼び出します。

テストを実行してレポートを検査する

生成された test{Variant}{SuiteName}{Target}TestSuite タスクを使用して、コマンドラインからスイートを実行します。

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

1 つのテストクラスまたはメソッドを実行するには、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