เมื่อผู้ใช้ตั้งค่าอุปกรณ์ใหม่หรือติดตั้งแอปอีกครั้ง Android จะกู้คืนข้อมูลของแอปจากข้อมูลสำรองในระบบคลาวด์หรือการโอนจากอุปกรณ์หนึ่งไปยังอีกอุปกรณ์หนึ่งได้ หากกฎการสำรองข้อมูลละเว้นข้อมูลสำคัญ หรือแอปไม่สามารถใช้ข้อมูลที่กู้คืนได้ ผู้ใช้จะสูญเสียการตั้งค่าและความคืบหน้าโดยไม่เห็นข้อผิดพลาด
การทดสอบการสำรองและกู้คืนข้อมูลอัตโนมัติช่วยให้คุณตรวจพบปัญหาเหล่านี้ก่อนที่จะเผยแพร่แอป โดยเป็นการทดสอบ JUnit 5 ที่ทำงานบนคอมพิวเตอร์สำหรับการพัฒนาซอฟต์แวร์และควบคุมอุปกรณ์ที่เชื่อมต่อผ่าน Android Debug Bridge (adb) การทดสอบแต่ละครั้งจะสร้างข้อมูลแอปในอุปกรณ์ สำรองและกู้คืนแอปผ่านเฟรมเวิร์กการสำรองข้อมูล Android จากนั้นตรวจสอบว่าข้อมูลไม่เสียหาย คุณกำหนดค่าการทดสอบเป็นชุดโปรแกรมทดสอบของปลั๊กอิน Android Gradle (AGP) ในไฟล์บิลด์ของโมดูล
วิธีการทำงาน
ชุดโปรแกรมทดสอบการสำรองและกู้คืนข้อมูลมี 2 ส่วนที่ทำงานร่วมกัน ได้แก่
- การทดสอบโฮสต์คือการทดสอบ JUnit 5 ที่ทำงานในคอมพิวเตอร์สำหรับการพัฒนาซอฟต์แวร์ โดยใช้
BackupRestoreControllerสำหรับอุปกรณ์แต่ละเครื่องเพื่อสร้างข้อมูล สำรองและกู้คืนแอป และตรวจสอบผลลัพธ์ - การดำเนินการกับอุปกรณ์คือคลาสที่ใช้
BackupDeviceActionโดยจะทำงานในกระบวนการของแอปบนอุปกรณ์ จึงสามารถอ่านและเขียนข้อมูลผ่านโค้ดของแอปเองได้ การทดสอบโฮสต์จะเรียกใช้การดำเนินการของอุปกรณ์ตามชื่อคลาส
เมื่อคุณเรียกใช้ชุดทดสอบ AGP จะสร้างแอปและ APK ทดสอบที่มีการดำเนินการของอุปกรณ์ เฟรมเวิร์กการทดสอบจะติดตั้ง APK ทั้ง 2 รายการในอุปกรณ์แต่ละเครื่องที่การทดสอบใช้ และล้างข้อมูลของแอปก่อนการทดสอบแต่ละครั้ง
ประเภทพื้นที่เก็บข้อมูลในตัว
ตารางต่อไปนี้แสดงคลาสย่อย StorageDomain ที่ช่วยให้คุณสร้างและยืนยันข้อมูลได้โดยไม่ต้องเขียนการดำเนินการของอุปกรณ์
| โดเมนพื้นที่เก็บข้อมูล | ข้อมูล |
|---|---|
StorageDomain.Preference |
คีย์ในไฟล์ SharedPreferences |
StorageDomain.DataStorePreference |
คีย์ในไฟล์ Preferences DataStore |
StorageDomain.Database |
แถวในตารางฐานข้อมูล SQLite |
StorageDomain.TextFile |
ไฟล์ข้อความในที่จัดเก็บข้อมูลภายในของแอป |
StorageDomain.BinaryFile |
ไฟล์ไบนารีในที่จัดเก็บข้อมูลภายในของแอป |
StorageDomain.ExcludedData |
โดเมนพื้นที่เก็บข้อมูลในตัวอีกโดเมนหนึ่งซึ่งไม่ควรคืนค่าข้อมูล เช่น ข้อมูลที่กฎการสำรองข้อมูลยกเว้นไว้ |
หากต้องการทดสอบข้อมูลอื่นๆ เช่น ไฟล์ Proto DataStore หรือฐานข้อมูล Room ให้เขียนการดำเนินการของอุปกรณ์
รูปแบบการเดินทาง
ข้อมูลสำรองแต่ละรายการจะใช้ค่า BackupTransportMode ตารางต่อไปนี้แสดงรูปแบบการเดินทางที่รองรับ
| โหมด | สถานการณ์ |
|---|---|
LOCAL |
การสำรองข้อมูลไปยังการส่งข้อมูลสำรองในเครื่องของอุปกรณ์ ข้อมูลสำรองจะยังคงอยู่ในอุปกรณ์ |
CLOUD_ENCRYPTED |
ข้อมูลสำรองในระบบคลาวด์ เช่น ข้อมูลที่บันทึกไว้ในบัญชี Google ของผู้ใช้จากอุปกรณ์ที่มีการเข้ารหัสฝั่งไคลเอ็นต์ |
CLOUD_UNENCRYPTED |
ข้อมูลสำรองในระบบคลาวด์จากอุปกรณ์ที่ไม่มีการเข้ารหัสฝั่งไคลเอ็นต์ |
DEVICE_TO_DEVICE |
การโอนจากอุปกรณ์หนึ่งไปยังอีกอุปกรณ์หนึ่ง เช่น ผ่านสายหรือ Wi-Fi |
LOCAL ใช้งานได้ในอุปกรณ์ที่รองรับทุกเครื่อง โหมดคลาวด์และโหมดอุปกรณ์ต่ออุปกรณ์จะสร้างข้อมูลสำรองแบบเดียวกับการดำเนินการสำรองข้อมูลแอปใน Android Studio โดยระบบจะบันทึกข้อมูลสำรองไว้ในคอมพิวเตอร์สำหรับการพัฒนาซอฟต์แวร์แทนการอัปโหลดหรือส่งไปยังอุปกรณ์อื่น โหมดคลาวด์และโหมดอุปกรณ์ต่ออุปกรณ์ต้องใช้บริการ Google Play ในอุปกรณ์และบิลด์ที่แก้ไขข้อบกพร่องได้ของแอป หากกฎการสำรองข้อมูลขึ้นอยู่กับการเข้ารหัสฝั่งไคลเอ็นต์ ให้ทดสอบโหมดคลาวด์ทั้ง 2 โหมด
ข้อกำหนด
หากต้องการใช้การทดสอบการสำรองและกู้คืนข้อมูลอัตโนมัติ โปรดตรวจสอบว่าสภาพแวดล้อมของคุณเป็นไปตามข้อกำหนดต่อไปนี้
- Gradle เวอร์ชัน 9.6.0 ขึ้นไป
- JDK เวอร์ชัน 17 ขึ้นไป
- อุปกรณ์หรือโปรแกรมจำลองที่ใช้ Android 12 (ระดับ API 31) ขึ้นไปซึ่งเชื่อมต่อผ่าน adb:
- อุปกรณ์หรือโปรแกรมจำลองในระดับ API 36.1 ขึ้นไปต้องใช้บริการ Google Play เวอร์ชัน 26.33.30 ขึ้นไป
- หากต้องการทดสอบการโอนระหว่างอุปกรณ์ 2 เครื่อง ให้เชื่อมต่ออุปกรณ์ 2 เครื่อง
ความเข้ากันได้
ตารางต่อไปนี้แสดงเวอร์ชันขั้นต่ำและเวอร์ชันที่แนะนำสำหรับการทดสอบการสำรองและกู้คืนข้อมูลอัตโนมัติ
| ส่วนประกอบ | เวอร์ชันขั้นต่ำ | เวอร์ชันที่แนะนํา |
|---|---|---|
| Android Studio | Rabbit 2 Canary 1 | Rabbit 2 Canary 4 ขึ้นไป |
| ปลั๊กอิน Android Gradle (AGP) | 9.5.0-alpha06 | 9.5.0-alpha09 ขึ้นไป |
ไลบรารี androidx.test.backup รายการ |
1.0.0-alpha01 | 1.0.0-alpha04 ขึ้นไป |
AGP เวอร์ชันตัวอย่างแต่ละเวอร์ชันต้องใช้ Android Studio เวอร์ชันตัวอย่างที่ตรงกัน ดูข้อมูลเพิ่มเติมได้ที่เวอร์ชันตัวอย่างของ AGP
ตั้งค่าโปรเจ็กต์
หากต้องการเพิ่มชุดโปรแกรมทดสอบการสำรองและกู้คืนข้อมูลลงในโมดูลแอป ให้ทำตามขั้นตอนต่อไปนี้
เปิดใช้แฟล็กเวอร์ชันทดลอง
ในไฟล์ gradle.properties ของโปรเจ็กต์ ให้เปิดใช้ชุดโปรแกรมทดสอบและการทดสอบการสำรองข้อมูล ดังนี้
android.experimental.testSuiteSupport=true
android.experimental.enableBackupTest=true
ประกาศชุดโปรแกรมทดสอบ
ในไฟล์ build.gradle.kts ของโมดูลแอป ให้ประกาศชุดโปรแกรมทดสอบการสำรองข้อมูลในบล็อก testOptions ดังนี้
android {
testOptions {
backupTests {
create("backupTest") {
backupTestLibraryVersion = "1.0.0-alpha04"
}
}
}
}
ชื่อชุด backupTest ในตัวอย่างนี้จะกำหนดไดเรกทอรีชุดซอร์สและชื่องาน Gradle คุณปรับแต่งชุดได้ด้วยพร็อพเพอร์ตี้ที่ไม่บังคับต่อไปนี้
- ใช้
backupTestLibraryVersionเพื่อตั้งค่าเวอร์ชันของไลบรารีandroidx.test.backupที่ AGP เพิ่มลงในชุด เช่น"1.0.0-alpha04"พร็อพเพอร์ตี้นี้ไม่บังคับ หากคุณละเว้น AGP จะกลับไปใช้เวอร์ชันไลบรารีเริ่มต้นตามเวอร์ชัน AGP ตัวอย่างในหน้านี้ต้องใช้เวอร์ชัน 1.0.0-alpha04 ขึ้นไป - ใช้
targetVariantsเพื่อระบุตัวแปรบิลด์ที่ชุดทดสอบ เช่นtargetVariants.add("demoDebug")พร็อพเพอร์ตี้นี้ไม่บังคับ หากคุณไม่ระบุ ชุดทดสอบจะทดสอบตัวแปรของtestBuildTypeของโมดูล ซึ่งก็คือdebugโดยค่าเริ่มต้น เราขอแนะนำให้ทดสอบตัวแปรที่แก้ไขข้อบกพร่องได้เนื่องจากโหมดการรับส่งข้อมูลในระบบคลาวด์และแบบอุปกรณ์ต่ออุปกรณ์ต้องใช้แอปที่แก้ไขข้อบกพร่องได้
AGP จะเพิ่มไลบรารีโฮสต์ androidx.test.backup:backup-host และ JUnit 5 ลงในการทดสอบโฮสต์ โดยจะเพิ่มไลบรารีอุปกรณ์ androidx.test.backup:backup ลงใน APK ทดสอบและตั้งค่าโปรแกรมเรียกใช้การวัดคุมของ APK ทดสอบ
หากต้องการเพิ่มทรัพยากร Dependency อื่นๆ ให้ใช้บล็อก hostJar และ testApk ของชุดโปรแกรม
ตัวอย่างเช่น หากต้องการใช้ Truth ในการทดสอบโฮสต์ ให้เพิ่มลงในบล็อก hostJar ดังนี้
create("backupTest") {
hostJar {
dependencies {
implementation("com.google.truth:truth:1.4.2")
}
}
}
สร้างชุดซอร์ส
สร้างไดเรกทอรีชุดซอร์สที่ตรงกับชื่อชุดโปรแกรม ดังนี้
- ใส่การทดสอบโฮสต์ใน
src/{suiteName}/test/kotlin/ - วางการดำเนินการกับอุปกรณ์ใน
src/{suiteName}/androidTest/kotlin/
ตัวอย่างเช่น ชุดทดสอบชื่อ backupTest จะใช้โครงสร้างไดเรกทอรีต่อไปนี้
app/src/backupTest/
├── androidTest/
│ └── kotlin/com/example/myapp/ThemeActions.kt
└── test/
└── kotlin/com/example/myapp/SettingsBackupTest.kt
ตรวจสอบการกำหนดค่าการสำรองข้อมูล
การทดสอบจะสำรองและกู้คืนข้อมูลที่รวมอยู่ในการกำหนดค่าการสำรองข้อมูลของแอป ตรวจสอบว่าได้เปิดใช้การสำรองข้อมูลสำหรับแอปแล้ว และกฎการสำรองข้อมูลมีข้อมูลที่คุณทดสอบอยู่
เขียนการทดสอบการสำรองและกู้คืนข้อมูล
เขียนการทดสอบโฮสต์ในชุดซอร์ส test ของชุดโปรแกรม ใส่คำอธิบายประกอบคลาสทดสอบแต่ละคลาสด้วย @ExtendWith(BackupRestoreExtension::class) ซึ่งจะจัดเตรียมอุปกรณ์ที่เชื่อมต่อสำหรับการทดสอบ การทดสอบจะทำงานกับตัวแปรแอปที่ชุดทดสอบกำหนดเป้าหมาย ดังนั้นคุณจึงไม่จำเป็นต้องตั้งค่ารหัสแอปพลิเคชัน
เมธอดการทดสอบแต่ละเมธอดจะประกาศพารามิเตอร์ BackupRestoreController สำหรับอุปกรณ์แต่ละเครื่องที่ใช้
ทดสอบประเภทพื้นที่เก็บข้อมูลในตัว
หากต้องการทดสอบประเภทพื้นที่เก็บข้อมูลในตัว ให้เรียกใช้ runBackupRestoreFlow พร้อมข้อมูลที่จะใช้เป็น Seed, ไดเรกทอรีสำหรับไฟล์ข้อมูลสำรอง และโหมด Transport เมธอดจะเรียกใช้ขั้นตอนต่อไปนี้ในอุปกรณ์
- สร้างโดเมนพื้นที่เก็บข้อมูลแต่ละโดเมน
- หยุดแอป
- สำรองข้อมูลแอป
- ล้างข้อมูลของแอป
- กู้คืนข้อมูลสำรอง
- ยืนยันว่าโดเมนพื้นที่เก็บข้อมูลแต่ละโดเมนมีค่าตั้งต้นหรือไม่มีเมื่อรวมอยู่ใน
StorageDomain.ExcludedData
หากขั้นตอนใดไม่สำเร็จ เมธอดจะแสดงข้อยกเว้น ซึ่งจะทำให้การทดสอบไม่สำเร็จ ตัวอย่างต่อไปนี้จะทดสอบ SharedPreferences, Preferences DataStore, SQLite, ไฟล์ภายใน และไฟล์การยกเว้นโดยใช้การส่งข้อมูลสำรองในเครื่อง
package com.example.myapp
import androidx.test.backup.host.BackupRestoreController
import androidx.test.backup.host.BackupRestoreExtension
import androidx.test.backup.host.BackupTransportMode
import androidx.test.backup.host.StorageDomain
import java.nio.file.Path
import kotlinx.coroutines.runBlocking
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.junit.jupiter.api.io.TempDir
@ExtendWith(BackupRestoreExtension::class)
class SettingsBackupTest {
@Test
fun settingsSurviveBackupAndRestore(
device: BackupRestoreController,
@TempDir outputDir: Path,
): Unit = runBlocking {
device.runBackupRestoreFlow(
storages = listOf(
StorageDomain.Preference(
prefName = "settings",
key = "channels",
value = setOf("news", "alerts"),
),
StorageDomain.DataStorePreference(
dataStoreName = "user_prefs",
key = "font_scale",
value = 1.25f,
),
StorageDomain.Database(
dbName = "notes.db",
table = "notes",
primaryKeyCol = "id",
primaryKeyVal = 1,
columnValues = mapOf("title" to "Groceries"),
),
StorageDomain.TextFile(
path = "drafts/note.txt",
content = "Buy milk",
),
// Check that a file excluded by backup rules isn't restored.
StorageDomain.ExcludedData(
StorageDomain.TextFile(
path = "auth/session.txt",
content = "temp-token",
)
),
),
outputDir = outputDir,
mode = BackupTransportMode.LOCAL,
)
}
}
โปรดคำนึงถึงสิ่งต่อไปนี้เมื่อกำหนดโดเมนพื้นที่เก็บข้อมูล
Preferenceจะใช้ชื่อของไฟล์SharedPreferencesโดยไม่มีนามสกุล.xmlDataStorePreferenceจะใช้ชื่อที่ส่งไปยังpreferencesDataStoreใช้ประเภท Kotlin เดียวกันสำหรับvalueเป็นคีย์ค่ากำหนดของแอป เช่น1.25fสำหรับfloatPreferencesKeyเพื่อให้แอปอ่านรายการที่กู้คืนได้TextFileและBinaryFileจะแปลง Relative Path ให้สอดคล้องกับfilesDirของแอปDatabaseจะเขียนแถวด้วย SQL และสร้างตารางที่มีคอลัมน์TEXTหากไม่มีตารางอยู่ หากแอปใช้ Room ให้ทดสอบเนื้อหาฐานข้อมูลด้วยการดำเนินการของอุปกรณ์ที่ใช้ DAO เพื่อให้ฐานข้อมูลตรงกับสคีมาของ RoomExcludedDataต้องมีโดเมนพื้นที่เก็บข้อมูลที่ไม่ได้รับการยกเว้นอย่างน้อย 1 โดเมนในการเรียกrunBackupRestoreFlowเดียวกันPreference,DataStorePreference,Database,TextFileและBinaryFileจะกำหนดเป้าหมายเป็นพื้นที่เก็บข้อมูลที่ได้รับการปกป้องของอุปกรณ์แทนพื้นที่เก็บข้อมูลเริ่มต้นของแอปเมื่อคุณตั้งค่าisDeviceProtectedStorage = true
เขียนการดำเนินการของอุปกรณ์
หากต้องการสร้างหรือยืนยันข้อมูลที่ประเภทพื้นที่เก็บข้อมูลในตัวไม่ครอบคลุม ให้เขียนการดำเนินการของอุปกรณ์ในชุดซอร์ส androidTest ของชุดทดสอบ ใช้ BackupDeviceAction และลบล้าง execute เพื่อเรียกใช้การดำเนินการด้วย Context ของแอปและอาร์กิวเมนต์จากการทดสอบโฮสต์ แสดงผล BackupDeviceActionResult ที่สร้างด้วย BackupDeviceActionResult.success หรือ BackupDeviceActionResult.failure โดยส่งข้อความแสดงข้อผิดพลาดไปยัง failure
เมธอด execute จะทำงานในกระบวนการของแอปในเทรดเบื้องหลัง จึงอาจบล็อกจนกว่าการอ่านและการเขียนจะเสร็จสิ้น หากต้องการเข้าถึงการวัดผลของ Test Runner เช่น UiAutomation ให้เรียกใช้ InstrumentationRegistry.getInstrumentation
ตัวอย่างต่อไปนี้จะสร้างและยืนยันการตั้งค่าธีมใน Proto DataStore โดยที่ settingsDataStore เป็นพร็อพเพอร์ตี้ DataStore<Settings> ที่กำหนดไว้ในแอปของคุณ
// In app/src/backupTest/androidTest/kotlin/com/example/myapp/ThemeActions.kt
package com.example.myapp
import android.content.Context
import androidx.test.backup.BackupDeviceAction
import androidx.test.backup.BackupDeviceActionArgs
import androidx.test.backup.BackupDeviceActionResult
import kotlinx.coroutines.flow.first
import kotlinx.coroutines.runBlocking
class SeedThemeAction : BackupDeviceAction {
override fun execute(
context: Context,
args: BackupDeviceActionArgs,
): BackupDeviceActionResult {
val theme = args["theme"]
?: return BackupDeviceActionResult.failure("Missing theme argument")
runBlocking {
context.settingsDataStore.updateData {
it.toBuilder().setTheme(theme).build()
}
}
return BackupDeviceActionResult.success()
}
}
class VerifyThemeAction : BackupDeviceAction {
override fun execute(
context: Context,
args: BackupDeviceActionArgs,
): BackupDeviceActionResult {
val expected = args["theme"]
val actual = runBlocking {
context.settingsDataStore.data.first().theme
}
return if (actual == expected) {
BackupDeviceActionResult.success()
} else {
BackupDeviceActionResult.failure("Expected $expected, found $actual")
}
}
}
หากต้องการเรียกใช้การดำเนินการป้อนข้อมูลและยืนยันใน runBackupRestoreFlow ให้ส่งชื่อคลาสไปยัง StorageDomain.CustomData ดังนี้
package com.example.myapp
import androidx.test.backup.host.BackupRestoreController
import androidx.test.backup.host.BackupRestoreExtension
import androidx.test.backup.host.BackupTransportMode
import androidx.test.backup.host.StorageDomain
import java.nio.file.Path
import kotlinx.coroutines.runBlocking
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.junit.jupiter.api.io.TempDir
const val SEED_THEME = "com.example.myapp.SeedThemeAction"
const val VERIFY_THEME = "com.example.myapp.VerifyThemeAction"
@ExtendWith(BackupRestoreExtension::class)
class ThemeBackupTest {
@Test
fun themeSurvivesCloudBackup(
device: BackupRestoreController,
@TempDir outputDir: Path,
): Unit = runBlocking {
device.runBackupRestoreFlow(
storage = StorageDomain.CustomData(
populateAction = SEED_THEME,
verifyAction = VERIFY_THEME,
args = mapOf("theme" to "dark"),
),
outputDir = outputDir,
mode = BackupTransportMode.CLOUD_ENCRYPTED,
)
}
}
หากต้องการส่งค่าที่สร้างขึ้นระหว่างการเริ่มต้นไปยังการดำเนินการยืนยัน ให้ส่งแผนที่ไปยัง BackupDeviceActionResult.success CustomData จะผสานรายการเหล่านั้นเข้ากับอาร์กิวเมนต์ของการดำเนินการยืนยัน
เรียกใช้แต่ละขั้นตอนของโฟลว์
หากต้องการปรับแต่งขั้นตอน เช่น เรียกใช้ uninstallApp และ installApk เพื่อทดสอบการอัปเกรด หรือเรียกใช้ launchApp ให้ทำตามขั้นตอนต่อไปนี้ด้วยตนเอง
package com.example.myapp
import androidx.test.backup.host.BackupRestoreController
import androidx.test.backup.host.BackupRestoreExtension
import androidx.test.backup.host.BackupTransportMode
import java.nio.file.Path
import kotlinx.coroutines.runBlocking
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.junit.jupiter.api.io.TempDir
@ExtendWith(BackupRestoreExtension::class)
class CustomFlowBackupTest {
@Test
fun themeSurvivesLaunchAfterRestore(
device: BackupRestoreController,
@TempDir outputDir: Path,
): Unit = runBlocking {
val args = mapOf("theme" to "dark")
device.runOnDevice(SEED_THEME, args).getOrThrow()
device.stopApp()
val backupFile = device.performBackup(
BackupTransportMode.CLOUD_ENCRYPTED,
outputDir,
)
device.clearAppData()
device.performRestore(backupFile)
device.launchApp()
device.runOnDevice(VERIFY_THEME, args).getOrThrow()
}
}
เมื่อการดำเนินการของอุปกรณ์ล้มเหลว runOnDevice จะแสดงผล BackupActionResult.Failure แทนการแสดงข้อยกเว้น
เรียกใช้ getOrThrow เพื่อรับแผนที่ data ที่แสดงผลเมื่อสำเร็จ หรือแสดง IOException เมื่อไม่สำเร็จ
ทดสอบการโอนระหว่างอุปกรณ์
หากต้องการทดสอบการโอนระหว่างอุปกรณ์ 2 เครื่อง ให้ประกาศพารามิเตอร์ BackupRestoreController สำหรับอุปกรณ์แต่ละเครื่อง และส่งอุปกรณ์เป้าหมายไปยัง restoreOn ใน runBackupRestoreFlow ดังนี้
package com.example.myapp
import androidx.test.backup.host.BackupRestoreController
import androidx.test.backup.host.BackupRestoreExtension
import androidx.test.backup.host.BackupTransportMode
import androidx.test.backup.host.Device
import androidx.test.backup.host.StorageDomain
import java.nio.file.Path
import kotlinx.coroutines.runBlocking
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.junit.jupiter.api.io.TempDir
@ExtendWith(BackupRestoreExtension::class)
class ThemeTransferTest {
@Test
fun themeTransfersToNewDevice(
@Device(role = "source") source: BackupRestoreController,
@Device(role = "target") target: BackupRestoreController,
@TempDir outputDir: Path,
): Unit = runBlocking {
source.runBackupRestoreFlow(
storage = StorageDomain.DataStorePreference(
dataStoreName = "settings",
key = "theme",
value = "dark",
),
outputDir = outputDir,
mode = BackupTransportMode.DEVICE_TO_DEVICE,
restoreOn = target,
)
}
}
ใน source ขั้นตอนจะเริ่มต้นและสำรองข้อมูลแอป ใน target ขั้นตอนจะล้างข้อมูลแอป กู้คืนข้อมูลสำรอง และยืนยันข้อมูล การกู้คืนในอุปกรณ์อื่นต้องใช้ DEVICE_TO_DEVICE หรือโหมดการโอนผ่านระบบคลาวด์ เนื่องจากข้อมูลสำรองของ LOCAL จะยังคงอยู่ในอุปกรณ์ต้นทาง
ค่า role ของ @Device ช่วยให้คุณเลือกอุปกรณ์สำหรับพารามิเตอร์แต่ละรายการได้เมื่อทำการทดสอบ หากเชื่อมต่ออุปกรณ์ที่ตรงกันเพียงเครื่องเดียว พารามิเตอร์ทั้งสองจะใช้อุปกรณ์นั้นร่วมกันและจำลองการโอนในอุปกรณ์เครื่องเดียว
เลือกอุปกรณ์
โดยค่าเริ่มต้น เฟรมเวิร์กการทดสอบจะจัดเรียงอุปกรณ์ออนไลน์ตามหมายเลขซีเรียลและกำหนดพารามิเตอร์ BackupRestoreController แต่ละรายการให้กับอุปกรณ์ที่ตรงกันเมื่อมีอุปกรณ์เชื่อมต่อเพียงพอ พารามิเตอร์ที่ไม่สามารถรับอุปกรณ์แยกต่างหากจะแชร์อุปกรณ์ที่ตรงกันเครื่องแรก ตัวแปรสภาพแวดล้อม ANDROID_SERIAL ไม่มีผลต่อการมอบหมายอุปกรณ์
หากต้องการเลือกอุปกรณ์โดยไม่ใส่หมายเลขซีเรียลในการทดสอบ ให้กำหนดบทบาทให้พารามิเตอร์อุปกรณ์แต่ละรายการด้วย @Device(role = "...") จากนั้นเมื่อคุณทำการทดสอบ ให้เชื่อมโยงแต่ละบทบาทกับอุปกรณ์ด้วยพร็อพเพอร์ตี้ระบบ androidx.test.backup.device.serial.{role} ตัวอย่างเช่น คำสั่งต่อไปนี้จะเรียกใช้ชุดทดสอบโดยมี emulator-5554 เป็นอุปกรณ์ต้นทางและ emulator-5556 เป็นอุปกรณ์เป้าหมาย
./gradlew :app:testDebugBackupTestDefaultTestSuite -Dandroidx.test.backup.device.serial.source=emulator-5554 -Dandroidx.test.backup.device.serial.target=emulator-5556การเชื่อมโยงจะมีผลกับพารามิเตอร์ที่มีบทบาทนั้นเท่านั้น พารามิเตอร์อื่นๆ จะได้รับอุปกรณ์ที่ตรงกันที่เหลืออยู่
นอกจากนี้ คุณยังกรองอุปกรณ์ที่มี serial, api, minApi และ maxApi ใน @Device ได้ เช่น @Device(role = "target", minApi = 35) หากต้องการตั้งค่าหมายเลขซีเรียลหรือระดับ API ที่แน่นอนจากบรรทัดคำสั่ง ให้ส่งพร็อพเพอร์ตี้ระบบต่อไปนี้ด้วย -D
| พร็อพเพอร์ตี้ของระบบ | คำอธิบาย |
|---|---|
androidx.test.backup.device.serial.{role} |
หมายเลขซีเรียลของอุปกรณ์สำหรับพารามิเตอร์ที่มีคำอธิบายประกอบ @Device(role = "{role}") มีความสำคัญเหนือ serials, serial และค่า serial ของ @Device |
androidx.test.backup.device.serials |
รายการที่คั่นด้วยคอมมาของหมายเลขซีเรียล ซึ่งกำหนดให้กับพารามิเตอร์อุปกรณ์ตามลำดับ มีความสำคัญเหนือ serial และค่า serial ของ @Device |
androidx.test.backup.device.serial |
หมายเลขซีเรียลสำหรับพารามิเตอร์อุปกรณ์ที่ serials ไม่ครอบคลุม มีความสำคัญเหนือกว่าค่า serial ของ @Device |
androidx.test.backup.device.apis |
รายการระดับ API ที่คั่นด้วยคอมมา ซึ่งกำหนดให้กับพารามิเตอร์อุปกรณ์ตามลำดับ ใช้ 0 เพื่อจับคู่กับระดับ API ใดก็ได้ แทนที่ api ในวันที่ @Device ภายใน minApi และ maxApi |
androidx.test.backup.device.api |
ระดับ API สำหรับพารามิเตอร์อุปกรณ์ที่ apis ไม่ครอบคลุม ใช้ 0 เพื่อจับคู่กับระดับ API ใดก็ได้ แทนที่ api ในวันที่ @Device ภายใน minApi และ maxApi |
พร็อพเพอร์ตี้ serial, serials, api และ apis จะมีผลกับการทดสอบทุกรายการที่ทำงาน ดังนั้นให้ใช้ตัวเลือก --tests เพื่อเรียกใช้เฉพาะการทดสอบที่ต้องการพร็อพเพอร์ตี้ดังกล่าว
ทดสอบการกู้คืนข้อมูลเข้าสู่ระบบ
หากแอปใช้ Restore Credentials ให้ทดสอบว่าคีย์การกู้คืนยังคงอยู่หลังจากการสำรองและกู้คืนข้อมูล โหมดคลาวด์และโหมดอุปกรณ์ต่ออุปกรณ์จะสำรองคีย์ไว้กับข้อมูลของแอป แต่ LOCAL จะไม่สำรอง
เขียนการดำเนินการของอุปกรณ์ที่สร้างคีย์และรับคีย์ด้วย Credential Manager การดำเนินการสร้างจะแสดงรหัสข้อมูลเข้าสู่ระบบของคีย์ เพื่อให้การดำเนินการยืนยันสามารถตรวจสอบได้ว่าการกู้คืนจะนำคีย์เดิมกลับมา ในตัวอย่างนี้ createRequestJson และ getRequestJson คือสตริง JSON ของคำขอที่แอปส่งไปยัง Credential Manager
// In app/src/backupTest/androidTest/kotlin/com/example/myapp/RestoreKeyActions.kt
package com.example.myapp
import android.content.Context
import androidx.credentials.CreateRestoreCredentialRequest
import androidx.credentials.CreateRestoreCredentialResponse
import androidx.credentials.CredentialManager
import androidx.credentials.GetCredentialRequest
import androidx.credentials.GetRestoreCredentialOption
import androidx.credentials.RestoreCredential
import androidx.test.backup.BackupDeviceAction
import androidx.test.backup.BackupDeviceActionArgs
import androidx.test.backup.BackupDeviceActionResult
import kotlinx.coroutines.runBlocking
import org.json.JSONObject
class CreateRestoreKeyAction : BackupDeviceAction {
override fun execute(
context: Context,
args: BackupDeviceActionArgs,
): BackupDeviceActionResult {
val request = CreateRestoreCredentialRequest(createRequestJson)
val response = runBlocking {
CredentialManager.create(context).createCredential(context, request)
} as CreateRestoreCredentialResponse
val credentialId = JSONObject(response.responseJson).getString("id")
return BackupDeviceActionResult.success(mapOf("credential_id" to credentialId))
}
}
class VerifyRestoreKeyAction : BackupDeviceAction {
override fun execute(
context: Context,
args: BackupDeviceActionArgs,
): BackupDeviceActionResult {
val option = GetRestoreCredentialOption(getRequestJson)
val response = runBlocking {
CredentialManager.create(context)
.getCredential(context, GetCredentialRequest(listOf(option)))
}
val credential = response.credential as RestoreCredential
val credentialId = JSONObject(credential.authenticationResponseJson).getString("id")
val expected = args["credential_id"]
return if (credentialId == expected) {
BackupDeviceActionResult.success()
} else {
BackupDeviceActionResult.failure("Expected key $expected, found $credentialId")
}
}
}
การทดสอบโฮสต์ต่อไปนี้จะสร้างคีย์ในอุปกรณ์ต้นทาง กู้คืนคีย์ในอุปกรณ์เป้าหมาย และยืนยันว่ารหัสข้อมูลเข้าสู่ระบบตรงกัน
package com.example.myapp
import androidx.test.backup.host.BackupRestoreController
import androidx.test.backup.host.BackupRestoreExtension
import androidx.test.backup.host.BackupTransportMode
import androidx.test.backup.host.Device
import androidx.test.backup.host.StorageDomain
import java.nio.file.Path
import kotlinx.coroutines.runBlocking
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import org.junit.jupiter.api.io.TempDir
const val CREATE_RESTORE_KEY = "com.example.myapp.CreateRestoreKeyAction"
const val VERIFY_RESTORE_KEY = "com.example.myapp.VerifyRestoreKeyAction"
@ExtendWith(BackupRestoreExtension::class)
class RestoreKeyTest {
@Test
fun restoreKeyTransfersToNewDevice(
@Device(role = "source") source: BackupRestoreController,
@Device(role = "target") target: BackupRestoreController,
@TempDir outputDir: Path,
): Unit = runBlocking {
// Clears target (including any existing restore key) before restoring.
source.runBackupRestoreFlow(
storage = StorageDomain.CustomData(
populateAction = CREATE_RESTORE_KEY,
verifyAction = VERIFY_RESTORE_KEY,
),
outputDir = outputDir,
mode = BackupTransportMode.DEVICE_TO_DEVICE,
restoreOn = target,
)
}
}
หากต้องการสร้างคีย์โดยตั้งค่า isCloudBackupEnabled เป็น true ซึ่งเป็นค่าเริ่มต้น อุปกรณ์ต้นทางต้องมีบัญชี Google ที่เปิดการสำรองข้อมูลไว้และมีการล็อกหน้าจอ
ไม่เช่นนั้น Credential Manager จะแสดงข้อผิดพลาด E2eeUnavailableException
โหมดระบบคลาวด์ไม่จำเป็นต้องใช้บัญชี Google เดียวกันหรือการล็อกหน้าจอของอุปกรณ์ต้นทางเหมือนกับการกู้คืนในระบบคลาวด์ในอุปกรณ์ใหม่ และโหมดเหล่านี้จะกู้คืนคีย์ที่สร้างขึ้นโดยตั้งค่า isCloudBackupEnabled เป็น false
เก็บข้อมูลแอปไว้ระหว่างการทดสอบ
ก่อนการทดสอบแต่ละครั้ง เฟรมเวิร์กการทดสอบจะล้างข้อมูลของแอปในอุปกรณ์แต่ละเครื่องที่ใช้ทดสอบ หากต้องการปิดฟีเจอร์นี้สำหรับคลาสหรือเมธอดทดสอบ ให้ใส่คำอธิบายประกอบด้วย @Isolation(IsolationPolicy.MANUAL)
เขียนการทดสอบใน Java
เมธอด BackupRestoreController เป็นฟังก์ชันระงับของ Kotlin หากคุณเขียนการทดสอบโฮสต์ใน Java ให้ใช้ตัวแปร Async ของแต่ละเมธอด เช่น runBackupRestoreFlowAsync ซึ่งจะแสดงผล ListenableFuture
เรียกใช้การทดสอบการสำรองและกู้คืนข้อมูล
AGP จะสร้างงาน Gradle สำหรับแต่ละตัวแปรที่ชุดทดสอบ โดยตั้งชื่อว่า test{Variant}{SuiteName}DefaultTestSuite หากต้องการเรียกใช้ชุด backupTest กับตัวแปร debug ให้เชื่อมต่ออุปกรณ์และเรียกใช้งานต่อไปนี้
./gradlew :app:testDebugBackupTestDefaultTestSuiteงาน check, test และ connectedCheck ไม่ได้เรียกใช้ชุดโปรแกรมทดสอบการสำรองและกู้คืนข้อมูล ดังนั้นให้เรียกใช้งานของชุดโปรแกรมอย่างชัดเจน
หากต้องการเรียกใช้คลาสหรือเมธอดการทดสอบรายการเดียว ให้ใช้ตัวเลือก --tests ดังนี้
./gradlew :app:testDebugBackupTestDefaultTestSuite --tests "com.example.myapp.ThemeBackupTest"ตรวจสอบรายงานการทดสอบ
หลังจากที่การทดสอบเสร็จสมบูรณ์ AGP จะสร้างรายงานการทดสอบ HTML ที่ {module}/build/reports/tests/{taskName}/index.html เช่น app/build/reports/tests/testDebugBackupTestDefaultTestSuite/index.html
เมื่อการทดสอบไม่สำเร็จ เฟรมเวิร์กการทดสอบจะบันทึก Logcat จากอุปกรณ์แต่ละเครื่องที่การทดสอบใช้ และแสดงรายการเส้นทางไฟล์ที่บันทึกไว้ในเอาต์พุตความล้มเหลว หากต้องการปิดการบันทึก ให้ส่ง -Dandroidx.test.backup.device.logs.enabled=false
แก้ปัญหาการกู้คืนที่ล้มเหลว
การกู้คืนข้อมูลในระบบคลาวด์หรือการโอนจากอุปกรณ์เครื่องหนึ่งไปยังอีกเครื่องจะล้มเหลวพร้อมข้อความแสดงข้อผิดพลาดในกรณีต่อไปนี้
- บริการ Google Play ข้ามแอปของคุณ เช่น เนื่องจากรหัสแอปพลิเคชันขึ้นต้นด้วย
com.google.หรือcom.android., ข้อมูลสำรองว่างเปล่า หรือมีการตั้งค่าandroid:allowBackup="false"หากต้องการทดสอบแอปที่มีรหัสแอปพลิเคชันดังกล่าว ให้ใช้โหมดLOCAL - บริการ Google Play มีเวอร์ชันต่ำกว่า 26.33.30 ในอุปกรณ์หรือโปรแกรมจำลองที่ใช้ API ระดับ 36.1 ขึ้นไป อัปเดตบริการ Google Play ผ่าน Play Store ในอุปกรณ์ หรือใช้อิมเมจระบบที่มาพร้อมกับเวอร์ชัน 26.33.30 ขึ้นไป
ปัญหาและข้อจำกัดที่ทราบ
การทดสอบการสำรองและกู้คืนข้อมูลอัตโนมัติมีปัญหาที่ทราบและข้อจำกัดดังต่อไปนี้
- Android Studio ยังไม่รองรับชุดโปรแกรมทดสอบ ตัวแก้ไขโค้ดอาจแสดงข้อผิดพลาดการอ้างอิงที่ยังไม่ได้รับการแก้ไขในไฟล์ต้นฉบับของชุดโปรแกรมทดสอบ แม้ว่าคุณจะกำหนดค่าโปรเจ็กต์อย่างถูกต้องแล้วก็ตาม สร้างและเรียกใช้การทดสอบการสำรองและกู้คืนข้อมูลจากบรรทัดคำสั่งโดยใช้ Gradle แทน
- การทดสอบจะทำงานในอุปกรณ์และโปรแกรมจำลองที่เชื่อมต่อกับคอมพิวเตอร์สำหรับการพัฒนาซอฟต์แวร์ผ่าน adb เท่านั้น ไม่รองรับ Firebase Test Lab
- การทดสอบจะล้างข้อมูลของแอปและเปลี่ยนการตั้งค่าการสำรองข้อมูลในอุปกรณ์ที่ใช้ เราขอแนะนำให้ใช้อุปกรณ์ทดสอบโดยเฉพาะ
ดูการเปลี่ยนแปลงในแต่ละรุ่นได้ที่บันทึกประจำรุ่นของการทดสอบการสำรองและกู้คืนข้อมูล