Retry on Espresso Tests

Author: steve-the-edwards

samples/containers/hello-back-button/src/androidTest/java/com/squareup/sample/hellobackbutton/HelloBackButtonEspressoTest.kt

@@ -12,6 +12,7 @@ import com.squareup.workflow1.ui.internal.test.DetectLeaksAfterTestSuccess
 import com.squareup.workflow1.ui.internal.test.IdlingDispatcherRule
 import com.squareup.workflow1.ui.internal.test.actuallyPressBack
 import com.squareup.workflow1.ui.internal.test.inAnyView
+import com.squareup.workflow1.ui.internal.test.retryBlocking
 import org.junit.Rule
 import org.junit.Test
 import org.junit.rules.RuleChain
@@ -26,7 +27,7 @@ class HelloBackButtonEspressoTest {
     .around(scenarioRule)
     .around(IdlingDispatcherRule)
 
-  @Test fun wrappedTakesPrecedence() {
+  @Test fun wrappedTakesPrecedence() = retryBlocking {
     inAnyView(withId(R.id.hello_message)).apply {
       check(matches(withText("Able")))
       perform(click())
@@ -40,7 +41,7 @@ class HelloBackButtonEspressoTest {
     }
   }
 
-  @Test fun outerHandlerAppliesIfWrappedHandlerIsNull() {
+  @Test fun outerHandlerAppliesIfWrappedHandlerIsNull() = retryBlocking {
     inAnyView(withId(R.id.hello_message)).apply {
       actuallyPressBack()
       inAnyView(withText("Are you sure you want to do this thing?"))

samples/tictactoe/app/src/androidTest/java/com/squareup/sample/TicTacToeEspressoTest.kt

@@ -23,6 +23,7 @@ import com.squareup.workflow1.ui.internal.test.DetectLeaksAfterTestSuccess
 import com.squareup.workflow1.ui.internal.test.IdlingDispatcherRule
 import com.squareup.workflow1.ui.internal.test.actuallyPressBack
 import com.squareup.workflow1.ui.internal.test.inAnyView
+import com.squareup.workflow1.ui.internal.test.retryBlocking
 import org.hamcrest.CoreMatchers.allOf
 import org.hamcrest.CoreMatchers.endsWith
 import org.junit.After
@@ -64,7 +65,7 @@ class TicTacToeEspressoTest {
     }
   }
 
-  @Test fun configChangeReflectsWorkflowState() {
+  @Test fun configChangeReflectsWorkflowState() = retryBlocking {
     inAnyView(withId(R.id.login_email)).type("bad email")
     inAnyView(withId(R.id.login_button)).perform(click())
 
@@ -73,7 +74,7 @@ class TicTacToeEspressoTest {
     inAnyView(withId(R.id.login_error_message)).check(matches(withText("Invalid address")))
   }
 
-  @Test fun editTextSurvivesConfigChange() {
+  @Test fun editTextSurvivesConfigChange() = retryBlocking {
     inAnyView(withId(R.id.login_email)).type("foo@bar")
     inAnyView(withId(R.id.login_password)).type("password")
     rotate()
@@ -82,7 +83,7 @@ class TicTacToeEspressoTest {
     inAnyView(withId(R.id.login_password)).check(matches(withText("")))
   }
 
-  @Test fun backStackPopRestoresViewState() {
+  @Test fun backStackPopRestoresViewState() = retryBlocking {
     // The loading screen is pushed onto the back stack.
     inAnyView(withId(R.id.login_email)).type("foo@bar")
     inAnyView(withId(R.id.login_password)).type("bad password")
@@ -95,7 +96,7 @@ class TicTacToeEspressoTest {
       .check(matches(withText("Unknown email or invalid password")))
   }
 
-  @Test fun dialogSurvivesConfigChange() {
+  @Test fun dialogSurvivesConfigChange() = retryBlocking {
     inAnyView(withId(R.id.login_email)).type("foo@bar")
     inAnyView(withId(R.id.login_password)).type("password")
     inAnyView(withId(R.id.login_button)).perform(click())
@@ -112,7 +113,7 @@ class TicTacToeEspressoTest {
       .check(matches(isDisplayed()))
   }
 
-  @Test fun canGoBackFromAlert() {
+  @Test fun canGoBackFromAlert() = retryBlocking {
     inAnyView(withId(R.id.login_email)).type("foo@bar")
     inAnyView(withId(R.id.login_password)).type("password")
     inAnyView(withId(R.id.login_button)).perform(click())
@@ -133,7 +134,7 @@ class TicTacToeEspressoTest {
     clickCell(0)
   }
 
-  @Test fun canGoBackInModalViewAndSeeRestoredViewState() {
+  @Test fun canGoBackInModalViewAndSeeRestoredViewState() = retryBlocking {
     // Log in and hit the 2fa screen.
     inAnyView(withId(R.id.login_email)).type("foo@2fa")
     inAnyView(withId(R.id.login_password)).type("password")
@@ -146,7 +147,7 @@ class TicTacToeEspressoTest {
     inAnyView(withId(R.id.login_email)).check(matches(withText("foo@2fa")))
   }
 
-  @Test fun canGoBackInModalViewAfterConfigChangeAndSeeRestoredViewState() {
+  @Test fun canGoBackInModalViewAfterConfigChangeAndSeeRestoredViewState() = retryBlocking {
     // Log in and hit the 2fa screen.
     inAnyView(withId(R.id.login_email)).type("foo@2fa")
     inAnyView(withId(R.id.login_password)).type("password")
@@ -164,7 +165,7 @@ class TicTacToeEspressoTest {
    * On tablets this revealed a problem with SavedStateRegistry.
    * https://github.com/square/workflow-kotlin/pull/656#issuecomment-1027274391
    */
-  @Test fun fullJourney() {
+  @Test fun fullJourney() = retryBlocking {
     inAnyView(withId(R.id.login_email)).type("foo@bar")
     inAnyView(withId(R.id.login_password)).type("password")
     inAnyView(withId(R.id.login_button)).perform(click())

workflow-ui/internal-testing-android/api/internal-testing-android.api

@@ -61,6 +61,8 @@ public final class com/squareup/workflow1/ui/internal/test/EspressoKt {
 	public static final fun inAnyView (Lorg/hamcrest/Matcher;)Landroidx/test/espresso/ViewInteraction;
 	public static final fun retry (Ljava/lang/String;JLkotlin/jvm/functions/Function0;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public static synthetic fun retry$default (Ljava/lang/String;JLkotlin/jvm/functions/Function0;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public static final fun retryBlocking (Ljava/lang/String;JLkotlin/jvm/functions/Function0;)V
+	public static synthetic fun retryBlocking$default (Ljava/lang/String;JLkotlin/jvm/functions/Function0;ILjava/lang/Object;)V
 }
 
 public final class com/squareup/workflow1/ui/internal/test/IdleAfterTestRule : org/junit/rules/TestRule {

workflow-ui/internal-testing-android/src/main/java/com/squareup/workflow1/ui/internal/test/Espresso.kt

@@ -12,6 +12,7 @@ import androidx.test.espresso.matcher.ViewMatchers.isRoot
 import com.squareup.workflow1.ui.WorkflowUiExperimentalApi
 import junit.framework.AssertionFailedError
 import kotlinx.coroutines.delay
+import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.withTimeoutOrNull
 import org.hamcrest.Description
 import org.hamcrest.Matcher
@@ -91,3 +92,13 @@ public suspend inline fun retry(
     throw it
   }
 }
+
+public inline fun retryBlocking(
+  clue: String = "",
+  timeout_ms: Long = DEFAULT_RETRY_TIMEOUT,
+  crossinline predicate: () -> Any
+) {
+  runBlocking {
+    retry(clue, timeout_ms, predicate)
+  }
+}