Update HistoryStateOperationsTest waits to include failure messages.

ios/web/navigation/history_state_operations_inttest.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.
 
 #include "base/memory/ptr_util.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/strings/sys_string_conversions.h"
 #include "base/strings/utf_string_conversions.h"
-#include "base/test/ios/wait_util.h"
+#import "ios/testing/wait_util.h"
 #import "ios/web/navigation/navigation_item_impl.h"
 #import "ios/web/public/navigation_item.h"
 #import "ios/web/public/navigation_manager.h"
 #import "ios/web/public/test/http_server.h"
 #include "ios/web/public/test/http_server_util.h"
 #import "ios/web/public/test/web_view_interaction_test_util.h"
 #import "ios/web/public/web_state/web_state.h"
 #import "ios/web/test/web_int_test.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "testing/gtest_mac.h"
@@ skipping 83 matching lines @@
     return [ExecuteJavaScript(kOnLoadCheckScript) boolValue];
   }
 
   // Executes JavaScript to check whether the no-op text is visible.
   bool IsNoOpTextVisible() {
     return [ExecuteJavaScript(kNoOpCheckScript) boolValue];
   }
 
   // Waits for the NoOp text to be visible.
   void WaitForNoOpText() {
-    base::test::ios::WaitUntilCondition(^bool {
-      return IsNoOpTextVisible();
-    });
+    BOOL completed = testing::WaitUntilConditionOrTimeout(
+        testing::kWaitForJSCompletionTimeout, ^{

[Eugene But (OOO till 7-30), 2017/03/07 21:10:38]

This does not look like JS execution. Is there a better constant?

Same question for other places.

[michaeldo, 2017/03/07 22:21:54]

This one is JS execution (defined in the helper above). However some of them are
not, I think we should use kWaitForPageLoadTimeout if it is not JS execution.
PTAL at the updated patch.

[Eugene But (OOO till 7-30), 2017/03/08 00:55:00]

Those are all State Update operations, which is half native code half JS. And
they don't load the page. Can you create a separate constant for them in this
file?

[michaeldo, 2017/03/08 07:26:54]

Thanks for the explanation, it wasn't immediately clear what was updated this
state. I've added a constant and used the JS timeout amount for it of 2.0.

+          return IsNoOpTextVisible();
+        });
+    EXPECT_TRUE(completed) << "NoOp text failed to be visible.";
   }
 
  private:
   GURL state_operations_url_;
 };
 
 // Tests that calling window.history.pushState() is a no-op for unresolvable
 // URLs.
 TEST_F(HistoryStateOperationsTest, NoOpPushUnresolvable) {
   // Perform a window.history.pushState() with an unresolvable URL.  This will
@@ skipping 114 matching lines @@
     navigation_manager()->GoBack();
   });
   EXPECT_EQ(state_operations_url(), GetLastCommittedItem()->GetURL());
   // Set up the state parameters and tap the replace state button.
   std::string empty_state;
   std::string new_title("NEW TITLE");
   GURL empty_url;
   SetStateParams(empty_state, new_title, empty_url);
   ASSERT_TRUE(web::test::TapWebViewElementWithId(web_state(), kReplaceStateId));
   // Wait for the title to be reflected in the NavigationItem.
-  base::test::ios::WaitUntilCondition(^bool {
-    return GetLastCommittedItem()->GetTitle() == ASCIIToUTF16(new_title);
-  });
+  BOOL completed = testing::WaitUntilConditionOrTimeout(
+      testing::kWaitForJSCompletionTimeout, ^{
+        return GetLastCommittedItem()->GetTitle() == ASCIIToUTF16(new_title);
+      });
+  EXPECT_TRUE(completed) << "Failed to validate NavigationItem title.";
   // Verify that the forward navigation was not pruned.
   EXPECT_EQ(GetIndexOfNavigationItem(GetLastCommittedItem()) + 1,
             GetIndexOfNavigationItem(about_blank_item));
 }
 
 // Tests that calling window.history.replaceState() with a new state object
 // replaces the state object for the current NavigationItem.
 TEST_F(HistoryStateOperationsTest, StateReplacement) {
   // Navigate to about:blank then navigate back to the test page.  The created
   // NavigationItem can be used later to verify that the state is replaced
   // rather than pushed.
   GURL about_blank("about:blank");
   LoadUrl(about_blank);
   web::NavigationItem* about_blank_item = GetLastCommittedItem();
   ExecuteBlockAndWaitForLoad(state_operations_url(), ^{
     navigation_manager()->GoBack();
   });
   ASSERT_EQ(state_operations_url(), GetLastCommittedItem()->GetURL());
   // Set up the state parameters and tap the replace state button.
   std::string new_state("STATE OBJECT");
   std::string empty_title;
   GURL empty_url;
   SetStateParams(new_state, empty_title, empty_url);
   ASSERT_TRUE(web::test::TapWebViewElementWithId(web_state(), kReplaceStateId));
   // Verify that the state is reflected in the JavaScript context.
-  base::test::ios::WaitUntilCondition(^bool {
-    return GetJavaScriptState() == new_state;
-  });
+  BOOL verify_java_script_context_completed =
+      testing::WaitUntilConditionOrTimeout(
+          testing::kWaitForJSCompletionTimeout, ^{
+            return GetJavaScriptState() == new_state;
+          });
+  EXPECT_TRUE(verify_java_script_context_completed)
+      << "Failed to validate JavaScript state.";
   // Verify that the state is reflected in the latest NavigationItem.
   std::string serialized_state("\"STATE OBJECT\"");
-  base::test::ios::WaitUntilCondition(^bool {
-    web::NavigationItemImpl* item =
-        static_cast<web::NavigationItemImpl*>(GetLastCommittedItem());
-    std::string item_state =
-        base::SysNSStringToUTF8(item->GetSerializedStateObject());
-    return item_state == serialized_state;
-  });
+  BOOL verify_navigation_item_completed = testing::WaitUntilConditionOrTimeout(
+      testing::kWaitForJSCompletionTimeout, ^{
+        web::NavigationItemImpl* item =
+            static_cast<web::NavigationItemImpl*>(GetLastCommittedItem());
+        std::string item_state =
+            base::SysNSStringToUTF8(item->GetSerializedStateObject());
+        return item_state == serialized_state;
+      });
+  EXPECT_TRUE(verify_navigation_item_completed)
+      << "Failed to validate NavigationItem state.";
   // Verify that the forward navigation was not pruned.
   EXPECT_EQ(GetIndexOfNavigationItem(GetLastCommittedItem()) + 1,
             GetIndexOfNavigationItem(about_blank_item));
 }
 
 // Tests that the state object is reset to the correct value after reloading a
 // page whose state has been replaced.
 TEST_F(HistoryStateOperationsTest, StateReplacementReload) {
   // Set up the state parameters and tap the replace state button.
   std::string new_state("STATE OBJECT");
   std::string empty_title;
   GURL empty_url;
   SetStateParams(new_state, empty_title, empty_url);
   ASSERT_TRUE(web::test::TapWebViewElementWithId(web_state(), kReplaceStateId));
   // Reload the page and check that the state object is present.
   Reload();
   ASSERT_TRUE(IsOnLoadTextVisible());
-  base::test::ios::WaitUntilCondition(^bool {
-    return GetJavaScriptState() == new_state;
-  });
+  BOOL completed = testing::WaitUntilConditionOrTimeout(
+      testing::kWaitForJSCompletionTimeout, ^{
+        return GetJavaScriptState() == new_state;
+      });
+  EXPECT_TRUE(completed) << "Failed to validate JavaScript state.";
 }
 
 // Tests that the state object is correctly set for a page after a back/forward
 // navigation.
 TEST_F(HistoryStateOperationsTest, StateReplacementBackForward) {
   // Navigate to about:blank then navigate back to the test page.  The created
   // NavigationItem can be used later to verify that the state is replaced
   // rather than pushed.
   GURL about_blank("about:blank");
   LoadUrl(about_blank);
   ExecuteBlockAndWaitForLoad(state_operations_url(), ^{
     navigation_manager()->GoBack();
   });
   ASSERT_EQ(state_operations_url(), GetLastCommittedItem()->GetURL());
   // Set up the state parameters and tap the replace state button.
   std::string new_state("STATE OBJECT");
   std::string empty_title("");
   GURL empty_url("");
   SetStateParams(new_state, empty_title, empty_url);
   ASSERT_TRUE(web::test::TapWebViewElementWithId(web_state(), kReplaceStateId));
   // Go forward and back, then check that the state object is present.
   ExecuteBlockAndWaitForLoad(about_blank, ^{
     navigation_manager()->GoForward();
   });
   ExecuteBlockAndWaitForLoad(state_operations_url(), ^{
     navigation_manager()->GoBack();
   });
   ASSERT_TRUE(IsOnLoadTextVisible());
-  base::test::ios::WaitUntilCondition(^bool {
-    return GetJavaScriptState() == new_state;
-  });
+  BOOL completed = testing::WaitUntilConditionOrTimeout(
+      testing::kWaitForJSCompletionTimeout, ^{
+        return GetJavaScriptState() == new_state;
+      });
+  EXPECT_TRUE(completed) << "Failed to validate JavaScript state.";
 }
 
 // Tests that calling window.history.pushState() creates a new NavigationItem
 // and prunes trailing items.
 TEST_F(HistoryStateOperationsTest, PushState) {
   // Navigate to about:blank then navigate back to the test page.  The created
   // NavigationItem can be used later to verify that the state is replaced
   // rather than pushed.
   GURL about_blank("about:blank");
   LoadUrl(about_blank);
   web::NavigationItem* about_blank_item = GetLastCommittedItem();
   ExecuteBlockAndWaitForLoad(state_operations_url(), ^{
     navigation_manager()->GoBack();
   });
   ASSERT_EQ(state_operations_url(), GetLastCommittedItem()->GetURL());
   web::NavigationItem* non_pushed_item = GetLastCommittedItem();
   // Set up the state parameters and tap the replace state button.
   std::string empty_state;
   std::string empty_title;
   GURL new_url = state_operations_url().Resolve("path");
   SetStateParams(empty_state, empty_title, new_url);
   ASSERT_TRUE(web::test::TapWebViewElementWithId(web_state(), kPushStateId));
   // Verify that the url with the path is pushed.
-  base::test::ios::WaitUntilCondition(^bool {
-    return GetLastCommittedItem()->GetURL() == new_url;
-  });
+  BOOL completed = testing::WaitUntilConditionOrTimeout(
+      testing::kWaitForJSCompletionTimeout, ^{
+        return GetLastCommittedItem()->GetURL() == new_url;
+      });
+  EXPECT_TRUE(completed) << "Failed to validate current url.";
   // Verify that a new NavigationItem was created and that the forward item was
   // pruned.
   EXPECT_EQ(GetIndexOfNavigationItem(non_pushed_item) + 1,
             GetIndexOfNavigationItem(GetLastCommittedItem()));
   EXPECT_EQ(NSNotFound, GetIndexOfNavigationItem(about_blank_item));
 }
 
 // Tests that performing a replaceState() on a page created with a POST request
 // resets the page to a GET request.
 TEST_F(HistoryStateOperationsTest, ReplaceStatePostRequest) {
   // Add POST data to the current NavigationItem.
   base::scoped_nsobject<NSData> post_data([NSData data]);
   static_cast<web::NavigationItemImpl*>(GetLastCommittedItem())
       ->SetPostData(post_data);
   ASSERT_TRUE(GetLastCommittedItem()->HasPostData());
   // Set up the state parameters and tap the replace state button.
   std::string new_state("STATE OBJECT");
   std::string empty_title;
   GURL new_url = state_operations_url().Resolve("path");
   SetStateParams(new_state, empty_title, new_url);
   ASSERT_TRUE(web::test::TapWebViewElementWithId(web_state(), kReplaceStateId));
   // Verify that url has been replaced.
-  base::test::ios::WaitUntilCondition(^bool {
-    return GetLastCommittedItem()->GetURL() == new_url;
-  });
+  BOOL completed = testing::WaitUntilConditionOrTimeout(
+      testing::kWaitForJSCompletionTimeout, ^{
+        return GetLastCommittedItem()->GetURL() == new_url;
+      });
+  EXPECT_TRUE(completed) << "Failed to validate current url.";
   // Verify that the NavigationItem no longer has POST data.
   EXPECT_FALSE(GetLastCommittedItem()->HasPostData());
 }
 
 // Tests that performing a replaceState() on a page where only the URL fragment
 // is updated does not trigger a hashchange event.
 TEST_F(HistoryStateOperationsTest, ReplaceStateNoHashChangeEvent) {
   // Set up the state parameters and tap the replace state button.
   std::string empty_state;
   std::string empty_title;
   GURL new_url = state_operations_url().Resolve("#hash");
   SetStateParams(empty_state, empty_title, new_url);
   ASSERT_TRUE(web::test::TapWebViewElementWithId(web_state(), kReplaceStateId));
   // Verify that url has been replaced.
-  base::test::ios::WaitUntilCondition(^bool {
-    return GetLastCommittedItem()->GetURL() == new_url;
-  });
+  BOOL completed = testing::WaitUntilConditionOrTimeout(
+      testing::kWaitForJSCompletionTimeout, ^{
+        return GetLastCommittedItem()->GetURL() == new_url;
+      });
+  EXPECT_TRUE(completed) << "Failed to validate current url.";
   // Verify that the hashchange event was not fired.
   EXPECT_FALSE(static_cast<web::NavigationItemImpl*>(GetLastCommittedItem())
                    ->IsCreatedFromHashChange());
 }