Custom valgrind runner to allow capturing logs

Author: Hendrik van Antwerpen

.github/workflows/ci.yml

@@ -47,20 +47,16 @@ jobs:
         run: ${{ env.CARGO_HACK }} test
       - name: Run test suite with all optimizations (default features)
         run: cargo test --release
-      - name: Install cargo-valgrind
+      - name: Install valgrind
         run: |
           sudo apt-get update
           sudo apt-get install -y valgrind
-          cargo install cargo-valgrind
       - name: Run test suite under valgrind (default features)
+        id: valgrind
         # We only need to use valgrind to test the crates that have C bindings.
-        run: cargo valgrind test -p stack-graphs
-        env:
-          # Since Rust 1.83, Valgrind reports some possible leaks that cargo-valgrind
-          # treats as fatal. The given suppressions file makes sure these are ignored.
-          VALGRINDFLAGS: --suppressions=valgrind.supp --gen-suppressions=all --log-file=${{ runner.temp }}/valgrind.log
+        run: script/ci-test-valgrind -p stack-graphs
       - name: Upload valgrind log
-        if: ${{ failure() }}
+        if: ${{ failure() && steps.valgrind.outcome == 'failure' }}
         uses: actions/upload-artifact@v4
         with:
           name: valgrind logs

script/ci-test-valgrind

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+set -eu
+
+# Start by building the test binary, before we try to get its filename
+cargo test "$@" --no-run
+
+# Cargo does not have a clean way to get the test binary, so we do some text processing here to get it
+test="$(cargo test "$@" --no-run 2>&1 | grep 'Executable' | head -1 | sed -e 's/[^(]*(\(.*\)).*$/\1/')"
+log="${RUNNER_TEMP-.}/valgrind.log"
+
+# Run the test binary under valgrind
+if ! valgrind \
+    --leak-check=full \
+    --show-leak-kinds=all \
+    --error-exitcode=1 \
+    --suppressions=valgrind.supp \
+    --gen-suppressions=all \
+    --log-file="$log" \
+    "$test"; then
+  echo "Valgrind detected errors! See logs: $log"
+  exit 1
+fi