Refactor Assert[No]CookieExists to return a boolean

ios/chrome/browser/ui/settings/settings_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>
 #include <map>
 
 #include "base/bind.h"
 #import "base/mac/bind_objc_block.h"
+#include "base/mac/foundation_util.h"
 #include "base/memory/ptr_util.h"
 #include "base/strings/sys_string_conversions.h"
 #include "components/browsing_data/core/pref_names.h"
 #include "components/metrics/metrics_pref_names.h"
 #include "components/password_manager/core/common/password_manager_pref_names.h"
 #include "components/prefs/pref_member.h"
 #include "components/prefs/pref_service.h"
 #include "components/strings/grit/components_strings.h"
 #import "ios/chrome/app/main_controller.h"
 #include "ios/chrome/browser/browser_state/chrome_browser_state.h"
@@ skipping 32 matching lines @@
 using chrome_test_util::NavigationBarDoneButton;
 
 namespace {
 
 const char kTestOrigin1[] = "http://host1:1/";
 
 const char kUrl[] = "http://foo/browsing";
 const char kUrlWithSetCookie[] = "http://foo/set_cookie";
 const char kResponse[] = "bar";
 const char kResponseWithSetCookie[] = "bar with set cookie";
-const char kNoCookieText[] = "No cookies";
+const char kNoCookieText[] = "No cookies!";
 const char kCookie[] = "a=b";
 const char kJavaScriptGetCookies[] =
     "var c = document.cookie ? document.cookie.split(/;\\s*/) : [];"
     "if (!c.length) {"
     "  document.documentElement.innerHTML = 'No cookies!';"
     "} else {"
     "  document.documentElement.innerHTML = 'OK: ' + c.join(',');"
     "}";
 
 enum MetricsServiceType {
@@ skipping 82 matching lines @@
 }
 // Matcher for the Privacy Translate Settings button on the privacy UI.
 id<GREYMatcher> TranslateSettingsButton() {
   return ButtonWithAccessibilityLabelId(IDS_IOS_TRANSLATE_SETTING);
 }
 // Matcher for the save button in the save password bar.
 id<GREYMatcher> savePasswordButton() {
   return ButtonWithAccessibilityLabelId(IDS_IOS_PASSWORD_MANAGER_SAVE_BUTTON);
 }
 
-// Asserts that there is no cookie in current web state.
-void AssertNoCookieExists() {
-  NSError* error = nil;
-  chrome_test_util::ExecuteJavaScript(
+// Returns true if there is no cookie in current web state.

[baxley, 2017/03/10 21:58:17]

nit: s/current/the current

[liaoyuke, 2017/03/13 16:12:50]

Done.

+bool IsCookieEmpty() {

[baxley, 2017/03/10 21:58:17]

Would IsCookiePresent() be more clear? We're not checking for an empty "cookie",
are we checking for there being no cookies?

[liaoyuke, 2017/03/13 16:12:50]

Acknowledged.

+  NSError* error;
+  id result = chrome_test_util::ExecuteJavaScript(
       base::SysUTF8ToNSString(kJavaScriptGetCookies), &error);
-  [[EarlGrey selectElementWithMatcher:chrome_test_util::WebViewContainingText(
-                                          kNoCookieText)]
-      assertWithMatcher:grey_notNil()];
+
+  if (error)
+    return false;
+
+  NSString* const resultCookie = base::mac::ObjCCastStrict<NSString>(result);
+  NSString* const expectedCookie = base::SysUTF8ToNSString(kNoCookieText);
+
+  return [resultCookie isEqualToString:expectedCookie];
 }
 
-// Asserts |cookie| exists in current web state.
-void AssertCookieExists(const char cookie[]) {
-  NSError* error = nil;
-  chrome_test_util::ExecuteJavaScript(
+// Returns true if |cookie| is the only cookie exists in current web state.

[baxley, 2017/03/10 21:58:17]

Returns true if |cookie| is the only cookie that exists in the current web
state.

i.e. s/cookie exists/cookie that exists/ and s/current/the current

[liaoyuke, 2017/03/13 16:12:50]

Acknowledged.

+bool IsCookieEquals(const char cookie[]) {

[baxley, 2017/03/10 21:58:17]

Sorry, I don't have great suggestions, but IsCookieEquals doesn't make it clear
what two cookies we're comparing.

IsCookiePresent(cookie)? IsOneCookiePresent(cookie)?

[liaoyuke, 2017/03/13 16:12:50]

Acknowledged.

+  NSError* error;
+  id result = chrome_test_util::ExecuteJavaScript(
       base::SysUTF8ToNSString(kJavaScriptGetCookies), &error);
-  NSString* const expectedCookieText =
+
+  if (error)
+    return false;
+
+  NSString* const resultCookie = base::mac::ObjCCastStrict<NSString>(result);
+  NSString* const expectedCookie =
       [NSString stringWithFormat:@"OK: %@", base::SysUTF8ToNSString(cookie)];
-  [[EarlGrey
-      selectElementWithMatcher:chrome_test_util::WebViewContainingText(
-                                   base::SysNSStringToUTF8(expectedCookieText))]
-      assertWithMatcher:grey_notNil()];
+
+  return [resultCookie isEqualToString:expectedCookie];

[baxley, 2017/03/10 21:58:17]

Do you see any value in having a helper method to do the comparison, since it
looks like the above 11 lines of code are the same (with the exception of
building the expectedCookie here). Just a thought, I leave it up to you, I don't
want to over engineer this or drag it out longer than necessary.

[liaoyuke, 2017/03/13 16:12:50]

Done.

 }
 
 // Run as a task to check if a certificate has been added to the ChannelIDStore.
 // Signals the given |semaphore| if the cert was added, or reposts itself
 // otherwise.
 void CheckCertificate(scoped_refptr<net::URLRequestContextGetter> getter,
                       dispatch_semaphore_t semaphore) {
   net::ChannelIDService* channel_id_service =
       getter->GetURLRequestContext()->channel_id_service();
   if (channel_id_service->channel_id_count() == 0) {
@@ skipping 482 matching lines @@
   response[web::test::HttpServer::MakeUrl(kUrl)] =
       std::pair<std::string, std::string>("", kResponse);
 
   web::test::SetUpSimpleHttpServerWithSetCookies(response);
 
   // Load |kUrl| and check that cookie is not set.
   [ChromeEarlGrey loadURL:web::test::HttpServer::MakeUrl(kUrl)];
   [[EarlGrey selectElementWithMatcher:chrome_test_util::WebViewContainingText(
                                           kResponse)]
       assertWithMatcher:grey_notNil()];
-  AssertNoCookieExists();
+
+  GREYAssertTrue(IsCookieEmpty(), @"Web state is expected to have no cookie.");
 
   // Visit |kUrlWithSetCookie| to set a cookie and then load |kUrl| to check it
   // is still set.
   [ChromeEarlGrey loadURL:web::test::HttpServer::MakeUrl(kUrlWithSetCookie)];
   [[EarlGrey selectElementWithMatcher:chrome_test_util::WebViewContainingText(
                                           kResponseWithSetCookie)]
       assertWithMatcher:grey_notNil()];
   [ChromeEarlGrey loadURL:web::test::HttpServer::MakeUrl(kUrl)];
   [[EarlGrey selectElementWithMatcher:chrome_test_util::WebViewContainingText(
                                           kResponse)]
       assertWithMatcher:grey_notNil()];
 
-  AssertCookieExists(kCookie);
+  NSString* const errorMessage = [NSString
+      stringWithFormat:@"Web state is expected to have following cookie: %@.",
+                       base::SysUTF8ToNSString(kCookie)];
+  GREYAssertTrue(IsCookieEquals(kCookie), errorMessage);
 
   // Restore the Clear Browsing Data checkmarks prefs to their default state in
   // Teardown.
   [self setTearDownHandler:^{
     [self restoreClearBrowsingDataCheckmarksToDefault];
   }];
 
   // Clear all cookies.
   [self clearCookiesAndSiteData];
 
   // Reload and test that there are no cookies left.
   [ChromeEarlGrey loadURL:web::test::HttpServer::MakeUrl(kUrl)];
   [[EarlGrey selectElementWithMatcher:chrome_test_util::WebViewContainingText(
                                           kResponse)]
       assertWithMatcher:grey_notNil()];
-  AssertNoCookieExists();
+  GREYAssertTrue(IsCookieEmpty(), @"Web state is expected to have no cookie.");
   chrome_test_util::CloseAllTabs();
 }
 
 // Verifies that logging into a form on a web page allows the user to save and
 // then clear a password.
 - (void)testClearPasswords {
 
   ios::ChromeBrowserState* browserState =
       chrome_test_util::GetOriginalBrowserState();
   PrefService* preferences = browserState->GetPrefs();
@@ skipping 325 matching lines @@
       performAction:grey_tap()];
   [[EarlGrey selectElementWithMatcher:PrivacyButton()]
       performAction:grey_tap()];
   [[EarlGrey selectElementWithMatcher:SendUsageDataButton()]
       performAction:grey_tap()];
   chrome_test_util::VerifyAccessibilityForCurrentScreen();
   [self closeSubSettingsMenu];
 }
 
 @end