ci: run fuzzers (#138)

Author: dmehala

.circleci/config.yml

@@ -1,5 +1,16 @@
 version: 2.1
 
+main_branch_only: &main_branch_only
+  requires:
+    - build-bazel
+    - build-and-test-cmake
+    - build-and-test-windows-bazel
+    - build-and-test-windows-cmake
+  filters:
+    branches:
+      only:
+        - main
+
 orbs:
   codecov: codecov/[email protected]
 
@@ -13,6 +24,27 @@ executors:
       - image: "datadog/docker-library:dd-trace-cpp-ci"
     resource_class: arm.xlarge
 
+commands:
+  run_timeout:
+    description: "Run a command for a specified duration"
+    parameters:
+      command:
+        type: string
+      duration:
+        type: string
+      description:
+        type: string
+    steps:
+      - run:
+          name: << parameters.description >>
+          command: |
+            set +e
+            timeout << parameters.duration >> << parameters.command >>
+            # `124` is the exit code timeout returns when the duration is reached
+            if [[ $? -eq 124 ]]; then
+              exit 0
+            fi
+
 jobs:
   format:
     docker:
@@ -171,6 +203,25 @@ jobs:
       - store_artifacts:
           path: logs_cpp_parametric_dev.tar.gz
 
+  fuzz-testing:
+    docker:
+    - image: "datadog/docker-library:dd-trace-cpp-ci"
+    resource_class: xlarge
+    environment:
+      MAKE_JOB_COUNT: 8
+    steps:
+      - checkout
+      - run: bin/with-toolchain llvm cmake . -B .build -DCMAKE_BUILD_TYPE=Debug -DDD_TRACE_BUILD_FUZZERS=1 -DDD_TRACE_ENABLE_SANITIZE=1
+      - run: cmake --build .build -j ${MAKE_JOB_COUNT} --target dd_trace_cpp-fuzzers
+      - run_timeout: 
+          description: Run W3C propagation fuzzer
+          command: ./.build/fuzz/w3c-propagation/w3c-propagation-fuzz
+          duration: 5m
+      - run_timeout: 
+          description: Run Base64 fuzzer
+          command: timeout 5m ./.build/fuzz/base64/base64-fuzz
+          duration: 5m
+
 workflows:
   pull-request:
     jobs:
@@ -199,12 +250,6 @@ workflows:
         requires:
           - build-and-test-cmake
     - system-tests:
-        requires:
-          - build-bazel
-          - build-and-test-cmake
-          - build-and-test-windows-bazel
-          - build-and-test-windows-cmake
-        filters:
-          branches:
-            only:
-              - main
+        <<: *main_branch_only
+    - fuzz-testing:
+        <<: *main_branch_only

CMakeLists.txt

@@ -34,6 +34,7 @@ endif ()
 # Linking this library requires threads.
 find_package(Threads REQUIRED)
 include(cmake/deps/curl.cmake)
+include(cmake/utils.cmake)
 
 file(STRINGS ${CMAKE_CURRENT_SOURCE_DIR}/src/datadog/version.cpp DD_TRACE_VERSION_CPP_CONTENTS REGEX "#define DD_TRACE_VERSION( |_NUM )")
 string(REGEX MATCH "#define DD_TRACE_VERSION \"[^\"]*" DD_TRACE_VERSION ${DD_TRACE_VERSION_CPP_CONTENTS})

cmake/utils.cmake

@@ -0,0 +1,22 @@
+# Function for organizing targets into logical groups.
+#
+# Description:
+#   This function add the target to a group of targets. If the group does not exist yet, it will create
+#   a custom target. The group acts as a meta-target that does not build anything itself but depends on 
+#   other targets.
+#
+# Parameters:
+#   TARGET_TO_ADD (string): The name of the target to be added to the group.
+#   GROUP (string): The name of the group target to which the target will be added.
+#
+# Usage:
+#   ADD_TARGET_TO_GROUP(<TARGET_TO_ADD> <GROUP>)
+function (ADD_TARGET_TO_GROUP TARGET_TO_ADD GROUP)
+  if (NOT TARGET ${GROUP})
+    add_custom_target(${GROUP})
+  endif ()
+
+  message(STATUS "Adding target ${TARGET_TO_ADD} to ${GROUP} group")
+  add_dependencies(${GROUP} ${TARGET_TO_ADD})
+endfunction ()
+

fuzz/CMakeLists.txt

@@ -1,2 +1,3 @@
 add_subdirectory(base64)
 add_subdirectory(w3c-propagation)
+

fuzz/base64/CMakeLists.txt

@@ -2,3 +2,5 @@ add_executable(base64-fuzz main.cpp)
 
 add_dependencies(base64-fuzz dd_trace_cpp-static)
 target_link_libraries(base64-fuzz dd_trace_cpp-static)
+
+add_target_to_group(base64-fuzz dd_trace_cpp-fuzzers)

fuzz/w3c-propagation/CMakeLists.txt

@@ -2,3 +2,5 @@ add_executable(w3c-propagation-fuzz fuzz.cpp)
 
 add_dependencies(w3c-propagation-fuzz dd_trace_cpp-static)
 target_link_libraries(w3c-propagation-fuzz dd_trace_cpp-static)
+
+add_target_to_group(w3c-propagation-fuzz dd_trace_cpp-fuzzers)

fuzz/w3c-propagation/fuzz.cpp

@@ -20,7 +20,7 @@ namespace {
 dd::Tracer& tracer_singleton() {
   thread_local auto tracer = []() {
     dd::TracerConfig config;
-    config.defaults.service = "fuzzer";
+    config.service = "fuzzer";
     config.collector = std::make_shared<dd::NullCollector>();
 
     const auto finalized_config = dd::finalize_config(config);
@@ -70,8 +70,10 @@ extern "C" int LLVMFuzzerTestOneInput(const std::uint8_t* data, size_t size) {
   for (const char* begin_tracestate = begin_traceparent;
        begin_tracestate <= end; ++begin_tracestate) {
     MockDictReader reader;
-    reader.traceparent = dd::range(begin_traceparent, begin_tracestate);
-    reader.tracestate = dd::range(begin_tracestate, end);
+    reader.traceparent =
+        dd::StringView(begin_traceparent, begin_tracestate - begin_traceparent);
+    reader.tracestate =
+        dd::StringView(begin_tracestate, end - begin_tracestate);
 
     const auto span = tracer.extract_span(reader);
     if (!span) {