wsd: move the old Log::prefix to tests only

Change-Id: Ia5127c9f1869e9a57c6ed2da1231e757b6211303
Signed-off-by: Ashod Nakashian <[email protected]>

Author: Ashod

common/Log.cpp

@@ -649,8 +649,9 @@ namespace Log
         return _prefix;
     }
 
-    char* prefix(const std::chrono::time_point<std::chrono::system_clock>& tp, char* buffer,
-                 const std::string_view level)
+#ifdef BUILDING_TESTS
+    char* prefixReference(const std::chrono::time_point<std::chrono::system_clock>& tp,
+                          char* buffer, const std::string_view level)
     {
 #if defined(IOS) || defined(__FreeBSD__)
         // Don't bother with the "Source" which would be just "Mobile" always (or whatever the app
@@ -752,6 +753,7 @@ namespace Log
 
         return buffer;
     }
+#endif // BUILDING_TESTS
 
     void initialize(const std::string& name,
                     const std::string& logLevel,

common/Log.hpp

@@ -118,11 +118,11 @@ namespace Log
         char* _level_pos;
     };
 
-    /// Generates log entry prefix. Example follows (without the vertical bars).
-    /// |wsd-07272-07298 2020-04-25 17:29:28.928697 -0400 [ websrv_poll ] TRC  |
-    /// This is fully signal-safe. Buffer must be at least 128 bytes.
-    char* prefix(const std::chrono::time_point<std::chrono::system_clock>& tp, char* buffer,
-                 const std::string_view level);
+#ifdef BUILDING_TESTS
+    /// Generates the reference log entry prefix. Do *not* use, except for tests.
+    char* prefixReference(const std::chrono::time_point<std::chrono::system_clock>& tp,
+                          char* buffer, const std::string_view level);
+#endif
 
     inline std::string_view
     prefix(const std::string_view level,

test/LoggingWhiteBoxTests.cpp

@@ -77,7 +77,7 @@ void LoggingTests::testLogPrefix()
     {
         char buffer[256];
         const auto str = prefix.update(level, tp);
-        LOK_ASSERT_EQUAL_STR(Log::prefix(tp, buffer, level), str);
+        LOK_ASSERT_EQUAL_STR(Log::prefixReference(tp, buffer, level), str);
         const auto firstPos = str.find_first_of(' ');
         const auto secondPos = str.find_first_of(' ', firstPos + 1);
         const auto thirdPos = str.find_first_of(' ', secondPos + 1);
@@ -141,13 +141,13 @@ void LoggingTests::testLogPrefix()
 
         char buffer[256];
         const auto str = prefix.update(level, tp);
-        LOK_ASSERT_EQUAL_STR(Log::prefix(tp, buffer, level), str);
+        LOK_ASSERT_EQUAL_STR(Log::prefixReference(tp, buffer, level), str);
 
         Log::Prefix prefix2;
         LOK_ASSERT_EQUAL_STR(buffer, prefix2.update(level, tp));
 
         tp += std::chrono::seconds(1);
-        LOK_ASSERT_EQUAL_STR(Log::prefix(tp, buffer, level), prefix2.update(level, tp));
+        LOK_ASSERT_EQUAL_STR(Log::prefixReference(tp, buffer, level), prefix2.update(level, tp));
     }
 
     // Randomized comparative tests.
@@ -159,7 +159,7 @@ void LoggingTests::testLogPrefix()
 
         char buffer[256];
         const auto str = prefix.update(level, tp);
-        LOK_ASSERT_EQUAL_STR(Log::prefix(tp, buffer, level), str);
+        LOK_ASSERT_EQUAL_STR(Log::prefixReference(tp, buffer, level), str);
 
         Log::Prefix prefix2;
         LOK_ASSERT_EQUAL_STR(buffer, prefix2.update(level, tp));
@@ -183,7 +183,7 @@ void LoggingTests::testLogPrefix()
         for (int i = 0; i < 1'000'000; ++i)
         {
             const auto tp = getSystemTimeRoundedToMillis(i * 32);
-            [[maybe_unused]] const auto str = Log::prefix(tp, buffer, level);
+            [[maybe_unused]] const auto str = Log::prefixReference(tp, buffer, level);
         }
 
         LOG_INF("Old prefix took: " << sw.elapsed<std::chrono::microseconds>());