Espresso-Intents は Espresso の拡張機能であり、テスト対象のアプリから送信されるインテントの検証とスタブ化を可能にします。Mockito に似ていますが、Android インテント用です。
アプリが他のアプリまたはプラットフォームに機能を委任している場合は、Espresso-Intents を使用して、他のアプリまたはプラットフォームが正しく機能していると仮定して、対象アプリのロジックのテストに専念できます。Espresso-Intents を使用すれば、送信されるインテントのマッチングや検証を行えるうえ、実際のインテント レスポンスの代わりにスタブ レスポンスを使うこともできます。
プロジェクトへの Espresso-Intents の組み込み
アプリの app/build.gradle ファイルで、dependencies 内に次の行を追加します。
Groovy
androidTestImplementation 'androidx.test.espresso:espresso-intents:3.6.1'
Kotlin
androidTestImplementation('androidx.test.espresso:espresso-intents:3.6.1')
Espresso-Intents は、Espresso 2.1 以降および Android テスト ライブラリのバージョン 0.3 以降とのみ互換性があるため、それらの行も更新してください。
Groovy
androidTestImplementation 'androidx.test:runner:1.6.1' androidTestImplementation 'androidx.test:rules:1.6.1' androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
Kotlin
androidTestImplementation('androidx.test:runner:1.6.1') androidTestImplementation('androidx.test:rules:1.6.1') androidTestImplementation('androidx.test.espresso:espresso-core:3.6.1')
テストルールの作成
Espresso-Intents テストを作成する前に、IntentsTestRule をセットアップします。これは ActivityTestRule クラスの拡張機能であり、機能 UI テストで Espresso-Intents API を簡単に使用できるようにします。IntentsTestRule は、@Test アノテーションが付けられた各テストの前に Espresso-Intents を初期化し、各テスト実行後に Espresso-Intents をリリースします。
次のコード スニペットは、IntentsTestRule の例を示しています。
@get:Rule val intentsTestRule = IntentsTestRule(MyActivity::class.java)
一致
Espresso-Intents には、Hamcrest Matcher を使用して定義された特定の一致条件に基づいて、送信インテントをインターセプトする機能が用意されています。Hamcrest を使用すると、次のことが可能になります。
- 既存のインテント マッチャーを使用する: 最も簡単なオプションであり、ほとんどの場合に推奨されます。
- 独自のインテント マッチャーの実装: 最も自由度の高いオプションです。詳細については、Hamcrest チュートリアルの「Writing custom matchers」セクションをご覧ください。
Espresso-Intents には、インテントの検証とスタブ化を行うための intended() メソッドと intending() メソッドがそれぞれ用意されています。どちらも Hamcrest Matcher<Intent> オブジェクトを引数として受け取ります。
次のコード スニペットは、ブラウザを起動する送信インテントに一致する既存のインテント マッチャーを使用したインテント検証を示しています。
assertThat(intent).hasAction(Intent.ACTION_VIEW) assertThat(intent).categories().containsExactly(Intent.CATEGORY_BROWSABLE) assertThat(intent).hasData(Uri.parse("www.google.com")) assertThat(intent).extras().containsKey("key1") assertThat(intent).extras().string("key1").isEqualTo("value1") assertThat(intent).extras().containsKey("key2") assertThat(intent).extras().string("key2").isEqualTo("value2")
インテントの検証
Espresso-Intents は、テスト対象のアプリからアクティビティを起動しようとするすべてのインテントを記録します。Mockito.verify() と同様の intended() メソッドを使用すると、特定のインテントが確認されたことをアサートできます。ただし、Espresso-Intents は、明示的に構成しない限り、インテントに対するレスポンスをスタブ化しません。
次のコード スニペットは、外部の「電話」アクティビティを起動する送信インテントを検証するテストの例です。ただし、レスポンスのスタブは行いません。
@Test fun validateIntentSentToPackage() { // User action that results in an external "phone" activity being launched. user.clickOnView(system.getView(R.id.callButton)) // Using a canned RecordedIntentMatcher to validate that an intent resolving // to the "phone" activity has been sent. intended(toPackage("com.android.phone")) }
スタブ化
Mockito.when() と同様の intending() メソッドを使用すると、startActivityForResult() で起動されるアクティビティにスタブ レスポンスを提供できます。これは、外部アクティビティのユーザー インターフェースを操作することも、テスト対象のアクティビティに返される ActivityResult を制御することもできないため、外部アクティビティに特に役立ちます。
次のコード スニペットは、activityResult_DisplaysContactsPhoneNumber() テストの例を実装しています。このテストでは、ユーザーがテスト対象のアプリで「連絡先」アクティビティを起動したときに、連絡先の電話番号が表示されることを確認します。
特定のアクティビティが起動された際に返す結果を準備します。このサンプルテストでは、「contacts」に送信されたすべてのインテントをインターセプトし、結果コード
RESULT_OKを使用して、有効なActivityResultでレスポンスをスタブ化します。val resultData = Intent() val phoneNumber = "123-345-6789" resultData.putExtra("phone", phoneNumber) val result = Instrumentation.ActivityResult(Activity.RESULT_OK, resultData)
「contacts」インテントのすべての呼び出しに対してスタブ結果オブジェクトを返すように Espresso に指示します。
intending(toPackage("com.android.contacts")).respondWith(result)
アクティビティの起動に使用されたアクションが、想定どおりのスタブ結果を生成することを確認します。この場合、サンプルテストでは、「連絡先アクティビティ」が起動されたときに、電話番号 "123-345-6789" が返されて表示されることを確認します。
onView(withId(R.id.pickButton)).perform(click()) onView(withId(R.id.phoneNumber)).check(matches(withText(phoneNumber)))
activityResult_DisplaysContactsPhoneNumber() のテスト全体を次に示します。
@Test fun activityResult_DisplaysContactsPhoneNumber() { // Build the result to return when the activity is launched. val resultData = Intent() val phoneNumber = "123-345-6789" resultData.putExtra("phone", phoneNumber) val result = Instrumentation.ActivityResult(Activity.RESULT_OK, resultData) // Set up result stubbing when an intent sent to "contacts" is seen. intending(toPackage("com.android.contacts")).respondWith(result) // User action that results in "contacts" activity being launched. // Launching activity expects phoneNumber to be returned and displayed. onView(withId(R.id.pickButton)).perform(click()) // Assert that the data we set up above is shown. onView(withId(R.id.phoneNumber)).check(matches(withText(phoneNumber))) }
参考情報
Android テストで Espresso-Intents を使用する方法について詳しくは、以下のリソースをご覧ください。
サンプル
- IntentsBasicSample:
intended()とintending()の基本的な使用方法。 - IntentsAdvancedSample: ユーザーがカメラを使用してビットマップを取得する動作をシミュレートします。