Added blocking_queue::clear. Improved unit tests for signal_handler::wait_for_quit return codes.

Author: StefanoLusardiTC

sdk/include/teiacare/sdk/blocking_queue.hpp

@@ -189,6 +189,24 @@ class blocking_queue : private non_copyable, private non_moveable
         return _capacity;
     }
 
+    /*!
+     * \brief Clear the queue
+     *
+     * Removes all items from the queue.
+     */
+    void clear()
+    {
+        std::lock_guard lock(_mutex);
+        if (is_empty())
+            return;
+
+        while (!_queue.empty())
+            _queue.pop();
+
+        _last_item_popped.notify_all();
+        _first_item_pushed.notify_all();
+    }
+
 private:
     std::queue<T> _queue;
     mutable std::mutex _mutex;
@@ -218,6 +236,7 @@ class blocking_queue : private non_copyable, private non_moveable
     {
         return _queue.empty();
     }
+
     inline bool is_full() const
     {
         return _queue.size() >= _capacity;

sdk/tests/src/test_blocking_queue.cpp

@@ -15,11 +15,64 @@
 #include "test_blocking_queue.hpp"
 
 #include <gtest/gtest.h>
+#include <semaphore>
 
 using namespace std::string_literals;
 
 namespace tc::sdk::tests
 {
+constexpr size_t QUEUE_CAPACITY = 3;
+
+TEST(test_blocking_queue_clear, clear_after_construction)
+{
+    tc::sdk::blocking_queue<int> queue = tc::sdk::blocking_queue<int>(QUEUE_CAPACITY);
+
+    queue.clear();
+
+    EXPECT_EQ(queue.size(), 0);
+    EXPECT_EQ(queue.capacity(), QUEUE_CAPACITY);
+}
+
+TEST(test_blocking_queue_clear, clear_after_push)
+{
+    tc::sdk::blocking_queue<int> queue = tc::sdk::blocking_queue<int>(QUEUE_CAPACITY);
+
+    queue.push(1);
+    queue.push(2);
+    queue.push(3);
+    queue.clear();
+
+    EXPECT_EQ(queue.size(), 0);
+    EXPECT_EQ(queue.capacity(), QUEUE_CAPACITY);
+}
+
+TEST(test_blocking_queue_clear, push_after_clear)
+{
+    tc::sdk::blocking_queue<int> queue = tc::sdk::blocking_queue<int>(QUEUE_CAPACITY);
+
+    std::thread push_thread([&queue]() {
+        queue.push(1);
+        queue.push(2);
+        queue.push(3);
+        queue.push(4);
+    });
+
+    std::thread clear_thread([&queue]() {
+        while (queue.size() < QUEUE_CAPACITY)
+        {
+            std::this_thread::yield();
+        }
+
+        queue.clear();
+    });
+
+    clear_thread.join();
+    push_thread.join();
+
+    EXPECT_EQ(queue.size(), 1);
+    EXPECT_EQ(queue.capacity(), QUEUE_CAPACITY);
+}
+
 class test_blocking_queue_push_int : public test_blocking_queue<int>
 {
 };

sdk/tests/src/test_signal_handler.cpp

@@ -45,7 +45,8 @@ TEST_P(test_signal_handler, raise)
         std::raise(params.signal);
     });
 
-    tc::sdk::wait_for_quit();
+    int ret = tc::sdk::wait_for_quit();
+    EXPECT_EQ(ret, params.signal);
 }
 
 // NOLINTNEXTLINE
@@ -58,7 +59,8 @@ TEST_P(test_signal_handler, quit)
         tc::sdk::quit(params.name, params.signal);
     });
 
-    tc::sdk::wait_for_quit();
+    int ret = tc::sdk::wait_for_quit();
+    EXPECT_EQ(ret, params.signal);
 }
 
 // NOLINTNEXTLINE
@@ -73,7 +75,9 @@ TEST_F(test_signal_handler_shutdown, null_callback)
     });
 
     auto arrival_token = sync.arrive();
-    tc::sdk::wait_for_quit();
+    int ret = tc::sdk::wait_for_quit();
+    EXPECT_EQ(ret, 0);
+
     (void)arrival_token;
 }
 
@@ -93,7 +97,9 @@ TEST_F(test_signal_handler_shutdown, quit_arguments)
     });
 
     auto arrival_token = sync.arrive();
-    tc::sdk::wait_for_quit();
+    int ret = tc::sdk::wait_for_quit();
+    EXPECT_EQ(ret, 1234);
+
     (void)arrival_token;
 }
 
@@ -118,7 +124,8 @@ TEST_F(test_signal_handler_shutdown, multiple_quit)
     for (auto i = 0; i < total_count; ++i)
     {
         auto arrival_token = sync.arrive();
-        tc::sdk::wait_for_quit();
+        int ret = tc::sdk::wait_for_quit();
+        EXPECT_EQ(ret, 0);
         (void)arrival_token;
     }