Issue #4826 - Use latch to replace thread-sleeping in tests

test/GlobalJsObject.cpp

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #include "BaseJsTest.h"
+#include "JsLatch.h"
 
 namespace
 {
   class GlobalJsObjectTest : public BaseJsTest
   {
   };
 }
 
 TEST_F(GlobalJsObjectTest, SetTimeout)
 {
-  jsEngine->Evaluate("setTimeout(function() {foo = 'bar';}, 100)");
-  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
-  std::this_thread::sleep_for(std::chrono::milliseconds(200));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("setTimeout(function() {foo = 'bar'; latch.Arrive();}, 100)");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined()); // RACE

[Eric, 2017/01/19 18:38:07]

The race condition in these timeout tests is mostly benign. It would be useful
to have a test that verifies that timeouts do not fire prematurely, but writing
one correctly (without races) is quite involved.

Also, with the current implementation, it just pushes a race condition into the
thread scheduler. The timeout implementation would have to guarantee that
timeouts fire without rearrangement to be able to write a race-free test.

+  latch.Wait();
   ASSERT_EQ("bar", jsEngine->Evaluate("this.foo")->AsString());
 }
 
 TEST_F(GlobalJsObjectTest, SetTimeoutWithArgs)
 {
-  jsEngine->Evaluate("setTimeout(function(s) {foo = s;}, 100, 'foobar')");
-  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined());
-  std::this_thread::sleep_for(std::chrono::milliseconds(200));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("setTimeout(function(s) {foo = s; latch.Arrive();}, 100, 'foobar')");
+  ASSERT_TRUE(jsEngine->Evaluate("this.foo")->IsUndefined()); // RACE
+  latch.Wait();
   ASSERT_EQ("foobar", jsEngine->Evaluate("this.foo")->AsString());
 }
 
 TEST_F(GlobalJsObjectTest, SetTimeoutWithInvalidArgs)
 {
   ASSERT_ANY_THROW(jsEngine->Evaluate("setTimeout()"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("setTimeout('', 1)"));
 }
 
 TEST_F(GlobalJsObjectTest, SetMultipleTimeouts)
 {
+  JsTestingLatch latch(engine, "latch", 2); // two arrivals
   jsEngine->Evaluate("foo = []");
-  jsEngine->Evaluate("setTimeout(function(s) {foo.push('1');}, 100)");
-  jsEngine->Evaluate("setTimeout(function(s) {foo.push('2');}, 150)");
-  std::this_thread::sleep_for(std::chrono::milliseconds(200));
+  jsEngine->Evaluate("setTimeout(function(s) {foo.push('1'); latch.Arrive();}, 100)");
+  jsEngine->Evaluate("setTimeout(function(s) {foo.push('2'); latch.Arrive();}, 150)");
+  latch.Wait();
   ASSERT_EQ("1,2", jsEngine->Evaluate("this.foo")->AsString());
 }