Improve tests and examples.

Author: ObiWahn

CMakeLists.txt

@@ -69,7 +69,11 @@ target_compile_options(ext-logging PRIVATE ${ext_stone-warnings})
 target_compile_definitions(ext-logging PUBLIC ${ext_common_compile_definitions})
 target_compile_definitions(ext-logging PUBLIC EXT_SHARED_LIB)
 target_compile_definitions(ext-logging PRIVATE EXT_IN_LIB=1)
-target_link_libraries(ext-logging PUBLIC ext::basics Threads::Threads)
+target_link_libraries(ext-logging PUBLIC
+    ext::basics
+    Threads::Threads
+    $<$<BOOL:UNIX>:stdc++fs>
+)
 
 # set up folder structure for XCode and VisualStudio
 set_target_properties (ext-logging PROPERTIES FOLDER logging)

examples/logging.cpp

@@ -5,29 +5,44 @@
 #include <vector>
 
 #ifndef _WIN32
-    #include <ext/logging.hpp>
+#include <ext/logging.hpp>
+
+struct test {
+	test() {
+		EXT_LOG("test class", error) << "hello form ctor";
+	}
+};
+
+static test someclass{};
 
 int main(/*int argc, const char *argv[]*/) {
-    {
-        using namespace ext::logging;
-        configuration::function = false;
-        configuration::append_newline = true;
-    }
+    namespace el = ext::logging;
 
-    EXT_DEV << "geil";
-    EXT_DEVV << "ballern";
+    using namespace ext::logging;
+    el::configuration::function = false;
+    el::configuration::append_newline = true;
+    el::set_level_all(ext::logging::level::info);
 
-    EXT_LOG("mic", info) << "1"
-                         << "2"
-                         << "3";
+    EXT_DEV << "foo";
+    EXT_DEVV << "bar";
+
+	// clang-format off
+    EXT_LOG("hi mic", warn) << "1" << "2" << "3";
+	// clang-format on
 
     EXT_LOG("cafe") << "default level and topic";
     EXT_LOG("0000", trace) << "where is the byte gone";
     EXT_LOG("1111", network, debug) << "ohlala";
     EXT_LOG("2222", info) << "Hi there!";
+
+    el::set_level_all(ext::logging::level::error);
+    EXT_LOG("2222", info) << "Hi there!";
+    EXT_LOG_STATIC("3333", warn) << "something is wrong";
     EXT_LOG_STATIC("3333", warn) << "something is wrong";
+
     EXT_LOG_STATIC("4444", network, error, false) << "your network is broken";
     EXT_LOG_STATIC("5555", network, error, true) << "your network is broken";
+    EXT_LOG("music", network, warn) << "Green Day";
     EXT_LOG("6666", fatal) << "your app will terminate";
 
 #else

include/ext/logging.hpp

@@ -33,11 +33,12 @@
 // inactivity completely away. If you want the level to be configurable at
 // runtime you need to pay for it by having the instructions in your code.
 
-// TODO -- static_assert parameters
+// non static
 #define _EXT_LOG_INTERNAL(id_, topic_, macro_level_, cond_)                        \
     if (ext::logging::_detail::level_is_active((macro_level_), (topic_)) && cond_) \
     ext::logging::_detail::logger(id_, (topic_), (macro_level_), __FILE__, __LINE__, __FUNCTION__)
 
+// static
 #define _EXT_LOG_INTERNAL_STATIC(id_, topic_, macro_level_, cond_)               \
     if constexpr (ext::logging::_detail::default_level_is_active((macro_level_))       \
         ext::logging::_detail::logger(id_, (topic_), (macro_level_), __FILE__, __LINE__, __FUNCTION__)
@@ -51,13 +52,13 @@
 #define _EXT_LOG_SELECT5TH_PARAMETER(_1, _2, _3, _4, NAME, ...) NAME
 
 // constexpr macros
-#define EXT_LOGC4(id, topic_, macro_level_, cond_) _EXT_LOG_INTERNAL_ADD_PREFIX(id, no_topic, macro_level_, cond_)
+#define EXT_LOGVARIABLE4(id, topic_, macro_level_, cond_) _EXT_LOG_INTERNAL_ADD_PREFIX(id, no_topic, macro_level_, cond_)
 
-#define EXT_LOGC3(id, topic_, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX(id, topic_, macro_level_, true)
+#define EXT_LOGVARIABLE3(id, topic_, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX(id, topic_, macro_level_, true)
 
-#define EXT_LOGC2(id, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX(id, no_topic, macro_level_, true)
+#define EXT_LOGVARIABLE2(id, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX(id, no_topic, macro_level_, true)
 
-#define EXT_LOGC1(id) _EXT_LOG_INTERNAL_ADD_PREFIX(id, no_topic, EXT_LOGGING_DEFAULT_LEVEL, true)
+#define EXT_LOGVARIABLE1(id) _EXT_LOG_INTERNAL_ADD_PREFIX(id, no_topic, EXT_LOGGING_DEFAULT_LEVEL, true)
 
 #define EXT_DEVC _EXT_LOG_INTERNAL_ADD_PREFIX("@@@@", dev, EXT_LOGGING_DEFAULT_LEVEL, true)
 
@@ -66,34 +67,34 @@
 #ifdef EXT_COMPILER_VC
     // __VA_ARGS__ does not expand on VisualStudio compiler :(
     #define _EXT_LOG_EXPAND(x) x
-    #define EXT_LOGC(...)                                                                                        \
-        _EXT_LOG_SELECT5TH_PARAMETER(_EXT_LOG_EXPAND(__VA_ARGS__), EXT_LOGC4, EXT_LOGC3, EXT_LOGC2, EXT_LOGC1, ) \
+    #define EXT_LOGVARIABLE(...)                                                                                        \
+        _EXT_LOG_SELECT5TH_PARAMETER(_EXT_LOG_EXPAND(__VA_ARGS__), EXT_LOGVARIABLE4, EXT_LOGVARIABLE3, EXT_LOGVARIABLE2, EXT_LOGVARIABLE1, ) \
         (_EXT_LOG_EXPAND(__VA_ARGS__))
 #else
-    #define EXT_LOGC(...)                                                                       \
-        _EXT_LOG_SELECT5TH_PARAMETER(__VA_ARGS__, EXT_LOGC4, EXT_LOGC3, EXT_LOGC2, EXT_LOGC1, ) \
+    #define EXT_LOGVARIABLE(...)                                                                       \
+        _EXT_LOG_SELECT5TH_PARAMETER(__VA_ARGS__, EXT_LOGVARIABLE4, EXT_LOGVARIABLE3, EXT_LOGVARIABLE2, EXT_LOGVARIABLE1, ) \
         (__VA_ARGS__)
 #endif // EXT_COMPILER_VC
 
 // runtime configurable macros
-#define EXT_LOGV4(id, topic_, macro_level_, cond_) \
+#define EXT_LOGSTATIC4(id, topic_, macro_level_, cond_) \
     _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC(id, no_topic, macro_level_, cond_)
 
-#define EXT_LOGV3(id, topic_, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC(id, topic_, macro_level_, true)
+#define EXT_LOGSTATIC3(id, topic_, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC(id, topic_, macro_level_, true)
 
-#define EXT_LOGV2(id, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC(id, no_topic, macro_level_, true)
+#define EXT_LOGSTATIC2(id, macro_level_) _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC(id, no_topic, macro_level_, true)
 
-#define EXT_LOGV1(id) _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC(id, no_topic, EXT_LOGGING_DEFAULT_LEVEL, true)
+#define EXT_LOGSTATIC1(id) _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC(id, no_topic, EXT_LOGGING_DEFAULT_LEVEL, true)
 
 #define EXT_DEVV _EXT_LOG_INTERNAL_ADD_PREFIX_STATIC("$$$$", dev, EXT_LOGGING_DEFAULT_LEVEL, true)
 
-#define EXT_LOGV(...)                                                                       \
-    _EXT_LOG_SELECT5TH_PARAMETER(__VA_ARGS__, EXT_LOGV4, EXT_LOGV3, EXT_LOGV2, EXT_LOGV1, ) \
+#define EXT_LOGSTATIC(...)                                                                       \
+    _EXT_LOG_SELECT5TH_PARAMETER(__VA_ARGS__, EXT_LOGSTATIC4, EXT_LOGSTATIC3, EXT_LOGSTATIC2, EXT_LOGSTATIC1, ) \
     (__VA_ARGS__)
 
 // set default macros
-#define EXT_LOG EXT_LOGC
-#define EXT_LOG_STATIC EXT_LOGV
+#define EXT_LOG EXT_LOGVARIABLE
+#define EXT_LOG_STATIC EXT_LOGSTATIC
 #define EXT_DEV EXT_DEVC
 
 #endif // EXT_LOGGING_HEADER

include/ext/logging/functionality.hpp

@@ -17,6 +17,13 @@ inline bool level_is_active(level macro_level, logtopic topic = topic::no_topic)
     // activation_level 60(info) && macro_level 20 (error) -> log
     // activation_level 60(info) && macro_level 100(trace) -> no log
     // activation level must be greater than macro level
+#ifdef NOT_DEFINED
+    std::cerr << "####################" << std::endl;
+    std::cerr << "activation_level: " << level_to_str(topic.activation_level) << std::endl;
+    std::cerr << "macro_level: " << level_to_str(macro_level) << std::endl;
+    std::cerr << "activates: " << std::boolalpha << (topic.activation_level >= macro_level) << std::endl;
+    std::cerr << "####################" << std::endl;
+#endif
     return topic.activation_level >= macro_level;
 }
 

src/logging.cpp

@@ -17,13 +17,13 @@ EXT_INIT_PRIORITY_GNU(102)
 std::map<int, _detail::logtopic*> _detail::topics_map{};
 
 EXT_INIT_PRIORITY_GNU(103)
-_detail::logtopic topic::no_topic{1, "default"s, level::info};
+_detail::logtopic topic::no_topic{1, "default"s, level::warn};
 EXT_INIT_PRIORITY_GNU(103)
 _detail::logtopic topic::dev{2, "development"s, level::debug};
 EXT_INIT_PRIORITY_GNU(103)
-_detail::logtopic topic::network{3, "network"s, level::error};
+_detail::logtopic topic::network{3, "network"s, level::warn};
 EXT_INIT_PRIORITY_GNU(103)
-_detail::logtopic topic::engine{4, "engine"s, level::error};
+_detail::logtopic topic::engine{4, "engine"s, level::warn};
 
 bool configuration::prefix_newline{false};
 bool configuration::append_newline{true};

tests/logging.cpp

@@ -1,72 +1,153 @@
 // Copyright - 2016-2020 - Jan Christoph Uhde <[email protected]>
 // Please see LICENSE.md for license or visit https://github.com/extcpp/basics
 #include <cstring>
-#include <ext/logging.hpp>
+#include <fstream>
+#include <filesystem>
+
+#include <gtest/gtest.h>
+
 #include <ext/macros/platform.hpp>
 #include <ext/util/except.hpp>
-#include <gtest/gtest.h>
+#include <ext/util/files.hpp>
+
+#define EXT_LOGGING_DEFAULT_LEVEL warn
+#include <ext/logging.hpp>
+
 
 using namespace std::literals;
 
-class LoggingTest : public ::testing::Test {
+struct LoggingTest : public ::testing::Test {
+    LoggingTest() : _log{"test.log", std::ios::trunc} {
+        ext::logging::configuration::stream = &_log;
+    };
+
+
+    void compare(std::string const& expected = ""){
+        _log.close();
+        std::ifstream file{"test.log"};
+        std::istreambuf_iterator<char> eos;
+        std::string logged{std::istreambuf_iterator<char>(file), eos};
+        ASSERT_EQ(expected, logged);
+    }
+
+    std::string path() {
+        auto path = std::filesystem::current_path().parent_path()
+                                              .parent_path()
+                                              .parent_path()
+                                              / "logging" / "tests" / "logging.cpp";
+        return path.string();
+    };
+
+    std::string line() {
+        return std::to_string(_line);
+    }
+
+    std::ofstream _log;
+    std::size_t _line;
 
 };
 using LoggingDeathTest = LoggingTest;
 
-TEST_F(LoggingTest, logging_no_crash) {
+TEST_F(LoggingTest, logging_no_crash_gdb_vim) {
     using namespace ext::logging;
-
     configuration::gdb = true;
     configuration::vim = true;
     configuration::prefix_newline = false;
     configuration::append_newline = true;
 
+    _line = __LINE__ + 1;
     ASSERT_NO_THROW(EXT_LOG("babe") << "cafe?");
 
+    compare(
+        "# vim "s + path() + " +" + line() +"\n"
+        "# break logging.cpp:" + line() + "\n"
+        "[babe] warning in TestBody(): 'cafe?'\n"
+    );
+}
+
+TEST_F(LoggingTest, logging_no_crash) {
+    using namespace ext::logging;
     configuration::gdb = false;
     configuration::vim = false;
     configuration::prefix_newline = true;
     configuration::append_newline = false;
 
+    _line = __LINE__ + 1;
     ASSERT_NO_THROW(EXT_LOG("babe") << "2cafe?");
-    ASSERT_NO_THROW(EXT_LOG("music", network, warn) << "Green Day");
+    compare("\n[babe] warning logging.cpp:" + line() + " in TestBody(): '2cafe?'");
+}
+
+TEST_F(LoggingTest, logging_level_too_low) {
+    using namespace ext::logging;
+    configuration::gdb = false;
+    configuration::vim = false;
+    configuration::prefix_newline = true;
+    configuration::append_newline = false;
+    topic::network.activation_level = level::error;
+
+    _line = __LINE__ + 1;
+    ASSERT_NO_THROW(EXT_LOG("music", network, warn) << "Green" << "Day");
+    compare("");
+}
+
+TEST_F(LoggingTest, logging_level_ok) {
+    using namespace ext::logging;
+    configuration::gdb = false;
+    configuration::vim = false;
+    configuration::prefix_newline = true;
+    configuration::append_newline = false;
+
+    _line = __LINE__ + 1;
+    ASSERT_NO_THROW(EXT_LOG("music", network, error) << "Green" << " Day");
+    compare("\n[music] error (network) logging.cpp:" + line() +" in TestBody(): 'Green Day'");
 }
 
 // does not die
 #ifndef EXT_COMPILER_VC
 TEST_F(LoggingDeathTest, fatal) {
     ::testing::FLAGS_gtest_death_test_style = "threadsafe";
     using namespace ext::logging;
-
     ASSERT_DEATH_IF_SUPPORTED(EXT_LOG("work", network, fatal) << "What?!?! No Cafe!?!?!? :(", "");
 }
 #endif // EXT_COMPILER_VC
 
-TEST_F(LoggingTest, levels) {
+TEST_F(LoggingTest, change_all_levels) {
     using namespace ext::logging;
 
     EXPECT_TRUE(_detail::level_is_active(level::error));
-    EXPECT_TRUE(_detail::level_is_active(level::info));
+    EXPECT_TRUE(_detail::level_is_active(level::warn));
+    EXPECT_FALSE(_detail::level_is_active(level::info));
     EXPECT_FALSE(_detail::level_is_active(level::trace));
 
+    // fix compiled in
     EXPECT_TRUE(_detail::default_level_is_active(level::error));
-    EXPECT_TRUE(_detail::default_level_is_active(level::info));
+    EXPECT_TRUE(_detail::default_level_is_active(level::warn));
+    EXPECT_FALSE(_detail::default_level_is_active(level::info));
     EXPECT_FALSE(_detail::default_level_is_active(level::trace));
 
-    set_level_all(level::warn);
+    set_level_all(level::error);
 
     EXPECT_TRUE(_detail::level_is_active(level::error));
+    EXPECT_FALSE(_detail::level_is_active(level::warn));
     EXPECT_FALSE(_detail::level_is_active(level::info));
     EXPECT_FALSE(_detail::level_is_active(level::trace));
 
+    // fix compiled in
     EXPECT_TRUE(_detail::default_level_is_active(level::error));
-    EXPECT_TRUE(_detail::default_level_is_active(level::info));
+    EXPECT_TRUE(_detail::default_level_is_active(level::warn));
+    EXPECT_FALSE(_detail::default_level_is_active(level::info));
     EXPECT_FALSE(_detail::default_level_is_active(level::trace));
 }
 
-TEST_F(LoggingTest, levels_to_string) {
+TEST_F(LoggingTest, change_single_level) {
     using namespace ext::logging;
+    EXPECT_FALSE(_detail::level_is_active(level::info, topic::network));
+    topic::network.activation_level = level::info;
+    EXPECT_TRUE(_detail::level_is_active(level::info, topic::network));
+}
 
+TEST_F(LoggingTest, levels_to_string) {
+    using namespace ext::logging;
     EXPECT_STREQ(_detail::level_to_str(level::fatal).c_str(), "fatal");
     EXPECT_STREQ(_detail::level_to_str(level::error).c_str(), "error");
     EXPECT_STREQ(_detail::level_to_str(level::warn).c_str(), "warning");