#include #include #include #include #include #include #include #include #include #include #include namespace boost_logging = boost::log; namespace sinks = boost_logging::sinks; // Undefine the original TEST macro #undef TEST // Redefine TEST to use our BaseTest class, to automatically use our BaseTest fixture #define TEST(test_case_name, test_name) \ GTEST_TEST_(test_case_name, test_name, ::BaseTest, \ ::testing::internal::GetTypeId<::BaseTest>()) /** * @brief Base class for tests. * * This class provides a base test fixture for all tests. * * ``cout``, ``stderr``, and ``stdout`` are redirected to a buffer, and the buffer is printed if the test fails. * * @todo Retain the color of the original output. */ class BaseTest: public ::testing::Test { protected: // https://stackoverflow.com/a/58369622/11214013 // we can possibly use some internal googletest functions to capture stdout and stderr, but I have not tested this // https://stackoverflow.com/a/33186201/11214013 // Add a member variable for deinit_guard std::unique_ptr deinit_guard; // Add a member variable to store the sink boost::shared_ptr> test_sink; BaseTest(): sbuf { nullptr }, pipe_stdout { nullptr }, pipe_stderr { nullptr } { // intentionally empty } ~BaseTest() override = default; void SetUp() override { // todo: only run this one time, instead of every time a test is run // see: https://stackoverflow.com/questions/2435277/googletest-accessing-the-environment-from-a-test // get command line args from the test executable testArgs = ::testing::internal::GetArgvs(); // then get the directory of the test executable // std::string path = ::testing::internal::GetArgvs()[0]; testBinary = testArgs[0]; // get the directory of the test executable testBinaryDir = std::filesystem::path(testBinary).parent_path(); // If testBinaryDir is empty or `.` then set it to the current directory // maybe some better options here: https://stackoverflow.com/questions/875249/how-to-get-current-directory if (testBinaryDir.empty() || testBinaryDir.string() == ".") { testBinaryDir = std::filesystem::current_path(); } // Create a sink that writes to our stringstream (BOOST_LOG) typedef sinks::synchronous_sink test_text_sink; test_sink = boost::make_shared(); // Set the stringstream as the target of the sink (BOOST_LOG) boost::shared_ptr stream(&boost_log_buffer, [](std::ostream *) {}); test_sink->locked_backend()->add_stream(stream); // Register the sink in the logging core (BOOST_LOG) boost_logging::core::get()->add_sink(test_sink); sbuf = std::cout.rdbuf(); // save cout buffer (std::cout) std::cout.rdbuf(cout_buffer.rdbuf()); // redirect cout to buffer (std::cout) // todo: do this only once // setup a mail object mail::man = std::make_shared(); deinit_guard = logging::init(0, "test.log"); if (!deinit_guard) { FAIL() << "Logging failed to initialize"; } } void TearDown() override { std::cout.rdbuf(sbuf); // restore cout buffer // get test info const ::testing::TestInfo *const test_info = ::testing::UnitTest::GetInstance()->current_test_info(); if (test_info->result()->Failed()) { std::cout << std::endl << "Test failed: " << test_info->name() << std::endl << std::endl << "Captured boost log:" << std::endl << boost_log_buffer.str() << std::endl << "Captured cout:" << std::endl << cout_buffer.str() << std::endl << "Captured stdout:" << std::endl << stdout_buffer.str() << std::endl << "Captured stderr:" << std::endl << stderr_buffer.str() << std::endl; } sbuf = nullptr; // clear sbuf if (pipe_stdout) { pclose(pipe_stdout); pipe_stdout = nullptr; } if (pipe_stderr) { pclose(pipe_stderr); pipe_stderr = nullptr; } // Remove the sink from the logging core (BOOST_LOG) boost_logging::core::get()->remove_sink(test_sink); test_sink.reset(); } // functions and variables std::vector testArgs; // CLI arguments used std::filesystem::path testBinary; // full path of this binary std::filesystem::path testBinaryDir; // full directory of this binary std::stringstream boost_log_buffer; // declare boost_log_buffer std::stringstream cout_buffer; // declare cout_buffer std::stringstream stdout_buffer; // declare stdout_buffer std::stringstream stderr_buffer; // declare stderr_buffer std::streambuf *sbuf; FILE *pipe_stdout; FILE *pipe_stderr; int exec(const char *cmd) { std::array buffer {}; pipe_stdout = popen((std::string(cmd) + " 2>&1").c_str(), "r"); pipe_stderr = popen((std::string(cmd) + " 2>&1").c_str(), "r"); if (!pipe_stdout || !pipe_stderr) { throw std::runtime_error("popen() failed!"); } while (fgets(buffer.data(), buffer.size(), pipe_stdout) != nullptr) { stdout_buffer << buffer.data(); } while (fgets(buffer.data(), buffer.size(), pipe_stderr) != nullptr) { stderr_buffer << buffer.data(); } int returnCode = pclose(pipe_stdout); pipe_stdout = nullptr; if (returnCode != 0) { std::cout << "Error: " << stderr_buffer.str() << std::endl << "Return code: " << returnCode << std::endl; } return returnCode; } }; class PlatformInitBase: public virtual BaseTest { protected: void SetUp() override { std::cout << "PlatformInitTest:: starting Fixture SetUp" << std::endl; // initialize the platform deinit_guard = platf::init(); if (!deinit_guard) { FAIL() << "Platform failed to initialize"; } std::cout << "PlatformInitTest:: finished Fixture SetUp" << std::endl; } void TearDown() override { std::cout << "PlatformInitTest:: starting Fixture TearDown" << std::endl; deinit_guard.reset(nullptr); std::cout << "PlatformInitTest:: finished Fixture TearDown" << std::endl; } private: std::unique_ptr deinit_guard; };