Deflakes DrawerActionsIntegrationTest by using DrawerListener for waiting for close.

testOpenDrawer_clickItem was flaking 3/200 times. With these changes, it doesn't flake after 2000 runs. clickItem now uses a drawerListener to listen for the close to happen so there's no race condition.

PiperOrigin-RevId: 608675813

Author: copybara-androidxtest

espresso/CHANGELOG.md

@@ -21,6 +21,8 @@ The following artifacts were released:
 
 **New Features**
 
+* Add waitForClose to DrawerActions.
+
 **Breaking Changes**
 
 **API Changes**

espresso/contrib/java/androidx/test/espresso/contrib/DrawerActions.java

@@ -60,7 +60,6 @@ private DrawerActions() {
   }
 
   private abstract static class DrawerAction implements ViewAction {
-
     @Override
     public final Matcher<View> getConstraints() {
       return isAssignableFrom(DrawerLayout.class);
@@ -84,7 +83,6 @@ public final void perform(UiController uiController, View view) {
         drawer.addDrawerListener(idlingListener);
         IdlingRegistry.getInstance().register(idlingListener);
       }
-
       performAction(uiController, drawer);
       uiController.loopMainThreadUntilIdle();
 
@@ -194,17 +192,81 @@ protected Matcher<View> checkAction() {
       }
 
       @Override
-      protected void performAction(UiController uiController, DrawerLayout view) {
-        view.closeDrawer(gravity);
+      public void performAction(UiController uiController, DrawerLayout drawer) {
+        IdlingDrawerClosedListener closeListener = new IdlingDrawerClosedListener();
+        drawer.addDrawerListener(closeListener);
+        drawer.closeDrawer(gravity);
         uiController.loopMainThreadUntilIdle();
-        // If still open wait some more...
-        if (view.isDrawerVisible(gravity)) {
-          uiController.loopMainThreadForAtLeast(300);
-        }
+        // Need to wait extra time after it closes to reduce flakiness.
+        uiController.loopMainThreadForAtLeast(300);
+        drawer.removeDrawerListener(closeListener);
+      }
+    };
+  }
+
+  /**
+   * Creates an action that will wait for the drawer to close. Use this in cases where the closing
+   * of the drawer is implicit, such as selecting an item in the drawer. No operation if the drawer
+   * is closed. This uses an idling resource to wait for close, so it will fail if it does not close
+   * within the idling resource timeout.
+   */
+  public static ViewAction waitForClose() {
+    return new DrawerAction() {
+      @Override
+      public String getDescription() {
+        return "waiting for drawer to close";
+      }
+
+      @Override
+      protected Matcher<View> checkAction() {
+        return isOpen();
+      }
+
+      @Override
+      public void performAction(UiController uiController, DrawerLayout drawer) {
+        // Add a listener that waits for the drawer to be closed, wait for it to idle,
+        // and then remove the listener immediately.
+        IdlingDrawerClosedListener closeListener = new IdlingDrawerClosedListener();
+        drawer.addDrawerListener(closeListener);
+        uiController.loopMainThreadUntilIdle();
+        drawer.removeDrawerListener(closeListener);
       }
     };
   }
 
+  /** Drawer listener that functions as an {@link IdlingResource} for Espresso. */
+  private static final class IdlingDrawerClosedListener extends SimpleDrawerListener
+      implements IdlingResource {
+
+    private final int id = nextId.getAndIncrement();
+
+    private ResourceCallback callback;
+    private boolean isClosed = false;
+
+    @Override
+    public void onDrawerClosed(View view) {
+      isClosed = true;
+      if (callback != null) {
+        callback.onTransitionToIdle();
+      }
+    }
+
+    @Override
+    public String getName() {
+      return "IdlingDrawerListener::" + id;
+    }
+
+    @Override
+    public boolean isIdleNow() {
+      return isClosed;
+    }
+
+    @Override
+    public void registerIdleTransitionCallback(ResourceCallback callback) {
+      this.callback = callback;
+    }
+  }
+
   /** Drawer listener that functions as an {@link IdlingResource} for Espresso. */
   private static final class IdlingDrawerListener extends SimpleDrawerListener
       implements IdlingResource {

espresso/contrib/java/androidx/test/espresso/contrib/api/current_public.txt

@@ -20,6 +20,7 @@ package androidx.test.espresso.contrib {
     method public static androidx.test.espresso.ViewAction! open(int);
     method @Deprecated public static void openDrawer(int);
     method @Deprecated public static void openDrawer(int, int);
+    method public static androidx.test.espresso.ViewAction! waitForClose();
   }
 
   public final class DrawerMatchers {

espresso/contrib/javatests/androidx/test/espresso/contrib/DrawerActionsIntegrationTest.java

@@ -24,6 +24,7 @@
 import static androidx.test.espresso.assertion.ViewAssertions.matches;
 import static androidx.test.espresso.contrib.DrawerActions.close;
 import static androidx.test.espresso.contrib.DrawerActions.open;
+import static androidx.test.espresso.contrib.DrawerActions.waitForClose;
 import static androidx.test.espresso.contrib.DrawerMatchers.isClosed;
 import static androidx.test.espresso.contrib.DrawerMatchers.isOpen;
 import static androidx.test.espresso.matcher.ViewMatchers.withId;
@@ -91,6 +92,8 @@ public void testOpenDrawer_clickItem() {
     String rowContents = DrawerActivity.DRAWER_CONTENTS[rowIndex];
     onData(allOf(is(instanceOf(String.class)), is(rowContents))).perform(click());
 
+    onView(withId(R.id.drawer_layout)).perform(waitForClose());
+
     // clicking the item should close the drawer.
     onView(withId(R.id.drawer_layout)).check(matches(isClosed()));