사용자가 새 기기를 설정하거나 앱을 재설치할 때 Android는 클라우드 백업 또는 기기 간 전송을 통해 앱 데이터를 복원할 수 있습니다. 백업 규칙에서 중요한 데이터를 제외하거나 앱이 복원하는 데이터를 사용할 수 없는 경우 사용자는 오류를 보지 않고 설정과 진행 상황을 잃게 됩니다.
자동 백업 및 복원 테스트를 사용하면 앱을 출시하기 전에 이러한 문제를 포착할 수 있습니다. 이 테스트는 개발 머신에서 실행되고 Android 디버그 브리지(adb)를 통해 연결된 기기를 제어하는 JUnit 5 테스트입니다. 각 테스트는 기기에 앱 데이터를 시드하고 Android 백업 프레임워크를 통해 앱을 백업 및 복원한 다음 데이터가 손상되지 않았는지 확인합니다. 모듈의 빌드 파일에서 테스트를 Android Gradle 플러그인(AGP) 테스트 모음으로 구성합니다.
작동 방식
백업 및 복원 테스트 모음에는 함께 작동하는 두 부분이 있습니다.
- 호스트 테스트는 개발 머신에서 실행되는 JUnit 5 테스트입니다. 각 기기에
BackupRestoreController를 사용하여 데이터를 시드하고 앱을 백업 및 복원하며 결과를 확인합니다. - 기기 작업은
BackupDeviceAction를 구현하는 클래스입니다. 기기에서 앱의 프로세스로 실행되므로 앱의 자체 코드를 통해 데이터를 읽고 쓸 수 있습니다. 호스트 테스트는 클래스 이름으로 기기 작업을 호출합니다.
이 모음을 실행하면 AGP가 앱과 기기 작업이 포함된 테스트 APK를 빌드합니다. 테스트 프레임워크는 테스트에서 사용하는 각 기기에 두 APK를 모두 설치하고 각 테스트 전에 앱의 데이터를 삭제합니다.
기본 제공 스토리지 유형
다음 표에는 기기 작업을 작성하지 않고도 데이터를 시드하고 확인할 수 있는 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 스튜디오의 Backup App Data 작업과 동일한 백업을 만듭니다. 백업은 업로드되거나 다른 기기로 전송되는 대신 개발 머신에 저장됩니다. 클라우드 및 기기 간 모드를 사용하려면 기기에 Google Play 서비스가 있고 앱의 디버그 가능한 빌드가 있어야 합니다. 백업 규칙이 클라이언트 측 암호화에 종속되는 경우 두 클라우드 모드를 모두 테스트하세요.
요구사항
자동 백업 및 복원 테스트를 사용하려면 환경이 다음 요구사항을 충족하는지 확인하세요.
- Gradle 버전 9.6.0 이상
- JDK 버전 17 이상
- adb를 통해 연결된 Android 12(API 수준 31) 이상을 실행하는 기기 또는 에뮬레이터:
- API 수준 36.1 이상의 기기 또는 에뮬레이터에는 Google Play 서비스 버전 26.33.30 이상이 필요합니다.
- 두 기기 간의 전송을 테스트하려면 두 기기를 연결하세요.
호환성
다음 표에는 자동 백업 및 복원 테스트의 최소 버전과 권장 버전이 나와 있습니다.
| 구성요소 | 최소 버전 | 권장 버전 |
|---|---|---|
| Android 스튜디오 | 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 스튜디오 프리뷰 버전이 필요합니다. 자세한 내용은 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를 사용하여 AGP가 모음에 추가하는androidx.test.backup라이브러리(예:"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의 계측 실행기를 설정합니다.
다른 종속 항목을 추가하려면 도구 모음의 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) 주석을 답니다. 이 주석은 연결된 기기를 테스트에 제공합니다. 테스트는 도구 모음이 타겟팅하는 앱 변형에 대해 실행되므로 애플리케이션 ID를 설정할 필요가 없습니다.
각 테스트 메서드는 사용하는 각 기기의 BackupRestoreController 매개변수를 선언합니다.
기본 제공 저장소 유형 테스트
기본 제공 저장소 유형을 테스트하려면 시드할 데이터, 백업 파일의 디렉터리, 전송 모드를 사용하여 runBackupRestoreFlow를 호출합니다. 이 메서드는 기기에서 다음 단계를 실행합니다.
- 각 스토리지 도메인을 시드합니다.
- 앱을 중지합니다.
- 앱을 백업합니다.
- 앱의 데이터를 삭제합니다.
- 백업을 복원합니다.
- 각 저장소 도메인에 시드 값이 있는지 또는
StorageDomain.ExcludedData로 래핑된 경우 없는지 확인합니다.
단계가 실패하면 메서드에서 예외가 발생하여 테스트가 실패합니다. 다음 예에서는 로컬 백업 전송을 사용하여 SharedPreferences, 환경설정 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은.xml확장자가 없는SharedPreferences파일의 이름을 사용합니다.DataStorePreference는preferencesDataStore에 전달된 이름을 사용합니다. 앱이 복원된 항목을 읽을 수 있도록value에 앱의 환경설정 키와 동일한 Kotlin 유형(예:floatPreferencesKey의 경우1.25f)을 사용합니다.TextFile및BinaryFile는 앱의filesDir에 대한 상대 경로를 확인합니다.Database는 SQL로 행을 작성하고 테이블이 없으면TEXT열로 테이블을 만듭니다. 앱에서 Room을 사용하는 경우 DAO를 사용하는 기기 작업으로 데이터베이스 콘텐츠를 테스트하여 데이터베이스가 Room의 스키마와 일치하도록 합니다.ExcludedData에는 동일한runBackupRestoreFlow호출에 제외되지 않은 저장소 도메인이 하나 이상 필요합니다.isDeviceProtectedStorage = true를 설정하면Preference,DataStorePreference,Database,TextFile,BinaryFile는 앱의 기본 저장소 대신 기기 보호 저장소를 타겟팅합니다.
기기 작업 작성
기본 제공 저장소 유형에서 다루지 않는 데이터를 시드하거나 확인하려면 도구 모음의 androidTest 소스 세트에 기기 작업을 작성합니다. BackupDeviceAction를 구현하고 execute를 재정의하여 앱의 Context 및 호스트 테스트의 인수로 작업을 실행합니다. BackupDeviceActionResult.success 또는 BackupDeviceActionResult.failure로 생성된 BackupDeviceActionResult를 반환하여 오류 메시지를 failure에 전달합니다.
execute 메서드는 백그라운드 스레드의 앱 프로세스에서 실행되므로 읽기 및 쓰기가 완료될 때까지 차단할 수 있습니다. 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를 발생시킵니다.
기기 간 전송 테스트
두 기기 간의 전송을 테스트하려면 각 기기의 BackupRestoreController 매개변수를 선언하고 대상 기기를 runBackupRestoreFlow의 restoreOn에 전달합니다.
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 백업 데이터가 소스 기기에 남아 있기 때문입니다.
@Device의 role 값을 사용하면 테스트를 실행할 때 각 매개변수의 기기를 선택할 수 있습니다. 일치하는 기기가 하나만 연결된 경우 두 매개변수는 해당 기기를 공유하고 단일 기기에서 전송을 시뮬레이션합니다.
기기 선택
기본적으로 테스트 프레임워크는 온라인 기기를 일련번호별로 정렬하고 충분한 기기가 연결되면 각 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바인딩은 해당 역할이 있는 매개변수에만 적용됩니다. 다른 매개변수는 나머지 일치하는 기기를 가져옵니다.
@Device에서 serial, api, minApi, maxApi를 사용하여 기기를 필터링할 수도 있습니다(예: @Device(role = "target", minApi = 35)). 명령줄에서 일련번호 또는 정확한 API 수준을 설정하려면 -D를 사용하여 다음 시스템 속성을 전달합니다.
| 시스템 속성 | 설명 |
|---|---|
androidx.test.backup.device.serial.{role} |
@Device(role = "{role}")로 주석이 달린 매개변수의 기기 일련번호입니다. serials, serial, @Device의 serial 값보다 우선 적용됩니다. |
androidx.test.backup.device.serials |
기기 매개변수에 순서대로 할당된 일련번호의 쉼표로 구분된 목록입니다. serial 및 @Device의 serial 값보다 우선 적용됩니다. |
androidx.test.backup.device.serial |
serials에서 다루지 않는 기기 매개변수의 일련번호입니다. @Device의 serial 값보다 우선 적용됩니다. |
androidx.test.backup.device.apis |
기기 매개변수에 순서대로 할당된 API 수준의 쉼표로 구분된 목록입니다. 0를 사용하여 모든 API 수준을 일치시킵니다. minApi 및 maxApi 내에서 @Device의 api를 대체합니다. |
androidx.test.backup.device.api |
apis에서 다루지 않는 기기 매개변수의 API 수준입니다. 0를 사용하여 모든 API 수준을 일치시킵니다. minApi 및 maxApi 내에서 @Device의 api를 대체합니다. |
serial, serials, api, apis 속성은 실행되는 모든 테스트에 적용되므로 --tests 옵션을 사용하여 필요한 테스트만 실행합니다.
사용자 인증 정보 복원 테스트
앱에서 사용자 인증 정보 복원을 사용하는 경우 복원 키가 백업 및 복원 후에도 유지되는지 테스트합니다. 클라우드 및 기기 간 모드는 앱 데이터와 함께 키를 백업하지만 LOCAL는 백업하지 않습니다.
키를 만들고 인증 관리자로 키를 가져오는 기기 작업을 작성합니다. 생성 작업은 키의 사용자 인증 정보 ID를 반환하므로 확인 작업에서 복원이 동일한 키를 다시 가져오는지 확인할 수 있습니다. 이 예에서 createRequestJson 및 getRequestJson은 앱이 인증 관리자에 전달하는 요청 JSON 문자열입니다.
// 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")
}
}
}
다음 호스트 테스트는 소스 기기에서 키를 만들고 대상 기기에서 복원하며 사용자 인증 정보 ID가 일치하는지 확인합니다.
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 계정과 화면 잠금이 있어야 합니다.
그렇지 않으면 인증 관리자가 E2eeUnavailableException를 발생시킵니다.
새 기기에서 클라우드 복원과 달리 클라우드 모드에는 동일한 Google 계정이나 소스 기기의 화면 잠금이 필요하지 않으며 isCloudBackupEnabled가 false로 설정된 상태에서 생성된 키를 복원합니다.
테스트 간 앱 데이터 유지
각 테스트 전에 테스트 프레임워크는 테스트에서 사용하는 각 기기의 앱 데이터를 삭제합니다. 테스트 클래스 또는 메서드에서 이 기능을 사용 중지하려면 @Isolation(IsolationPolicy.MANUAL)로 주석을 지정합니다.
Java로 테스트 작성
BackupRestoreController 메서드는 Kotlin 정지 함수입니다. 자바로 호스트 테스트를 작성하는 경우 ListenableFuture를 반환하는 각 메서드의 Async 변형(예: runBackupRestoreFlowAsync)을 사용합니다.
백업 및 복원 테스트 실행
AGP는 테스트 모음이 테스트하는 각 변형에 대해 test{Variant}{SuiteName}DefaultTestSuite라는 Gradle 작업을 만듭니다. debug 변형에 대해 backupTest 도구 모음을 실행하려면 기기를 연결하고 작업을 실행합니다.
./gradlew :app:testDebugBackupTestDefaultTestSuitecheck, test, connectedCheck 태스크는 백업 및 복원 테스트 모음을 실행하지 않으므로 모음의 태스크를 명시적으로 실행합니다.
단일 테스트 클래스 또는 메서드를 실행하려면 --tests 옵션을 사용합니다.
./gradlew :app:testDebugBackupTestDefaultTestSuite --tests "com.example.myapp.ThemeBackupTest"테스트 보고서 검사
테스트 실행이 완료되면 AGP는 {module}/build/reports/tests/{taskName}/index.html(예: app/build/reports/tests/testDebugBackupTestDefaultTestSuite/index.html)에 HTML 테스트 보고서를 생성합니다.
테스트가 실패하면 테스트 프레임워크는 테스트에 사용된 각 기기의 logcat을 저장하고 실패 출력에 저장된 파일 경로를 나열합니다. 로그 저장을 사용 중지하려면 -Dandroidx.test.backup.device.logs.enabled=false를 전달합니다.
복원 실패 문제 해결하기
다음과 같은 경우 클라우드 또는 기기 간 복원이 오류 메시지와 함께 실패합니다.
- Google Play 서비스가 앱을 건너뜁니다. 예를 들어 애플리케이션 ID가
com.google.또는com.android.로 시작하거나 백업이 비어 있거나android:allowBackup="false"를 설정하기 때문입니다. 이러한 애플리케이션 ID로 앱을 테스트하려면LOCAL모드를 사용하세요. - API 수준 36.1 이상을 실행하는 기기 또는 에뮬레이터에서 Google Play 서비스 버전이 26.33.30보다 낮습니다. 기기의 Play 스토어를 통해 Google Play 서비스를 업데이트하거나 버전 26.33.30 이상과 함께 제공되는 시스템 이미지를 사용하세요.
알려진 문제 및 제한사항
자동 백업 및 복원 테스트에는 다음과 같은 알려진 문제 및 제한사항이 있습니다.
- 테스트 모음에 대한 Android 스튜디오 지원은 아직 제공되지 않습니다. 프로젝트가 올바르게 구성된 경우에도 코드 편집기에서 테스트 모음 소스 파일에 확인되지 않은 참조 오류가 표시될 수 있습니다. 대신 Gradle을 사용하여 명령줄에서 백업 및 복원 테스트를 빌드하고 실행합니다.
- 테스트는 adb를 통해 개발 머신에 연결된 기기 및 에뮬레이터에서만 실행됩니다. Firebase Test Lab은 지원되지 않습니다.
- 테스트는 앱의 데이터를 지우고 사용하는 기기의 백업 설정을 변경합니다. 전용 테스트 기기를 사용하는 것이 좋습니다.
각 출시의 변경사항은 백업 및 복원 테스트 출시 노트를 참고하세요.