adding tests

Author: Samuel Rodriguez Sevilla

CMakeLists.txt

@@ -1,6 +1,7 @@
 cmake_minimum_required(VERSION 3.25)
 project(lzc-coro VERSION 0.1.0
                  DESCRIPTION "A simple header-only C++ library to use coroutines"
+                 HOMEPAGE_URL "https://github.com/lazy-coders/lzc-coro"
                  LANGUAGES CXX)
 
 #set(CMAKE_CXX_STANDARD 23)
@@ -34,4 +35,5 @@ install(TARGETS lzc-coro
 #    INSTALL_DESTINATION
 #    ${CMAKE_INSTALL_DATAROOTDIR}/${PROJECT_NAME}/cmake)
 
+enable_testing()
 add_subdirectory(tests)

include/lzcoders/coro.hpp

@@ -44,7 +44,7 @@ struct task : std::coroutine_handle<promise<T>>
         d("Resuming this task");
         this->resume();
         d("Returning the result");
-        return this->promise().result_.get_future().get();
+        return this->promise().get_result();
     }
 
     auto get_future()
@@ -96,6 +96,12 @@ struct promise
 
         return t;
     }
+
+    T get_result()
+    {
+        return result_.get_future().get();
+    }
+
     std::promise<T> result_;
     std::shared_ptr<coro_execution_context> context_ = std::make_shared<default_execution_context>();
     std::optional<std::coroutine_handle<>> continuation_;
@@ -108,7 +114,7 @@ struct promise<void>
     std::suspend_always initial_suspend() noexcept { d(); return {}; }
     std::suspend_always final_suspend() noexcept { d(); return {}; }
     void unhandled_exception() { d(); throw; }
-    void return_void() { d(); }
+    void return_void() { d(); ended_.set_value(true); }
 
     template<typename U>
     auto await_transform(task<U> t)
@@ -127,6 +133,12 @@ struct promise<void>
 
         return t;
     }
+
+    void get_result()
+    {
+        ended_.get_future().get();
+    }
+    std::promise<bool> ended_;
     std::shared_ptr<coro_execution_context> context_ = std::make_shared<default_execution_context>();
 };
 

include/lzcoders/debug.hpp

@@ -91,7 +91,7 @@ void d(const auto_location& t, Args&&... args)
     std::clog << "\" }" << std::endl;
 }
 
-void d(const std::source_location& sl = std::source_location::current())
+inline void d(const std::source_location& sl = std::source_location::current())
 {
     d(auto_location("", sl));
 }

tests/CMakeLists.txt

@@ -1,12 +1,16 @@
-#CPMAddPackage(
-#  NAME googletest
-#  GITHUB_REPOSITORY google/googletest
-#  GIT_TAG release-1.12.1
-#  VERSION 1.12.1
-#  OPTIONS "INSTALL_GTEST OFF" "gtest_force_shared_crt"
-#)
-
-#add_test(NAME lzc-coro-test )
-add_executable(lzc-coro-test main.cpp)
-target_link_libraries(lzc-coro-test  PRIVATE lzc-coro)
-#target_include_directories(coro PUBLIC include)
+project(lzc-coro-test)
+
+include(../cmake/CPM.cmake)
+
+CPMAddPackage(
+  NAME googletest
+  GITHUB_REPOSITORY google/googletest
+  GIT_TAG release-1.12.1
+  VERSION 1.12.1
+  OPTIONS "INSTALL_GTEST OFF" "gtest_force_shared_crt"
+)
+
+add_executable(lzc-coro-test test_simple.cpp test_simulated_http.cpp)
+target_link_libraries(lzc-coro-test  PRIVATE lzc-coro GTest::gtest_main GTest::gtest GTest::gmock)
+
+add_test(lzc-coro-test ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/lzc-coro-test)

tests/test_simple.cpp

@@ -0,0 +1,58 @@
+#include <gtest/gtest.h>
+#include <lzcoders/coro.hpp>
+#include <condition_variable>
+#include <memory>
+#include <lzcoders/debug.hpp>
+
+using namespace lzcoders;
+
+task<void> notify_at_end(std::shared_ptr<int> counter)
+{
+    struct guard {
+        ~guard()
+        {
+            d();
+            (*counter)++;
+        }
+        std::shared_ptr<int> counter;
+    };
+    guard guard_{counter};
+
+    co_return;
+}
+
+TEST(lzc_coro, task_with_void_return_should_be_waited_and_completed)
+{
+    auto counter = std::make_shared<int>(0);
+    auto t = notify_at_end(counter);
+    t();
+    EXPECT_EQ(*counter, 1);
+}
+
+task<int> return_same_value(int value)
+{
+    co_return value;
+}
+
+TEST(lzc_coro, value_should_be_returned_correctly)
+{
+    for(int i = -5; i < 10; i++)
+    {
+        auto t = return_same_value(i);
+        EXPECT_EQ(i, t());
+    }
+}
+
+task<int> return_double_using_co_await_of_task(int value)
+{
+    co_return co_await return_same_value(value) + co_await return_same_value(value);
+}
+
+TEST(lzc_coro, co_await_of_task_should_work)
+{
+    for(int i = -5; i < 10; i++)
+    {
+        auto t = return_double_using_co_await_of_task(i);
+        EXPECT_EQ(i+i, t());
+    }
+}

tests/main.cpp renamed to tests/test_simulated_http.cpp

@@ -3,6 +3,7 @@
 #include <lzcoders/coro.hpp>
 #include "io_reader.hpp"
 #include "co_spawn.hpp"
+#include <gtest/gtest.h>
 constexpr std::size_t PoolSize = 1;
 std::atomic<int> tasks = 1;
 
@@ -42,13 +43,12 @@ lzcoders::task<void> http_acceptor_loop(lzcoders::thread_pool<PoolSize>& pool)
     co_return /*'a'*/;
 }
 
-int main()
+TEST(lzc_coro, simulated_http)
 {
     lzcoders::thread_pool<PoolSize> pool;
 
     lzcoders::co_spawn(pool, http_acceptor_loop(pool));
 
     while(tasks > 0)
         ;
-    return 0;
 }