coverage WIP

Author: pfeatherstone

.github/workflows/coverage.yml

@@ -0,0 +1,51 @@
+name: Coverage
+on:
+  push:
+    branches:
+      - '**'
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  build-test:
+    runs-on: ubuntu-24.04
+    name: ubuntu-coverage
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y ninja-build cmake clang llvm
+
+      - name: Run CMake configuration and build
+        run: |
+          cmake examples -B build -G Ninja \
+            -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+            -DCMAKE_C_COMPILER=clang \
+            -DCMAKE_CXX_COMPILER=clang++ \
+            -DHTTP_BUILD_FUZZERS=ON
+          cmake --build build --target request_parser --parallel
+
+      - name: Extract corpus
+        run: |
+          
+      - name: Run fuzzers
+        run: |
+          ./build/RelWithDebInfo/request_parser /tmp/corpus/ examples/fuzz/seeds/request_parser/ -max_total_time=30
+
+      - name: Generate coverage report
+        run: |
+          llvm-profdata merge -sparse default.profraw -o default.profdata
+          llvm-cov show ./build/RelWithDebInfo/request_parser \
+            -instr-profile=default.profdata \
+            -format=html \
+            -output-dir=coverage-report
+    
+      - name: Upload coverage report as artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: coverage-report
+          path: coverage-report

.gitignore

@@ -1,2 +1,5 @@
 **/build
-**/.vscode
+**/.vscode
+**/default.profraw
+**/default.profdata
+**/fuzzer.profdata

examples/CMakeLists.txt

@@ -1,6 +1,9 @@
 cmake_minimum_required(VERSION 3.13)
 project(Http)
 
+# Helpers
+set(IS_CLANG "$<CXX_COMPILER_ID:Clang>")
+
 # Deps
 include(FetchContent)
 find_package(Threads REQUIRED)
@@ -17,11 +20,15 @@ FetchContent_Declare(
   URL_HASH MD5=3edffaacd2cfe63c240ef1b99497c74f)
 FetchContent_MakeAvailable(Boost)
 
+# Options
+option(HTTP_BUILD_FUZZERS "Builds Fuzz tests (requires clang)" OFF)
+
 # Lib
 add_library(http ${CMAKE_CURRENT_SOURCE_DIR}/../src/http.cpp)
 target_compile_features(http PUBLIC cxx_std_17)
 target_include_directories(http PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/../src)
 target_link_libraries(http PUBLIC OpenSSL::SSL OpenSSL::Crypto Boost::asio)
+target_compile_options(http PRIVATE $<$<AND:${IS_CLANG},$<BOOL:${HTTP_BUILD_FUZZERS}>>:-fprofile-instr-generate -fcoverage-mapping>)
 
 # Examples
 function(add_executable_20 target_name)
@@ -54,4 +61,16 @@ add_executable(tests
 target_compile_features(tests PUBLIC cxx_std_20)
 target_link_options(tests PRIVATE $<$<CONFIG:Release>:-s>)
 target_include_directories(tests PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/extra)
-target_link_libraries(tests PRIVATE http)
+target_link_libraries(tests PRIVATE http)
+
+# Fuzz tests
+if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND HTTP_BUILD_FUZZERS)
+  function(add_fuzz target_name)
+    add_executable(${target_name} ${ARGN})
+    target_link_libraries(${target_name} PRIVATE http)
+    target_compile_options(${target_name} PRIVATE -fprofile-instr-generate -fcoverage-mapping)
+    target_link_options(${target_name} PRIVATE -fsanitize=fuzzer -fprofile-instr-generate -fcoverage-mapping)
+  endfunction()
+
+  add_fuzz(request_parser fuzz/request_parser.cpp)
+endif()

examples/fuzz/request_parser.cpp

@@ -0,0 +1,13 @@
+#include <cstdint>
+#include <cstddef>
+#include <http.h>
+
+extern "C" int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size)
+{
+    std::string     buf(reinterpret_cast<const char*>(data), size);
+    http::request   req{};
+    std::error_code ec{};
+    http::parser<http::request> parser;
+    parser.parse(req, buf, ec);
+    return 0;
+}