add unbounded unlimited queue test

odygrd · Sep 28, 2024 · 9afba2a · 9afba2a
1 parent 5b03aa5
commit 9afba2a
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 2 deletions.
diff --git a/test/integration_tests/CMakeLists.txt b/test/integration_tests/CMakeLists.txt
@@ -111,6 +111,7 @@ quill_add_test(TEST_StringRandomLogging StringRandomLoggingTest.cpp)
 quill_add_test(TEST_StringRandomSmallLogging StringRandomSmallLoggingTest.cpp)
 quill_add_test(TEST_StringRef StringRefTest.cpp)
 quill_add_test(TEST_TagsLogging TagsLoggingTest.cpp)
+quill_add_test(TEST_UnboundedUnlimitedQueue UnboundedUnlimitedQueueTest.cpp)
 quill_add_test(TEST_UserClockSource UserClockSourceTest.cpp)
 quill_add_test(TEST_UserDefinedTypeLogging UserDefinedTypeLoggingTest.cpp)
 quill_add_test(TEST_UserSink UserSinkTest.cpp)

diff --git a/test/integration_tests/StringLoggingTest.cpp b/test/integration_tests/StringLoggingTest.cpp
@@ -139,7 +139,7 @@ TEST_CASE("string_logging")
               c_style_string, end_s, c_style_char_array_empty, c_style_char_array);
   }
 
-  // Log a big string
+  // Log a string
   for (size_t i = 0; i < number_of_messages; ++i)
   {
     std::string v{"Lorem ipsum dolor sit amet, consectetur "};
@@ -219,7 +219,7 @@ TEST_CASE("string_logging")
     file_contents, std::string{"LOG_INFO      " + logger_name + "       Logging int: 0, int: 0, string: Lorem ipsum dolor sit amet, consectetur 0, char: Lorem ipsum dolor sit amet, consectetur 0"}));
 
   REQUIRE(quill::testing::file_contains(
-    file_contents, std::string{"LOG_INFO      " + logger_name + "       Logging int: 1999, int: 19990, string: Lorem ipsum dolor sit amet, consectetur 1999, char: Lorem ipsum dolor sit amet, consectetur 1999"}));
+    file_contents, std::string{"LOG_INFO      " + logger_name + "       Logging int: 9999, int: 99990, string: Lorem ipsum dolor sit amet, consectetur 9999, char: Lorem ipsum dolor sit amet, consectetur 9999"}));
 
   testing::remove_file(filename);
 }
diff --git a/test/integration_tests/UnboundedUnlimitedQueueTest.cpp b/test/integration_tests/UnboundedUnlimitedQueueTest.cpp
@@ -0,0 +1,80 @@
+#include "doctest/doctest.h"
+
+#include "misc/TestUtilities.h"
+#include "quill/Backend.h"
+#include "quill/Frontend.h"
+#include "quill/LogMacros.h"
+#include "quill/sinks/FileSink.h"
+
+#include <string>
+#include <vector>
+
+using namespace quill;
+
+// Define custom Frontend Options
+struct CustomFrontendOptions
+{
+  static constexpr quill::QueueType queue_type = quill::QueueType::UnboundedUnlimited;
+  static constexpr uint32_t initial_queue_capacity = 131'072;
+  static constexpr uint32_t blocking_queue_retry_interval_ns = 800;
+  static constexpr bool huge_pages_enabled = false;
+};
+
+using CustomFrontend = FrontendImpl<CustomFrontendOptions>;
+using CustomLogger = LoggerImpl<CustomFrontendOptions>;
+
+TEST_CASE("unbounded_unlimited_queue")
+{
+  static constexpr char const* filename = "unbounded_unlimited_queue.log";
+  static std::string const logger_name = "logger";
+  static constexpr size_t number_of_messages = 1000;
+
+  // Start the logging backend thread
+  Backend::start();
+
+  auto file_sink = CustomFrontend::create_or_get_sink<FileSink>(
+    filename,
+    []()
+    {
+      FileSinkConfig cfg;
+      cfg.set_open_mode('w');
+      return cfg;
+    }(),
+    FileEventNotifier{});
+
+  CustomLogger* logger = CustomFrontend::create_or_get_logger(logger_name, std::move(file_sink));
+
+  // Log a string
+  for (size_t i = 0; i < number_of_messages; ++i)
+  {
+    std::string v{"Lorem ipsum dolor sit amet, consectetur "};
+    v += std::to_string(i);
+
+    LOG_INFO(logger, "Logging int: {}, int: {}, string: {}, char: {}", i, i * 10, v, v.c_str());
+  }
+
+  // log a very large string
+  std::string const very_large(std::numeric_limits<uint32_t>::max(), 'A');
+  LOG_INFO(logger, "Very large string {}", very_large);
+
+  logger->flush_log();
+  Frontend::remove_logger(logger);
+
+  // Wait until the backend thread stops for test stability
+  Backend::stop();
+
+  // Read file and check
+  std::vector<std::string> const file_contents = quill::testing::file_contents(filename);
+  REQUIRE_EQ(file_contents.size(), number_of_messages + 1);
+
+  REQUIRE(quill::testing::file_contains(
+    file_contents, std::string{"LOG_INFO      " + logger_name + "       Logging int: 0, int: 0, string: Lorem ipsum dolor sit amet, consectetur 0, char: Lorem ipsum dolor sit amet, consectetur 0"}));
+
+  REQUIRE(quill::testing::file_contains(
+    file_contents, std::string{"LOG_INFO      " + logger_name + "       Logging int: 999, int: 9990, string: Lorem ipsum dolor sit amet, consectetur 999, char: Lorem ipsum dolor sit amet, consectetur 999"}));
+
+  REQUIRE(quill::testing::file_contains(
+    file_contents, std::string{"LOG_INFO      " + logger_name + "       Very large string"}));
+
+  testing::remove_file(filename);
+}