Jetpack Compose: Assert Intent Data Consumption in Instrumented Tests

ComposeUiTest.md

Gists for medium article titled Jetpack Compose: Assert Intent Data Consumption in Instrumented Tests

createAndroidComposeRule.kt

fun <A : ComponentActivity> createAndroidComposeRule(
    startActivityIntent: Intent
): AndroidComposeTestRule<ActivityScenarioRule<A>, A> = AndroidComposeTestRule(
    activityRule = ActivityScenarioRule(startActivityIntent),
    activityProvider = ::getActivityFromTestRule
)

LaunchWithActivityScenario.kt

runAndroidComposeUiTest(
    activityLauncher = {
        ActivityScenario.launch<YourActivity>(
            Intent(ApplicationProvider.getApplicationContext(), YourActivity::class.java)
                .putExtra("key", "value"),
            Bundle().apply {
                putString("key", "value")
            }
        )
    }
) {
    // assert composables
}

LaunchWithIntent.kt

runAndroidComposeUiTest<YourActivity>(
    startActivityIntent = Intent(
        ApplicationProvider.getApplicationContext(),
        YourActivity::class.java
    ).putExtra("key", "value")
) {
    // assert composables
    // example assertion below
    // onNodeWithText("hello").assertExists().assertIsDisplayed()
}

LaunchWithTestRule.kt

@get:Rule
val composeTestRule = createAndroidComposeRule<YourActivity>(
    Intent(ApplicationProvider.getApplicationContext(), YourActivity::class.java)
        .putExtra("key", "value")
)

runAndroidComposeUiTest.kt

@ExperimentalTestApi
fun <A : ComponentActivity> runAndroidComposeUiTest(
    activityLauncher: () -> ActivityScenario<A>,
    effectContext: CoroutineContext = EmptyCoroutineContext,
    block: AndroidComposeUiTest<A>.() -> Unit
) {
    var scenario: ActivityScenario<A>? = null
    val environment = AndroidComposeUiTestEnvironment(effectContext) {
        requireNotNull(scenario) {
            "ActivityScenario has not yet been launched, or has already finished. Make sure that " +
                    "any call to ComposeUiTest.setContent() and AndroidComposeUiTest.getActivity() " +
                    "is made within the lambda passed to AndroidComposeUiTestEnvironment.runTest()"
        }.getActivity()
    }
    try {
        environment.runTest {
            scenario = activityLauncher()
            block()
        }
    } finally {
        scenario?.close()
    }
}