Merge branch '135-logger_tests-fail' into develop

fixes #135

Author: HerbertKoelman

CMakeLists.txt

@@ -6,8 +6,8 @@ cmake_minimum_required(VERSION 3.11)
 
 project(
   cpp-logger
-  VERSION 2.2.6
-  DESCRIPTION "Simple C++ logger (${GIT_LOG})")
+  VERSION 2.2.7
+  DESCRIPTION "Simple C++ logger")
 
 option(GCOV "Activate GCOV options")
 
@@ -35,18 +35,21 @@ find_package(SonarCloud PATHS cmake)
 #
 if( CMAKE_BUILD_TYPE MATCHES Release )
   if( GIT_LOG )
-    add_definitions( -DCPP_LOGGER_VERSION="${PROJECT_VERSION} - ${GIT_LOG}")
+    set(CPP_LOGGER_VERSION "${PROJECT_VERSION} - ${GIT_LOG}")
   else()
-    add_definitions( -DCPP_LOGGER_VERSION="${PROJECT_VERSION}")
+    set(CPP_LOGGER_VERSION "${PROJECT_VERSION}")
   endif()
 else()
   if( GIT_LOG )
-    add_definitions( -DCPP_LOGGER_VERSION="${PROJECT_VERSION}-${GIT_LOG}-SNAPSHOT")
+    set(CPP_LOGGER_VERSION "${PROJECT_VERSION}-${GIT_LOG}-SNAPSHOT")
   else()
-    add_definitions( -DCPP_LOGGER_VERSION="${PROJECT_VERSION}-SNAPSHOT")
+    set(CPP_LOGGER_VERSION "${PROJECT_VERSION}-SNAPSHOT")
   endif()
 endif()
 
+message(STATUS "Building ${PROJECT_NAME} version ${CPP_LOGGER_VERSION}")
+add_definitions( -DCPP_LOGGER_VERSION="${CPP_LOGGER_VERSION}")
+
 # targets --------------------------------------------------
 #
 # project's public headers
@@ -92,9 +95,10 @@ endif()
 #
 find_package(Doxygen REQUIRED dot OPTIONAL_COMPONENTS mscgen dia)
 if (Doxygen_FOUND)
+  set(DOXYGEN_PROJECT_NUMBER ${CPP_LOGGER_VERSION})
   set(DOXYGEN_EXAMPLE_PATH tests)
   set(DOXYGEN_EXTRACT_ALL yes)
-  set(DOXYGEN_PROJECT_BRIEF ${PROJECT_DESCRUPTION})
+  set(DOXYGEN_PROJECT_BRIEF ${PROJECT_DESCRIPTION})
   set(DOXYGEN_USE_MDFILE_AS_MAINPAGE "${CMAKE_SOURCE_DIR}/README.md")
   doxygen_add_docs(doxygen README.md src include COMMENT "generate on-line documentation")
 endif()

README.md

@@ -1,6 +1,7 @@
 ## cpp-logger 
 
-[![Build Status](https://travis-ci.com/HerbertKoelman/cpp-logger.svg?branch=master)](https://travis-ci.com/HerbertKoelman/cpp-logger) [![codecov](https://codecov.io/gh/HerbertKoelman/cpp-logger/branch/master/graph/badge.svg)](https://codecov.io/gh/HerbertKoelman/cpp-logger) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=HerbertKoelman_cpp-logger&metric=alert_status)](https://sonarcloud.io/dashboard?id=HerbertKoelman_cpp-logger)
+[![Build Status](https://travis-ci.com/HerbertKoelman/cpp-logger.svg?branch=master)](https://travis-ci.com/HerbertKoelman/cpp-logger)  [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=HerbertKoelman_cpp-logger&metric=alert_status)](https://sonarcloud.io/dashboard?id=HerbertKoelman_cpp-logger)
+ [![codecov](https://codecov.io/gh/HerbertKoelman/cpp-logger/branch/master/graph/badge.svg)](https://codecov.io/gh/HerbertKoelman/cpp-logger)
 
 ### What it does
 

include/logger/definitions.hpp

@@ -34,8 +34,7 @@ namespace logger {
     constexpr short MAXECIDLEN   = 64;//!< execution ID maximum size/length
     constexpr char const *LOGGER_LOG_PATTERN = "<%d>1 %s %s %s.%d.%d - %-16s";
 
-    const long HOST_NAME_MAX = sysconf(_SC_HOST_NAME_MAX); //!< hostname max size/length
-    //if (host_name_max <= 0) host_name_max = _POSIX_HOST_NAME_MAX;
+    const     long HOST_NAME_MAX = sysconf(_SC_HOST_NAME_MAX); //!< hostname max size/length
 
     class logger;
 

include/logger/sinks.hpp

@@ -102,7 +102,7 @@ namespace logger {
          * @param pname program name
          * @param level initial log level (defaults to logger::log_level::info)
          */
-        explicit sink(const std::string &name = "default", const std::string &pname = "prog", log_level level = log_levels::info);
+        explicit sink(const std::string &name, const std::string &pname = "prog", log_level level = log_levels::info);
 
         /** @return display name for a given log level
          */
@@ -128,13 +128,13 @@ namespace logger {
 #endif
 
         // when _ecid is accessed, we need to do more than just set/get it's value. Therefore, we cannot use std::atomic
-        std::string   _ecid;   //!< execution control ID. Helps to track everything that was logged by one business operation
-
-        std::atomic<log_level>     _level;  //!< current logging level
+        std::string       _ecid;   //!< execution control ID. Helps to track everything that was logged by one business operation
 
         // these are read-only, we don't need to handle concurrency
-        std::string   _name;   //!< logging domain name (as for now, this is equal to the logger name)
-        std::string   _pname;  //!< program name
+        std::string       _name;   //!< logging domain name (as for now, this is equal to the logger name)
+        std::string       _pname;  //!< program name
+
+        std::atomic<log_level>     _level;  //!< current logging level
 
     }; // sink
 
@@ -195,7 +195,7 @@ namespace logger {
         pid_t             _pid;      //!< process ID
         std::string       _lag;      //!< date time lag (i.e. +02:00)
         std::string       _hostname; //!< hostname (this will be displayed by log messages)
-        std::string   _pattern; //!< message pattern (layout)
+        std::string       _pattern;  //!< message pattern (layout)
     };
 
     /** stdout sink.

sonar-project.properties.in

@@ -21,6 +21,7 @@ sonar.login=2b1f6109db48c393e3c42b58e47d60cb1c2e59b0
 
 # wrapper MUSt use this directory to produce it's data
 sonar.cfamily.build-wrapper-output=@CMAKE_CURRENT_BINARY_DIR@/bw-output
+# sonar.cfamily.gcov.reportsPath=@CMAKE_CURRENT_BINARY_DIR@
 
 #-----------------------------------------------------------------------------
 #
@@ -38,3 +39,4 @@ sonar.projectBaseDir=@CMAKE_SOURCE_DIR@
 
 # directories that contain code to analyze
 sonar.sources=src,include
+sonar.tests=tests

src/cpp-logger.cpp

@@ -15,11 +15,11 @@ namespace logger {
 
     const char *cpp_logger_version(){
 
-    #ifndef CPP_LOGGER_VERSION
-      return "missing CPP_LOGGER_VERSION define. Re-run configure" ;
-    #else
-      return CPP_LOGGER_VERSION ;
-    #endif
+#ifndef CPP_LOGGER_VERSION
+    return "missing CPP_LOGGER_VERSION define. Re-run configure" ;
+#else
+    return CPP_LOGGER_VERSION ;
+#endif
   }
 }
 #endif /* cpp_logger_hpp */

src/sink.cpp

@@ -13,7 +13,6 @@ namespace logger {
     // abstract sink class -------------------
     //
     sink::sink(const std::string &name, const std::string &pname, log_level level) :
-    // init class data
             _name(name),
             _pname(pname),
             _level(level){

src/syslog_sink.cpp

@@ -22,7 +22,7 @@ namespace logger {
     syslog_sink::syslog_sink(const std::string &name, const std::string &pname, log_level level, const syslog::facility &facility, int options):
             sink(name, pname, level) {
 
-        try {
+//        try {
 #ifdef DEBUG
             printf("DEBUG %s name: %s, pname: %s, level: %d, facility: %d, options: %d\n", __FUNCTION__,
                 name.c_str(),
@@ -49,9 +49,9 @@ namespace logger {
 
             openlog(program_name().c_str(), options, (int)facility.code());
 
-        } catch ( std::exception &err ){
-            throw logger_exception(err.what());
-        }
+ //       } catch ( std::exception &err ){
+ //           throw logger_exception(err.what());
+ //       }
     };
 
     syslog_sink::syslog_sink(const std::string &name, const std::string &pname, log_level level) :