Add base::RunLoop and update ui_test_utils to use it to reduce flakiness

content/test/test_navigation_observer.cc

Index: content/test/test_navigation_observer.cc
diff --git a/content/test/test_navigation_observer.cc b/content/test/test_navigation_observer.cc
index 89ff36fd575feb8ec98c98463596d8c7442c5a2e..2342c63e0ccfce664d90409f132d2569fa32ec74 100644
--- a/content/test/test_navigation_observer.cc
+++ b/content/test/test_navigation_observer.cc
@@ -6,6 +6,7 @@
 
 #include "base/bind.h"
 #include "base/message_loop.h"
+#include "base/run_loop.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/render_view_host_observer.h"
@@ -14,6 +15,21 @@
 
 namespace content {
 
+namespace {
+
+// Allow some pending tasks up to |num_deferrals| generations to complete.
+void DeferredQuitRunLoop(const base::Closure& quit_task,

[Paweł Hajdan Jr., 2012/06/27 07:33:28]

I've seen this routine in this CL before. Please de-duplicate and move it to
ui_test_utils.

[jbates, 2012/06/28 20:46:11]

Yeah it should be moved to content/test/test_utils.h (or similar). Added TODO.

+                         int num_quit_deferrals) {
+  if (num_quit_deferrals <= 0) {
+    quit_task.Run();
+  } else {
+    MessageLoop::current()->PostTask(FROM_HERE,
+        base::Bind(&DeferredQuitRunLoop, quit_task, num_quit_deferrals - 1));
+  }
+}
+
+}  // namespace
+
 // This class observes |render_view_host| and calls OnJsInjectionReady() of
 // |js_injection_ready_observer| when the time is right to inject JavaScript
 // into the page.
@@ -84,11 +100,14 @@ void TestNavigationObserver::WaitForObservation(
 }
 
 void TestNavigationObserver::Wait() {
+  base::RunLoop run_loop;
+  // Number of times to repost Quit task to allow pending tasks to complete. See
+  // kNumQuitDeferrals in ui_test_utils.cc for explanation.

[Paweł Hajdan Jr., 2012/06/27 07:33:28]

Why not make ui_test_utils expose its kNumQuitDeferrals constant instead of
duplicating it here?

Ah right, this is content/ vs. chrome/ thing... Feel free to create some test
utils files in content/test then.

And because this CL is already complex, feel free to do that in a separate CL
(just stick a TODO here so that things are not forgotten).

[jbates, 2012/06/28 20:46:11]

Sounds good, added a TODO.

+  const int num_quit_deferrals = 10;
   WaitForObservation(
-      base::Bind(&MessageLoop::Run,
-                 base::Unretained(MessageLoop::current())),
-      base::Bind(&MessageLoop::Quit,
-                 base::Unretained(MessageLoop::current())));
+      base::Bind(&base::RunLoop::Run, base::Unretained(&run_loop)),
+      base::Bind(&DeferredQuitRunLoop, run_loop.QuitClosure(),
+                 num_quit_deferrals));
 }
 
 TestNavigationObserver::TestNavigationObserver(
@@ -131,8 +150,10 @@ void TestNavigationObserver::Observe(
           ++navigations_completed_ == number_of_navigations_) {
         navigation_started_ = false;
         done_ = true;
-        if (running_)
+        if (running_) {
+          running_ = false;
           done_callback_.Run();
+        }
       }
       break;
     case NOTIFICATION_RENDER_VIEW_HOST_CREATED: