Reland "Batch BottomSheetControllerTests"

This is a reland of 3c8430ae

This patch adds a check for the currently running animation. Animations
on Android M seem to continue for a few updates after cancellation.

Original change's description:
> Batch BottomSheetControllerTests
>
> This patch batches all the tests in BottomSheetControllerTest.
> Consequently, some new methods to reset the sheet's state were added
> to the test support classes and BlankCTATabInitialState was updated to
> support any subclass of ChromeActivity.
>
> Bug: 1122163
> Change-Id: I3fbb73431eff206010d93d8c5e26e4942b84adb8
> Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2377664
> Reviewed-by: Michael Thiessen <mthiesse@chromium.org>
> Commit-Queue: Matthew Jones <mdjones@chromium.org>
> Cr-Commit-Position: refs/heads/master@{#803156}

Bug: 1122163
Change-Id: I2b562243eb50b7990fa82bd9d353c8d1f16589cd
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2387433Reviewed-by: Michael Thiessen <mthiesse@chromium.org>
Commit-Queue: Matthew Jones <mdjones@chromium.org>
Cr-Commit-Position: refs/heads/master@{#804935}

chrome/android/javatests/src/org/chromium/chrome/browser/widget/bottomsheet/BottomSheetControllerTest.java

@@ -15,12 +15,15 @@ import android.view.View;
 import androidx.test.filters.MediumTest;
 import androidx.test.filters.SmallTest;
 
+import org.junit.After;
 import org.junit.Before;
+import org.junit.ClassRule;
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
 import org.chromium.base.ThreadUtils;
+import org.chromium.base.test.util.Batch;
 import org.chromium.base.test.util.CallbackHelper;
 import org.chromium.base.test.util.CommandLineFlags;
 import org.chromium.base.test.util.Feature;
@@ -35,6 +38,7 @@ import org.chromium.chrome.browser.tab.TabSelectionType;
 import org.chromium.chrome.browser.tabmodel.TabModelObserver;
 import org.chromium.chrome.test.ChromeJUnit4ClassRunner;
 import org.chromium.chrome.test.ChromeTabbedActivityTestRule;
+import org.chromium.chrome.test.batch.BlankCTATabInitialStateRule;
 import org.chromium.chrome.test.util.ChromeTabUtils;
 import org.chromium.components.browser_ui.bottomsheet.BottomSheetContent;
 import org.chromium.components.browser_ui.bottomsheet.BottomSheetController;
@@ -57,9 +61,17 @@ import java.util.concurrent.TimeoutException;
 @RunWith(ChromeJUnit4ClassRunner.class)
 @CommandLineFlags.Add(ChromeSwitches.DISABLE_FIRST_RUN_EXPERIENCE)
 @Restriction(UiRestriction.RESTRICTION_TYPE_PHONE) // TODO(mdjones): Remove this (crbug.com/837838).
+@Batch(Batch.PER_CLASS)
 public class BottomSheetControllerTest {
+    @ClassRule
+    public static final ChromeTabbedActivityTestRule sActivityTestRule =
+            new ChromeTabbedActivityTestRule();
+
     @Rule
-    public ChromeTabbedActivityTestRule mActivityTestRule = new ChromeTabbedActivityTestRule();
+    public final BlankCTATabInitialStateRule mIninialStateRule =
+            new BlankCTATabInitialStateRule(sActivityTestRule, false);
+
+    private ChromeTabbedActivity mActivity;
 
     private BottomSheetController mSheetController;
     private BottomSheetTestSupport mTestSupport;
@@ -72,35 +84,42 @@ public class BottomSheetControllerTest {
 
     @Before
     public void setUp() throws Exception {
-        mActivityTestRule.startMainActivityOnBlankPage();
-        final ChromeTabbedActivity activity = mActivityTestRule.getActivity();
+        mActivity = sActivityTestRule.getActivity();
 
         ThreadUtils.runOnUiThreadBlocking(() -> {
             BottomSheetTestSupport.setSmallScreen(false);
 
-            mScrimCoordinator = mActivityTestRule.getActivity()
-                                        .getRootUiCoordinatorForTesting()
-                                        .getScrimCoordinatorForTesting();
+            mScrimCoordinator =
+                    mActivity.getRootUiCoordinatorForTesting().getScrimCoordinatorForTesting();
             mScrimCoordinator.disableAnimationForTesting(true);
 
-            mSheetController = activity.getRootUiCoordinatorForTesting().getBottomSheetController();
+            mSheetController =
+                    mActivity.getRootUiCoordinatorForTesting().getBottomSheetController();
             mTestSupport = new BottomSheetTestSupport(mSheetController);
 
             mLowPriorityContent = new TestBottomSheetContent(
-                    mActivityTestRule.getActivity(), BottomSheetContent.ContentPriority.LOW, false);
-            mHighPriorityContent = new TestBottomSheetContent(mActivityTestRule.getActivity(),
-                    BottomSheetContent.ContentPriority.HIGH, false);
+                    mActivity, BottomSheetContent.ContentPriority.LOW, false);
+            mHighPriorityContent = new TestBottomSheetContent(
+                    mActivity, BottomSheetContent.ContentPriority.HIGH, false);
 
             mBackInterceptingContent = new TestBottomSheetContent(
-                    mActivityTestRule.getActivity(), BottomSheetContent.ContentPriority.LOW, false);
+                    mActivity, BottomSheetContent.ContentPriority.LOW, false);
             mBackInterceptingContent.setHandleBackPress(true);
 
-            mPeekableContent = new TestBottomSheetContent(mActivityTestRule.getActivity());
-            mNonPeekableContent = new TestBottomSheetContent(mActivityTestRule.getActivity());
+            mPeekableContent = new TestBottomSheetContent(mActivity);
+            mNonPeekableContent = new TestBottomSheetContent(mActivity);
             mNonPeekableContent.setPeekHeight(BottomSheetContent.HeightMode.DISABLED);
         });
     }
 
+    @After
+    public void tearDown() {
+        ThreadUtils.runOnUiThreadBlocking(() -> {
+            mTestSupport.forceDismissAllContent();
+            mTestSupport.endAllAnimations();
+        });
+    }
+
     @Test
     @SmallTest
     @Feature({"BottomSheetController"})
@@ -206,22 +225,21 @@ public class BottomSheetControllerTest {
     @Feature({"BottomSheetController"})
     public void testSheetHiddenAfterTabSwitcher() throws TimeoutException {
         // Open a second tab and then reselect the original activity tab.
-        Tab tab1 = mActivityTestRule.getActivity().getActivityTab();
-        ChromeTabUtils.newTabFromMenu(
-                InstrumentationRegistry.getInstrumentation(), mActivityTestRule.getActivity());
-        Tab tab2 = mActivityTestRule.getActivity().getActivityTab();
+        Tab tab1 = mActivity.getActivityTab();
+        openNewTabInForeground();
+        Tab tab2 = mActivity.getActivityTab();
 
         requestContentInSheet(mLowPriorityContent, true);
 
         // Enter the tab switcher and select a different tab.
         ThreadUtils.runOnUiThreadBlocking(() -> {
-            mActivityTestRule.getActivity().getLayoutManager().showOverview(false);
+            mActivity.getLayoutManager().showOverview(false);
             mTestSupport.endAllAnimations();
             assertEquals("The bottom sheet should be hidden.",
                     BottomSheetController.SheetState.HIDDEN, mSheetController.getSheetState());
-            mActivityTestRule.getActivity().getTabModelSelector().getCurrentModel().setIndex(
+            mActivity.getTabModelSelector().getCurrentModel().setIndex(
                     0, TabSelectionType.FROM_USER);
-            mActivityTestRule.getActivity().getLayoutManager().hideOverview(false);
+            mActivity.getLayoutManager().hideOverview(false);
             mTestSupport.endAllAnimations();
         });
 
@@ -286,9 +304,8 @@ public class BottomSheetControllerTest {
     @MediumTest
     @Feature({"BottomSheetController"})
     public void testSwitchTabsMultipleTimes() throws TimeoutException {
-        ChromeTabbedActivity activity = mActivityTestRule.getActivity();
-        final int originalTabIndex =
-                activity.getTabModelSelector().getCurrentModel().indexOf(activity.getActivityTab());
+        final int originalTabIndex = mActivity.getTabModelSelector().getCurrentModel().indexOf(
+                mActivity.getActivityTab());
         requestContentInSheet(mLowPriorityContent, true);
 
         assertEquals("The bottom sheet should be peeking.", BottomSheetController.SheetState.PEEK,
@@ -302,7 +319,7 @@ public class BottomSheetControllerTest {
                 mSheetController.getCurrentSheetContent());
 
         ThreadUtils.runOnUiThreadBlocking(() -> {
-            activity.getTabModelSelector().getCurrentModel().setIndex(
+            mActivity.getTabModelSelector().getCurrentModel().setIndex(
                     originalTabIndex, TabSelectionType.FROM_USER);
         });
 
@@ -324,14 +341,14 @@ public class BottomSheetControllerTest {
         requestContentInSheet(mHighPriorityContent, true);
         requestContentInSheet(mLowPriorityContent, false);
 
-        TestBottomSheetContent customLifecycleContent = new TestBottomSheetContent(
-                mActivityTestRule.getActivity(), BottomSheetContent.ContentPriority.LOW, true);
+        TestBottomSheetContent customLifecycleContent =
+                new TestBottomSheetContent(mActivity, BottomSheetContent.ContentPriority.LOW, true);
         requestContentInSheet(customLifecycleContent, false);
         assertEquals(mHighPriorityContent, mSheetController.getCurrentSheetContent());
 
         // Change URL and wait for PageLoadStarted event.
         CallbackHelper pageLoadStartedHelper = new CallbackHelper();
-        Tab tab = mActivityTestRule.getActivity().getActivityTab();
+        Tab tab = mActivity.getActivityTab();
         tab.addObserver(new EmptyTabObserver() {
             @Override
             public void onPageLoadStarted(Tab tab, String url) {
@@ -367,8 +384,8 @@ public class BottomSheetControllerTest {
     @Test
     @MediumTest
     public void testCustomScrimLifecycle() throws TimeoutException {
-        TestBottomSheetContent customScrimContent = new TestBottomSheetContent(
-                mActivityTestRule.getActivity(), BottomSheetContent.ContentPriority.LOW, true);
+        TestBottomSheetContent customScrimContent =
+                new TestBottomSheetContent(mActivity, BottomSheetContent.ContentPriority.LOW, true);
         customScrimContent.setHasCustomScrimLifecycle(true);
         requestContentInSheet(customScrimContent, true);
 
@@ -607,11 +624,11 @@ public class BottomSheetControllerTest {
      */
     private void enterAndExitTabSwitcher() {
         ThreadUtils.runOnUiThreadBlocking(() -> {
-            mActivityTestRule.getActivity().getLayoutManager().showOverview(false);
+            mActivity.getLayoutManager().showOverview(false);
             mTestSupport.endAllAnimations();
             assertEquals("The bottom sheet should be hidden.",
                     BottomSheetController.SheetState.HIDDEN, mSheetController.getSheetState());
-            mActivityTestRule.getActivity().getLayoutManager().hideOverview(false);
+            mActivity.getLayoutManager().hideOverview(false);
             mTestSupport.endAllAnimations();
         });
     }
@@ -621,20 +638,18 @@ public class BottomSheetControllerTest {
      */
     private void openNewTabInBackground() throws TimeoutException {
         CallbackHelper tabSelectedHelper = new CallbackHelper();
-        mActivityTestRule.getActivity().getTabModelSelector().getCurrentModel().addObserver(
-                new TabModelObserver() {
-                    @Override
-                    public void didSelectTab(Tab tab, @TabSelectionType int type, int lastId) {
-                        tabSelectedHelper.notifyCalled();
-                    }
-                });
+        mActivity.getTabModelSelector().getCurrentModel().addObserver(new TabModelObserver() {
+            @Override
+            public void didSelectTab(Tab tab, @TabSelectionType int type, int lastId) {
+                tabSelectedHelper.notifyCalled();
+            }
+        });
 
         int previousCallCount = tabSelectedHelper.getCallCount();
 
         ThreadUtils.runOnUiThreadBlocking(() -> {
-            mActivityTestRule.getActivity().getTabCreator(false).createNewTab(
-                    new LoadUrlParams("about:blank"), TabLaunchType.FROM_LONGPRESS_BACKGROUND,
-                    null);
+            mActivity.getTabCreator(false).createNewTab(new LoadUrlParams("about:blank"),
+                    TabLaunchType.FROM_LONGPRESS_BACKGROUND, null);
         });
 
         tabSelectedHelper.waitForCallback(previousCallCount, 1);
@@ -645,8 +660,8 @@ public class BottomSheetControllerTest {
      * Open a new tab in front of the active tab and wait for it to be completely loaded.
      */
     private void openNewTabInForeground() {
-        ChromeTabUtils.fullyLoadUrlInNewTab(InstrumentationRegistry.getInstrumentation(),
-                mActivityTestRule.getActivity(), "about:blank", false);
+        ChromeTabUtils.fullyLoadUrlInNewTab(
+                InstrumentationRegistry.getInstrumentation(), mActivity, "about:blank", false);
         ThreadUtils.runOnUiThreadBlocking(() -> mTestSupport.endAllAnimations());
     }
 }

chrome/test/android/javatests/src/org/chromium/chrome/test/batch/BlankCTATabInitialStateRule.java

@@ -22,11 +22,13 @@ import org.chromium.content_public.browser.test.util.TestThreadUtils;
  *
  * State is stored statically, and so the Activity may be reused across multiple test suites within
  * the same {@link Batch}.
+ *
+ * @param <T> The type of {@link ChromeActivity}.
  */
-public class BlankCTATabInitialStateRule implements TestRule {
+public class BlankCTATabInitialStateRule<T extends ChromeActivity> implements TestRule {
     private static ChromeActivity sActivity;
 
-    private final ChromeActivityTestRule<ChromeActivity> mActivityTestRule;
+    private final ChromeActivityTestRule<T> mActivityTestRule;
     private final boolean mClearAllTabState;
 
     /**
@@ -35,7 +37,7 @@ public class BlankCTATabInitialStateRule implements TestRule {
      *     renderer process between each test.
      */
     public BlankCTATabInitialStateRule(
-            ChromeActivityTestRule<ChromeActivity> activityTestRule, boolean clearAllTabState) {
+            ChromeActivityTestRule<T> activityTestRule, boolean clearAllTabState) {
         super();
         mActivityTestRule = activityTestRule;
         mClearAllTabState = clearAllTabState;
@@ -52,7 +54,7 @@ public class BlankCTATabInitialStateRule implements TestRule {
                     mActivityTestRule.startMainActivityOnBlankPage();
                     sActivity = mActivityTestRule.getActivity();
                 } else {
-                    mActivityTestRule.setActivity(sActivity);
+                    mActivityTestRule.setActivity((T) sActivity);
                     if (mClearAllTabState) {
                         resetTabStateThorough();
                     } else {

components/browser_ui/android/bottomsheet/internal/java/src/org/chromium/components/browser_ui/bottomsheet/BottomSheet.java

@@ -609,6 +609,9 @@ class BottomSheet extends FrameLayout
         mSettleAnimator.addUpdateListener(new ValueAnimator.AnimatorUpdateListener() {
             @Override
             public void onAnimationUpdate(ValueAnimator animator) {
+                // Cancelled animation on M seem to continue updating, block them.
+                if (animator != mSettleAnimator) return;
+
                 setSheetOffsetFromBottom((Float) animator.getAnimatedValue(), reason);
             }
         });

components/browser_ui/android/bottomsheet/internal/java/src/org/chromium/components/browser_ui/bottomsheet/BottomSheetControllerImpl.java

@@ -367,6 +367,14 @@ class BottomSheetControllerImpl implements ManagedBottomSheetController {
         mBottomSheet.endAnimations();
     }
 
+    @VisibleForTesting
+    public void forceDismissAllContent() {
+        clearRequestsAndHide();
+
+        // Handle content that has a custom lifecycle.
+        hideContent(mBottomSheet.getCurrentSheetContent(), /* animate= */ true);
+    }
+
     @Override
     public boolean requestShowContent(BottomSheetContent content, boolean animate) {
         if (mBottomSheet == null) mSheetInitializer.run();

components/browser_ui/android/bottomsheet/test/java/src/org/chromium/components/browser_ui/bottomsheet/BottomSheetTestSupport.java

@@ -41,7 +41,7 @@ public class BottomSheetTestSupport {
 
     /** End all animations on the sheet for testing purposes. */
     public void endAllAnimations() {
-        mController.endAnimationsForTesting();
+        if (getBottomSheet() != null) mController.endAnimationsForTesting();
     }
 
     /** @see {@link BottomSheet#setSheetOffsetFromBottom(float, int)} */
@@ -99,6 +99,11 @@ public class BottomSheetTestSupport {
         return getBottomSheet().forceScrollingStateForTesting(sheetHeight, yVelocity);
     }
 
+    /** Dismiss all content currently queued in the controller including custom lifecycles. */
+    public void forceDismissAllContent() {
+        mController.forceDismissAllContent();
+    }
+
     /** @return The bottom sheet view. */
     private BottomSheet getBottomSheet() {
         return (BottomSheet) mController.getBottomSheetViewForTesting();