Move logging backend to spdlog

.ci/build-kit/install_and_test.sh

@@ -2,6 +2,11 @@
 
 set -e
 
+copy_logs() {
+    cp build/Testing/Temporary/LastTest.log /ext/ctest-report
+    cp -R build/everest-log_gcovr_coverage /ext/gcovr-coverage
+}
+
 cmake \
     -B build \
     -S "$EXT_MOUNT/source" \
@@ -12,4 +17,12 @@ cmake \
 
 ninja -j$(nproc) -C build install
 
+trap "copy_logs" ERR
+
 ninja -j$(nproc) -C build test
+
+pip install gcovr==6
+
+ninja -j$(nproc) -C build everest-log_gcovr_coverage
+
+copy_logs

.github/workflows/build_and_test.yaml

@@ -53,8 +53,13 @@ jobs:
           build-kit run-script install_and_test
       - name: Archive test results
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: ctest-report
-          path: /workspace/build/tests/Testing/Temporary/LastTest.log
-
+          path: ${{ github.workspace }}/ctest-report
+      - name: Archive coverage report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: gcovr-coverage
+          path: ${{ github.workspace }}/gcovr-coverage

CMakeLists.txt

@@ -1,7 +1,7 @@
 cmake_minimum_required(VERSION 3.11)
 
 project(everest-log
-    VERSION 0.2.1
+    VERSION 0.3
     DESCRIPTION "EVerest logging library"
     LANGUAGES CXX C
 )
@@ -18,9 +18,27 @@ option(BUILD_EXAMPLES "Build liblog example binaries." OFF)
 option(LOG_INSTALL "Install the library (shared data might be installed anyway)" ${EVC_MAIN_PROJECT})
 option(CMAKE_RUN_CLANG_TIDY "Run clang-tidy" OFF)
 option(LIBLOG_USE_BOOST_FILESYSTEM "Usage of boost/filesystem.hpp instead of std::filesystem" OFF)
+option(LIBLOG_OMIT_FILE_AND_LINE_NUMBERS "Always omit file and line numbers in logs" OFF)
 
-# library dependencies
+if((${CMAKE_PROJECT_NAME} STREQUAL ${PROJECT_NAME} OR ${PROJECT_NAME}_BUILD_TESTING) AND BUILD_TESTING)
+    set(LIBLOG_BUILD_TESTING ON)
+    evc_include(CodeCoverage)
+
+    append_coverage_compiler_flags()
+endif()
+
+if(NOT DISABLE_EDM)
+    evc_setup_edm()
 
+    # In EDM mode, we can't install exports (because the dependencies usually do not install their exports)
+    set(LOG_INSTALL OFF)
+endif()
+
+# library dependencies
+# use cmakes FindBoost module until we require Boost 1.70+ which provides its own BoostConfig.cmake
+if("${CMAKE_VERSION}" VERSION_GREATER_EQUAL "3.30")
+    cmake_policy(SET CMP0167 OLD)
+endif()
 if (LIBLOG_USE_BOOST_FILESYSTEM) 
     message(STATUS "Using boost/filesystem instead of std::filesystem")
     find_package(Boost COMPONENTS log_setup log filesystem REQUIRED)
@@ -68,26 +86,26 @@ endif()
 
 
 # testing
-if((${CMAKE_PROJECT_NAME} STREQUAL ${PROJECT_NAME} OR ${PROJECT_NAME}_BUILD_TESTING) AND BUILD_TESTING)
-    include(CTest)
-    add_subdirectory(tests)
-
+if(LIBLOG_BUILD_TESTING)
     set(CMAKE_BUILD_TYPE Debug CACHE STRING "Build type" FORCE)
 
-    evc_include(CodeCoverage)
-
-    append_coverage_compiler_flags()
+    include(CTest)
+    enable_testing()
+    add_subdirectory(tests)
 
     setup_target_for_coverage_gcovr_html(
-        NAME gcovr_coverage_liblog
-        EXECUTABLE test_config
-        DEPENDENCIES test_config everest
+        NAME ${PROJECT_NAME}_gcovr_coverage
+        EXECUTABLE ctest
+        DEPENDENCIES ${PROJECT_NAME}_tests
+        EXCLUDE "examples/*"
     )
 
     setup_target_for_coverage_lcov(
-        NAME lcov_coverage_liblog
-        EXECUTABLE test_config
-        DEPENDENCIES test_config everest
+        NAME ${PROJECT_NAME}_lcov_coverage
+        EXECUTABLE ctest
+        DEPENDENCIES ${PROJECT_NAME}_tests
+        LCOV_ARGS "--ignore-errors=empty,missing"
+        EXCLUDE "examples/*"
     )
 else()
     message("Not running unit tests")

dependencies.yaml

@@ -0,0 +1,14 @@
+libfmt:
+  git: https://github.com/fmtlib/fmt.git
+  git_tag: 10.1.0
+  options:
+    ["FMT_TEST OFF", "FMT_DOC OFF", "BUILD_SHARED_LIBS ON", "FMT_INSTALL ON"]
+spdlog:
+  git: https://github.com/gabime/spdlog.git
+  git_tag: v1.14.1
+  options:
+    ["SPDLOG_NO_TLS ON", "SPDLOG_FMT_EXTERNAL ON"]
+gtest:
+  git: https://github.com/google/googletest.git
+  git_tag: release-1.12.1
+  cmake_condition: "LIBLOG_BUILD_TESTING"

examples/logging.ini

@@ -3,7 +3,7 @@
 
 [Core]
 DisableLogging=false
-Filter="%Severity% >= DEBG"
+Filter="(%Severity% >= VERB and %Process% contains EVerest)"
 
 [Sinks.Console]
 Destination=Console
@@ -16,3 +16,15 @@ SeverityStringColorInfo="\033[1;37m"
 SeverityStringColorWarning="\033[1;33m"
 SeverityStringColorError="\033[1;31m"
 SeverityStringColorCritical="\033[1;35m"
+
+[Sinks.TextFile]
+Destination=TextFile
+FileName="FileLog%5N.log"
+Format = "%TimeStamp% [%Severity%] %Message%"
+RotationSize = 500 # bytes
+MaxFiles = 5
+
+[Sinks.Syslog]
+Destination=Syslog
+Format="%TimeStamp% [%Severity%] %Message%"
+EnableFormatting=false

examples/main.cpp

@@ -1,14 +1,26 @@
 // SPDX-License-Identifier: Apache-2.0
-// Copyright 2020 - 2021 Pionix GmbH and Contributors to EVerest
+// Copyright Pionix GmbH and Contributors to EVerest
+#include <everest/exceptions.hpp>
 #include <everest/logging.hpp>
 
 #include <iostream>
+#include <thread>
 
 #include <boost/exception/diagnostic_information.hpp>
 #include <boost/program_options.hpp>
 
 namespace po = boost::program_options;
 
+struct TestStruct {
+    std::string hello;
+    int integer;
+};
+
+std::ostream& operator<<(std::ostream& os, const TestStruct& test) {
+    os << "TestStruct: hello " << test.hello << " " << test.integer;
+    return os;
+}
+
 int main(int argc, char* argv[]) {
     po::options_description desc("EVerest::log example");
     desc.add_options()("help,h", "produce help message");
@@ -28,7 +40,7 @@ int main(int argc, char* argv[]) {
     if (vm.count("logconf") != 0) {
         logging_config = vm["logconf"].as<std::string>();
     }
-    Everest::Logging::init(logging_config, "hello there");
+    Everest::Logging::init(logging_config, "hello there. EVerest");
 
     EVLOG_debug << "logging_config was set to " << logging_config;
 
@@ -39,5 +51,33 @@ int main(int argc, char* argv[]) {
     EVLOG_error << "This is a ERROR message.";
     EVLOG_critical << "This is a CRITICAL message.";
 
+    TestStruct test_struct{"there", 42};
+    EVLOG_info << "This logs a TestStruct using a operator<<: " << test_struct;
+    EVLOG_info << "Test logs with an additional std::endl at the end" << std::endl;
+    EVLOG_info << "Test logs with different types: " << 42 << " " << 12.34;
+
+    EVLOG_critical << Everest::Logging::LogSource("file.name", 42, "function_with_file_name_and_line_nr()")
+                   << "This is a CRITICAL message";
+    EVLOG_critical << Everest::Logging::LogSource("function_without_file_name_or_line_nr()")
+                   << "This is a CRITICAL message";
+
+    auto t = std::thread([]() { EVLOG_info << "From another thread"; });
+    t.join();
+
+    try {
+        EVTHROW(std::runtime_error("hello there"));
+
+    } catch (...) {
+    }
+    try {
+        EVLOG_AND_THROW(std::runtime_error("hello there"));
+
+    } catch (...) {
+    }
+    try {
+        EVTHROW(EVEXCEPTION(Everest::EverestInternalError, "Something", " with", " multiple", " args"));
+
+    } catch (...) {
+    }
     return 0;
 }