Espresso アイドリング リソース

アイドリング リソースは、結果が UI テストの後続のオペレーションに影響する非同期オペレーションを表します。アイドリング リソースを Espresso に登録すると、アプリのテスト時にこれらの非同期オペレーションをより確実に検証できます。

アイドリング リソースが必要になるケースの特定

Espresso には、高度な同期機能が用意されています。ただし、フレームワークのこの特性は、MessageQueue にメッセージをポストするオペレーション(画面にコンテンツを描画する View のサブクラスなど)にのみ適用されます。

Espresso は、バックグラウンド スレッドで実行されているオペレーションなど、他の非同期オペレーションを認識しないため、そのような状況では同期を保証できません。Espresso がアプリの長時間実行オペレーションを認識できるようにするには、各オペレーションをアイドリング リソースとして登録する必要があります。

アプリの非同期処理の結果をテストする際にアイドリング リソースを使用しない場合、テストの信頼性を高めるために、次のような不適切な回避策を使用しなければならないことがあります。

  • Thread.sleep() への通話を追加する。テストに人工的な遅延を追加すると、テストスイートの実行が完了するまでに時間がかかり、低速なデバイスで実行するとテストが失敗することがあります。また、このような遅延はスケーラビリティに欠けます。アプリの今後のリリースで、より時間のかかる非同期処理を実行しなければならない可能性があるためです。
  • 再試行ラッパーを実装する。ループを使用して、タイムアウトが発生するまでアプリが非同期処理を継続しているかどうかを繰り返し確認します。テストで最大再試行回数を指定した場合でも、再実行のたびにシステム リソース(特に CPU)が消費されます。
  • CountDownLatch のインスタンスを使用する。これにより、別のスレッドで実行されている特定の数のオペレーションが完了するまで、1 つ以上のスレッドを待機させることができます。これらのオブジェクトでは、タイムアウトの長さを指定する必要があります。指定しないと、アプリが無期限にブロックされる可能性があります。また、ラッチを使用するとコードが不必要に複雑になり、メンテナンスが難しくなります。

Espresso を使用すると、このような信頼性の低い回避策をテストから削除し、代わりにアプリの非同期処理をアイドリング リソースとして登録できます。

一般的なユースケース

テストで次の例のようなオペレーションを実行する場合は、アイドリング リソースの使用を検討してください。

  • インターネットやローカル データソースからのデータの読み込み。
  • データベースやコールバックとの接続の確立。
  • マネージド サービス。システム サービスまたは IntentService のインスタンスを使用します。
  • ビットマップ変換などの複雑なビジネス ロジックの実行。

これらのオペレーションが、テストで検証する UI を更新する場合は、アイドリング リソースを登録することが特に重要です。

アイドリング リソースの実装例

以下に、アプリに統合できるアイドリング リソースの実装例をいくつか示します。

CountingIdlingResource
アクティブなタスクのカウンタを保持します。カウンタがゼロになると、関連付けられたリソースはアイドル状態と見なされます。この機能は Semaphore の機能とよく似ています。ほとんどの場合、この実装はテスト中にアプリの非同期処理を管理するのに十分です。
UriIdlingResource
CountingIdlingResource と同様ですが、リソースがアイドル状態と見なされる前に、カウンタが特定の期間ゼロである必要があります。この追加の待機期間は、連続するネットワーク リクエストを考慮したものです。スレッド内のアプリが、前のリクエストに対するレスポンスを受信した直後に新しいリクエストを行う可能性があるためです。
IdlingThreadPoolExecutor
作成されたスレッドプール内で実行中のタスクの合計数を追跡する ThreadPoolExecutor のカスタム実装。このクラスは、CountingIdlingResource を使用して、アクティブなタスクのカウンタを維持します。
IdlingScheduledThreadPoolExecutor
ScheduledThreadPoolExecutor のカスタム実装。IdlingThreadPoolExecutor クラスと同じ機能を提供しますが、将来実行するようにスケジュールされているタスクや、定期的に実行するようにスケジュールされているタスクも追跡できます。

独自のアイドリング リソースの作成

アプリのテストでアイドリング リソースを使用する場合、カスタムのリソース管理やロギングが必要になることがあります。そのような場合、前のセクションで説明した実装では不十分なことがあります。その場合は、これらのアイドリング リソース実装のいずれかを拡張するか、独自の実装を作成できます。

独自のアイドリング リソース機能を実装する場合は、次のベスト プラクティス(特に最初のもの)を念頭に置いてください。

アイドル状態の確認の部分で、アイドル状態への遷移を呼び出さない。
アプリがアイドル状態になったら、isIdleNow() の実装外で onTransitionToIdle() を呼び出します。これにより、Espresso は、特定のアイドリング リソースがアイドル状態かどうかを判断するために、不要な 2 回目のチェックを行いません。

次のコード スニペットは、この推奨事項について示しています。

fun isIdle() {
    // DON'T call callback.onTransitionToIdle() here!
}

fun backgroundWorkDone() {
    // Background work finished.
    callback.onTransitionToIdle() // Good. Tells Espresso that the app is idle.

    // Don't do any post-processing work beyond this point. Espresso now
    // considers your app to be idle and moves on to the next test action.
}

アイドリング リソースは必要になる前に登録する。

アイドリング リソースに関連する同期のメリットは、Espresso がそのリソースの isIdleNow() メソッドを最初に呼び出した後にのみ有効になります。

この性質の例を以下に示します。

  • @Before アノテーションを付けたメソッドにアイドリング リソースを登録すると、アイドリング リソースは各テストの最初の行で有効になります。
  • テスト内でアイドリング リソースを登録すると、アイドリング リソースは次の Espresso ベースのアクション中に有効になります。この動作は、次のアクションが、アイドリング リソースを登録するステートメントと同じテスト内にある場合でも発生します。
アイドリング リソース使用終了後は登録を解除する。

システム リソースを節約するには、不要になったアイドル状態のリソースの登録をすぐに解除する必要があります。たとえば、@Before アノテーション付きのメソッドでアイドリング リソースを登録する場合は、@After アノテーション付きの対応するメソッドでこのリソースの登録を解除することをおすすめします。

アイドリング リソースの登録と登録解除にはアイドリング レジストリを使用する。

アプリのアイドリング リソースにこのコンテナを使用すると、必要に応じてアイドリング リソースの登録と登録解除を繰り返し、一貫した動作を観察できます。

アイドリング リソース内では単純なアプリの状態のみを保持する。

たとえば、実装して登録するアイドリング リソースに、View オブジェクトへの参照を含めないようにします。

アイドリング リソースの登録

Espresso には、アプリのアイドリング リソースを配置できるコンテナクラスが用意されています。このクラスは IdlingRegistry と呼ばれ、アプリのオーバーヘッドを最小限に抑える自己完結型のアーティファクトです。このクラスを使用すると、アプリのメンテナンス性を向上させるために、次の手順を行うことができます。

  • アプリのテストで、 に含まれるアイドリング リソースではなく、IdlingRegistry への参照を作成します。
  • 各ビルド バリアントで使用するアイドリング リソースのコレクションの違いを維持します。
  • アイドリング リソースは、それらのサービスを参照する UI コンポーネントではなく、アプリのサービスで定義します。

アイドリング リソースのアプリへの統合

アイドリング リソースをアプリに追加する方法はいくつかありますが、特に、アプリのカプセル化を維持しながら、特定のアイドリング リソースが表す特定のオペレーションを指定できる方法があります。

アプリにアイドリング リソースを追加する場合は、アイドリング リソースのロジックをアプリ自体に配置し、テストでは登録と登録解除のオペレーションのみを行うことを強くおすすめします。

このアプローチでは、本番環境コードでテスト専用インターフェースを使用するという通常とは異なる状況を作り出すことになりますが、既存のコードをアイドリング リソースでラップできるため、アプリの APK サイズとメソッド数を維持できます。

その他の方法

アプリの本番環境コードにアイドリング リソース ロジックを組み込みたくない場合は、他にもいくつかの統合戦略が考えられます。

  • Gradle のプロダクト フレーバーなどのビルド バリアントを作成し、アプリのデバッグビルドでのみアイドリング リソースを使用します。
  • Dagger などの依存関係挿入フレームワークを使用して、アプリのアイドリング リソース依存関係グラフをテストに挿入します。Dagger 2 を使用している場合、インジェクション自体はサブコンポーネントから発生する必要があります。
  • アプリのテストにアイドリング リソースを実装し、それらのテストで同期する必要があるアプリの実装部分を公開します。

    注意: この設計上の決定は、アイドリング リソースへの自己完結型の参照を作成するように見えますが、最も単純なアプリを除くすべてのアプリでカプセル化を破ることになります。

参考情報

Android テストでの Espresso の使用方法について詳しくは、以下のリソースをご覧ください。

サンプル