chore(crashtracking): Add testing framework and add more tests to crashtracker (#1183)

* Add building of test library
* Add a test and fix the build id computation
* Factorize some code
* Forgot to add the C file
* Add license
* use cc instead of clang
* Add feature
* Fix cross tests

Author: gleocadie

.github/workflows/test.yml

@@ -51,16 +51,16 @@ jobs:
       - name: "[${{ steps.rust-version.outputs.version}}] cargo build --workspace --exclude builder --verbose"
         shell: bash
         run: cargo build --workspace --exclude builder --verbose
-      - name: "[${{ steps.rust-version.outputs.version}}] cargo nextest run --workspace --exclude builder --profile ci --verbose -E '!test(tracing_integration_tests::)'"
+      - name: "[${{ steps.rust-version.outputs.version}}] cargo nextest run --workspace --features datadog-crashtracker/generate-unit-test-files --exclude builder --profile ci --verbose -E '!test(tracing_integration_tests::)'"
         shell: bash
         # Run doc tests with cargo test and run tests with nextest and generate junit.xml
-        run: cargo test --workspace --exclude builder --doc --verbose && cargo nextest run --workspace --exclude builder --profile ci --verbose -E '!test(tracing_integration_tests::)'
+        run: cargo test --workspace --features datadog-crashtracker/generate-unit-test-files --exclude builder --doc --verbose && cargo nextest run --workspace --features datadog-crashtracker/generate-unit-test-files --exclude builder --profile ci --verbose -E '!test(tracing_integration_tests::)'
         env:
           RUST_BACKTRACE: full
-      - name: "[${{ steps.rust-version.outputs.version}}] Tracing integration tests: cargo nextest run --workspace --exclude builder --profile ci --test-threads=1 --verbose -E 'test(tracing_integration_tests::)'"
+      - name: "[${{ steps.rust-version.outputs.version}}] Tracing integration tests: cargo nextest run --workspace --features datadog-crashtracker/generate-unit-test-files --exclude builder --profile ci --test-threads=1 --verbose -E 'test(tracing_integration_tests::)'"
         if: runner.os == 'Linux'
         shell: bash
-        run: cargo nextest run --workspace --exclude builder --profile ci --test-threads=1 --verbose -E 'test(tracing_integration_tests::)'
+        run: cargo nextest run --workspace --features datadog-crashtracker/generate-unit-test-files --exclude builder --profile ci --test-threads=1 --verbose -E 'test(tracing_integration_tests::)'
         env:
           RUST_BACKTRACE: full
       - name: "[${{ steps.rust-version.outputs.version}}] RUSTFLAGS=\"-C prefer-dynamic\" cargo nextest run --package test_spawn_from_lib --features prefer-dynamic -E '!test(tracing_integration_tests::)'"
@@ -225,8 +225,8 @@ jobs:
           rust_version: cross-centos7
       - run: cargo install cross || true
       - run: cross build --workspace --target x86_64-unknown-linux-gnu --exclude builder
-      - run: cross test --workspace --target x86_64-unknown-linux-gnu --exclude builder  -- --skip "::single_threaded_tests::" --skip "tracing_integration_tests::"
-      - run: cross test --workspace --target x86_64-unknown-linux-gnu --exclude builder --exclude bin_tests -- --skip "::tests::" --skip "::api_tests::" --test-threads 1 --skip "tracing_integration_tests::"
+      - run: cross test --workspace --features datadog-crashtracker/generate-unit-test-files --target x86_64-unknown-linux-gnu --exclude builder  -- --skip "::single_threaded_tests::" --skip "tracing_integration_tests::"
+      - run: cross test --workspace --features datadog-crashtracker/generate-unit-test-files --target x86_64-unknown-linux-gnu --exclude builder --exclude bin_tests -- --skip "::tests::" --skip "::api_tests::" --test-threads 1 --skip "tracing_integration_tests::"
 
   ffi_bake:
     strategy:

Cargo.lock

@@ -1,4 +1,4 @@
-root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, cc_utils, datadog-library-config, datadog-library-config-ffi, datadog-live-debugger, datadog-live-debugger-ffi, datadog-profiling, datadog-profiling-protobuf, datadog-profiling-ffi, data-pipeline-ffi, data-pipeline, datadog-trace-protobuf, datadog-trace-utils, datadog-trace-normalization, dogstatsd-client, datadog-log-ffi, datadog-log, ddsketch-ffi, ddtelemetry-ffi, symbolizer-ffi, datadog-profiling-replayer, datadog-remote-config, datadog-sidecar, datadog-sidecar-macros, datadog-sidecar-ffi, datadog-trace-obfuscation, datadog-tracer-flare, sidecar_mockgen, test_spawn_from_lib
+root_name: builder, build_common, tools, datadog-alloc, datadog-crashtracker, ddcommon, ddtelemetry, datadog-ddsketch, cc_utils, datadog-crashtracker-ffi, ddcommon-ffi, datadog-ipc, datadog-ipc-macros, tarpc, tarpc-plugins, tinybytes, spawn_worker, datadog-library-config, datadog-library-config-ffi, datadog-live-debugger, datadog-live-debugger-ffi, datadog-profiling, datadog-profiling-protobuf, datadog-profiling-ffi, data-pipeline-ffi, data-pipeline, datadog-trace-protobuf, datadog-trace-utils, datadog-trace-normalization, dogstatsd-client, datadog-log-ffi, datadog-log, ddsketch-ffi, ddtelemetry-ffi, symbolizer-ffi, datadog-profiling-replayer, datadog-remote-config, datadog-sidecar, datadog-sidecar-macros, datadog-sidecar-ffi, datadog-trace-obfuscation, datadog-tracer-flare, sidecar_mockgen, test_spawn_from_lib
 third_party_libraries:
 - package_name: addr2line
   package_version: 0.24.2

LICENSE-3rdparty.yml

@@ -24,6 +24,7 @@ collector = []
 receiver = []
 # Enables the collection of crash-info on Windows
 collector_windows = []
+generate-unit-test-files = []
 
 [target.'cfg(unix)'.dependencies]
 # Should be kept in sync with the libdatadog symbolizer crate (also using blasesym)
@@ -63,3 +64,4 @@ tempfile = { version = "3.3" }
 [build-dependencies]
 # If we use a newer version of cc, CI fails on alpine.
 cc = "1.1.31"
+cc_utils = {path = "../tools/cc_utils"}

datadog-crashtracker/Cargo.toml

@@ -1,11 +1,113 @@
 // Copyright 2025-Present Datadog, Inc. https://www.datadoghq.com/
 // SPDX-License-Identifier: Apache-2.0
+#[cfg(unix)]
+mod unix_imports {
+    pub use std::path::Path;
+    pub use std::path::PathBuf;
+    pub use std::process::Command;
+}
+
+#[cfg(unix)]
+use unix_imports::*;
+
+pub use cc_utils::cc;
+
+#[cfg(unix)]
+fn build_shared_libs() {
+    build_c_file();
+    build_cpp_file();
+}
+
+#[cfg(unix)]
+fn get_data_folder_path() -> PathBuf {
+    Path::new(&env!("CARGO_MANIFEST_DIR"))
+        .join("data")
+        .canonicalize()
+        .expect("Failed to canonicalize base path for libtest")
+}
+
+#[cfg(unix)]
+fn build_c_file() {
+    let base_path = get_data_folder_path();
+
+    let src = base_path.join("libtest.c");
+    let dst = base_path.join("libtest.so");
+    let dst_file = dst
+        .to_str()
+        .expect("Failed to convert dst file path to str");
+
+    println!("cargo:rerun-if-changed={}", &dst_file);
+    cc_utils::ImprovedBuild::new()
+        .file(&src)
+        .link_dynamically("dl")
+        // this is needed for the cross compile (cargo cross)
+        .flag("-std=c99")
+        // Fix build id to ease in testing.
+        .flag("-Wl,--build-id=0xaaaabbbbccccddddeeeeffff0011223344556677")
+        .flag("-O0")
+        .flag("-gdwarf-4")
+        .flag("-Wl,--compress-debug-sections=zlib")
+        .warnings(true)
+        .warnings_into_errors(true)
+        .emit_rerun_if_env_changed(true)
+        .try_compile_shared_lib(dst_file)
+        .unwrap();
+
+    // We use objcopy to change the alignment of the debug_abbrev ELF section.
+    // By setting the alignment to 1 we make sure that the section is misaligned.
+    // This will help to identify regressions in blazesym.
+    // Note: we could have picked any other debug_xx sections. As long as it's a
+    // debug ELF sections.
+    let mut modify_alignment = Command::new("objcopy")
+        .args(["--set-section-alignment", ".debug_abbrev=1"])
+        .arg(dst_file)
+        .arg(dst_file)
+        .spawn()
+        .expect("failed to spawn objcopy");
+
+    modify_alignment
+        .wait()
+        .expect("Failed to change alignement of debug_abbrev ELF section");
+}
+
+#[cfg(unix)]
+fn build_cpp_file() {
+    let base_path = get_data_folder_path();
+
+    let src = base_path.join("libtest_cpp.cpp");
+    let dst = base_path.join("libtest_cpp.so");
+    let dst_file = dst
+        .to_str()
+        .expect("Failed to convert dst file path to str");
+
+    println!("cargo:rerun-if-changed={}", &dst_file);
+    cc_utils::ImprovedBuild::new()
+        .cpp(true)
+        .file(&src)
+        .link_dynamically("dl")
+        .flag("-std=c++11")
+        // Fix build id to ease in testing.
+        .flag("-Wl,--build-id=0x0011223344556677aaaabbbbccccddddeeeeffff")
+        .flag("-O0")
+        .flag("-gdwarf-4")
+        .warnings(true)
+        .warnings_into_errors(true)
+        .emit_rerun_if_env_changed(true)
+        .try_compile_shared_lib(dst_file)
+        .unwrap();
+}
 
 #[cfg(unix)]
 fn main() {
     cc::Build::new()
         .file("src/crash_info/emit_sicodes.c")
         .compile("emit_sicodes");
+    if cfg!(all(
+        feature = "generate-unit-test-files",
+        not(target_os = "macos")
+    )) {
+        build_shared_libs();
+    }
 }
 
 #[cfg(not(unix))]

datadog-crashtracker/build.rs

@@ -0,0 +1,66 @@
+// Copyright 2025-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+
+#include <stdio.h>
+
+int my_function(void) {
+    return 42;
+}
+
+// The following code helps in generating a case where blazesym failed at
+// opening the file and we were failing at normalizing/symbolizing the
+// address.
+// The goal is to increase the size of the debug_XX sections and make sure
+// that at least one of them will be compressed (and not aligned)
+#define MAKE_FUNC(N) \
+    void func##N(void) { \
+        int arr[100]; \
+        for (int i = 0; i < 100; i++) { \
+            arr[i] = i * N; \
+        } \
+        printf("Function %d called, value = %d\n", N, arr[99]); \
+    }
+
+#define MAKE_STRUCT(N) \
+    struct Struct##N { \
+        int a[50]; \
+        double b[50]; \
+        char c[100]; \
+    };
+
+MAKE_STRUCT(1)
+MAKE_STRUCT(2)
+MAKE_STRUCT(3)
+MAKE_STRUCT(4)
+MAKE_STRUCT(5)
+MAKE_STRUCT(6)
+MAKE_STRUCT(7)
+MAKE_STRUCT(8)
+MAKE_STRUCT(9)
+MAKE_STRUCT(10)
+
+MAKE_FUNC(1)
+MAKE_FUNC(2)
+MAKE_FUNC(3)
+MAKE_FUNC(4)
+MAKE_FUNC(5)
+MAKE_FUNC(6)
+MAKE_FUNC(7)
+MAKE_FUNC(8)
+MAKE_FUNC(9)
+MAKE_FUNC(10)
+
+int main(void) {
+    printf("Starting main\n");
+    func1();
+    func2();
+    func3();
+    func4();
+    func5();
+    func6();
+    func7();
+    func8();
+    func9();
+    func10();
+    return 0;
+}

datadog-crashtracker/data/libtest.c

@@ -0,0 +1,71 @@
+// Copyright 2025-Present Datadog, Inc. https://www.datadoghq.com/
+// SPDX-License-Identifier: Apache-2.0
+
+#include <iostream>
+#include <string>
+
+int cpp_function() {
+    std::cout << "Hello world" << std::endl;
+    return 0;
+}
+
+// For normalization/symbolization tests
+// do not use template class, depending on the compiler the mangled names
+// won't be the same and the test will fail
+namespace MyNamespace {
+    class ClassInNamespace {
+    public:
+        void MethodInNamespace1(float, long long);
+        static void MethodInNamespace2(double, char);
+
+        class InnerClassInNamespace {
+        public:
+            void InnerMethod1();
+            static void InnerMethod2(int, int, long long);
+        };
+    };
+
+    void ClassInNamespace::MethodInNamespace1(float, long long) {
+        std::cout << "ClassInNamespace::MethodInNamespace1 called" << std::endl;
+    }
+
+    void ClassInNamespace::MethodInNamespace2(double, char) {
+        std::cout << "ClassInNamespace::MethodInNamespace2 called" << std::endl;
+    }
+
+    void ClassInNamespace::InnerClassInNamespace::InnerMethod1() {
+        std::cout << "ClassInNamespace::InnerClassInNamespace::InnerMethod1 called" << std::endl;
+    }
+
+    void ClassInNamespace::InnerClassInNamespace::InnerMethod2(int, int, long long) {
+        std::cout << "ClassInNamespace::InnerClassInNamespace::InnerMethod2 called" << std::endl;
+    }
+}
+
+class FirstClass {
+public:
+    void Method1();
+    static void Method2(int, bool, std::string);
+
+    class InnerClass {
+    public:
+        void InnerMethod1();
+        static void InnerMethod2();
+    };
+};
+
+void FirstClass::Method1() {
+    std::cout << "FirstClass::Method1 called" << std::endl;
+}
+
+void FirstClass::Method2(int, bool, std::string) {
+    std::cout << "FirstClass::Method2 called" << std::endl;
+}
+
+void FirstClass::InnerClass::InnerMethod1() {
+    std::cout << "FirstClass::InnerClass" << std::endl;
+}
+
+void FirstClass::InnerClass::InnerMethod2() {
+    std::cout << "FirstClass::InnerClass::InnerMethod2 called" << std::endl;
+}