Create ContentShellActivityTestRule and BaseJUnitRunner

content/shell/android/javatests/src/org/chromium/content_shell_apk/ContentShellTestBase.java

 // Copyright 2012 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.content_shell_apk;
 
-import static org.chromium.base.test.util.ScalableTimeout.scaleTimeout;
+import android.app.Instrumentation;
+import android.content.Intent;
 
-import android.annotation.TargetApi;
-import android.content.ComponentName;
-import android.content.Context;
-import android.content.Intent;
-import android.net.Uri;
-import android.os.Build;
-import android.os.PowerManager;
-import android.text.TextUtils;
-import android.view.ViewGroup;
-
-import org.chromium.base.ThreadUtils;
 import org.chromium.base.test.BaseActivityInstrumentationTestCase;
 import org.chromium.base.test.util.CallbackHelper;
 import org.chromium.base.test.util.CommandLineFlags;
-import org.chromium.base.test.util.UrlUtils;
 import org.chromium.content.browser.ContentView;
 import org.chromium.content.browser.ContentViewCore;
-import org.chromium.content.browser.test.util.Criteria;
-import org.chromium.content.browser.test.util.CriteriaHelper;
 import org.chromium.content.browser.test.util.TestCallbackHelperContainer;
 import org.chromium.content.common.ContentSwitches;
 import org.chromium.content_public.browser.LoadUrlParams;
 import org.chromium.content_public.browser.NavigationController;
 import org.chromium.content_public.browser.WebContents;
 import org.chromium.content_shell.Shell;
+import org.chromium.content_shell_apk.ContentShellActivityTestRule.RerunWithUpdatedContainerView;
+import org.chromium.content_shell_apk.ContentShellTestCommon.TestCommonCallback;
 
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
 import java.lang.reflect.AnnotatedElement;
-import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutionException;
-import java.util.concurrent.TimeUnit;
 
 /**
  * Base test class for all ContentShell based tests.
  */
 @CommandLineFlags.Add(ContentSwitches.ENABLE_TEST_INTENTS)
-public class ContentShellTestBase
-        extends BaseActivityInstrumentationTestCase<ContentShellActivity> {
-    /** The maximum time the waitForActiveShellToBeDoneLoading method will wait. */
-    private static final long WAIT_FOR_ACTIVE_SHELL_LOADING_TIMEOUT = scaleTimeout(10000);
+public class ContentShellTestBase extends BaseActivityInstrumentationTestCase<ContentShellActivity>
+        implements TestCommonCallback<ContentShellActivity> {
+    protected static final long WAIT_PAGE_LOADING_TIMEOUT_SECONDS =
+            ContentShellTestCommon.WAIT_PAGE_LOADING_TIMEOUT_SECONDS;
 
-    protected static final long WAIT_PAGE_LOADING_TIMEOUT_SECONDS = scaleTimeout(15);
+    private ContentShellTestCommon mDelegate;
 
     public ContentShellTestBase() {
         super(ContentShellActivity.class);
+        mDelegate = new ContentShellTestCommon(this);
+    }
+
+    @SuppressWarnings("deprecation")
+    @Override
+    public ContentShellActivity getActivityForTestCommon() {
+        return getActivity();
     }
 
     @Override
+    @SuppressWarnings("deprecation")
+    public Instrumentation getInstrumentationForTestCommon() {
+        return getInstrumentation();
+    }
+
+    @SuppressWarnings("deprecation")
+    @Override
+    public ContentShellActivity launchActivityWithIntentForTestCommon(Intent intent) {
+        setActivityIntent(intent);
+        return getActivity();
+    }
+
+    @SuppressWarnings("deprecation")
+    @Override
+    public void runOnUiThreadForTestCommon(Runnable runnable) throws Throwable {
+        runTestOnUiThread(runnable);
+    }
+
+    @Override
+    @SuppressWarnings("deprecation")
     protected void setUp() throws Exception {
         super.setUp();
-        assertScreenIsOn();
-    }
-
-    @TargetApi(Build.VERSION_CODES.KITKAT_WATCH)
-    @SuppressWarnings("deprecation")
-    private void assertScreenIsOn() {
-        PowerManager pm = (PowerManager) getInstrumentation().getContext().getSystemService(
-                Context.POWER_SERVICE);
-
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT_WATCH) {
-            assertTrue("Many tests will fail if the screen is not on.", pm.isInteractive());
-        } else {
-            assertTrue("Many tests will fail if the screen is not on.", pm.isScreenOn());
-        }
+        mDelegate.assertScreenIsOn();
     }
 
     /**
      * Starts the ContentShell activity and loads the given URL.
      * The URL can be null, in which case will default to ContentShellActivity.DEFAULT_SHELL_URL.
      */
-    protected ContentShellActivity launchContentShellWithUrl(String url) {
-        Intent intent = new Intent(Intent.ACTION_MAIN);
-        intent.addCategory(Intent.CATEGORY_LAUNCHER);
-        intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
-        if (url != null) intent.setData(Uri.parse(url));
-        intent.setComponent(new ComponentName(getInstrumentation().getTargetContext(),
-                ContentShellActivity.class));
-        setActivityIntent(intent);
-        return getActivity();
+    public ContentShellActivity launchContentShellWithUrl(String url) {
+        return mDelegate.launchContentShellWithUrl(url);
     }
 
     // TODO(cjhopman): These functions are inconsistent with launchContentShell***. Should be
     // startContentShell*** and should use the url exactly without the getTestFileUrl call. Possibly
     // these two ways of starting the activity (launch* and start*) should be merged into one.
     /**
      * Starts the content shell activity with the provided test url.
      * The url is synchronously loaded.
      * @param url Test url to load.
      */
-    protected void startActivityWithTestUrl(String url) {
-        launchContentShellWithUrl(UrlUtils.getIsolatedTestFileUrl(url));
-        assertNotNull(getActivity());
-        waitForActiveShellToBeDoneLoading();
-        assertEquals(UrlUtils.getIsolatedTestFileUrl(url),
-                getContentViewCore().getWebContents().getUrl());
+    public void startActivityWithTestUrl(String url) {
+        mDelegate.launchContentShellWithUrlSync(url);
     }
 
     /**
      * Returns the current ContentViewCore or null if there is no ContentView.
      */
-    protected ContentViewCore getContentViewCore() {
-        return getActivity().getActiveShell().getContentViewCore();
+    public ContentViewCore getContentViewCore() {
+        return mDelegate.getContentViewCore();
     }
 
     /**
      * Returns the WebContents of this Shell.
      */
-    protected WebContents getWebContents() {
-        return getActivity().getActiveShell().getWebContents();
+    public WebContents getWebContents() {
+        return mDelegate.getWebContents();
     }
 
     /**
      * Waits for the Active shell to finish loading.  This times out after
      * WAIT_FOR_ACTIVE_SHELL_LOADING_TIMEOUT milliseconds and it shouldn't be used for long
      * loading pages. Instead it should be used more for test initialization. The proper way
      * to wait is to use a TestCallbackHelperContainer after the initial load is completed.
      */
-    protected void waitForActiveShellToBeDoneLoading() {
-        final ContentShellActivity activity = getActivity();
-
-        // Wait for the Content Shell to be initialized.
-        CriteriaHelper.pollUiThread(new Criteria() {
-            @Override
-            public boolean isSatisfied() {
-                Shell shell = activity.getActiveShell();
-                // There are two cases here that need to be accounted for.
-                // The first is that we've just created a Shell and it isn't
-                // loading because it has no URL set yet.  The second is that
-                // we've set a URL and it actually is loading.
-                if (shell == null) {
-                    updateFailureReason("Shell is null.");
-                    return false;
-                }
-                if (shell.isLoading()) {
-                    updateFailureReason("Shell is still loading.");
-                    return false;
-                }
-                if (TextUtils.isEmpty(shell.getContentViewCore().getWebContents().getUrl())) {
-                    updateFailureReason("Shell's URL is empty or null.");
-                    return false;
-                }
-                return true;
-            }
-        }, WAIT_FOR_ACTIVE_SHELL_LOADING_TIMEOUT, CriteriaHelper.DEFAULT_POLLING_INTERVAL);
+    public void waitForActiveShellToBeDoneLoading() {
+        mDelegate.waitForActiveShellToBeDoneLoading();
     }
 
     /**
      * Creates a new {@link Shell} and waits for it to finish loading.
      * @param url The URL to create the new {@link Shell} with.
      * @return A new instance of a {@link Shell}.
      * @throws ExecutionException
      */
-    protected Shell loadNewShell(final String url) throws ExecutionException {
-        Shell shell = ThreadUtils.runOnUiThreadBlocking(new Callable<Shell>() {
-            @Override
-            public Shell call() {
-                getActivity().getShellManager().launchShell(url);
-                return getActivity().getActiveShell();
-            }
-        });
+    public Shell loadNewShell(String url) throws ExecutionException {
+        return mDelegate.loadNewShell(url);
+    }
 
-        assertNotNull("Unable to create shell.", shell);
-        assertEquals("Active shell unexpected.", shell, getActivity().getActiveShell());
-
-        waitForActiveShellToBeDoneLoading();
-
-        return shell;
-    }
     /**
      * Loads a URL in the specified content view.
      *
      * @param navigationController The navigation controller to load the URL in.
      * @param callbackHelperContainer The callback helper container used to monitor progress.
      * @param params The URL params to use.
      */
-    protected void loadUrl(
-            final NavigationController navigationController,
-            TestCallbackHelperContainer callbackHelperContainer,
-            final LoadUrlParams params) throws Throwable {
-        handleBlockingCallbackAction(
-                callbackHelperContainer.getOnPageFinishedHelper(),
-                new Runnable() {
-                    @Override
-                    public void run() {
-                        navigationController.loadUrl(params);
-                    }
-                });
+    public void loadUrl(NavigationController navigationController,
+            TestCallbackHelperContainer callbackHelperContainer, LoadUrlParams params)
+            throws Throwable {
+        mDelegate.loadUrl(navigationController, callbackHelperContainer, params);
     }
 
     /**
      * Handles performing an action on the UI thread that will return when the specified callback
      * is incremented.
      *
      * @param callbackHelper The callback helper that will be blocked on.
      * @param action The action to be performed on the UI thread.
      */
-    protected void handleBlockingCallbackAction(
-            CallbackHelper callbackHelper, Runnable action) throws Throwable {
-        int currentCallCount = callbackHelper.getCallCount();
-        runTestOnUiThread(action);
-        callbackHelper.waitForCallback(
-                currentCallCount, 1, WAIT_PAGE_LOADING_TIMEOUT_SECONDS, TimeUnit.SECONDS);
+    public void handleBlockingCallbackAction(CallbackHelper callbackHelper, Runnable action)
+            throws Throwable {
+        mDelegate.handleBlockingCallbackAction(callbackHelper, action);
     }
 
     // TODO(aelias): This method needs to be removed once http://crbug.com/179511 is fixed.
     // Meanwhile, we have to wait if the page has the <meta viewport> tag.
     /**
      * Waits till the ContentViewCore receives the expected page scale factor
      * from the compositor and asserts that this happens.
      */
-    protected void assertWaitForPageScaleFactorMatch(float expectedScale) {
-        CriteriaHelper.pollInstrumentationThread(
-                Criteria.equals(expectedScale, new Callable<Float>() {
-                    @Override
-                    public Float call() {
-                        return getContentViewCore().getScale();
-                    }
-                }));
+    public void assertWaitForPageScaleFactorMatch(float expectedScale) {
+        mDelegate.assertWaitForPageScaleFactorMatch(expectedScale);
     }
 
     /**
      * Replaces the {@link ContentViewCore#mContainerView} with a newly created
      * {@link ContentView}.
      */
     @SuppressWarnings("javadoc")
-    protected void replaceContainerView() throws Throwable {
-        ThreadUtils.runOnUiThreadBlocking(new Runnable() {
-                @Override
-            public void run() {
-                ContentView cv = ContentView.createContentView(getActivity(), getContentViewCore());
-                ((ViewGroup) getContentViewCore().getContainerView().getParent()).addView(cv);
-                getContentViewCore().setContainerView(cv);
-                getContentViewCore().setContainerViewInternals(cv);
-                cv.requestFocus();
-            }
-        });
+    public void replaceContainerView() throws Throwable {
+        mDelegate.replaceContainerView();
     }
 
+    @SuppressWarnings("deprecation")
     @Override
     protected void runTest() throws Throwable {
         super.runTest();
         try {
             AnnotatedElement method = getClass().getMethod(getName(), (Class[]) null);
             if (method.isAnnotationPresent(RerunWithUpdatedContainerView.class)) {
                 replaceContainerView();
                 super.runTest();
             }
         } catch (Throwable e) {
             throw new Throwable("@RerunWithUpdatedContainerView failed."
                     + " See ContentShellTestBase#runTest.", e);
         }
     }
-
-    /**
-     * Annotation for tests that should be executed a second time after replacing
-     * the ContentViewCore's container view (see {@link #runTest()}).
-     *
-     * <p>Please note that {@link #setUp()} is only invoked once before both runs,
-     * and that any state changes produced by the first run are visible to the second run.
-     */
-    @Target(ElementType.METHOD)
-    @Retention(RetentionPolicy.RUNTIME)
-    public @interface RerunWithUpdatedContainerView {
-    }
 }