Intents

Artifact: androidx.test.espresso:espresso-intents

Kotlin |Java

class Intents

Intents enables validation and stubbing of intents sent out by the application under test.

An example test that simply validates an outgoing intent:

public void testValidateIntentSentToPackage() {
  // 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"));
}

An example test with intent stubbing:

public void testActivityResultIsHandledProperly() {
  // Build a result to return when a particular activity is launched.
  Intent resultData = new Intent();
  String phoneNumber = "123-345-6789";
  resultData.putExtra("phone", phoneNumber);
  ActivityResult result = new 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 displays it on the screen.
  user.clickOnView(system.getView(R.id.pickButton));

  // Assert that data we set up above is shown.
  assertTrue(user.waitForText(phoneNumber));
}

Summary

Public functions
`java-static Unit`	`assertNoUnverifiedIntents()` Asserts that Intents does not have any unverified intents.
`java-static (Mutable)List<Intent!>!`	`getIntents()` Returns the list of captured intents.
`java-static Unit`	`init()` Initializes Intents and begins recording intents.
`java-static Unit`	`intended(matcher: Matcher<Intent!>!)` Asserts that the given matcher matches one and only one intent sent by the application under test.
`java-static Unit`	`intended(matcher: Matcher<Intent!>!, verificationMode: VerificationMode!)` Asserts that the given matcher matches a specified number of intents sent by the application under test.
`java-static OngoingStubbing!`	`@CheckReturnValue intending(matcher: Matcher<Intent!>!)` Enables stubbing intent responses.
`java-static Unit`	`release()` Clears Intents state.
`java-static VerificationMode!`	`times(times: Int)` Allows verifying a specific number of intents sent by the application under test.

Public functions

assertNoUnverifiedIntents

java-static fun assertNoUnverifiedIntents(): Unit

Asserts that Intents does not have any unverified intents. You can use this method after you have verified your intents to make sure that nothing unexpected was sent out. This is an equivalent of verifyNoMoreInteractions() in Mockito.

getIntents

java-static fun getIntents(): (Mutable)List<Intent!>!

Returns the list of captured intents. Intents are recorded from the time that is called.

Callers can then verify the list of captured intents using their choice of assertion framework, such as truth.

init

java-static fun init(): Unit

Initializes Intents and begins recording intents. Must be called prior to triggering any actions that send out intents which need to be verified or stubbed. This is similar to MockitoAnnotations.initMocks.

intended

java-static fun intended(matcher: Matcher<Intent!>!): Unit

Asserts that the given matcher matches one and only one intent sent by the application under test. This is an equivalent of verify(mock, times(1)) in Mockito. Verification does not have to occur in the same order as the intents were sent. Intents are recorded from the time that Intents.init is called.

Parameters
`matcher: Matcher<Intent!>!`	the `Matcher` to be applied to captured intents

Throws
`junit.framework.AssertionFailedError`	if the given `Matcher` did not match any or matched more than one of the recorded intents

intended

java-static fun intended(matcher: Matcher<Intent!>!, verificationMode: VerificationMode!): Unit

Asserts that the given matcher matches a specified number of intents sent by the application under test. This is an equivalent of verify(mock, times(num)) in Mockito. Verification does not have to occur in the same order as the intents were sent. Intents are recorded from the time that Intents.init is called.

Parameters
`matcher: Matcher<Intent!>!`	the `Matcher` to be applied to captured intents
`verificationMode: VerificationMode!`	the verification mode to use

Throws
`junit.framework.AssertionFailedError`	if the given `Matcher` did not match the expected number of recorded intents

intending

@CheckReturnValue
java-static fun intending(matcher: Matcher<Intent!>!): OngoingStubbing!

Enables stubbing intent responses. This method is similar to Mockito.when and is particularly useful when the activity launching the intent expects data to be returned (and especially in the case when the destination activity is external). In this case, the test author can call intending(matcher).thenRespond(myResponse) and validate that the launching activity handles the result correctly. Note: the destination activity will not be launched.

Parameters
`matcher: Matcher<Intent!>!`	the `Matcher` that matches intents for which stubbed response should be provided

Returns
`OngoingStubbing!`	`OngoingStubbing` object to set stubbed response

release

java-static fun release(): Unit

Clears Intents state. Must be called after each test case.

times

java-static fun times(times: Int): VerificationMode!

Allows verifying a specific number of intents sent by the application under test. This is an equivalent of times(num) in Mockito.

Parameters
`times: Int`	the number of times that the intent should be matched.