Espresso-Intents

O Espresso-Intents é uma extensão do Espresso que permite a validação e o stubbing de intents enviadas pelo aplicativo em teste. É como o Mockito, mas para intents do Android.

Se o app delegar funcionalidades a outros apps ou à plataforma, use o Espresso-Intents para se concentrar na lógica do seu app, supondo que os outros apps ou a plataforma funcionem corretamente. Com o Espresso-Intents, você pode combinar e validar suas intents de saída ou inclusive disponibilizar respostas de stub em vez de respostas de intent reais.

Incluir o Espresso-Intents no projeto

No arquivo app/build.gradle do seu app, adicione a seguinte linha dentro de dependencies:

Groovy

androidTestImplementation 'androidx.test.espresso:espresso-intents:3.6.1'

Kotlin

androidTestImplementation('androidx.test.espresso:espresso-intents:3.6.1')

O Espresso-Intents é compatível apenas com o Espresso 2.1+ e a versão 0.3+ das bibliotecas de teste do Android. Portanto, atualize também estas linhas:

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')

Programar regras de teste

Antes de programar um teste do Espresso-Intents, configure uma IntentsTestRule. Essa é uma extensão da classe ActivityTestRule e facilita o uso das APIs Espresso-Intents em testes de interface funcionais. Uma IntentsTestRule inicializa o Espresso-Intents antes de cada teste anotado com @Test e o libera após cada execução de teste.

O snippet de código a seguir é um exemplo de um IntentsTestRule.

@get:Rule
val intentsTestRule = IntentsTestRule(MyActivity::class.java)

Correspondência

O Espresso-Intents permite interceptar intents de saída com base em determinados critérios de correspondência, que são definidos usando os Matchers do Hamcrest. O Hamcrest permite:

  • Usar um correspondente de intent atual: é a opção mais fácil e quase sempre preferível.
  • implementar o próprio matcher de intent: opção mais flexível. Mais detalhes estão disponíveis na seção "Writing custom matchers" do tutorial do Hamcrest (em inglês).

O Espresso-Intents oferece os métodos intended() e intending() para validação e stubbing de intents, respectivamente. Ambos usam um objeto Hamcrest Matcher<Intent> como argumento.

O snippet de código a seguir mostra a validação de intent que usa correspondências de intent existentes que correspondem a uma intent de saída que inicia um navegador:

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")

Validar intents

O Espresso-Intents registra todas as intents que tentam iniciar atividades do aplicativo em teste. Usando o método intended(), que é semelhante a Mockito.verify(), é possível declarar que uma determinada intent foi vista. No entanto, o Espresso-Intents não cria stubs de respostas a intents, a menos que você o configure explicitamente para fazer isso.

O snippet de código abaixo é um exemplo de teste que valida, mas não simula respostas para uma intent de saída que inicia uma atividade externa de "telefone":

@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"))
}

Criar stubs

Usando o método intending(), que é semelhante a Mockito.when(), é possível fornecer uma resposta de stub para atividades iniciadas com startActivityForResult(). Isso é especialmente útil para atividades externas, porque não é possível manipular a interface do usuário de uma atividade externa nem controlar o ActivityResult retornado para a atividade em teste.

Os snippets de código abaixo implementam um exemplo de teste activityResult_DisplaysContactsPhoneNumber(), que verifica se, quando um usuário inicia uma atividade de "contato" no app em teste, o número de telefone do contato é exibido:

  1. Crie o resultado a ser retornado quando uma atividade específica for iniciada. O teste de exemplo intercepta todas as intents enviadas para "contacts" e substitui as respostas por um ActivityResult válido, usando o código de resultado RESULT_OK.

    val resultData = Intent()
    val phoneNumber = "123-345-6789"
    resultData.putExtra("phone", phoneNumber)
    val result = Instrumentation.ActivityResult(Activity.RESULT_OK, resultData)
  2. Instrua o Espresso a fornecer o objeto de resultado de stub em resposta a todas as invocações da intent "contacts":

    intending(toPackage("com.android.contacts")).respondWith(result)
  3. Verifique se a ação usada para iniciar a atividade produz o resultado de stub esperado. Nesse caso, o teste de exemplo verifica se o número de telefone "123-345-6789" é retornado e mostrado quando a "atividade de contatos" é iniciada:

    onView(withId(R.id.pickButton)).perform(click())
    onView(withId(R.id.phoneNumber)).check(matches(withText(phoneNumber)))

Este é o teste activityResult_DisplaysContactsPhoneNumber() completo:

@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)))
}

Outros recursos

Para mais informações sobre o uso de Espresso-Intents em testes do Android, consulte os recursos abaixo.

Amostras