[ios] Wait for new tab page load and animations to complete in tests.

Non CRWNativeContent NTP pages do not load instantly, and instead
load similarly to web view page loads.  Add logic to wait for the
webState to finish loading and the NTP animation to complete.

Bug: 783192
Change-Id: If3d47e7467c2831697ae8baf9fd8f6755aa535af
Reviewed-on: https://chromium-review.googlesource.com/c/1324229Reviewed-by: Peter Lee <pkl@chromium.org>
Reviewed-by: Eugene But <eugenebut@chromium.org>
Commit-Queue: Justin Cohen <justincohen@chromium.org>
Cr-Commit-Position: refs/heads/master@{#607338}

ios/chrome/browser/device_sharing/handoff_manager_egtest.mm

@@ -71,7 +71,7 @@ void AssertHandoffURL(const GURL& gurl) {
 
 // Tests Handoff URL for a new tab.
 - (void)testTypicalURLInNewTab {
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   const GURL destinationUrl = web::test::HttpServer::MakeUrl(
       "http://ios/testing/data/http_server_files/pony.html");
   [ChromeEarlGrey loadURL:destinationUrl];
@@ -81,7 +81,7 @@ void AssertHandoffURL(const GURL& gurl) {
 // Tests that Handoff URL should never be set for an incognito tab.
 - (void)testTypicalURLInNewIncognitoTab {
   // Opens an incognito tab and loads a web page. Check that Handoff URL is nil.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   const GURL destinationUrl = web::test::HttpServer::MakeUrl(
       "http://ios/testing/data/http_server_files/destination.html");
   [ChromeEarlGrey loadURL:destinationUrl];
@@ -107,9 +107,9 @@ void AssertHandoffURL(const GURL& gurl) {
 
   // Sets up the state for 3 tabs.
   [ChromeEarlGrey loadURL:tab1URL];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey loadURL:tab2URL];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey loadURL:tab3URL];
 
   // When tab 3 is closed, tab 2 is front and Handoff URL should be the URL for
@@ -135,13 +135,13 @@ void AssertHandoffURL(const GURL& gurl) {
   // Loads one page.
   [ChromeEarlGrey loadURL:tab1URL];
   // Loads page two in incognito and verifies that Handoff URL is nil.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey loadURL:tab2URL];
   AssertHandoffURL(GURL());
 
   // Loads page three in a new normal tab and verify that Handoff URL is not
   // nil.
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey loadURL:tab3URL];
   AssertHandoffURL(tab3URL);
 }

ios/chrome/browser/metrics/ukm_egtest.mm

@@ -144,7 +144,7 @@ void ClearBrowsingData() {
 
 void OpenNewIncognitoTab() {
   NSUInteger incognito_tab_count = GetIncognitoTabCount();
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey waitForIncognitoTabCount:(incognito_tab_count + 1)];
   GREYAssert(IsIncognitoMode(), @"Failed to switch to incognito mode.");
 }
@@ -171,7 +171,7 @@ void CloseAllIncognitoTabs() {
 
 void OpenNewRegularTab() {
   NSUInteger tab_count = chrome_test_util::GetMainTabCount();
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey waitForMainTabCount:(tab_count + 1)];
 }
 

ios/chrome/browser/net/cookies_egtest.mm

@@ -111,7 +111,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
 
   // Opens an incognito tab, loads the dummy page, and sets incognito test
   // cookie.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlIncognitoSetCookie)];
   cookies = [ChromeEarlGrey cookies];
@@ -122,7 +122,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
 
   // Switches back to normal profile by opening up a new tab. Test cookie
   // should not be found.
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlNormalBrowsing)];
   cookies = [ChromeEarlGrey cookies];
@@ -138,7 +138,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
   // incognito tabs and synchronize with the UI.
   [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
 
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlIncognitoBrowsing)];
   cookies = [ChromeEarlGrey cookies];
@@ -155,7 +155,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlNormalBrowsing)];
 
   // Opens an incognito tab, loads a page, and sets an incognito cookie.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlIncognitoSetCookie)];
   NSDictionary* cookies = [ChromeEarlGrey cookies];
@@ -170,13 +170,13 @@ NSString* const kIncognitoCookieValue = @"rainbow";
   // incognito tabs and synchronize with the UI.
   [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
 
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlNormalBrowsing)];
 
   // Opens a new incognito tab and verify that the previously set cookie
   // is no longer there.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlIncognitoBrowsing)];
   cookies = [ChromeEarlGrey cookies];
@@ -205,7 +205,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
                   @"Only one cookie should be found in normal mode.");
 
   // Switches to a new incognito tab and verifies that cookie is not there.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlIncognitoBrowsing)];
   cookies = [ChromeEarlGrey cookies];
@@ -219,7 +219,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
   // incognito tabs and synchronize with the UI.
   [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
 
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlNormalBrowsing)];
   cookies = [ChromeEarlGrey cookies];
@@ -237,7 +237,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
   // cookie in incognito tab.
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlNormalBrowsing)];
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlIncognitoSetCookie)];
   NSDictionary* cookies = [ChromeEarlGrey cookies];
@@ -248,7 +248,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
 
   // Switches back to a normal tab and verifies that cookie set in incognito tab
   // is not available.
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlNormalBrowsing)];
   cookies = [ChromeEarlGrey cookies];
@@ -256,7 +256,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
                   @"Incognito cookie should not be found in normal mode.");
 
   // Returns back to Incognito tab and cookie is still there.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlIncognitoBrowsing)];
   cookies = [ChromeEarlGrey cookies];
@@ -279,7 +279,7 @@ NSString* const kIncognitoCookieValue = @"rainbow";
                   @"Only one cookie should be found in normal mode.");
 
   // Creates another normal tab and verifies that the cookie is also there.
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey
       loadURL:web::test::HttpServer::MakeUrl(kTestUrlNormalBrowsing)];
   cookies = [ChromeEarlGrey cookies];

ios/chrome/browser/ntp_tiles/ntp_tiles_egtest.mm

@@ -47,7 +47,7 @@ using web::test::HttpServer;
   GREYAssertTrue(chrome_test_util::ClearBrowsingHistory(),
                  @"Clearing Browsing History timed out");
   [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
 
   [[EarlGrey selectElementWithMatcher:
                  chrome_test_util::StaticTextWithAccessibilityLabel(@"title1")]
@@ -59,9 +59,7 @@ using web::test::HttpServer;
   // with the icon present.
   [ChromeEarlGrey goBack];
 
-  chrome_test_util::OpenNewTab();
-  // New tab page is not loaded within a single tick so wait before assert.
-  [ChromeEarlGrey waitForPageToFinishLoading];
+  [ChromeEarlGrey openNewTab];
 
   [[EarlGrey selectElementWithMatcher:
                  chrome_test_util::StaticTextWithAccessibilityLabel(@"title1")]
@@ -95,7 +93,7 @@ using web::test::HttpServer;
   GREYAssertTrue(chrome_test_util::ClearBrowsingHistory(),
                  @"Clearing Browsing History timed out");
   [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [[EarlGrey selectElementWithMatcher:
                  chrome_test_util::StaticTextWithAccessibilityLabel(@"title2")]
       assertWithMatcher:grey_nil()];
@@ -107,7 +105,7 @@ using web::test::HttpServer;
   // After loading URL, need to do another action before opening a new tab
   // with the icon present.
   [ChromeEarlGrey goBack];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
 
   // Which of the two tiles that is displayed is an implementation detail, and
   // this test helps document it. The purpose of the test is to verify that only

ios/chrome/browser/prerender/prerender_egtest.mm

@@ -76,8 +76,7 @@ std::unique_ptr<net::test_server::HttpResponse> StandardResponse(
   [ChromeEarlGrey loadURL:pageURL];
   [ChromeEarlGrey goBack];
   [[self class] closeAllTabs];
-  chrome_test_util::OpenNewTab();
-  [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
+  [ChromeEarlGrey openNewTab];
 
   [[EarlGrey
       selectElementWithMatcher:grey_accessibilityID(
@@ -89,8 +88,7 @@ std::unique_ptr<net::test_server::HttpResponse> StandardResponse(
       performAction:grey_typeText([pageString stringByAppendingString:@"\n"])];
   [ChromeEarlGrey waitForPageToFinishLoading];
   [[self class] closeAllTabs];
-  chrome_test_util::OpenNewTab();
-  [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
+  [ChromeEarlGrey openNewTab];
 
   // Type the begining of the address to have the autocomplete suggestion.
   [[EarlGrey

ios/chrome/browser/translate/translate_egtest.mm

@@ -739,7 +739,7 @@ using translate::LanguageDetectionController;
   }
 
   // Do a translation in incognito
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey loadURL:URL];
   [self simulateTranslationFromSpanishToEnglish];
   // Check that the infobar does not contain the "Always Translate" switch.

ios/chrome/browser/ui/bookmarks/bookmarks_egtest.mm

@@ -278,7 +278,7 @@ id<GREYMatcher> SearchIconButton() {
   const GURL secondURL = web::test::HttpServer::MakeUrl(
       "http://ios/testing/data/http_server_files/destination.html");
   [ChromeEarlGrey loadURL:firstURL];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey loadURL:secondURL];
 
   [BookmarksTestCase bookmarkCurrentTabWithTitle:@"my bookmark"];
@@ -2115,7 +2115,7 @@ id<GREYMatcher> SearchIconButton() {
   [BookmarksTestCase verifyOrderOfTabsWithCurrentTabIndex:0];
 
   // Switch to Incognito mode by adding a new incognito tab.
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
 
   [BookmarksTestCase openBookmarks];
 

ios/chrome/browser/ui/content_suggestions/content_suggestions_egtest.mm

@@ -503,10 +503,7 @@ GREYElementInteraction* CellWithMatcher(id<GREYMatcher> matcher) {
   [ChromeEarlGrey goBack];
 
   [[self class] closeAllTabs];
-  chrome_test_util::OpenNewTab();
-  // TODO(crbug.com/783192): ChromeEarlGrey should have a method to open a new
-  // tab and synchronize with the UI.
-  [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
+  [ChromeEarlGrey openNewTab];
 
   [[EarlGrey selectElementWithMatcher:
                  chrome_test_util::StaticTextWithAccessibilityLabel(pageTitle)]

ios/chrome/browser/ui/content_suggestions/ntp_home_egtest.mm

@@ -577,7 +577,7 @@ std::unique_ptr<net::test_server::HttpResponse> StandardResponse(
   // with the icon present.
   [ChromeEarlGrey goBack];
   [[self class] closeAllTabs];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
 }
 
 @end

ios/chrome/browser/ui/download/download_manager_egtest.mm

@@ -114,9 +114,7 @@ bool WaitForDownloadButton() {
 // presented. EarlGrey does not allow testing "Open in..." dialog, because it
 // is run in a separate process. Performs download in Incognito.
 - (void)testSucessfullDownloadInIncognito {
-  chrome_test_util::OpenNewIncognitoTab();
-  [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
-
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGrey loadURL:self.testServer->GetURL("/")];
   [ChromeEarlGrey waitForWebViewContainingText:"Download"];
   [ChromeEarlGrey tapWebViewElementWithID:@"download"];
@@ -164,8 +162,7 @@ bool WaitForDownloadButton() {
     // does not wait until the download progress bar becomes idle (which will
     // not happen until the download is complete).
     ScopedSynchronizationDisabler disabler;
-    chrome_test_util::OpenNewTab();
-    [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
+    [ChromeEarlGrey openNewTab];
   }
 
   // Load a URL in a separate Tab and close that tab.

ios/chrome/browser/ui/infobars/infobar_egtest.mm

@@ -133,7 +133,7 @@ void VerifyNumberOfInfobarsInManager(size_t number_of_infobars) {
   NSString* infoBarMessage = @"TestInfoBar";
 
   // Create the second tab, navigate to the test page, and add the test infobar.
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey loadURL:ponyURL];
   [ChromeEarlGrey waitForMainTabCount:2];
   VerifyTestInfoBarVisibleForCurrentTab(false, infoBarMessage);

ios/chrome/browser/ui/ntp/new_tab_page_egtest.mm

@@ -18,6 +18,7 @@
 #import "ios/chrome/test/app/chrome_test_util.h"
 #import "ios/chrome/test/app/tab_test_util.h"
 #import "ios/chrome/test/earl_grey/accessibility_util.h"
+#import "ios/chrome/test/earl_grey/chrome_earl_grey.h"
 #import "ios/chrome/test/earl_grey/chrome_matchers.h"
 #import "ios/chrome/test/earl_grey/chrome_test_case.h"
 #include "ui/base/l10n/l10n_util.h"
@@ -61,7 +62,7 @@ void WaitForHistoryToDisappear() {
 
 // Tests that all items are accessible on the incognito page.
 - (void)testAccessibilityOnIncognitoTab {
-  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey openNewIncognitoTab];
   WaitForHistoryToDisappear();
   chrome_test_util::VerifyAccessibilityForCurrentScreen();
   GREYAssert(chrome_test_util::CloseAllIncognitoTabs(), @"Tabs did not close");

ios/chrome/browser/ui/recent_tabs/recent_tabs_egtest.mm

@@ -44,7 +44,7 @@ NSString* const kTitleOfTestPage = @"TestPageTitle";
 void OpenRecentTabsPanel() {
   // At least one tab is needed to be able to open the recent tabs panel.
   if (chrome_test_util::GetMainTabCount() == 0)
-    chrome_test_util::OpenNewTab();
+    [ChromeEarlGrey openNewTab];
 
   [ChromeEarlGreyUI openToolsMenu];
   [ChromeEarlGreyUI tapToolsMenuButton:RecentTabsMenuButton()];

ios/chrome/browser/ui/settings/settings_egtest.mm

@@ -607,8 +607,7 @@ bool IsCertificateCleared() {
 // Verifies that Settings opens when signed-out and in Incognito mode.
 // This tests that crbug.com/607335 has not regressed.
 - (void)testSettingsSignedOutIncognito {
-  chrome_test_util::OpenNewIncognitoTab();
-
+  [ChromeEarlGrey openNewIncognitoTab];
   [ChromeEarlGreyUI openSettingsMenu];
   [[EarlGrey selectElementWithMatcher:SettingsCollectionView()]
       assertWithMatcher:grey_notNil()];

ios/chrome/browser/ui/settings/sync_utils/sync_fake_server_egtest.mm

@@ -373,7 +373,7 @@ void AssertNumberOfEntitiesWithName(int entity_count,
 
   // Load both URLs in separate tabs.
   [ChromeEarlGrey loadURL:URL1];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey loadURL:URL2];
 
   // Sign in to sync, after opening two tabs.

ios/chrome/browser/ui/toolbar/adaptive_toolbar_egtest.mm

@@ -765,7 +765,7 @@ void FocusOmnibox() {
   [[GREYUIThreadExecutor sharedInstance] drainUntilIdleWithTimeout:2];
 
   [[self class] closeAllTabs];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
 
   // Check that the bottom toolbar is visible.
   [[EarlGrey selectElementWithMatcher:SearchButton()]

ios/chrome/browser/web/tab_order_egtest.mm

@@ -124,7 +124,7 @@ const char kLinksTestURL2Text[] = "arrived";
 
   // Add a non-owned tab. It should be added at the end and marked as the
   // current tab. Next tab should wrap back to index 0, the original parent tab.
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey waitForMainTabCount:6U];
   GREYAssertEqual(parentTab, chrome_test_util::GetNextTab(),
                   @"Unexpected next tab");

ios/chrome/browser/web/window_open_by_dom_egtest.mm

@@ -139,7 +139,7 @@ id<GREYMatcher> PopupBlocker() {
   [[EarlGrey selectElementWithMatcher:test_page_matcher]
       performAction:link_tap];
   [ChromeEarlGrey waitForMainTabCount:2];
-  chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey openNewTab];
   [ChromeEarlGrey waitForMainTabCount:3];
   chrome_test_util::SelectTabAtIndexInCurrentMode(0);
   [[EarlGrey selectElementWithMatcher:test_page_matcher]

ios/chrome/test/earl_grey/chrome_earl_grey.h

@@ -61,6 +61,9 @@ id ExecuteJavaScript(NSString* javascript, NSError* __autoreleasing* out_error);
 // Opens a new tab and waits for the new tab animation to complete.
 + (void)openNewTab;
 
+// Opens a new incognito tab and waits for the new tab animation to complete.
++ (void)openNewIncognitoTab;
+
 // Waits for the page to finish loading within a timeout, or a GREYAssert is
 // induced.
 + (void)waitForPageToFinishLoading;

ios/chrome/test/earl_grey/chrome_earl_grey.mm

@@ -133,6 +133,13 @@ id ExecuteJavaScript(NSString* javascript,
 
 + (void)openNewTab {
   chrome_test_util::OpenNewTab();
+  [ChromeEarlGrey waitForPageToFinishLoading];
+  [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
+}
+
++ (void)openNewIncognitoTab {
+  chrome_test_util::OpenNewIncognitoTab();
+  [ChromeEarlGrey waitForPageToFinishLoading];
   [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
 }
 

ios/chrome/test/earl_grey/chrome_test_case.mm

@@ -19,6 +19,7 @@
 #include "ios/chrome/test/app/signin_test_util.h"
 #import "ios/chrome/test/app/sync_test_util.h"
 #import "ios/chrome/test/app/tab_test_util.h"
+#import "ios/chrome/test/earl_grey/chrome_earl_grey.h"
 #import "ios/web/public/test/http_server/http_server.h"
 #include "testing/coverage_util_ios.h"
 
@@ -194,8 +195,7 @@ const CFTimeInterval kDrainTimeout = 5;
 
   chrome_test_util::ResetSigninPromoPreferences();
   chrome_test_util::ResetMockAuthentication();
-  chrome_test_util::OpenNewTab();
-  [[GREYUIThreadExecutor sharedInstance] drainUntilIdle];
+  [ChromeEarlGrey openNewTab];
 }
 
 // Tear down called once per test, to close all tabs and menus, and clear the