このページは Cloud Translation API によって翻訳されました。

バックアップと復元をテストする

このページでは、アプリのクラウドバックアップとデバイス間（D2D）転送プロセスをテストする方法について説明します。ユーザーが新しいデバイスでアプリを引き続き使用できるようにするには、アプリのメジャーリリースごとにこれらの両方をテストすることが重要です。バックアップと転送はどちらも似ていますが、Android 12（API レベル 31）以降では、両者の間に重要な違いがあります。特に、転送のデータサイズの上限は 2 GB と、クラウドバックアップの 25 MB と比べて大幅に大きくなっています。

このガイドでは、開発サイクル全体でクラウドのバックアップと復元、D2D 転送の両方を効率的にテストする方法について説明します。

バックアップのテストの仕組み

このセクションでは、Android バックアップフレームワークのさまざまな要素と、それらが自動バックアップと Key-Value バックアップをサポートするアプリとどのようにやり取りするかを説明します。アプリ開発段階では、フレームワークの内部作業のほとんどが抽象化されているため、このような情報を知る必要はありません。ただし、テスト段階では、こうした概念を理解することがより重要になります。

次の図は、クラウドのバックアップと復元時のデータの流れを示しています。テスト目的では、クラウドのバックアップと復元に同じデバイスを使用できます。

バックアップフレームワークのデータフロー

次の図は、D2D 転送中のデータフローを説明しています。

転送フレームワークのデータフロー

クラウドのバックアップと復元のテストとは異なり、D2D テストでは、コピー元とコピー先のソースデバイスとターゲットデバイスが必要です。

バックアップマネージャーサービスは、バックアップと復元処理を調整および開始する Android システムサービスです。このサービスには Backup Manager API でアクセスできます。

バックアップ処理中、このサービスはアプリにバックアップデータをクエリしてバックアップトランスポートに渡します。データはバックアップトランスポートによってクラウドにアーカイブされます。復元オペレーション中に、Backup Manager サービスはバックアップトランスポートからバックアップデータを取得し、デバイスに復元します。D2D 転送の場合、バックアップマネージャーサービスはアプリにバックアップデータをクエリし、新しいデバイスのバックアップマネージャーサービスに直接渡します。このサービスは、アプリにデータを読み込みます。

バックアップトランスポートは、アプリデータの保存と取得を行う Android コンポーネントです。Android 搭載デバイスには 0 個以上のバックアップトランスポートを含めることができますが、アクティブとしてマークできるのは 1 つだけです。デバイスメーカーやサービスプロバイダによるカスタマイズにより、利用できるバックアップトランスポートはデバイスによって異なる場合がありますが、ほとんどの Google Play 対応デバイスには次のトランスポートが付属しています。

GMS トランスポート: ほとんどのデバイスでアクティブなクラウドバックアップトランスポート。Google モバイルサービスの一部です。このトランスポートは、データを Android Backup Service に保存します。
D2D トランスポート: このトランスポートは、D2D 移行でデバイス間でデータを直接転送するために使用されます。

ツール

バックアップと復元処理をテストするには、以下のツールに関する知識が少々必要です。

adb: デバイスまたはエミュレータでコマンドを実行します。
bmgr: さまざまなバックアップと復元オペレーションを実行します。
logcat: バックアップオペレーションと復元オペレーションの出力を確認します。

クラウドバックアップをテストする

このセクションの手順に沿って、単一のデバイスを使用して Cloud のバックアップと復元を行うことができます。

クラウドバックアップ用にデバイスやエミュレータを準備する

次のチェックリストを確認して、バックアップテスト用のデバイスまたはエミュレータを準備します。

自動バックアップの場合は、Android 6.0（API レベル 23）以降を搭載しているデバイスまたはエミュレータを使用していることを確認します。
Key-Value バックアップの場合は、Android 2.2（API レベル 8）以降を搭載したデバイスまたはエミュレータを使用していることを確認します。
クラウドバックアップをテストするには、インターネットに接続している必要があります。
Google アカウントでデバイスにログインし、[設定] -> [Google] -> [バックアップ] でデバイスをバックアップアカウントとして設定します。

クラウドバックアップをテストするには、クラウドバックアップをトリガーし、アプリをアンインストールしてから再インストールします。これらの手順を繰り返すには、test_cloud_backup.sh スクリプトを使用します。このスクリプトは、アプリをバックアップし、APK をローカルにダウンロードし、アンインストールして、APK を再インストールします。

#!/bin/bash -eu
: "${1?"Usage: $0 package name"}"

# Initialize and create a backup
adb shell bmgr enable true
adb shell bmgr transport com.android.localtransport/.LocalTransport | grep -q "Selected transport" || (echo "Error: error selecting local transport"; exit 1)
adb shell settings put secure backup_local_transport_parameters 'is_encrypted=true'
adb shell bmgr backupnow "$1" | grep -F "Package $1 with result: Success" || (echo "Backup failed"; exit 1)

# Uninstall and reinstall the app to clear the data and trigger a restore
apk_path_list=$(adb shell pm path "$1")
OIFS=$IFS
IFS=$'\n'
apk_number=0
for apk_line in $apk_path_list
do
    (( ++apk_number ))
    apk_path=${apk_line:8:1000}
    adb pull "$apk_path" "myapk${apk_number}.apk"
done
IFS=$OIFS
adb shell pm uninstall --user 0 "$1"
apks=$(seq -f 'myapk%.f.apk' 1 $apk_number)
adb install-multiple -t --user 0 $apks

# Clean up
adb shell bmgr transport com.google.android.gms/.backup.BackupTransportService
rm $apks

echo "Done"

テスト手順

アプリを開いてログインし、すべての設定を変更します。
パッケージ名（test_cloud_backup.sh com.example.myapp など）を渡してスクリプトを実行します。
アプリを再び開き、すべてのデータが保持された状態で正常に動作することを確認します。

ユーザーがログインする必要はなく、すべての設定、進行状況、アプリデータが以前と同じである必要があります。テスト結果がこれらの条件を満たしていない場合は、重要なデータを省略することなくバックアップを正しく構成していること、およびバックアップから除外したキャッシュデータの再作成も処理していることを確認してください。テストの反復処理ごとに手順 1 ～ 3 を繰り返します。

D2D 転送をテストする

D2D 転送を最も包括的にテストする方法は、スマートフォンのコンテンツ全体を新しい出荷時の設定のデバイスに転送し、正しく動作することを確認することです。ただし、このプロセスを複数回繰り返す必要がある場合は、不便で時間がかかります。以下の手順では、デバイスを出荷時の設定にリセットしなくても、1 台のデバイスで移行をシミュレートする方法について説明します。

D2D テスト用にデバイスを準備する

1 台のデバイスで D2D 転送をテストするには、次のように準備します。

デバイスに Android 12（API レベル 31）以降が搭載されていること。
D2D の最新バージョンをテストするには、アプリで Android 12（API レベル 31）以降を対象にしてください。
テストの繰り返しをサポートするために、次のスクリプト test_d2d.sh を作成します。

#!/bin/bash -eu
: "${1?"Usage: $0 package name"}"

# Initialize and create a backup
adb shell bmgr enable true
adb shell settings put secure backup_enable_d2d_test_mode 1
adb shell bmgr transport com.google.android.gms/.backup.migrate.service.D2dTransport
adb shell bmgr init com.google.android.gms/.backup.migrate.service.D2dTransport
adb shell bmgr list transports | grep -q -F "  * com.google.android.gms/.backup.migrate.service.D2dTransport" || (echo "Failed to select and initialize backup transport"; exit 1)
adb shell bmgr backupnow "$1" | grep -F "Package $1 with result: Success" || (echo "Backup failed"; exit 1)

# Uninstall and reinstall the app to clear the data and trigger a restore
apk_path_list=$(adb shell pm path "$1")
OIFS=$IFS
IFS=$'\n'
apk_number=0
for apk_line in $apk_path_list
do
    (( ++apk_number ))
    apk_path=${apk_line:8:1000}
    adb pull "$apk_path" "myapk${apk_number}.apk"
done
IFS=$OIFS
adb shell pm uninstall --user 0 "$1"
adb shell bmgr transport com.google.android.gms/.backup.BackupTransportService
apks=$(seq -f 'myapk%.f.apk' 1 $apk_number)
adb install-multiple -t --user 0 $apks

# Clean up
adb shell bmgr init com.google.android.gms/.backup.migrate.service.D2dTransport
adb shell settings put secure backup_enable_d2d_test_mode 0
adb shell bmgr transport com.google.android.gms/.backup.BackupTransportService
rm $apks

echo "Done"

テスト手順

テストするアプリをデバイスにインストールします。
アプリを開いてログインし、アプリの設定を変更します。
デバイスでスクリプトを実行し、パッケージ名（test_d2d.sh com.example.myapp など）を渡します。
スクリプトが完了したら、デバイスでアプリを開き、すべてのデータが保持された状態で正しく動作することを確認します。

ユーザーがログインする必要はなく、すべての設定、進行状況、アプリデータがスクリプトの実行前と同じように表示される必要があります。テスト結果がこれらの条件を満たしていない場合は、重要なデータが欠落することなく転送が正しく構成されていること、転送から除外したキャッシュに保存されたデータの再作成も処理されていることを確認してください。テストの反復処理ごとに手順 2 ～ 4 を繰り返します。

バックアップと復元に関するトラブルシューティング

このセクションでは、一般的な問題のトラブルシューティングについて説明します。

トランスポートの容量超過

Logcat の次のメッセージは、アプリがトランスポートの割り当てを超過したことを示します。

I/PFTBT: Transport rejected backup of <PACKAGE>, skipping

--- or ---

I/PFTBT: Transport quota exceeded for package: <PACKAGE>

バックアップデータの量を減らして、もう一度お試しください。たとえば、アプリのキャッシュディレクトリにのみデータをキャッシュしていることを確認します。キャッシュディレクトリはバックアップに含まれません。

フルバックアップができない

Logcat の次のメッセージは、デバイスで Key-Value バックアップ処理がまだ行われていないため、フルバックアップ処理が失敗したことを示しています。

I/BackupManagerService: Full backup not currently possible -- key/value backup
not yet run?

bmgr run コマンドで Key-Value バックアップをトリガーしてから、もう一度お試しください。

エージェントの待機中にタイムアウトした

Logcat の次のメッセージは、バックアップのためにアプリの起動に 10 秒以上かかったことを示しています。

12-05 18:59:02.033  1910  2251 D BackupManagerService:
    awaiting agent for ApplicationInfo{5c7cde0 com.your.app.package}
12-05 18:59:12.117  1910  2251 W BackupManagerService:
    Timeout waiting for agent ApplicationInfo{5c7cde0 com.your.app.package}
12-05 18:59:12.117  1910  2251 W BackupManagerService:
    Can't find backup agent for com.your.app.package

ログ出力に示されているタイムスタンプの差分を確認してください。通常、このエラーはアプリが ProGuard なしで Multidex 構成を使用している場合に発生します。

バックアップアカウントが初期化されていません

Logcat の次のメッセージは、バックアップデータセットが初期化されていないためにバックアップが停止されたことを示しています。

01-31 14:32:45.698 17280 17292 I Backup: [GmsBackupTransport] Try to backup for
an uninitialized backup account.
01-31 14:32:45.699  1043 18255 W PFTBT: Transport failed; aborting backup: -1001
01-31 14:32:45.699  1043 18255 I PFTBT: Full backup completed with status: -1000

adb shell bmgr run コマンドでバックアップマネージャーを実行してから、もう一度バックアップを実行してください。

アプリのメソッドが呼び出されていない

自動バックアップは Application の基本クラスを使用してアプリを起動するため、アプリの設定メソッドが呼び出されない場合があります。自動バックアップもアプリのアクティビティを起動しないため、アプリがアクティビティで設定を行うとエラーが表示される場合があります。詳細については、BackupAgent を実装するをご覧ください。

一方、Key-Value バックアップでは、アプリマニフェストファイルで宣言した Application サブクラスでアプリが起動します。

バックアップするデータがない

Logcat の次のメッセージは、アプリにバックアップするデータがないことを示しています。

I Backup  : [FullBackupSession] Package com.your.app.package doesn't have any backup data.

--- or ---

I Backup  : [D2dTransport] Package com.your.app.package doesn't have any backup data.

独自の BackupAgent を実装している場合は、バックアップにデータやファイルを追加していない可能性があります。

バックアップと復元をテストする

バックアップのテストの仕組み

ツール

クラウド バックアップをテストする

クラウド バックアップ用にデバイスやエミュレータを準備する

テスト手順

D2D 転送をテストする

D2D テスト用にデバイスを準備する

テスト手順

バックアップと復元に関するトラブルシューティング

クラウドバックアップをテストする

クラウドバックアップ用にデバイスやエミュレータを準備する