Clarify WebappNavigationTests

This CL:
- Clarifies which tests test that a CCT is launched and which do not
- Adds testing that the toolbar is hidden/shown in test cases where the toolbar
  should be shown instead of launching a CCT.
- Removes deceptively named assertOffOrigin() which does not assert but instead
  waits for a condition to be met. Instead:
- Changes WebappNavigationTest#waitFor() to wait till the tab for an activity has
  been created
- Uses ChromeTabUtils#waitForTabPageLoaded()

BUG=None

Change-Id: If588dcc4ae2a9341221eb64ac7184bb5b75efd33
Reviewed-on: https://chromium-review.googlesource.com/777903
Commit-Queue: Peter Kotwicz <pkotwicz@chromium.org>
Reviewed-by: Dominick Ng <dominickn@chromium.org>
Cr-Commit-Position: refs/heads/master@{#517823}

chrome/android/javatests/src/org/chromium/chrome/browser/webapps/WebappNavigationTest.java

@@ -35,6 +35,7 @@ import org.chromium.chrome.browser.customtabs.CustomTabActivity;
 import org.chromium.chrome.browser.externalnav.ExternalNavigationHandler.OverrideUrlLoadingResult;
 import org.chromium.chrome.browser.firstrun.FirstRunStatus;
 import org.chromium.chrome.browser.tab.InterceptNavigationDelegateImpl;
+import org.chromium.chrome.browser.tab.Tab;
 import org.chromium.chrome.test.ChromeJUnit4ClassRunner;
 import org.chromium.chrome.test.util.ChromeTabUtils;
 import org.chromium.chrome.test.util.MenuUtils;
@@ -66,43 +67,79 @@ public class WebappNavigationTest {
     @Rule
     public final NativeLibraryTestRule mNativeLibraryTestRule = new NativeLibraryTestRule();
 
+    /**
+     * Test that navigating a webapp whose launch intent does not specify a theme colour outside of
+     * the webapp scope by tapping a regular link:
+     * - Shows a CCT-like webapp toolbar.
+     * - Uses the default theme colour as the toolbar colour.
+     */
     @Test
     @SmallTest
     @Feature({"Webapps"})
     @RetryOnFailure
-    public void testRegularLinkOffOriginInCctNoWebappThemeColor() throws Exception {
+    public void testRegularLinkOffOriginNoWebappThemeColor() throws Exception {
         WebappActivity activity = runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent());
+        assertToolbarShowState(activity, false);
+
+        addAnchorAndClick(offOriginUrl(), "_self");
+
+        ChromeTabUtils.waitForTabPageLoaded(activity.getActivityTab(), offOriginUrl());
+        assertToolbarShowState(activity, true);
         Assert.assertEquals(
-                "Toolbar should use default primary color if theme color is not specified",
-                ApiCompatibilityUtils.getColor(
-                        activity.getResources(), R.color.default_primary_color),
-                activity.getToolbarManager().getPrimaryColor());
+                getDefaultPrimaryColor(), activity.getToolbarManager().getPrimaryColor());
+    }
 
-        addAnchor("testId", offOriginUrl(), "_self");
-        DOMUtils.clickNode(activity.getActivityTab().getContentViewCore(), "testId");
-        mActivityTestRule.waitUntilIdle();
+    /**
+     * Test that navigating a webapp whose launch intent specifies a theme colour outside of the
+     * webapp scope by tapping a regular link:
+     * - Shows a CCT-like webapp toolbar.
+     * - Uses the webapp theme colour as the toolbar colour.
+     */
+    @Test
+    @SmallTest
+    @Feature({"Webapps"})
+    @RetryOnFailure
+    public void testRegularLinkOffOriginThemeColor() throws Exception {
+        WebappActivity activity =
+                runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent().putExtra(
+                        ShortcutHelper.EXTRA_THEME_COLOR, (long) Color.CYAN));
+        assertToolbarShowState(activity, false);
+
+        addAnchorAndClick(offOriginUrl(), "_self");
 
-        assertOffOrigin(activity);
+        ChromeTabUtils.waitForTabPageLoaded(activity.getActivityTab(), offOriginUrl());
+        assertToolbarShowState(activity, true);
+        Assert.assertEquals(Color.CYAN, activity.getToolbarManager().getPrimaryColor());
     }
 
+    /**
+     * Test that navigating outside of the webapp scope by changing the top location via JavaScript:
+     * - Shows a CCT-like webapp toolbar.
+     * - Preserves the theme color specified in the launch intent.
+     */
     @Test
     @SmallTest
     @Feature({"Webapps"})
     @RetryOnFailure
-    public void testWindowTopLocationOffOriginInCctAndWebappThemeColor() throws Exception {
+    public void testWindowTopLocationOffOrigin() throws Exception {
         WebappActivity activity =
                 runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent().putExtra(
                         ShortcutHelper.EXTRA_THEME_COLOR, (long) Color.CYAN));
-        Assert.assertEquals("Toolbar should use the theme color of a webapp", Color.CYAN,
-                activity.getToolbarManager().getPrimaryColor());
+        assertToolbarShowState(activity, false);
 
         mActivityTestRule.runJavaScriptCodeInCurrentTab(
                 String.format("window.top.location = '%s'", offOriginUrl()));
-        mActivityTestRule.waitUntilIdle();
 
-        assertOffOrigin(activity);
+        ChromeTabUtils.waitForTabPageLoaded(activity.getActivityTab(), offOriginUrl());
+        assertToolbarShowState(activity, true);
+        Assert.assertEquals(Color.CYAN, activity.getToolbarManager().getPrimaryColor());
     }
 
+    /**
+     * Test that navigating outside of the webapp scope by tapping a link with target="_blank":
+     * - Launches a CCT.
+     * - The CCT toolbar does not use the webapp theme colour.
+     */
     @Test
     @SmallTest
     @Feature({"Webapps"})
@@ -110,40 +147,46 @@ public class WebappNavigationTest {
     public void testOffScopeNewTabLinkOpensInCct() throws Exception {
         runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent().putExtra(
                 ShortcutHelper.EXTRA_THEME_COLOR, (long) Color.CYAN));
-        addAnchor("testId", offOriginUrl(), "_blank");
-        DOMUtils.clickNode(
-                mActivityTestRule.getActivity().getActivityTab().getContentViewCore(), "testId");
-        CustomTabActivity customTab = assertCustomTabActivityLaunchedForOffOriginUrl();
+        addAnchorAndClick(offOriginUrl(), "_blank");
+        CustomTabActivity customTab = waitFor(CustomTabActivity.class);
+        ChromeTabUtils.waitForTabPageLoaded(customTab.getActivityTab(), offOriginUrl());
+
         Assert.assertEquals(
-                "CCT Toolbar should use default primary color even if webapp has theme color",
-                ApiCompatibilityUtils.getColor(
-                        customTab.getResources(), R.color.default_primary_color),
-                customTab.getToolbarManager().getPrimaryColor());
+                getDefaultPrimaryColor(), customTab.getToolbarManager().getPrimaryColor());
     }
 
+    /**
+     * Test that navigating within the webapp scope by tapping a link with target="_blank" launches
+     * a CCT.
+     */
     @Test
     @SmallTest
     @Feature({"Webapps"})
     @RetryOnFailure
     public void testInScopeNewTabLinkOpensInCct() throws Exception {
+        String inScopeUrl = mActivityTestRule.getTestServer().getURL(IN_SCOPE_PAGE_PATH);
         runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent().putExtra(
                 ShortcutHelper.EXTRA_THEME_COLOR, (long) Color.CYAN));
-        addAnchor("testId", mActivityTestRule.getTestServer().getURL(IN_SCOPE_PAGE_PATH), "_blank");
-        DOMUtils.clickNode(
-                mActivityTestRule.getActivity().getActivityTab().getContentViewCore(), "testId");
+        addAnchorAndClick(inScopeUrl, "_blank");
         CustomTabActivity customTab = waitFor(CustomTabActivity.class);
-        mActivityTestRule.waitUntilIdle(customTab);
+        ChromeTabUtils.waitForTabPageLoaded(customTab.getActivityTab(), inScopeUrl);
         Assert.assertTrue(
                 mActivityTestRule.runJavaScriptCodeInCurrentTab("document.body.textContent")
                         .contains("Do-nothing page with a service worker"));
     }
 
+    /**
+     * Test that navigating outside of the webapp via window.open():
+     * - Launches a CCT.
+     * - The CCT toolbar does not use the webapp theme colour.
+     */
     @Test
     @SmallTest
     @Feature({"Webapps"})
     @RetryOnFailure
     public void testWindowOpenInCct() throws Exception {
-        runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent());
+        runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent().putExtra(
+                ShortcutHelper.EXTRA_THEME_COLOR, (long) Color.CYAN));
         // Executing window.open() through a click on a link,
         // as it needs user gesture to avoid Chrome blocking it as a popup.
         mActivityTestRule.runJavaScriptCodeInCurrentTab(
@@ -159,30 +202,28 @@ public class WebappNavigationTest {
         DOMUtils.clickNode(
                 mActivityTestRule.getActivity().getActivityTab().getContentViewCore(), "testId");
 
-        CustomTabActivity customTab = assertCustomTabActivityLaunchedForOffOriginUrl();
-        Assert.assertEquals("CCT Toolbar should use default primary color",
-                ApiCompatibilityUtils.getColor(
-                        customTab.getResources(), R.color.default_primary_color),
-                customTab.getToolbarManager().getPrimaryColor());
+        CustomTabActivity customTab = waitFor(CustomTabActivity.class);
+        ChromeTabUtils.waitForTabPageLoaded(customTab.getActivityTab(), offOriginUrl());
+        Assert.assertEquals(
+                getDefaultPrimaryColor(), customTab.getToolbarManager().getPrimaryColor());
     }
 
+    /**
+     * Test that navigating a webapp within the webapp scope by tapping a regular link:
+     * - Does not show a CCT-like webapp toolbar.
+     * - Does not launch a CCT.
+     */
     @Test
     @SmallTest
     @Feature({"Webapps"})
     @RetryOnFailure
     public void testInScopeNavigationStaysInWebapp() throws Exception {
-        runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent());
-
+        WebappActivity activity = runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent());
         String otherPageUrl = mActivityTestRule.getTestServer().getURL(IN_SCOPE_PAGE_PATH);
-        mActivityTestRule.loadUrlInTab(otherPageUrl, PageTransition.LINK,
-                mActivityTestRule.getActivity().getActivityTab());
+        addAnchorAndClick(otherPageUrl, "_self");
+        ChromeTabUtils.waitForTabPageLoaded(activity.getActivityTab(), otherPageUrl);
 
-        mActivityTestRule.waitUntilIdle();
-        Assert.assertEquals(
-                otherPageUrl, mActivityTestRule.getActivity().getActivityTab().getUrl());
-
-        Assert.assertSame(
-                mActivityTestRule.getActivity(), ApplicationStatus.getLastTrackedFocusedActivity());
+        assertToolbarShowState(activity, false);
     }
 
     @Test
@@ -202,9 +243,7 @@ public class WebappNavigationTest {
                 R.id.contextmenu_open_in_chrome);
 
         ChromeTabbedActivity tabbedChrome = waitFor(ChromeTabbedActivity.class);
-
-        mActivityTestRule.waitUntilIdle(tabbedChrome);
-        assertOffOrigin(tabbedChrome);
+        ChromeTabUtils.waitForTabPageLoaded(tabbedChrome.getActivityTab(), offOriginUrl());
     }
 
     @Test
@@ -220,11 +259,8 @@ public class WebappNavigationTest {
                 InstrumentationRegistry.getInstrumentation(), activity, R.id.open_in_browser_id);
 
         ChromeTabbedActivity tabbedChrome = waitFor(ChromeTabbedActivity.class);
-        mActivityTestRule.waitUntilIdle(tabbedChrome);
-
-        Assert.assertEquals("Tab in tabbed activity should show the Web App page",
-                mActivityTestRule.getTestServer().getURL(WEB_APP_PATH),
-                tabbedChrome.getActivityTab().getUrl());
+        ChromeTabUtils.waitForTabPageLoaded(tabbedChrome.getActivityTab(),
+                mActivityTestRule.getTestServer().getURL(WEB_APP_PATH));
     }
 
     @Test
@@ -237,9 +273,7 @@ public class WebappNavigationTest {
         InterceptNavigationDelegateImpl navigationDelegate =
                 mActivityTestRule.getActivity().getActivityTab().getInterceptNavigationDelegate();
 
-        addAnchor("testLink", YOUTUBE_URL, "_self");
-        DOMUtils.clickNode(
-                mActivityTestRule.getActivity().getActivityTab().getContentViewCore(), "testLink");
+        addAnchorAndClick(YOUTUBE_URL, "_self");
 
         waitForExternalAppOrIntentPicker();
         Assert.assertEquals(OverrideUrlLoadingResult.OVERRIDE_WITH_EXTERNAL_INTENT,
@@ -253,9 +287,7 @@ public class WebappNavigationTest {
     public void testNewTabLinkToExternalApp() throws Exception {
         runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent());
 
-        addAnchor("testLink", YOUTUBE_URL, "_blank");
-        DOMUtils.clickNode(
-                mActivityTestRule.getActivity().getActivityTab().getContentViewCore(), "testLink");
+        addAnchorAndClick(YOUTUBE_URL, "_blank");
 
         waitForExternalAppOrIntentPicker();
     }
@@ -275,13 +307,9 @@ public class WebappNavigationTest {
                 mActivityTestRule.getActivity(), R.id.open_in_browser_id);
 
         ChromeTabbedActivity tabbedChrome = waitFor(ChromeTabbedActivity.class);
-        mActivityTestRule.waitUntilIdle(tabbedChrome);
-
         ThreadUtils.runOnUiThreadBlocking(
                 () -> tabbedChrome.getActivityTab().loadUrl(new LoadUrlParams(offOriginUrl())));
-
-        mActivityTestRule.waitUntilIdle(tabbedChrome);
-        assertOffOrigin(tabbedChrome);
+        ChromeTabUtils.waitForTabPageLoaded(tabbedChrome.getActivityTab(), offOriginUrl());
     }
 
     @Test
@@ -290,30 +318,27 @@ public class WebappNavigationTest {
     @RetryOnFailure
     public void testCloseButtonReturnsToMostRecentInScopeUrl() throws Exception {
         WebappActivity activity = runWebappActivityAndWaitForIdle(mActivityTestRule.createIntent());
+        Tab tab = activity.getActivityTab();
 
         String otherInScopeUrl = mActivityTestRule.getTestServer().getURL(IN_SCOPE_PAGE_PATH);
         mActivityTestRule.loadUrlInTab(
                 otherInScopeUrl, PageTransition.LINK, activity.getActivityTab());
-        Assert.assertEquals(otherInScopeUrl, activity.getActivityTab().getUrl());
+        Assert.assertEquals(otherInScopeUrl, tab.getUrl());
 
-        ThreadUtils.runOnUiThreadBlocking(() -> activity.getActivityTab().loadUrl(
-                new LoadUrlParams(offOriginUrl(), PageTransition.LINK)));
-        assertOffOrigin(activity);
-        ThreadUtils.runOnUiThreadBlocking(() -> activity.getActivityTab().loadUrl(
-                new LoadUrlParams("https://www.mozilla.org/", PageTransition.LINK)));
-        mActivityTestRule.waitUntilIdle();
+        mActivityTestRule.loadUrlInTab(offOriginUrl(), PageTransition.LINK, tab);
+        String mozillaUrl = mActivityTestRule.getTestServer().getURLWithHostName(
+                "mozilla.org", "/defaultresponse");
+        mActivityTestRule.loadUrlInTab(mozillaUrl, PageTransition.LINK, tab);
+
+        // Toolbar with the close button should be visible.
+        assertToolbarShowState(activity, true);
 
         // Navigate back to in-scope through a close button.
         ThreadUtils.runOnUiThreadBlocking(() -> activity.getToolbarManager()
                 .getToolbarLayout().findViewById(R.id.close_button).callOnClick());
 
         // We should end up on most recent in-scope URL.
-        CriteriaHelper.pollUiThread(new Criteria() {
-            @Override
-            public boolean isSatisfied() {
-                return otherInScopeUrl.equals(activity.getActivityTab().getUrl());
-            }
-        });
+        ChromeTabUtils.waitForTabPageLoaded(tab, otherInScopeUrl);
     }
 
     @Test
@@ -353,24 +378,24 @@ public class WebappNavigationTest {
         return mActivityTestRule.getActivity();
     }
 
-    private CustomTabActivity assertCustomTabActivityLaunchedForOffOriginUrl()
-            throws InterruptedException {
-        CustomTabActivity customTab = waitFor(CustomTabActivity.class);
-
-        mActivityTestRule.waitUntilIdle(customTab);
-        assertOffOrigin(customTab);
+    private void assertToolbarShowState(final ChromeActivity activity, final boolean showState) {
+        ThreadUtils.runOnUiThreadBlocking(new Runnable() {
+            @Override
+            public void run() {
+                Assert.assertEquals(showState, activity.getActivityTab().canShowBrowserControls());
+            }
+        });
+    }
 
-        return customTab;
+    private long getDefaultPrimaryColor() {
+        return ApiCompatibilityUtils.getColor(
+                mActivityTestRule.getActivity().getResources(), R.color.default_primary_color);
     }
 
     private String offOriginUrl() {
         return mActivityTestRule.getTestServer().getURLWithHostName("foo.com", "/defaultresponse");
     }
 
-    private void assertOffOrigin(ChromeActivity activity) throws InterruptedException {
-        ChromeTabUtils.waitForTabPageLoaded(activity.getActivityTab(), offOriginUrl());
-    }
-
     private void addAnchor(String id, String url, String target) throws Exception {
         mActivityTestRule.runJavaScriptCodeInCurrentTab(
                 String.format("var aTag = document.createElement('a');"
@@ -382,14 +407,21 @@ public class WebappNavigationTest {
                         id, url, target));
     }
 
+    private void addAnchorAndClick(String url, String target) throws Exception {
+        addAnchor("testId", url, target);
+        DOMUtils.clickNode(
+                mActivityTestRule.getActivity().getActivityTab().getContentViewCore(), "testId");
+    }
+
     @SuppressWarnings("unchecked")
-    private <T extends Activity> T waitFor(final Class<T> expectedClass) {
+    private <T extends ChromeActivity> T waitFor(final Class<T> expectedClass) {
         final Activity[] holder = new Activity[1];
         CriteriaHelper.pollUiThread(new Criteria() {
             @Override
             public boolean isSatisfied() {
                 holder[0] = ApplicationStatus.getLastTrackedFocusedActivity();
-                return holder[0] != null && expectedClass.isAssignableFrom(holder[0].getClass());
+                return holder[0] != null && expectedClass.isAssignableFrom(holder[0].getClass())
+                        && ((ChromeActivity) holder[0]).getActivityTab() != null;
             }
         });
         return (T) holder[0];