ci: run tests with sanitizers on Linux and MacOS

mozilla · Oct 2, 2024 · f542f56 · f542f56
1 parent eb92e43
commit f542f56
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 2 deletions.
diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml
@@ -45,7 +45,7 @@ jobs:
       - uses: ./.github/actions/rust
         with:
           version: ${{ matrix.rust-toolchain }}
-          components: ${{ matrix.rust-toolchain == 'stable' && 'llvm-tools-preview' || '' }}
+          components: ${{ matrix.rust-toolchain == 'stable' && 'llvm-tools-preview,' || '' }} ${{ matrix.rust-toolchain == 'nightly' && 'rust-src,' || '' }}
           tools: ${{ matrix.rust-toolchain == 'stable' && 'cargo-llvm-cov, ' || '' }} cargo-nextest
           token: ${{ secrets.GITHUB_TOKEN }}
 
@@ -97,6 +97,24 @@ jobs:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
         if: matrix.type == 'debug' && matrix.rust-toolchain == 'stable'
 
+      - name: Run tests with sanitizers
+        if: (matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest') && matrix.rust-toolchain == 'nightly'
+        env:
+          RUST_LOG: trace
+        run: |
+          if [ "${{ matrix.os }}" = "ubuntu-latest" ]; then
+            TARGET="x86_64-unknown-linux-gnu"
+            SANITIZERS="address thread leak"
+          elif [ "${{ matrix.os }}" = "macos-latest" ]; then
+            TARGET="aarch64-apple-darwin"
+            # no leak sanitizer support yet
+            SANITIZERS="address thread"
+          fi
+          for sanitizer in $SANITIZERS; do
+            echo "Running tests with $sanitizer sanitizer..."
+            RUSTFLAGS="-Z sanitizer=$sanitizer" RUSTDOCFLAGS="-Z sanitizer=$sanitizer" cargo +nightly nextest run -Z build-std --features ci --target "$TARGET"
+          done
+
   bench:
     needs: [check]
     uses: ./.github/workflows/bench.yml
diff --git a/neqo-common/build.rs b/neqo-common/build.rs
@@ -11,4 +11,12 @@ fn main() {
     if target.contains("windows") {
         println!("cargo:rustc-link-lib=winmm");
     }
+
+    // `cfg(sanitize = "..")` is not stabilized.
+    //
+    // See <https://doc.rust-lang.org/stable/unstable-book/language-features/cfg-sanitize.html>.
+    println!("cargo:rustc-check-cfg=cfg(neqo_sanitize)");
+    if env::var("CARGO_CFG_SANITIZE").is_ok() {
+        println!("cargo:rustc-cfg=neqo_sanitize");
+    }
 }
diff --git a/neqo-common/src/hrtime.rs b/neqo-common/src/hrtime.rs
@@ -374,7 +374,9 @@ impl Drop for Time {
 // inaccuracies are too high to pass the tests.
 #[cfg(all(
     test,
-    not(all(any(target_os = "macos", target_os = "windows"), feature = "ci"))
+    not(all(any(target_os = "macos", target_os = "windows"), feature = "ci")),
+    // Sanitizers are too slow to uphold timing assumptions.
+    not(neqo_sanitize),
 ))]
 mod test {
     use std::{