include coverage instrumentation

.github/workflows/test.yml

@@ -33,7 +33,7 @@ jobs:
       - name: install rust
         uses: dtolnay/rust-toolchain@master
         with:
-          components: rustfmt, clippy
+          components: rustfmt, clippy, llvm-tools-preview
           toolchain: ${{ matrix.rust }}
 
       - name: caching
@@ -52,11 +52,29 @@ jobs:
       - name: run checks & tests
         run: RUST_MATRIX=${{ matrix.rust }} cargo xtask run-checks ${{ matrix.test }}
 
+      - name: Install Grcov
+        run: cargo install grcov
+
+      - name: Run grcov
+        run: grcov . --binary-path target/debug/deps/ -s . -t cobertura --branch --ignore-not-existing --ignore 'target/**' --ignore '../**' --ignore '/*' -o coverage.xml
+
+      - name: Code Coverage Report
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: coverage.xml
+          badge: true
+          fail_below_min: false
+          format: markdown
+          hide_branch_rate: false
+          hide_complexity: false
+          indicators: true
+          output: both
+          thresholds: '60 80'
+
   check-typos:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
         uses: actions/checkout@v4
-
       - name: run spelling checks using typos
         run: cargo xtask run-checks typos

xtask/src/runchecks.rs

@@ -18,6 +18,7 @@
 //!     - `typos` to check typos in the source code
 //!     - `examples` to check the examples compile
 
+use std::collections::HashMap;
 use std::env;
 use std::process::{Child, Command, Stdio};
 use std::str;
@@ -62,6 +63,16 @@ fn rustup(target: &str) {
 
 // Define and run a cargo command
 fn run_cargo(command: &str, first_params: &[&str], second_params: &[&str], error: &str) {
+    run_cargo_with_envs(command, first_params, second_params, error, HashMap::new());
+}
+
+fn run_cargo_with_envs(
+    command: &str,
+    first_params: &[&str],
+    second_params: &[&str],
+    error: &str,
+    envs: HashMap<&str, &str>,
+) {
     // Print cargo command
     println!(
         "\ncargo {} {} {}\n",
@@ -75,6 +86,7 @@ fn run_cargo(command: &str, first_params: &[&str], second_params: &[&str], error
         .arg(command)
         .args(first_params)
         .args(second_params)
+        .envs(envs)
         .stdout(Stdio::inherit()) // Send stdout directly to terminal
         .stderr(Stdio::inherit()) // Send stderr directly to terminal
         .spawn()
@@ -106,14 +118,21 @@ fn cargo_install(params: &[&str]) {
     );
 }
 
-// Run cargo test command
-fn cargo_test(params: &[&str]) {
+// Run cargo test command with coverage instrumentation
+fn cargo_test_with_coverage(params: &[&str]) {
+    let envs = [
+        ("RUSTFLAGS", "-Cinstrument-coverage"),
+        ("CARGO_INCREMENTAL", "0"),
+        ("LLVM_PROFILE_FILE", "coverage-%p-%s.profraw"),
+    ];
+
     // Run cargo test
-    run_cargo(
+    run_cargo_with_envs(
         "test",
         params,
         &["--color=always", "--", "--color=always"],
         "Failed to run cargo test",
+        envs.iter().cloned().collect(),
     );
 }
 
@@ -161,7 +180,7 @@ fn build_and_test_no_std(crate_name: &str) {
     cargo_build(&["-p", crate_name, "--no-default-features"]);
 
     // Run cargo test --no-default-features
-    cargo_test(&["-p", crate_name, "--no-default-features"]);
+    cargo_test_with_coverage(&["-p", crate_name, "--no-default-features"]);
 
     // Run cargo build --no-default-features --target wasm32-unknown-unknowns
     cargo_build(&[
@@ -206,10 +225,10 @@ fn burn_core_std() {
     println!("\n\nRun checks for burn-core crate with tch and wgpu backend");
 
     // Run cargo test --features test-tch
-    cargo_test(&["-p", "burn-core", "--features", "test-tch"]);
+    cargo_test_with_coverage(&["-p", "burn-core", "--features", "test-tch"]);
 
     // Run cargo test --features test-wgpu
-    cargo_test(&["-p", "burn-core", "--features", "test-wgpu"]);
+    cargo_test_with_coverage(&["-p", "burn-core", "--features", "test-wgpu"]);
 }
 
 // Test burn-dataset features
@@ -220,7 +239,7 @@ fn burn_dataset_features_std() {
     cargo_build(&["-p", "burn-dataset", "--all-features"]);
 
     // Run cargo test --all-features
-    cargo_test(&["-p", "burn-dataset", "--all-features"]);
+    cargo_test_with_coverage(&["-p", "burn-dataset", "--all-features"]);
 
     // Run cargo doc --all-features
     cargo_doc(&["-p", "burn-dataset", "--all-features"]);
@@ -237,7 +256,7 @@ fn std_checks() {
     cargo_build(&["--workspace", "--exclude=xtask"]);
 
     // Test each workspace
-    cargo_test(&["--workspace"]);
+    cargo_test_with_coverage(&["--workspace"]);
 
     // Check format
     cargo_fmt();