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

test/UpdateCheck.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 <functional>
 
 #include "BaseJsTest.h"
+#include "JsLatch.h"
 #include "../src/JsEngineTransition.h"
 
 namespace
 {
   typedef std::shared_ptr<AdblockPlus::FilterEngine> FilterEnginePtr;
 
   void FindAndReplace(std::string& source, const std::string& find, const std::string& replace)
   {
     for (size_t pos = 0; (pos = source.find(find), pos) != std::string::npos; pos += replace.size())
       source.replace(pos, find.size(), replace);
@@ skipping 62 matching lines @@
       Destroy();
       webRequest.reset();
     }
 
     void Reset()
     {
       Destroy();
       Construct();
     }
 
-    void ForceUpdateCheck()
+    void ForceUpdateCheckSynchronous()
     {
-      filterEngine->ForceUpdateCheck(
-          std::bind(&UpdateCheckTest::UpdateCallback, this, std::placeholders::_1));
+      Latch latch(1);
+      filterEngine->ForceUpdateCheck([&, this](const std::string& error) -> void
+      {
+        UpdateCallback(error);
+        latch.Arrive();
+      });
+      latch.Wait();
     }
 
     void EventCallback(AdblockPlus::JsValueList& params)
     {
       eventCallbackCalled = true;
       eventCallbackParams = params;
     }
 
     void UpdateCallback(const std::string& error)
     {
       updateCallbackCalled = true;
       updateError = error;
     }
   };
 }
 
 TEST_F(UpdateCheckTest, RequestFailure)
 {
   webRequest->response.status = AdblockPlus::WebRequest::NS_ERROR_FAILURE;
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = false;
 
   Reset();
-  ForceUpdateCheck();
-
-  std::this_thread::sleep_for(std::chrono::milliseconds(100));
+  ForceUpdateCheckSynchronous();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_FALSE(updateError.empty());
 
   std::string expectedUrl(filterEngine->GetPref("update_url_release")->AsString());
   std::string platform = jsEngine->Evaluate("require('info').platform")->AsString();
   std::string platformVersion = jsEngine->Evaluate("require('info').platformVersion")->AsString();
 
   FindAndReplace(expectedUrl, "%NAME%", appInfo.name);
@@ skipping 14 matching lines @@
   webRequest->response.responseStatus = 200;
   webRequest->response.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
-  ForceUpdateCheck();
-
-  std::this_thread::sleep_for(std::chrono::milliseconds(100));
+  ForceUpdateCheckSynchronous();
 
   ASSERT_TRUE(eventCallbackCalled);
   ASSERT_EQ(1u, eventCallbackParams.size());
   ASSERT_EQ("https://foo.bar/", eventCallbackParams[0]->AsString());
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 
   std::string expectedUrl(filterEngine->GetPref("update_url_devbuild")->AsString());
   std::string platform = jsEngine->Evaluate("require('info').platform")->AsString();
   std::string platformVersion = jsEngine->Evaluate("require('info').platformVersion")->AsString();
@@ skipping 16 matching lines @@
   webRequest->response.responseStatus = 200;
   webRequest->response.responseText = "{\"1/4\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
-  ForceUpdateCheck();
-
-  std::this_thread::sleep_for(std::chrono::milliseconds(100));
+  ForceUpdateCheckSynchronous();
 
   ASSERT_TRUE(eventCallbackCalled);
   ASSERT_EQ(1u, eventCallbackParams.size());
   ASSERT_EQ("https://foo.bar/", eventCallbackParams[0]->AsString());
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 }
 
 TEST_F(UpdateCheckTest, WrongApplication)
 {
   webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
   webRequest->response.responseStatus = 200;
   webRequest->response.responseText = "{\"1/3\": {\"version\":\"3.1\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
-  ForceUpdateCheck();
-
-  std::this_thread::sleep_for(std::chrono::milliseconds(100));
+  ForceUpdateCheckSynchronous();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 }
 
 TEST_F(UpdateCheckTest, WrongVersion)
 {
   webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
   webRequest->response.responseStatus = 200;
   webRequest->response.responseText = "{\"1\": {\"version\":\"3\",\"url\":\"https://foo.bar/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
-  ForceUpdateCheck();
-
-  std::this_thread::sleep_for(std::chrono::milliseconds(100));
+  ForceUpdateCheckSynchronous();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_TRUE(updateError.empty());
 }
 
 TEST_F(UpdateCheckTest, WrongURL)
 {
   webRequest->response.status = AdblockPlus::WebRequest::NS_OK;
   webRequest->response.responseStatus = 200;
   webRequest->response.responseText = "{\"1\": {\"version\":\"3.1\",\"url\":\"http://insecure/\"}}";
 
   appInfo.name = "1";
   appInfo.version = "3";
   appInfo.application = "4";
   appInfo.applicationVersion = "2";
   appInfo.developmentBuild = true;
 
   Reset();
-  ForceUpdateCheck();
-
-  std::this_thread::sleep_for(std::chrono::milliseconds(100));
+  ForceUpdateCheckSynchronous();
 
   ASSERT_FALSE(eventCallbackCalled);
   ASSERT_TRUE(updateCallbackCalled);
   ASSERT_FALSE(updateError.empty());
 }