Modularised code; added tests and coverage

Author: SimonCahill

CMakeLists.txt

@@ -5,14 +5,17 @@ set(PROJECT_LONG_NAME "Endlessh Report Generator")
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
 
+option(ENABLE_COVERAGE "Enable compilation flags for gcov coverage" ON)
+
 include(CTest)
 
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/include/version.hpp.in ${CMAKE_CURRENT_BINARY_DIR}/include/version.hpp)
 
 add_compile_options(
     -Wpedantic
-#    -Werror
+    -Werror
     -Wall
+    -Wno-unused-function
 )
 
 include_directories(
@@ -28,10 +31,16 @@ if (DEFINED endlesshreport_DEBUG OR CMAKE_BUILD_TYPE STREQUAL "Debug")
 else()
     add_compile_options(
         -O2
-        -s
     )
 endif()
 
+if (ENABLE_COVERAGE)
+    message(STATUS "Building with coverage support (--coverage)")
+    add_compile_options(--coverage -O0 -g)
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} --coverage")
+    set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} --coverage")
+endif()
+
 ###
 # Make sure submodules are updated
 ###
@@ -44,21 +53,20 @@ execute_process(
 add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/submodules/date)
 add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/submodules/fmt)
 
-file(GLOB_RECURSE FILES FOLLOW_SYMLINKS ${CMAKE_CURRENT_SOURCE_DIR} src/*.cpp)
-
-add_executable(
-    ${PROJECT_NAME}
+add_library(endlessh_core STATIC src/core.cpp)
 
-    ${FILES}
-)
+add_executable(${PROJECT_NAME} src/main.cpp)
 
 target_link_libraries(
     ${PROJECT_NAME}
-
-    date
-    fmt
+    PRIVATE
+        endlessh_core
+        date
+        fmt
 )
 
+target_link_libraries(endlessh_core PRIVATE fmt date)
+
 if (BUILD_TESTING)
     add_subdirectory(tests)
 endif()
@@ -98,3 +106,10 @@ set(CPACK_PACKAGE_CONTACT "Simon Cahill <simon@simonc.eu>")
 set(CPACK_PACKAGE_VENDOR "Simon Cahill")
 set(CPACK_GENERATOR DEB)
 include(CPack)
+
+# Coverage target that runs the coverage helper script
+add_custom_target(coverage
+    COMMAND ${CMAKE_SOURCE_DIR}/scripts/coverage.sh
+    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+    COMMENT "Run tests and generate coverage report (requires lcov/genhtml)"
+)

include/extensions.hpp

@@ -31,6 +31,7 @@ using std::chrono::seconds;
 using std::chrono::system_clock;
 using std::function;
 using std::string;
+using std::string_view;
 using std::vector;
 
 /**
@@ -179,12 +180,8 @@ inline string getSpacerString(const uint32_t totalWidth, const uint32_t strLengt
  *
  * @return The trimmed string.
  */
-inline string trimStart(string nonTrimmed, const string& trimChar) {
-    //nonTrimmed.erase(nonTrimmed.begin(), find_if(nonTrimmed.begin(), nonTrimmed.end(), not1(ptr_fun<int32_t, int32_t>(isspace))));
-
-    function<bool(char)> shouldTrimChar = [=](char c) -> bool { return trimChar.size() == 0 ? isspace(c) : trimChar.find(c) != string::npos; };
-
-    nonTrimmed.erase(nonTrimmed.begin(), find_if(nonTrimmed.begin(), nonTrimmed.end(), not1(shouldTrimChar)));
+inline string& trimStart(string& nonTrimmed, const string_view trimChars) {
+    nonTrimmed.erase(nonTrimmed.begin(), std::find_if(nonTrimmed.begin(), nonTrimmed.end(), [&trimChars](int ch) { return trimChars.find(static_cast<char>(ch)) == string_view::npos; }));
 
     return nonTrimmed;
 }
@@ -196,11 +193,8 @@ inline string trimStart(string nonTrimmed, const string& trimChar) {
  *
  * @return The trimmed string.
  */
-inline string trimEnd(string nonTrimmed, const string& trimChar) {
-    // nonTrimmed.erase(find_if(nonTrimmed.rbegin(), nonTrimmed.rend(), not1(ptr_fun<int32_t, int32_t>(isspace))).base(), nonTrimmed.end());
-
-    function<bool(char)> shouldTrimChar = [=](char c) -> bool { return trimChar.size() == 0 ? isspace(c) : trimChar.find(c) != string::npos; };
-    nonTrimmed.erase(find_if(nonTrimmed.rbegin(), nonTrimmed.rend(), not1(shouldTrimChar)).base(), nonTrimmed.end());
+inline string& trimEnd(string& nonTrimmed, const string_view trimChars) {
+    nonTrimmed.erase(std::find_if(nonTrimmed.rbegin(), nonTrimmed.rend(), [&trimChars](int ch) { return trimChars.find(static_cast<char>(ch)) == string_view::npos; }).base(), nonTrimmed.end());
 
     return nonTrimmed;
 }
@@ -213,7 +207,7 @@ inline string trimEnd(string nonTrimmed, const string& trimChar) {
  *
  * @return The trimmed string.
  */
-inline string trim(const string& nonTrimmed, const string& trimChar) { return trimStart(trimEnd(nonTrimmed, trimChar), trimChar); }
+inline string& trim(string& nonTrimmed, const string_view trimChars) { return trimStart(trimEnd(nonTrimmed, trimChars), trimChars); }
 
 
 #endif // ENDLESSH_REPORT_INCLUDE_EXTENSIONS_HPP

src/main.cpp

@@ -33,6 +33,12 @@
 #include <regex.h>
 
 #include <fmt/format.h>
+#include <arpa/inet.h>
+#include <netdb.h>
+#include <netinet/in.h>
+#include <sys/socket.h>
+#include <cstring>
+#include "public_api.hpp"
 
 using fmt::format;
 
@@ -51,7 +57,7 @@ using std::vector;
 
 static bool    g_error{false}; //!< Whether or not a fatal error occurred
 static bool    g_disableAdvertisement{false}; //!< Whether or not to disable advertisement (default: false)
-static bool    g_performDnsLookup{false}; //!< Whether or not to perform DNS lookups (default: false)
+// g_performDnsLookup is defined in the `endlessh_core` library (src/core.cpp)
 static bool    g_printAbuseIpDbCsv{false}; //!< Whether or not to output AbuseIPDB-compatible CSV data (default: false; disables markdown-compatible stats)
 static bool    g_printIpStatistics{true}; //!< Whether or not to print IP stats (default: true)
 static bool    g_printConnectionStatistics{true}; //!< Whether or not to print connection stats (default: true)
@@ -64,13 +70,8 @@ static string  g_cacheFile{ReportCache::defaultCachePath()}; //!< Cache file loc
 static bool    g_cacheDirty{false}; //!< Whether or not the cache needs to be written
 static std::unique_ptr<ReportCache> g_reportCache{}; //!< Loaded cache (only when required)
 
-static string normalizeIp(string ip) {
-    const auto offset = ip.find("::ffff:");
-    if (offset != string::npos) {
-        ip = ip.substr(offset + 7);
-    }
-    return ip;
-}
+// normalizeIp implemented in src/core.cpp
+
 
 /**
  * @brief Contains information about a given connection.
@@ -94,7 +95,7 @@ struct ConnectionDetails {
 
 static int32_t                                 parseArgs(const int32_t&, char**); //!< Parses command-line arguments
 static map<string, pair<uint32_t, uint32_t>>   getConnections(const vector<string>&); //!< Gets the logged connections
-static string                                  getHostFromIp(const string&); //!< Gets the host from an IP address
+// getHostFromIp is declared in include/public_api.hpp
 static vector<ConnectionDetails>               getDetailledConnections(const vector<string>&); //!< Gets a detailled list of logged connections
 static vector<string>                          readEndlesshLog(); //!< Reads the log file into memory
 static void                                    printConnectionStatistics(const uint32_t uniqueIps, const uint32_t totalAccepted, const uint32_t totalClosed, const double totalTimeWasted, const uint32_t totalBytesSent); //!< Print connection statistics
@@ -381,16 +382,7 @@ map<string, pair<uint32_t, uint32_t>> getConnections(const vector<string>& logCo
     return connections;
 }
 
-string getHostFromIp(const string& ip) {
-    string host;
-    if (g_performDnsLookup) {
-        
-    } else {
-        host = ip;
-    }
-
-    return host;
-}
+// getHostFromIp implemented in src/core.cpp
 
 /**
  * @brief Gets a list with detailled information about all the incoming connections to the server.

tests/CMakeLists.txt

@@ -35,6 +35,7 @@ add_executable(
     endlessh-report-tests
     report_cache_test.cpp
     end_to_end_cache_test.cpp
+    main_extensions_test.cpp
 )
 
 target_link_libraries(
@@ -43,13 +44,15 @@ target_link_libraries(
         ${GTEST_MAIN_TARGET}
         ${GMOCK_TARGET}
         fmt
+    endlessh_core
 )
 
 target_include_directories(
     endlessh-report-tests
     PRIVATE
         ${PROJECT_SOURCE_DIR}/include
         ${PROJECT_BINARY_DIR}/include
+    ${PROJECT_SOURCE_DIR}/submodules/date/include
 )
 
 # Allow end-to-end tests to locate the built binary deterministically.