ชุดโปรแกรมทดสอบที่มีการใช้เครื่องมือจะจัดแพ็กเกจการทดสอบอุปกรณ์เป็น APK testApk ที่แยกต่างหากนอกไดเรกทอรี src/androidTest/ เริ่มต้นของโมดูล กำหนดค่าด้วย DSL ชุดโปรแกรมทดสอบของปลั๊กอิน Android Gradle (AGP) เพื่อแยกการตรวจสอบ UI, การผสานรวม หรือการตรวจสอบตั้งแต่ต้นจนจบด้วยทรัพยากร Dependency, ตัวแปร และอุปกรณ์เป้าหมายเฉพาะ
ข้อกำหนด
หากต้องการใช้ชุดโปรแกรมทดสอบการวัดคุม ให้ตรวจสอบว่าโปรเจ็กต์เป็นไปตามข้อกำหนดต่อไปนี้
- Android Studio Rabbit 3 Canary 3 ขึ้นไป
- AGP 9.6.0-alpha03 ขึ้นไป
- Gradle 9.7.1 ขึ้นไปและ JDK 17 ขึ้นไป
- โมดูล
com.android.applicationหรือcom.android.library - อุปกรณ์หรือโปรแกรมจำลองที่เชื่อมต่อผ่าน Android Debug Bridge (adb) หรือคำจำกัดความอุปกรณ์ที่จัดการโดยบิลด์
ดูข้อมูลเพิ่มเติมเกี่ยวกับการจับคู่เวอร์ชันตัวอย่างได้ที่ความเข้ากันได้กับเวอร์ชันตัวอย่างของปลั๊กอิน Android Gradle
ตั้งค่าชุดโปรแกรมทดสอบการวัดคุม
หากต้องการเพิ่มชุดโปรแกรมทดสอบการวัดคุมลงในแอปหรือโมดูลไลบรารี ให้ทำตามขั้นตอนต่อไปนี้
เปิดใช้ชุดโปรแกรมทดสอบ
เปิดใช้การรองรับชุดโปรแกรมทดสอบในไฟล์ gradle.properties ของโปรเจ็กต์ โดยทำดังนี้
android.experimental.testSuiteSupport=true
กำหนดค่าชุดโปรแกรม
ในไฟล์ build.gradle.kts ของโมดูล ให้สร้างชุดทดสอบภายในบล็อก testOptions.customSuites ด้วยบล็อก testApk และ useJunitEngine และค่า enum AgpTestSuiteInputParameters ดังนี้
import com.android.build.api.dsl.AgpTestSuiteInputParameters
android {
testOptions {
// Optional: define build-managed virtual devices and device groups.
managedDevices {
localDevices {
create("api34Atd") {
// Use a device profile from Android Studio.
device = "Pixel 6"
apiLevel = 34
systemImageSource = "aosp-atd"
}
}
groups {
create("ciPhones") {
targetDevices.add(allDevices.getByName("api34Atd"))
}
}
}
customSuites {
create("androidSuite") {
targetVariants += listOf("debug")
testApk {
dependencies {
implementation("junit:junit:4.13.2")
implementation("androidx.test.ext:junit:1.2.1")
implementation("androidx.test:runner:1.6.2")
}
}
useJunitEngine {
includeEngines += listOf("android-test-engine")
// Match the engine and listener versions to your AGP
// version.
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine:9.6.0-alpha03"
)
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine-result-listener:9.6.0-alpha03"
)
enginesDependencies.add(
"org.junit.platform:junit-platform-launcher:1.10.2"
)
inputs += listOf(
// Omit TESTED_APKS in com.android.library modules.
AgpTestSuiteInputParameters.TESTED_APKS,
AgpTestSuiteInputParameters.TEST_APKS,
AgpTestSuiteInputParameters.ADB_EXECUTABLE,
AgpTestSuiteInputParameters.AAPT2_EXECUTABLE,
)
}
targets {
// Runs on connected adb devices.
create("default")
// Optional: runs on build-managed devices or groups in
// targetDevices.
create("managed") {
targetDevices += listOf("ciPhones")
}
}
}
}
}
}
AGP จะกำหนดค่า Test Runner และรหัสแพ็กเกจ AndroidJUnitRunner โดยอัตโนมัติโดยไม่รับค่าทรัพยากร Dependency จากการกำหนดค่า androidTestImplementation หากต้องการใช้ Runner ที่กำหนดเอง ให้ตั้งค่าแอตทริบิวต์ android:name ในองค์ประกอบ instrumentation ในไฟล์ src/{suiteName}/AndroidManifest.xml
สร้างการทดสอบ
วางการทดสอบการวัดคุมในไดเรกทอรี {module}/src/{suiteName}/kotlin/ หรือ java/ พร้อมกับไดเรกทอรี res/ หรือ assets/ หรือไฟล์ AndroidManifest.xml (ไม่บังคับ) ตัวอย่างเช่น สร้างไฟล์ app/src/androidSuite/kotlin/com/example/myapp/AppContextSuiteTest.kt ดังนี้
package com.example.myapp
import androidx.test.ext.junit.runners.AndroidJUnit4
import androidx.test.platform.app.InstrumentationRegistry
import org.junit.Assert.assertEquals
import org.junit.Test
import org.junit.runner.RunWith
@RunWith(AndroidJUnit4::class)
class AppContextSuiteTest {
@Test
fun useAppContext() {
val appContext =
InstrumentationRegistry.getInstrumentation().targetContext
assertEquals("com.example.myapp", appContext.packageName)
}
}
รวมการทดสอบหน่วยและการทดสอบการวัดคุม
หากต้องการเรียกใช้การทดสอบ JVM ในเครื่องและการทดสอบอุปกรณ์ที่มีการใช้เครื่องมือในงาน Gradle เดียว ให้ประกาศทั้งบล็อก hostJar และ testApk ในชุดเดียว วางการทดสอบโฮสต์ในไดเรกทอรี src/{suiteName}/test/ และการทดสอบอุปกรณ์ในไดเรกทอรี src/{suiteName}/androidTest/ ดังนี้
import com.android.build.api.dsl.AgpTestSuiteInputParameters
android {
testOptions {
customSuites {
create("combinedSuite") {
targetVariants += listOf("debug")
hostJar {
dependencies {
implementation(
"org.junit.jupiter:junit-jupiter-api:5.10.2"
)
}
}
testApk {
dependencies {
implementation("junit:junit:4.13.2")
implementation("androidx.test.ext:junit:1.2.1")
implementation("androidx.test:runner:1.6.2")
}
}
useJunitEngine {
includeEngines += listOf(
"junit-jupiter",
"android-test-engine",
)
enginesDependencies.add(
"org.junit.jupiter:junit-jupiter-engine:5.10.2"
)
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine:9.6.0-alpha03"
)
enginesDependencies.add(
"com.android.tools.androidtest:" +
"android-test-engine-result-listener:9.6.0-alpha03"
)
enginesDependencies.add(
"org.junit.platform:junit-platform-launcher:1.10.2"
)
inputs += listOf(
// Omit TESTED_APKS in com.android.library modules.
AgpTestSuiteInputParameters.TESTED_APKS,
AgpTestSuiteInputParameters.TEST_APKS,
AgpTestSuiteInputParameters.ADB_EXECUTABLE,
AgpTestSuiteInputParameters.AAPT2_EXECUTABLE,
)
}
targets {
create("default")
}
}
}
}
}
เรียกใช้การทดสอบและรวบรวมความครอบคลุม
ใช้ Gradle เพื่อเรียกใช้ชุดเครื่องมือที่ใช้เครื่องมือวัด กรองกรอบการทดสอบ และสร้างรายงานความครอบคลุม
เรียกใช้ในอุปกรณ์ที่เชื่อมต่อหรืออุปกรณ์ที่จัดการโดยบิลด์
เรียกใช้เป้าหมายที่เชื่อมต่อในอุปกรณ์ adb ออนไลน์ทุกเครื่อง หรือเรียกใช้เป้าหมายที่กำหนดค่าด้วยพร็อพเพอร์ตี้ targetDevices
# Run on connected adb devices. ./gradlew :app:testDebugAndroidSuiteDefaultTestSuite# Run on the ciPhones build-managed device group. ./gradlew :app:testDebugAndroidSuiteManagedCiPhonesTestSuite
กรองการทดสอบการวัดคุม
กรองการทดสอบด้วยตัวเลือก --tests ของ Gradle
หรืออาร์กิวเมนต์ AndroidJUnitRunner:
./gradlew :app:testDebugAndroidSuiteDefaultTestSuite \
--tests "com.example.myapp.AppContextSuiteTest.useAppContext"นอกจากนี้ คุณยังส่งอาร์กิวเมนต์ AndroidJUnitRunner ในบรรทัดคำสั่งที่มีพร็อพเพอร์ตี้โปรเจ็กต์ เช่น -Pandroid.testInstrumentationRunnerArguments.size=small ได้ด้วย หากต้องการตั้งค่าอาร์กิวเมนต์ Runner เริ่มต้นในบล็อก useJunitEngine ให้เรียกใช้เมธอด addInputProperty เช่น addInputProperty("android-test.instrumentation-args", "size=small")
รวบรวมการครอบคลุมของโค้ดในอุปกรณ์
การครอบคลุมของโค้ดในอุปกรณ์ต้องใช้บิลด์ที่แก้ไขข้อบกพร่องได้และอุปกรณ์ที่ใช้ Android 9 (ระดับ API 28) ขึ้นไป หากต้องการรวบรวมความครอบคลุมสำหรับชุดการทดสอบที่มีการใช้เครื่องมือหรือแบบผสม ให้ทำตามขั้นตอนต่อไปนี้
- ตั้งค่าพร็อพเพอร์ตี้
android.experimental.androidTest.coverage.useOnDeviceAgent=trueในไฟล์gradle.properties - ตั้งค่าพร็อพเพอร์ตี้
codeCoverageเป็นtrueในชุดทดสอบ - หากเชื่อมต่ออุปกรณ์หลายเครื่อง ให้กำหนดเป้าหมายอุปกรณ์ 1 เครื่องด้วยตัวแปรสภาพแวดล้อม
ANDROID_SERIAL
ดูข้อมูลเพิ่มเติมเกี่ยวกับข้อกำหนดของ Agent ได้ที่ดูรายงานการครอบคลุมของโค้ด (ที่มี Agent ในอุปกรณ์)
ตรวจสอบรายงาน
หลังจากที่การรันเพื่อทดสอบเสร็จสมบูรณ์แล้ว AGP จะสร้างเอาต์พุตในเส้นทางต่อไปนี้
- รายงานการทดสอบ HTML:
{module}/build/reports/tests/{taskName}/index.html - ผลลัพธ์ JUnit XML:
{module}/build/test-results/{taskName}/ - XML และ logcat ต่ออุปกรณ์:
{module}/build/intermediates/{variant}/{taskName}/results/ - รายงานการครอบคลุมของโค้ด:
{module}/build/reports/coverage/{suiteName}/index.html