ชุดโปรแกรมทดสอบ Unit Test จะเรียกใช้การทดสอบ JVM ในเครื่องในชุดซอร์ส hostJar ที่แยกต่างหากนอกไดเรกทอรี src/test/ เริ่มต้นของโมดูล กำหนดค่าด้วย DSL ชุดโปรแกรมทดสอบของปลั๊กอิน Android Gradle (AGP) เพื่อแยกการทดสอบ JUnit 5, JUnit 4 หรือ Robolectric ตามตัวแปร
ข้อกำหนด
หากต้องการใช้ชุดโปรแกรมทดสอบ Unit Test โปรดตรวจสอบว่าโปรเจ็กต์เป็นไปตามข้อกำหนดต่อไปนี้
- 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
ตั้งค่าชุดโปรแกรมทดสอบ Unit Test
หากต้องการเพิ่มชุดโปรแกรมทดสอบหน่วยลงในโมดูลแอปหรือไลบรารี ให้ทำตามขั้นตอนต่อไปนี้
เปิดใช้ชุดโปรแกรมทดสอบ
เปิดใช้การรองรับชุดโปรแกรมทดสอบในไฟล์ 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
สร้างการทดสอบ
ใส่ Unit Test ในไดเรกทอรี {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
หากต้องการเข้าถึงทรัพยากร, ชิ้นงาน, ไฟล์ Manifest และคลาส R ของ Android ที่ผสานรวม เช่น สำหรับการทดสอบ Robolectric ให้ตั้งค่าพร็อพเพอร์ตี้ enableAndroidResources ของอินเทอร์เฟซ TestSuiteHostJarSpec เป็น 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")
}
}
}
}
}
ปรับแต่งงานและความครอบคลุม
เปิดใช้ความครอบคลุมของ JaCoCo ในชุดทดสอบด้วยพร็อพเพอร์ตี้ codeCoverage หากต้องการปรับแต่งตัวเลือก Test ของ Gradle ต่อเป้าหมาย ให้ส่ง Lambda การกำหนดค่าไปยังเมธอด 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หากต้องการเรียกใช้คลาสหรือเมธอดการทดสอบรายการเดียว ให้ส่งตัวเลือก --tests ของ Gradle ดังนี้
./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