add mutex to make tsan happy (#383)

* add mutex to make tsan happy * Remove race condition in test
MisterTea · Jan 29, 2021 · 5cfa137 · 5cfa137
1 parent 3edd879
commit 5cfa137
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 8 deletions.
diff --git a/src/base/SocketHandler.hpp b/src/base/SocketHandler.hpp
@@ -41,6 +41,7 @@ class SocketHandler {
 
   template <typename T>
   inline void writeProto(int fd, const T& t, bool timeout) {
+    lock_guard<std::mutex> guard(writeMutex);
     string s;
     if (!t.SerializeToString(&s)) {
       STFATAL << "Serialization of " << t.GetTypeName() << " failed!";
@@ -119,6 +120,10 @@ class SocketHandler {
   virtual void stopListening(const SocketEndpoint& endpoint) = 0;
   virtual void close(int fd) = 0;
   virtual vector<int> getActiveSockets() = 0;
+
+ protected:
+  // This mutex only exists to remove a tsan error in integration tests
+  mutex writeMutex;
 };
 }  // namespace et
 

diff --git a/test/TerminalTest.cpp b/test/TerminalTest.cpp
@@ -1,8 +1,7 @@
-#include "TestHeaders.hpp"
-
 #include "FakeConsole.hpp"
 #include "TerminalClient.hpp"
 #include "TerminalServer.hpp"
+#include "TestHeaders.hpp"
 
 namespace et {
 TEST_CASE("FakeConsoleTest", "[FakeConsoleTest]") {
@@ -69,8 +68,6 @@ TEST_CASE("FakeUserTerminalTest", "[FakeUserTerminalTest]") {
   thread t2([fakeUserTerminal, s]() {
     fakeUserTerminal->simulateTerminalResponse(s);
   });
-  usleep(1000);
-  REQUIRE(socketHandler->hasData(fakeUserTerminal->getFd()));
 
   string s3(64 * 1024, '\0');
   socketHandler->readAll(fakeUserTerminal->getFd(), &s3[0], s3.length(), false);
@@ -102,8 +99,7 @@ void readWriteTest(const string& clientId,
   shared_ptr<TerminalClient> terminalClient(new TerminalClient(
       clientSocketHandler, clientPipeSocketHandler, serverEndpoint, clientId,
       CRYPTO_KEY, fakeConsole, false, "", "", false, ""));
-  thread terminalClientThread(
-      [terminalClient]() { terminalClient->run(""); });
+  thread terminalClientThread([terminalClient]() { terminalClient->run(""); });
   sleep(3);
 
   string s(1024, '\0');
@@ -184,8 +180,8 @@ TEST_CASE("EndToEndTest", "[EndToEndTest]") {
   sleep(1);
 
   readWriteTest("1234567890123456", routerSocketHandler, fakeUserTerminal,
-                serverEndpoint, clientSocketHandler, clientPipeSocketHandler, fakeConsole,
-                routerEndpoint);
+                serverEndpoint, clientSocketHandler, clientPipeSocketHandler,
+                fakeConsole, routerEndpoint);
   server->shutdown();
   t_server.join();