Suite pengujian unit

Suite pengujian unit menjalankan pengujian JVM lokal di set sumber hostJar yang terisolasi di luar direktori src/test/ default modul Anda. Konfigurasikan dengan DSL suite pengujian plugin Android Gradle (AGP) untuk mengisolasi pengujian JUnit 5, JUnit 4, atau Robolectric per varian.

Persyaratan

Untuk menggunakan suite pengujian unit, pastikan project Anda memenuhi persyaratan berikut:

  • Android Studio Rabbit 3 Canary 3 atau yang lebih baru
  • AGP 9.6.0-alpha03 atau yang lebih tinggi
  • Gradle 9.7.1 atau yang lebih tinggi dan JDK 17 atau yang lebih tinggi
  • Modul com.android.application atau com.android.library

Untuk mengetahui informasi selengkapnya tentang pencocokan versi pratinjau, lihat Kompatibilitas dengan pratinjau plugin Android Gradle.

Menyiapkan suite pengujian unit

Untuk menambahkan suite pengujian unit ke modul aplikasi atau library, selesaikan langkah-langkah berikut:

Mengaktifkan suite pengujian

Di file gradle.properties project Anda, aktifkan dukungan suite pengujian:

android.experimental.testSuiteSupport=true

Mengonfigurasi suite

Dalam file build.gradle.kts modul Anda, buat suite di dalam blok testOptions.customSuites dengan blok hostJar dan 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")
                }
            }
        }
    }
}

Suite Anda mengakses class dan dependensi varian target secara otomatis tanpa mewarisi dependensi dari konfigurasi testImplementation.

Membuat pengujian

Tempatkan pengujian unit Anda di direktori {module}/src/{suiteName}/kotlin/ atau java/ dan resource pengujian Java di direktori {module}/src/{suiteName}/resources/. Misalnya, buat file 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)
    }
}

Menyertakan resource Android dan Robolectric

Untuk mengakses resource, aset, manifes, dan class R Android yang digabungkan, seperti untuk pengujian Robolectric, tetapkan properti enableAndroidResources dari antarmuka TestSuiteHostJarSpec ke 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")
                }
            }
        }
    }
}

Menyesuaikan tugas dan cakupan

Aktifkan cakupan JaCoCo pada suite dengan properti codeCoverage. Untuk menyesuaikan opsi Test Gradle per target, teruskan lambda konfigurasi ke metode AgpTestSuiteTarget.configureTestTasks, yang menyediakan instance TestTaskContext. Untuk melampirkan tugas verifikasi ke tugas check, gunakan metode 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)
                        }
                    }
                }
            }
        }
    }
}

Untuk menerapkan setelan tugas Test di setiap target dalam suite, panggil metode AgpTestSuite.configureTestTasks di suite.

Menjalankan pengujian dan memeriksa laporan

Jalankan suite Anda dari command line dengan tugas test{Variant}{SuiteName}{Target}TestSuite yang dihasilkan:

./gradlew :app:testDebugUnitSuiteDefaultTestSuite

Untuk menjalankan satu class atau metode pengujian, teruskan opsi --tests Gradle:

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

Setelah uji coba selesai, AGP akan membuat laporan di jalur berikut:

  • Laporan pengujian HTML: {module}/build/reports/tests/{taskName}/index.html
  • Hasil XML JUnit: {module}/build/test-results/{taskName}/
  • Laporan cakupan JaCoCo: {module}/build/reports/coverage/{suiteName}/index.html