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

test/FileSystemJsObject.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 <sstream>
 #include "BaseJsTest.h"
+#include "JsLatch.h"
+#include "../src/JsEngineTransition.h"
 
 namespace
 {
   class MockFileSystem : public AdblockPlus::FileSystem
   {
   public:
     bool success;
     std::string contentToRead;
     std::string lastWrittenPath;
     std::string lastWrittenContent;
@@ skipping 63 matching lines @@
     {
       if (!success)
         throw std::runtime_error("Unable to stat " + path);
       return path;
     }
   };
 
   void ReadFile(AdblockPlus::JsEnginePtr jsEngine, std::string& content,
                 std::string& error)
   {
-    jsEngine->Evaluate("_fileSystem.read('', function(r) {result = r})");
-    std::this_thread::sleep_for(std::chrono::milliseconds(50));
+    auto engine = ToInternal(jsEngine);
+    JsTestingLatch latch(engine, "latch");
+    jsEngine->Evaluate("_fileSystem.read('', function(r) {result = r; latch.Arrive();})");
+    latch.Wait();
     content = jsEngine->Evaluate("result.content")->AsString();
     error = jsEngine->Evaluate("result.error")->AsString();
   }
 
   typedef std::shared_ptr<MockFileSystem> MockFileSystemPtr;
 
   class FileSystemJsObjectTest : public BaseJsTest
   {
   protected:
     MockFileSystemPtr mockFileSystem;
@@ skipping 34 matching lines @@
   mockFileSystem->success = false;
   std::string content;
   std::string error;
   ReadFile(jsEngine, content, error);
   ASSERT_NE("", error);
   ASSERT_EQ("", content);
 }
 
 TEST_F(FileSystemJsObjectTest, Write)
 {
-  jsEngine->Evaluate("_fileSystem.write('foo', 'bar', function(e) {error = e})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.write('foo', 'bar', function(e) {error = e; latch.Arrive();})");
+  latch.Wait();
   ASSERT_EQ("foo", mockFileSystem->lastWrittenPath);
   ASSERT_EQ("bar", mockFileSystem->lastWrittenContent);
   ASSERT_EQ("", jsEngine->Evaluate("error")->AsString());
 }
 
 TEST_F(FileSystemJsObjectTest, WriteIllegalArguments)
 {
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.write()"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.write('', '', '')"));
 }
 
 TEST_F(FileSystemJsObjectTest, WriteError)
 {
   mockFileSystem->success = false;
-  jsEngine->Evaluate("_fileSystem.write('foo', 'bar', function(e) {error = e})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.write('foo', 'bar', function(e) {error = e; latch.Arrive();})");
+  latch.Wait();
   ASSERT_NE("", jsEngine->Evaluate("error")->AsString());
 }
 
 TEST_F(FileSystemJsObjectTest, Move)
 {
-  jsEngine->Evaluate("_fileSystem.move('foo', 'bar', function(e) {error = e})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.move('foo', 'bar', function(e) {error = e; latch.Arrive();})");
+  latch.Wait();
   ASSERT_EQ("foo", mockFileSystem->movedFrom);
   ASSERT_EQ("bar", mockFileSystem->movedTo);
   ASSERT_EQ("", jsEngine->Evaluate("error")->AsString());
 }
 
 TEST_F(FileSystemJsObjectTest, MoveIllegalArguments)
 {
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.move()"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.move('', '', '')"));
 }
 
 TEST_F(FileSystemJsObjectTest, MoveError)
 {
   mockFileSystem->success = false;
-  jsEngine->Evaluate("_fileSystem.move('foo', 'bar', function(e) {error = e})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.move('foo', 'bar', function(e) {error = e; latch.Arrive();})");
+  latch.Wait();
   ASSERT_NE("", jsEngine->Evaluate("error")->AsString());
 }
 
 TEST_F(FileSystemJsObjectTest, Remove)
 {
-  jsEngine->Evaluate("_fileSystem.remove('foo', function(e) {error = e})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.remove('foo', function(e) {error = e; latch.Arrive();})");
+  latch.Wait();
   ASSERT_EQ("foo", mockFileSystem->removedPath);
   ASSERT_EQ("", jsEngine->Evaluate("error")->AsString());
 }
 
 TEST_F(FileSystemJsObjectTest, RemoveIllegalArguments)
 {
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.remove()"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.remove('', '')"));
 }
 
 TEST_F(FileSystemJsObjectTest, RemoveError)
 {
   mockFileSystem->success = false;
-  jsEngine->Evaluate("_fileSystem.remove('foo', function(e) {error = e})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.remove('foo', function(e) {error = e; latch.Arrive();})");
+  latch.Wait();
   ASSERT_NE("", jsEngine->Evaluate("error")->AsString());
 }
 
 TEST_F(FileSystemJsObjectTest, Stat)
 {
   mockFileSystem->statExists = true;
   mockFileSystem->statIsDirectory= false;
   mockFileSystem->statIsFile = true;
   mockFileSystem->statLastModified = 1337;
-  jsEngine->Evaluate("_fileSystem.stat('foo', function(r) {result = r})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.stat('foo', function(r) {result = r; latch.Arrive();})");
+  latch.Wait();
   ASSERT_EQ("foo", mockFileSystem->statPath);
   ASSERT_EQ("", jsEngine->Evaluate("result.error")->AsString());
   ASSERT_TRUE(jsEngine->Evaluate("result.exists")->AsBool());
   ASSERT_FALSE(jsEngine->Evaluate("result.isDirectory")->AsBool());
   ASSERT_TRUE(jsEngine->Evaluate("result.isFile")->AsBool());
   ASSERT_EQ(1337, jsEngine->Evaluate("result.lastModified")->AsInt());
 }
 
 TEST_F(FileSystemJsObjectTest, StatIllegalArguments)
 {
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.stat()"));
   ASSERT_ANY_THROW(jsEngine->Evaluate("_fileSystem.stat('', '')"));
 }
 
 TEST_F(FileSystemJsObjectTest, StatError)
 {
   mockFileSystem->success = false;
-  jsEngine->Evaluate("_fileSystem.stat('foo', function(r) {result = r})");
-  std::this_thread::sleep_for(std::chrono::milliseconds(50));
+  JsTestingLatch latch(engine, "latch");
+  jsEngine->Evaluate("_fileSystem.stat('foo', function(r) {result = r; latch.Arrive();})");
+  latch.Wait();
   ASSERT_NE("", jsEngine->Evaluate("result.error")->AsString());
 }