Upstream oodles of Chrome for Android code into Chromium.

chrome/test/android/javatests_staging/src/org/chromium/chrome/test/util/ActivityUtils.java

+// Copyright 2015 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.chrome.test.util;
+
+import android.app.Activity;
+import android.app.DialogFragment;
+import android.app.Fragment;
+import android.app.Instrumentation;
+import android.app.Instrumentation.ActivityMonitor;
+
+import junit.framework.Assert;
+
+import org.chromium.chrome.browser.preferences.Preferences;
+import org.chromium.content.browser.test.util.Criteria;
+import org.chromium.content.browser.test.util.CriteriaHelper;
+
+/**
+ * Collection of activity utilities.
+ */
+public class ActivityUtils {
+    private static final long ACTIVITY_START_TIMEOUT_MS = 3000;
+    private static final long CONDITION_POLL_INTERVAL_MS = 100;
+
+    /**
+     * Waits for a particular fragment to be present on a given activity.
+     */
+    private static class FragmentPresentCriteria implements Criteria {
+
+        private final Activity mActivity;
+        private final String mFragmentTag;
+
+        public FragmentPresentCriteria(Activity activity, String fragmentTag) {
+            mActivity = activity;
+            mFragmentTag = fragmentTag;
+        }
+
+        @Override
+        public boolean isSatisfied() {
+            Fragment fragment = mActivity.getFragmentManager().findFragmentByTag(mFragmentTag);
+            if (fragment == null) return false;
+            if (fragment instanceof DialogFragment) {
+                DialogFragment dialogFragment = (DialogFragment) fragment;
+                return dialogFragment.getDialog() != null
+                        && dialogFragment.getDialog().isShowing();
+            }
+            return fragment.getView() != null;
+        }
+    }
+
+    /**
+     * Captures an activity of a particular type that is triggered from some action.
+     *
+     * @param <T> The type of activity to wait for.
+     * @param activityType The class type of the activity.
+     * @param activityTrigger The action that will trigger the new activity (run in this thread).
+     * @return The spawned activity.
+     */
+    public static <T> T waitForActivity(Instrumentation instrumentation, Class<T> activityType,
+            Runnable activityTrigger) {
+        return waitForActivityWithTimeout(instrumentation, activityType, activityTrigger,
+                ACTIVITY_START_TIMEOUT_MS);
+    }
+
+    /**
+     * Captures an activity of a particular type that is triggered from some action.
+     *
+     * @param activityType The class type of the activity.
+     * @param activityTrigger The action that will trigger the new activity (run in this thread).
+     * @param timeOut The maximum time to wait for activity creation
+     * @return The spawned activity.
+     */
+    public static <T> T waitForActivityWithTimeout(Instrumentation instrumentation,
+            Class<T> activityType, Runnable activityTrigger, long timeOut) {
+        ActivityMonitor monitor =
+                instrumentation.addMonitor(activityType.getCanonicalName(), null, false);
+
+        activityTrigger.run();
+        instrumentation.waitForIdleSync();
+        Activity activity = monitor.getLastActivity();
+        if (activity == null) {
+            activity = monitor.waitForActivityWithTimeout(timeOut);
+        }
+        Assert.assertNotNull(activityType.getName() + " did not start in: " + timeOut, activity);
+
+        return activityType.cast(activity);
+    }
+
+    /**
+     * Waits for a fragment to be registered by the specified activity.
+     *
+     * @param activity The activity that owns the fragment.
+     * @param fragmentTag The tag of the fragment to be loaded.
+     */
+    @SuppressWarnings("unchecked")
+    public static <T> T waitForFragment(Activity activity, String fragmentTag)
+            throws InterruptedException {
+        Assert.assertTrue(String.format("Could not locate the fragment with tag '%s'", fragmentTag),
+                CriteriaHelper.pollForCriteria(new FragmentPresentCriteria(activity, fragmentTag),
+                        ACTIVITY_START_TIMEOUT_MS, CONDITION_POLL_INTERVAL_MS));
+        return (T) activity.getFragmentManager().findFragmentByTag(fragmentTag);
+    }
+
+    /**
+     * Waits until the specified fragment has been attached to the specified activity. Note that
+     * we don't guarantee that the fragment is visible. Some UI operations can happen too
+     * quickly and we can miss the time that a fragment is visible. This method allows you to get a
+     * reference to any fragment that was attached to the activity at any point.
+     *
+     * @param <T> A subclass of android.app.Fragment
+     * @param activity An instance or subclass of Preferences
+     * @param fragmentClass The class object for T
+     * @return A reference to the requested fragment or null.
+     */
+    @SuppressWarnings("unchecked")
+    public static <T extends Fragment> T waitForFragmentToAttach(
+            final Preferences activity, final Class<T> fragmentClass)
+            throws InterruptedException {
+        boolean isFragmentAttached = CriteriaHelper.pollForCriteria(
+                new Criteria() {
+                    @Override
+                    public boolean isSatisfied() {
+                        return fragmentClass.isInstance(activity.getFragmentForTest());
+                    }
+                },
+                ACTIVITY_START_TIMEOUT_MS, CONDITION_POLL_INTERVAL_MS);
+        Assert.assertTrue("Could not find fragment " + fragmentClass, isFragmentAttached);
+        return (T) activity.getFragmentForTest();
+    }
+}