Feature: Integrate spdlog as logging backend for Trantor Logger (#294)

Author: Greisby

.github/workflows/cmake.yml

@@ -44,7 +44,7 @@ jobs:
         working-directory: ./build
         run: |
           [[ ${{ matrix.link }} == "SHARED" ]] && shared="ON" || shared="OFF"
-          cmake .. -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=on -DBUILD_SHARED_LIBS=$shared -DCMAKE_TOOLCHAIN_FILE="conan_toolchain.cmake" -DCMAKE_INSTALL_PREFIX=../install -DCMAKE_POLICY_DEFAULT_CMP0091=NEW
+          cmake .. -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=on -DUSE_SPDLOG=ON -DBUILD_SHARED_LIBS=$shared -DCMAKE_TOOLCHAIN_FILE="conan_toolchain.cmake" -DCMAKE_INSTALL_PREFIX=../install -DCMAKE_POLICY_DEFAULT_CMP0091=NEW
 
       - name: Build
         working-directory: ${{env.GITHUB_WORKSPACE}}
@@ -82,20 +82,20 @@ jobs:
     - name: (macOS) Install dependencies
       if: runner.os == 'macOS'
       run: |
-        brew install c-ares openssl
+        brew install c-ares openssl spdlog
 
     - name: (Linux) Install dependencies - OpenSSL
       if: matrix.buildname == 'ubuntu-20.04/gcc - OpenSSL'
       run: |
         # Installing packages might fail as the github image becomes outdated
         sudo apt update
-        sudo apt install openssl libssl-dev dos2unix
+        sudo apt install openssl libssl-dev dos2unix libspdlog-dev libfmt-dev
     - name: (Linux) Install dependencies
       if: matrix.buildname == 'ubuntu-20.04/gcc'
       run: |
         # Installing packages might fail as the github image becomes outdated
         sudo apt update
-        sudo apt install dos2unix
+        sudo apt install dos2unix libspdlog-dev libfmt-dev
     - name: install gtest
       run: |
         wget https://github.com/google/googletest/archive/refs/tags/v1.13.0.tar.gz
@@ -113,7 +113,7 @@ jobs:
       run: |
         mkdir build
         cd build
-        cmake .. -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBUILD_TESTING=on
+        cmake .. -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DBUILD_TESTING=on -DUSE_SPDLOG=ON
 
     - name: Build
       working-directory: ${{env.GITHUB_WORKSPACE}}

CMakeLists.txt

@@ -3,8 +3,10 @@ project(trantor)
 
 option(BUILD_DOC "Build Doxygen documentation" OFF)
 option(BUILD_C-ARES "Build C-ARES" ON)
+option(BUILD_TESTING "Build tests" OFF)
 option(BUILD_SHARED_LIBS "Build trantor as a shared lib" OFF)
 option(TRANTOR_USE_TLS "TLS provider for trantor. Valid options are 'openssl', 'botan' or '' (let the build scripr decide)" "")
+option(USE_SPDLOG "Allow using the spdlog logging library" OFF)
 
 list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake_modules/)
 
@@ -45,6 +47,13 @@ if(BUILD_SHARED_LIBS)
   endif()
 endif(BUILD_SHARED_LIBS)
 
+# Tells Visual Studio 2017 (15.7+) and newer to correctly set the value of the standard __cplusplus macro,
+# instead of leaving it to 199711L and settings the effective c++ version in _MSVC_LANG
+# Dropping support for older versions of VS would allow to only rely on __cplusplus
+if(MSVC AND MSVC_VERSION GREATER_EQUAL 1914)
+  add_compile_options(/Zc:__cplusplus)
+endif(MSVC)
+
 if (NOT ${CMAKE_SYSTEM_NAME} STREQUAL "Windows" AND CMAKE_CXX_COMPILER_ID MATCHES Clang|GNU)
     target_compile_options(${PROJECT_NAME} PRIVATE -Wall -Wextra -Werror)
 endif()
@@ -188,6 +197,19 @@ endif()
 message(STATUS "Trantor using SSL library: ${TRANTOR_TLS_PROVIDER}")
 target_compile_definitions(${PROJECT_NAME} PRIVATE TRANTOR_TLS_PROVIDER=${TRANTOR_TLS_PROVIDER})
 
+set(HAVE_SPDLOG NO)
+if(USE_SPDLOG)
+  find_package(spdlog CONFIG)
+  if(spdlog_FOUND)
+    message(STATUS "spdlog found!")
+    set(HAVE_SPDLOG TRUE)
+  endif(spdlog_FOUND)
+endif(USE_SPDLOG)
+if(HAVE_SPDLOG)
+  target_link_libraries(${PROJECT_NAME} PUBLIC spdlog::spdlog_header_only)
+  target_compile_definitions(${PROJECT_NAME} PUBLIC TRANTOR_SPDLOG_SUPPORT SPDLOG_FMT_EXTERNAL FMT_HEADER_ONLY)
+endif(HAVE_SPDLOG)
+
 set(HAVE_C-ARES NO)
 if (BUILD_C-ARES)
     find_package(c-ares)
@@ -206,7 +228,9 @@ if(HAVE_C-ARES)
       ${private_headers}
       trantor/net/inner/AresResolver.h)
   if(APPLE)
-      target_link_libraries(${PROJECT_NAME} PRIVATE resolv)
+    target_link_libraries(${PROJECT_NAME} PRIVATE resolv)
+  elseif(WIN32)
+    target_link_libraries(${PROJECT_NAME} PRIVATE Iphlpapi)
   endif()
 else()
   set(TRANTOR_SOURCES

ChangeLog.md

@@ -22,7 +22,7 @@ All notable changes to this project will be documented in this file.
 
 - Fix an error when sending files.
 
-- Include <memory> header in TcpConnectionImpl.cc.
+- Include &lt;memory&gt; header in TcpConnectionImpl.cc.
 
 ## [1.5.12] - 2023-08-20
 
@@ -54,7 +54,7 @@ All notable changes to this project will be documented in this file.
 
 - Fix override mark.
 
-- Add missing <cstdint> header with GCC 13.
+- Add missing &lt;cstdint&gt; header with GCC 13.
 
 - Fix AresResolver.
 

cmake/templates/TrantorConfig.cmake.in

@@ -20,6 +20,9 @@ if(@c-ares_FOUND@)
   find_dependency(c-ares)
 endif()
 find_dependency(Threads)
+if(@spdlog_FOUND@)
+  find_dependency(spdlog)
+endif()
 # Compute paths
 
 # Our library dependencies (contains definitions for IMPORTED targets)

conanfile.txt

@@ -2,6 +2,7 @@
 gtest/1.10.0
 openssl/1.1.1t
 #c-ares/1.17.1
+spdlog/1.12.0
 
 [generators]
 CMakeToolchain

trantor/net/TcpClient.h

@@ -209,6 +209,7 @@ class TRANTOR_EXPORT TcpClient : NonCopyable,
      * OpenSSL.
      * @param certPath The path of the certificate file.
      * @param keyPath The path of the private key file.
+     * @param caPath The path of the certificate authority file.
      * @note It's well known that TLS 1.0 and 1.1 are not considered secure in
      * 2020. And it's a good practice to only use TLS 1.2 and above.
      */

trantor/net/TcpConnection.h

@@ -125,7 +125,7 @@ class TRANTOR_EXPORT TcpConnection
      */
     virtual bool disconnected() const = 0;
 
-    /**
+    /* *
      * @brief Get the buffer in which the received data stored.
      *
      * @return MsgBuffer*

trantor/net/TcpServer.h

@@ -240,6 +240,7 @@ class TRANTOR_EXPORT TcpServer : NonCopyable
      * server.
      * @param sslConfCmds The commands used to call the SSL_CONF_cmd function in
      * OpenSSL.
+     * @param caPath The path of the certificate authority file.
      * @note It's well known that TLS 1.0 and 1.1 are not considered secure in
      * 2020. And it's a good practice to only use TLS 1.2 and above.
      */

trantor/tests/CMakeLists.txt

@@ -48,6 +48,11 @@ set(targets_list
     delayed_ssl_server_test
     delayed_ssl_client_test)
 
+if(HAVE_SPDLOG)
+  add_executable(spdlogger_test SpdLoggerTest.cc)
+  list(APPEND targets_list spdlogger_test)
+endif(HAVE_SPDLOG)
+
 set_property(TARGET ${targets_list} PROPERTY CXX_STANDARD 14)
 set_property(TARGET ${targets_list} PROPERTY CXX_STANDARD_REQUIRED ON)
 set_property(TARGET ${targets_list} PROPERTY CXX_EXTENSIONS OFF)