Create ChromeEarlGrey waitForWebViewContainingText.

ios/chrome/browser/ui/dialogs/javascript_dialog_egtest.mm

 // Copyright 2016 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.
 
 #import <EarlGrey/EarlGrey.h>
 #import <UIKit/UIKit.h>
 #import <XCTest/XCTest.h>
 
 #import "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
 #include "components/strings/grit/components_strings.h"
 #import "ios/chrome/browser/ui/dialogs/dialog_presenter.h"
 #include "ios/chrome/browser/ui/tools_menu/tools_menu_constants.h"
 #include "ios/chrome/browser/ui/ui_util.h"
 #include "ios/chrome/grit/ios_strings.h"
 #include "ios/chrome/test/app/chrome_test_util.h"
 #import "ios/chrome/test/earl_grey/chrome_actions.h"
 #import "ios/chrome/test/earl_grey/chrome_earl_grey.h"
 #import "ios/chrome/test/earl_grey/chrome_earl_grey_ui.h"
 #import "ios/chrome/test/earl_grey/chrome_matchers.h"
 #import "ios/chrome/test/earl_grey/chrome_test_case.h"
 #import "ios/testing/earl_grey/matchers.h"
 #import "ios/testing/wait_util.h"
+#import "ios/web/public/test/earl_grey/web_view_matchers.h"
 #import "ios/web/public/test/http_server.h"
 #import "ios/web/public/test/http_server_util.h"
 #include "ios/web/public/test/url_test_util.h"
 #include "ios/web/public/web_state/web_state.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/l10n/l10n_util_mac.h"
 #import "url/gurl.h"
 
 #if !defined(__has_feature) || !__has_feature(objc_arc)
 #error "This file requires ARC support."
 #endif
 
 using chrome_test_util::NavigationBarDoneButton;
 using web::test::HttpServer;
 
 namespace {
 
 // Enum specifying different types of JavaScript alerts:
 //   - JavaScriptAlertType::ALERT - Dialog with only one OK button.
 //   - JavaScriptAlertType::CONFIRMATION - Dialog with OK and Cancel button.
 //   - JavaScriptAlertType::PROMPT - Dialog with OK button, cancel button, and
 //     a text field.
 enum class JavaScriptAlertType : NSUInteger { ALERT, CONFIRMATION, PROMPT };
 
 // Script to inject that will show an alert.  The document's body will be reset
 // to |kAlertResultBody| after the dialog is dismissed.
-const char kAlertMessage[] = "This is a JavaScript alert.";
-const char kAlertResultBody[] = "JAVASCRIPT ALERT WAS DISMISSED";
-const char kJavaScriptAlertTestScriptFormat[] =
-    "(function(){ "
-    "  alert(\"%@\");"
-    "  document.body.innerHTML = \"%@\";"
-    "})();";
+NSString* const kAlertMessage = @"This is a JavaScript alert.";
+NSString* const kAlertResultBody = @"JAVASCRIPT ALERT WAS DISMISSED";
+NSString* const kJavaScriptAlertTestScriptFormat =
+    @"(function(){ "
+     "  alert(\"%@\");"
+     "  document.body.innerHTML = \"%@\";"
+     "})();";
 NSString* GetJavaScriptAlertTestScript() {
-  return [NSString stringWithFormat:@(kJavaScriptAlertTestScriptFormat),
-                                    @(kAlertMessage), @(kAlertResultBody)];
+  return [NSString stringWithFormat:kJavaScriptAlertTestScriptFormat,
+                                    kAlertMessage, kAlertResultBody];
 }
 
 // Script to inject that will show a confirmation dialog.  The document's body
 // will be reset to |kConfirmationResultBodyOK| or
 // |kConfirmationResultBodyCancelled| depending on whether the OK or Cancel
 // button was tapped.
-const char kConfirmationMessage[] = "This is a JavaScript confirmation.";
-const char kConfirmationResultBodyOK[] = "Okay";
-const char kConfirmationResultBodyCancelled[] = "Cancelled";
-const char kJavaScriptConfirmationScriptFormat[] =
-    "(function(){ "
-    "  if (confirm(\"%@\") == true) {"
-    "    document.body.innerHTML = \"%@\";"
-    "  } else {"
-    "    document.body.innerHTML = \"%@\";"
-    "  }"
-    "})();";
+NSString* const kConfirmationMessage = @"This is a JavaScript confirmation.";
+NSString* const kConfirmationResultBodyOK = @"Okay";
+NSString* const kConfirmationResultBodyCancelled = @"Cancelled";
+NSString* const kJavaScriptConfirmationScriptFormat =
+    @"(function(){ "
+     "  if (confirm(\"%@\") == true) {"
+     "    document.body.innerHTML = \"%@\";"
+     "  } else {"
+     "    document.body.innerHTML = \"%@\";"
+     "  }"
+     "})();";
 NSString* GetJavaScriptConfirmationTestScript() {
-  return [NSString stringWithFormat:@(kJavaScriptConfirmationScriptFormat),
-                                    @(kConfirmationMessage),
-                                    @(kConfirmationResultBodyOK),
-                                    @(kConfirmationResultBodyCancelled)];
+  return [NSString stringWithFormat:kJavaScriptConfirmationScriptFormat,
+                                    kConfirmationMessage,
+                                    kConfirmationResultBodyOK,
+                                    kConfirmationResultBodyCancelled];
 }
 
 // Script to inject that will show a prompt dialog.  The document's body will be
 // reset to |kPromptResultBodyCancelled| or |kPromptTestUserInput| depending on
 // whether the OK or Cancel button was tapped.
-const char kPromptMessage[] = "This is a JavaScript prompt.";
-const char kPromptResultBodyCancelled[] = "Cancelled";
-const char kPromptTestUserInput[] = "test";
-const char kJavaScriptPromptTestScriptFormat[] =
-    "(function(){ "
-    "  var input = prompt(\"%@\");"
-    "  if (input != null) {"
-    "    document.body.innerHTML = input;"
-    "  } else {"
-    "    document.body.innerHTML = \"%@\";"
-    "  }"
-    "})();";
+NSString* const kPromptMessage = @"This is a JavaScript prompt.";
+NSString* const kPromptResultBodyCancelled = @"Cancelled";
+NSString* const kPromptTestUserInput = @"test";
+NSString* const kJavaScriptPromptTestScriptFormat =
+    @"(function(){ "
+     "  var input = prompt(\"%@\");"
+     "  if (input != null) {"
+     "    document.body.innerHTML = input;"
+     "  } else {"
+     "    document.body.innerHTML = \"%@\";"
+     "  }"
+     "})();";
 NSString* GetJavaScriptPromptTestScript() {
-  return [NSString stringWithFormat:@(kJavaScriptPromptTestScriptFormat),
-                                    @(kPromptMessage),
-                                    @(kPromptResultBodyCancelled)];
+  return [NSString stringWithFormat:kJavaScriptPromptTestScriptFormat,
+                                    kPromptMessage, kPromptResultBodyCancelled];
 }
 
 // Script to inject that will show a JavaScript alert in a loop 20 times, then
 // reset the document's HTML to |kAlertLoopFinishedText|.
-const char kAlertLoopFinishedText[] = "Loop Finished";
-const char kJavaScriptAlertLoopScriptFormat[] =
-    "(function(){ "
-    "  for (i = 0; i < 20; ++i) {"
-    "    alert(\"ALERT TEXT\");"
-    "  }"
-    "  document.body.innerHTML = \"%@\";"
-    "})();";
+NSString* const kAlertLoopFinishedText = @"Loop Finished";
+NSString* const kJavaScriptAlertLoopScriptFormat =
+    @"(function(){ "
+     "  for (i = 0; i < 20; ++i) {"
+     "    alert(\"ALERT TEXT\");"
+     "  }"
+     "  document.body.innerHTML = \"%@\";"
+     "})();";
 NSString* GetJavaScriptAlertLoopScript() {
-  return [NSString stringWithFormat:@(kJavaScriptAlertLoopScriptFormat),
-                                    @(kAlertLoopFinishedText)];
+  return [NSString stringWithFormat:kJavaScriptAlertLoopScriptFormat,
+                                    kAlertLoopFinishedText];
 }
 
 // Returns the message for a JavaScript alert with |type|.
 NSString* GetMessageForAlertWithType(JavaScriptAlertType type) {
   switch (type) {
     case JavaScriptAlertType::ALERT:
-      return @(kAlertMessage);
+      return kAlertMessage;
     case JavaScriptAlertType::CONFIRMATION:
-      return @(kConfirmationMessage);
+      return kConfirmationMessage;
     case JavaScriptAlertType::PROMPT:
-      return @(kPromptMessage);
+      return kPromptMessage;
   }
   GREYFail(@"JavascriptAlertType not recognized.");
   return nil;
 }
 
 // Returns the script to show a JavaScript alert with |type|.
 NSString* GetScriptForAlertWithType(JavaScriptAlertType type) {
   switch (type) {
     case JavaScriptAlertType::ALERT:
       return GetJavaScriptAlertTestScript();
     case JavaScriptAlertType::CONFIRMATION:
       return GetJavaScriptConfirmationTestScript();
     case JavaScriptAlertType::PROMPT:
       return GetJavaScriptPromptTestScript();
   }
   GREYFail(@"JavascriptAlertType not recognized.");
   return nil;
 }
 
 // HTTP server constants.
 
 // URL and response for a blank document.
-const char* kJavaScriptTestURL = "http://jsalerts";
-const char* kJavaScriptTestResponse =
+const char kJavaScriptTestURL[] = "http://jsalerts";
+const char kJavaScriptTestResponse[] =
     "<!DOCTYPE html><html><body></body></html>";
 
 // URL and response for a page with an onload alert.
-const char* kOnLoadAlertURL = "http://onloadalert";
-const char* kOnLoadAlertResponse =
+const char kOnLoadAlertURL[] = "http://onloadalert";
+const char kOnLoadAlertResponse[] =
     "<!DOCTYPE html><html><body onload=\"alert('alert')\"></body></html>";
 
 // URL and response for a page with a link to |kOnLoadAlertURL|.
-const char* kPageWithLinkURL = "http://pagewithlink";
-const char* kPageWithLinkResponseFormat =
-    "<!DOCTYPE html><html><body><a id=\"%s\" href=\"%s\">%s</a></body></html>";
-const char* kPageWithLinkText = "LINK TO ONLOAD ALERT PAGE";
-const char* kLinkID = "link-id";
+const char kPageWithLinkURL[] = "http://pagewithlink";
+NSString* const kPageWithLinkResponseFormat =
+    @"<!DOCTYPE html><html><body><a id=\"%@\" href=\"%@\">%@</a></body></html>";
+NSString* const kPageWithLinkText = @"LINK TO ONLOAD ALERT PAGE";
+const char kLinkID[] = "link-id";
 std::string GetPageWithLinkResponse() {
-  return base::SysNSStringToUTF8([NSString
-      stringWithFormat:@(kPageWithLinkResponseFormat), kLinkID,
-                       HttpServer::MakeUrl(kOnLoadAlertURL).spec().c_str(),
-                       kPageWithLinkText]);
-}
-
-// Waits until |string| is displayed on the web view.
-void WaitForWebDisplay(const std::string& string) {
-  id<GREYMatcher> response1Matcher =
-      chrome_test_util::WebViewContainingText(string);
-  [[EarlGrey selectElementWithMatcher:response1Matcher]
-      assertWithMatcher:grey_notNil()];
+  NSString* URL = base::SysUTF8ToNSString(

[Eugene But (OOO till 7-30), 2017/04/21 18:49:21]

nit: s/URL/spec

+      HttpServer::MakeUrl(kOnLoadAlertURL).spec().c_str());
+  return base::SysNSStringToUTF8(
+      [NSString stringWithFormat:kPageWithLinkResponseFormat, @(kLinkID), URL,

[Eugene But (OOO till 7-30), 2017/04/21 18:49:21]

Is there a reason for converting everything to NSString and %@? %s was working
and needed less boilerplate code.

[Eugene But (OOO till 7-30), 2017/04/21 18:49:21]

Isn't @(char[]) just a wrapper for initWithUTF8String:, which we decided not to
use? I think in Chrome we always use base::SysUTF8ToNSString to avoid problems
with null pointers.

[baxley, 2017/04/21 20:09:01]

Acknowledged.

+                                 kPageWithLinkText]);
 }
 
 // Display the javascript alert.
 void DisplayJavaScriptAlert(JavaScriptAlertType type) {
   // Get the WebController.
   web::WebState* webState = chrome_test_util::GetCurrentWebState();
 
   // Evaluate JavaScript.
   NSString* script = GetScriptForAlertWithType(type);
   webState->ExecuteJavaScript(base::SysNSStringToUTF16(script));
@@ skipping 133 matching lines @@
   if (!errorOK || !errorCancel) {
     GREYFail(@"There are still alerts");
   }
   [super tearDown];
 }
 
 #pragma mark - Utility
 
 - (void)loadBlankTestPage {
   [ChromeEarlGrey loadURL:HttpServer::MakeUrl(kJavaScriptTestURL)];
-  WaitForWebDisplay(std::string());
+  [ChromeEarlGrey waitForWebViewContainingText:@""];
 }
 
 - (void)loadPageWithLink {
   [ChromeEarlGrey loadURL:HttpServer::MakeUrl(kPageWithLinkURL)];
-  WaitForWebDisplay(kPageWithLinkText);
+  [ChromeEarlGrey waitForWebViewContainingText:kPageWithLinkText];
 }
 
 #pragma mark - Tests
 
 // Tests that an alert is shown, and that the completion block is called.
 - (void)testShowJavaScriptAlert {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
                           @"correctly.");
 #endif
 
   // Load the blank test page and show an alert.
   [self loadBlankTestPage];
   ShowJavaScriptDialog(JavaScriptAlertType::ALERT);
 
   // Tap the OK button.
   TapOK();
 
   // Wait for the html body to be reset to the correct value.
-  WaitForWebDisplay(kAlertResultBody);
+  [ChromeEarlGrey waitForWebViewContainingText:kAlertResultBody];
 }
 
 // Tests that a confirmation dialog is shown, and that the completion block is
 // called with the correct value when the OK buton is tapped.
 - (void)testShowJavaScriptConfirmationOK {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
                           @"correctly.");
 #endif
 
   // Load the blank test page and show a confirmation dialog.
   [self loadBlankTestPage];
   ShowJavaScriptDialog(JavaScriptAlertType::CONFIRMATION);
 
   // Tap the OK button.
   TapOK();
 
   // Wait for the html body to be reset to the correct value.
-  WaitForWebDisplay(kConfirmationResultBodyOK);
+  [ChromeEarlGrey waitForWebViewContainingText:kConfirmationResultBodyOK];
 }
 
 // Tests that a confirmation dialog is shown, and that the completion block is
 // called with the correct value when the Cancel buton is tapped.
 - (void)testShowJavaScriptConfirmationCancelled {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
                           @"correctly.");
 #endif
 
   // Load the blank test page and show a confirmation dialog.
   [self loadBlankTestPage];
   ShowJavaScriptDialog(JavaScriptAlertType::CONFIRMATION);
 
   // Tap the Cancel button.
   TapCancel();
 
   // Wait for the html body to be reset to the correct value.
-  WaitForWebDisplay(kConfirmationResultBodyCancelled);
+  [ChromeEarlGrey
+      waitForWebViewContainingText:kConfirmationResultBodyCancelled];
 }
 
 // Tests that a prompt dialog is shown, and that the completion block is called
 // with the correct value when the OK buton is tapped.
 - (void)testShowJavaScriptPromptOK {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
                           @"correctly.");
 #endif
 
   // Load the blank test page and show a prompt dialog.
   [self loadBlankTestPage];
   ShowJavaScriptDialog(JavaScriptAlertType::PROMPT);
 
   // Enter text into text field.
-  TypeInPrompt(@(kPromptTestUserInput));
+  TypeInPrompt(kPromptTestUserInput);
 
   // Tap the OK button.
   TapOK();
 
   // Wait for the html body to be reset to the input text.
-  WaitForWebDisplay(kPromptTestUserInput);
+  [ChromeEarlGrey waitForWebViewContainingText:kPromptTestUserInput];
 }
 
 // Tests that a prompt dialog is shown, and that the completion block is called
 // with the correct value when the Cancel buton is tapped.
 - (void)testShowJavaScriptPromptCancelled {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
                           @"correctly.");
 #endif
 
   // Load the blank test page and show a prompt dialog.
   [self loadBlankTestPage];
   ShowJavaScriptDialog(JavaScriptAlertType::PROMPT);
 
   // Enter text into text field.
-  TypeInPrompt(@(kPromptTestUserInput));
+  TypeInPrompt(kPromptTestUserInput);
 
   // Tap the Cancel button.
   TapCancel();
 
   // Wait for the html body to be reset to the cancel text.
-  WaitForWebDisplay(kPromptResultBodyCancelled);
+  [ChromeEarlGrey waitForWebViewContainingText:kPromptResultBodyCancelled];
 }
 
 // Tests that JavaScript alerts that are shown in a loop can be suppressed.
 - (void)testShowJavaScriptAlertLoop {
   // Load the blank test page and show alerts in a loop.
   [self loadBlankTestPage];
   web::WebState* webState = chrome_test_util::GetCurrentWebState();
   NSString* script = GetJavaScriptAlertLoopScript();
   webState->ExecuteJavaScript(base::SysNSStringToUTF16(script));
   WaitForJavaScripDialogToBeShown();
 
   // Tap the OK button and wait for another dialog to be shown.
   TapOK();
   WaitForJavaScripDialogToBeShown();
 
   // Tap the suppress dialogs button.
   TapSuppressDialogsButton();
 
   // Wait for confirmation action sheet to be shown.
   NSString* alertLabel =
       l10n_util::GetNSString(IDS_JAVASCRIPT_MESSAGEBOX_SUPPRESS_OPTION);
   WaitForAlertToBeShown(alertLabel);
 
   // Tap the suppress dialogs confirmation button.
   TapSuppressDialogsButton();
 
   // Wait for the html body to be reset to the loop finished text.
-  WaitForWebDisplay(kAlertLoopFinishedText);
+  [ChromeEarlGrey waitForWebViewContainingText:kAlertLoopFinishedText];
 }
 
 // Tests to ensure crbug.com/658260 does not regress.
 // Tests that if an alert should be called when settings are displays, the alert
 // waits for the dismiss of the settings.
 - (void)testShowJavaScriptBehindSettings {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
@@ skipping 23 matching lines @@
   [[EarlGrey selectElementWithMatcher:NavigationBarDoneButton()]
       performAction:grey_tap()];
 
   // Make sure the alert is present.
   WaitForJavaScripDialogToBeShown();
 
   // Tap the OK button.
   TapOK();
 
   // Wait for the html body to be reset to the correct value.
-  WaitForWebDisplay(kAlertResultBody);
+  [ChromeEarlGrey waitForWebViewContainingText:kAlertResultBody];
 }
 
 // Tests that an alert is presented after displaying the share menu.
 - (void)testShowJavaScriptAfterShareMenu {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
                           @"correctly.");
 #endif
 
   // Load the blank test page.
   [self loadBlankTestPage];
 
   [ChromeEarlGreyUI openShareMenu];
 
   // Copy URL, dismissing the share menu.
   id<GREYMatcher> printButton =
       grey_allOf(grey_accessibilityLabel(@"Copy"),
                  grey_accessibilityTrait(UIAccessibilityTraitButton), nil);
   [[EarlGrey selectElementWithMatcher:printButton] performAction:grey_tap()];
 
   // Show an alert and assert it is present.
   ShowJavaScriptDialog(JavaScriptAlertType::ALERT);
 
   // Tap the OK button.
   TapOK();
 
   // Wait for the html body to be reset to the correct value.
-  WaitForWebDisplay(kAlertResultBody);
+  [ChromeEarlGrey waitForWebViewContainingText:kAlertResultBody];
 }
 
 // Tests that an alert is presented after a new tab animation is finished.
 - (void)testShowJavaScriptAfterNewTabAnimation {
 // TODO(crbug.com/663026): Reenable the test for devices.
 #if !TARGET_IPHONE_SIMULATOR
   EARL_GREY_TEST_DISABLED(@"Disabled for devices because existing system "
                           @"alerts would prevent app alerts to present "
                           @"correctly.");
 #endif
 
   // Load the test page with a link to kOnLoadAlertURL and long tap on the link.
   [self loadPageWithLink];
+
+  // TODO(crbug.com/712358): Use method LongPressElementAndTapOnButton once
+  // it is moved out of context_menu_egtests.mm and into a shared location.
+  [ChromeEarlGrey waitForWebViewContainingText:kPageWithLinkText];
   id<GREYMatcher> webViewMatcher =
-      chrome_test_util::WebViewContainingText(std::string(kPageWithLinkText));
+      web::WebViewInWebState(chrome_test_util::GetCurrentWebState());
+
   [[EarlGrey selectElementWithMatcher:webViewMatcher]
       performAction:chrome_test_util::LongPressElementForContextMenu(
                         kLinkID, true /* menu should appear */)];
 
   // Tap on the "Open In New Tab" button.
   id<GREYMatcher> newTabMatcher = testing::ContextMenuItemWithText(
       l10n_util::GetNSStringWithFixup(IDS_IOS_CONTENT_CONTEXT_OPENLINKNEWTAB));
   [[EarlGrey selectElementWithMatcher:newTabMatcher] performAction:grey_tap()];
 
   // This test case requires that a dialog is presented in the onload event so
@@ skipping 27 matching lines @@
 
   // Reenable synchronization on iPads now that the dialog has been dismissed.
   if (IsIPadIdiom()) {
     [[GREYConfiguration sharedInstance]
             setValue:@(YES)
         forConfigKey:kGREYConfigKeySynchronizationEnabled];
   }
 }
 
 @end