Merge pull request #27 from SimonCahill/feat/fix-multiple-reports

Bug fixes: Adds cache so reports aren't reported multiple times. Finally fixed #23

Author: SimonCahill

.dockerignore

@@ -0,0 +1,9 @@
+build
+.git
+.gitmodules
+submodules/fmt/.git
+submodules/date/.git
+*.tar.gz
+*.zip
+bin
+__pycache__

.github/workflows/coverage.yml

@@ -0,0 +1,32 @@
+name: Coverage CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y build-essential cmake lcov git
+
+      - name: Configure & Build
+        run: |
+          cmake -S . -B build -DENABLE_COVERAGE=ON -DCMAKE_BUILD_TYPE=Debug
+          cmake --build build -j
+
+      - name: Run tests and generate coverage
+        run: ./scripts/coverage.sh
+
+      - name: Upload coverage report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: build/coverage-report

CMakeLists.txt

@@ -1,16 +1,21 @@
 cmake_minimum_required(VERSION 3.10)
 
-project(endlessh-report VERSION 1.2.3 LANGUAGES CXX DESCRIPTION "A simple report generator for endlessh tarpits.")
+project(endlessh-report VERSION 1.3.0 LANGUAGES CXX DESCRIPTION "A simple report generator for endlessh tarpits.")
 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
     -Wall
+    -Wno-unused-function
 )
 
 include_directories(
@@ -26,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
 ###
@@ -42,21 +53,24 @@ 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_library(endlessh_core STATIC src/core.cpp)
 
-add_executable(
-    ${PROJECT_NAME}
-
-    ${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()
+
 ###
 # Docs target
 ###
@@ -92,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)"
+)

Dockerfile

@@ -0,0 +1,23 @@
+FROM ubuntu:22.04
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    cmake \
+    lcov \
+    git \
+    ca-certificates \
+    pkg-config \
+    wget \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /src
+
+# Copy project into image
+COPY . /src
+
+# Prepare build (do not run coverage at build time)
+RUN cmake -S . -B build -DENABLE_COVERAGE=ON -DCMAKE_BUILD_TYPE=Debug \
+    && cmake --build build -j
+
+ENTRYPOINT ["/src/scripts/coverage.sh"]

README.md

@@ -77,9 +77,13 @@ Switches:
     --detailed,     -d      Provide detailed information
     --help,         -h      Show this text and exit
     --version,      -v      Display version information and exit
+    --sort,         -x      Sort IP statistics
+    --dns-lookup,   -D      Perform DNS lookups on IP addresses
+    --strict,       -t      Skip IPs whose cached stats haven't changed
 
 Arguments:
     --syslog [f],   -S[f]   Override syslog/endlessh log location
+    --cache-file[f],-C[f]   Override persistent cache file location
 ```
 
 ## Output

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

include/options.hpp

@@ -30,7 +30,7 @@ using std::string_view;
  * 
  * @return constexpr string_view The arg string as required for @see getopt_long
  */
-constexpr string_view   getAppArgs() { return R"(icsandhvS:)"; }
+constexpr string_view   getAppArgs() { return R"(icsandhtvS:xDC:)"; }
 
 /**
  * @brief Gets the application's command-line options for @see getopt_long.
@@ -44,9 +44,14 @@ const option*           getAppOptions() {
         { "stdin",          no_argument,        nullptr,    's' },
         { "abuse-ipdb",     no_argument,        nullptr,    'a' },
         { "detailed",       no_argument,        nullptr,    'd' },
+        { "strict",         no_argument,        nullptr,    't' },
+        { "cache-file",     required_argument,  nullptr,    'C' },
         { "help",           no_argument,        nullptr,    'h' },
         { "syslog",         required_argument,  nullptr,    'S' },
         { "version",        no_argument,        nullptr,    'v' },
+        { "sort",           no_argument,        nullptr,    'x' },
+        { "no-ad",          no_argument,        nullptr,    'n' },
+        { "dns-lookup",     no_argument,        nullptr,    'D' },
         { nullptr,          no_argument,        nullptr,     0  }
     };
 
@@ -77,14 +82,18 @@ inline string           getAppHelpText(const string_view& binName = getProjectNa
     --abuse-ipdb,   -a      Enable AbuseIPDB-compatible CSV output
     --no-ad,        -n      No advertising please!
     --detailed,     -d      Provide detailed information
+    --strict,       -t      Skip IPs whose cached stats haven't changed
     --help,         -h      Show this text and exit
     --version,      -v      Display version information and exit
+    --sort,         -x      Sort IP statistics
+    --dns-lookup,   -D      Perform DNS lookups on IP addresses
 
 Arguments:
     --syslog [f],   -S[f]   Override syslog/endlessh log location
+    --cache-file[f],-C[f]   Override persistent cache file location
 )";
 
-    return fmt::format(HELP_TEXT_FMT, binName, getApplicationVersion(), getProjectDescription());
+    return fmt::format(fmt::runtime(HELP_TEXT_FMT), binName, getApplicationVersion(), getProjectDescription());
 }
 
 /**

include/public_api.hpp

@@ -0,0 +1,18 @@
+/**
+ * @file public_api.hpp
+ * @brief Public API wrappers for functions that are implemented in `main.cpp`.
+ */
+#ifndef ENDLESSH_REPORT_PUBLIC_API_HPP
+#define ENDLESSH_REPORT_PUBLIC_API_HPP
+
+#include <string>
+
+using std::string;
+
+// Expose utility functions for unit testing.
+string normalizeIp(string ip);
+string getHostFromIp(const string& ip);
+// Global configuration flags used by the application. Tests may rely on defaults.
+extern bool g_performDnsLookup;
+
+#endif // ENDLESSH_REPORT_PUBLIC_API_HPP