Araçlı test paketleri, cihaz testlerini modülünüzün varsayılan src/androidTest/ dizininin dışındaki izole testApk APK'larda paketler. Kullanıcı arayüzü, entegrasyon veya uçtan uca kontrolleri özel bağımlılıklar, varyantlar ve cihaz hedefleriyle ayırmak için bunları Android Gradle eklentisi (AGP) test paketleri DSL ile yapılandırın.
Şartlar
Enstrümantasyon test paketlerini kullanmak için projenizin aşağıdaki koşulları karşıladığından emin olun:
- Android Studio Rabbit 3 Canary 3 veya sonraki sürümler
- AGP 9.6.0-alpha03 veya sonraki sürümler
- Gradle 9.7.1 veya sonraki sürümler ve JDK 17 veya sonraki sürümler
com.android.applicationveyacom.android.librarymodülü- Android Debug Bridge (adb) üzerinden bağlı bir cihaz veya emülatör ya da derleme tarafından yönetilen cihaz tanımı
Önizleme sürümü eşleştirme hakkında daha fazla bilgi için Android Gradle eklentisi önizlemeleriyle uyumluluk bölümüne bakın.
Enstrümantasyon test paketi oluşturma
Bir uygulamaya veya kitaplık modülüne enstrümantasyon testi paketi eklemek için aşağıdaki adımları uygulayın:
Test paketlerini etkinleştirme
Projenizin gradle.properties dosyasında test paketi desteğini etkinleştirin:
android.experimental.testSuiteSupport=true
Paketi yapılandırma
Modülünüzün build.gradle.kts dosyasında, testOptions.customSuites bloğunun içinde testApk ve useJunitEngine blokları ve AgpTestSuiteInputParameters enum değerleriyle bir paket oluşturun:
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, androidTestImplementation yapılandırmasından bağımlılıkları devralmadan AndroidJUnitRunner test çalıştırıcısını ve paket kimliklerini otomatik olarak yapılandırır. Özel bir çalıştırıcı kullanmak için src/{suiteName}/AndroidManifest.xml dosyanızdaki instrumentation öğesinde android:name özelliğini ayarlayın.
Test oluşturma
Enstrümantasyon testlerinizi, isteğe bağlı res/ veya assets/ dizinleri ya da bir AndroidManifest.xml dosyasıyla birlikte {module}/src/{suiteName}/kotlin/ veya java/ dizinine yerleştirin. Örneğin, app/src/androidSuite/kotlin/com/example/myapp/AppContextSuiteTest.kt dosyasını oluşturun:
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)
}
}
Birim ve araçlı testleri birleştirme
Yerel JVM testlerini ve araçlı cihaz testlerini tek bir Gradle görevinde çalıştırmak için tek bir pakette hem hostJar hem de testApk bloklarını tanımlayın. Ana makine testlerini src/{suiteName}/test/ dizinine, cihaz testlerini ise src/{suiteName}/androidTest/ dizinine yerleştirin:
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")
}
}
}
}
}
Testleri çalıştırma ve kapsamı toplama
Araçlı paketleri çalıştırmak, test durumlarını filtrelemek ve kapsam raporları oluşturmak için Gradle'ı kullanın.
Bağlı veya derleme tarafından yönetilen cihazlarda çalıştırma
Bağlı bir hedefi her online adb cihazında çalıştırın veya targetDevices özelliğiyle yapılandırılmış bir hedefi çalıştırın:
# Run on connected adb devices. ./gradlew :app:testDebugAndroidSuiteDefaultTestSuite# Run on the ciPhones build-managed device group. ./gradlew :app:testDebugAndroidSuiteManagedCiPhonesTestSuite
Araçlı testleri filtreleme
Gradle'ın --tests seçeneği veya AndroidJUnitRunner bağımsız değişkenleriyle testleri filtreleyin:
./gradlew :app:testDebugAndroidSuiteDefaultTestSuite \
--tests "com.example.myapp.AppContextSuiteTest.useAppContext"AndroidJUnitRunner bağımsız değişkenlerini komut satırında -Pandroid.testInstrumentationRunnerArguments.size=small gibi bir proje özelliğiyle de iletebilirsiniz. useJunitEngine bloğunda varsayılan çalıştırıcı bağımsız değişkenlerini ayarlamak için addInputProperty yöntemini (ör. addInputProperty("android-test.instrumentation-args", "size=small")) çağırın.
Cihaz üzerinde kod kapsamını toplama
Cihaz üzerinde kod kapsamı için hata ayıklanabilir bir derleme ve Android 9 (API düzeyi 28) veya sonraki bir sürümü çalıştıran bir cihaz gerekir. Araçlı veya karma bir paketin kapsamını toplamak için aşağıdaki adımları uygulayın:
gradle.propertiesdosyanızdaandroid.experimental.androidTest.coverage.useOnDeviceAgent=trueözelliğini ayarlayın.- Paketteki
codeCoverageözelliğinitrueolarak ayarlayın. - Birden fazla cihaz bağlıysa
ANDROID_SERIALortam değişkeniyle bir cihazı hedefleyin.
Temsilci gereksinimleri hakkında daha fazla bilgi için Kod kapsamı raporlarını görüntüleme (cihaz üzerinde temsilci ile) başlıklı makaleyi inceleyin.
Raporları inceleme
Test çalıştırması tamamlandıktan sonra AGP, aşağıdaki yollarda çıkışlar oluşturur:
- HTML test raporu:
{module}/build/reports/tests/{taskName}/index.html - JUnit XML sonuçları:
{module}/build/test-results/{taskName}/ - Cihaz başına XML ve logcat:
{module}/build/intermediates/{variant}/{taskName}/results/ - Kod kapsamı raporu:
{module}/build/reports/coverage/{suiteName}/index.html