fix(cargo-codspeed): throw an error when a bench process fails

Author: art049

crates/bencher_compat/src/compat.rs

@@ -64,7 +64,7 @@ macro_rules! benchmark_group {
         pub fn $group_name(bencher: &mut $crate::Bencher) {
             bencher.push_group(stringify!($group_name));
             $(
-                bencher.set_current_file(codspeed::abs_file!());
+                bencher.set_current_file($crate::abs_file!());
                 bencher.set_current_bench_path(stringify!($function));
                 $function(bencher);
             )+

crates/bencher_compat/src/lib.rs

@@ -6,6 +6,8 @@ mod compat_bencher {
 #[cfg(codspeed)]
 #[path = "."]
 mod compat_bencher {
+    pub use codspeed::abs_file;
+
     mod compat;
     pub use compat::*;
 }

crates/cargo-codspeed/src/run.rs

@@ -76,7 +76,17 @@ pub fn run_benches(
         std::process::Command::new(bench)
             .env("CODSPEED_CARGO_WORKSPACE_ROOT", workspace_root.as_ref())
             .status()
-            .map_err(|_| anyhow!("failed to execute the benchmark process"))?;
+            .map_err(|_| anyhow!("failed to execute the benchmark process"))
+            .and_then(|status| {
+                if status.success() {
+                    Ok(())
+                } else {
+                    Err(anyhow!(
+                        "failed to execute the benchmark process, exit code: {}",
+                        status.code().unwrap_or(1)
+                    ))
+                }
+            })?;
         ws.config().shell().status_with_color(
             "Done",
             format!("running {}", bench_name),

crates/codspeed/src/macros.rs

@@ -1,9 +1,12 @@
 #[macro_export]
 macro_rules! abs_file {
     () => {
-        std::path::PathBuf::from(std::env::var("CODSPEED_CARGO_WORKSPACE_ROOT").unwrap())
-            .join(file!())
-            .to_string_lossy()
+        std::path::PathBuf::from(
+            std::env::var("CODSPEED_CARGO_WORKSPACE_ROOT")
+            .expect("Could not find CODSPEED_CARGO_WORKSPACE_ROOT env variable, make sure you are using the latest version of cargo-codspeed")
+        )
+        .join(file!())
+        .to_string_lossy()
     };
 }
 

crates/codspeed/src/utils.rs

@@ -1,6 +1,5 @@
 use std::io;
 use std::path::{Path, PathBuf};
-use std::process::Command;
 
 fn get_parent_git_repo_path(abs_path: &Path) -> io::Result<PathBuf> {
     if abs_path.join(".git").exists() {
@@ -28,32 +27,6 @@ where
     }
 }
 
-/// Returns the path to the root of the cargo workspace.
-/// This is needed since file! returns the path relatively to the workspace root
-/// while CARGO_MANIFEST_DIR returns the path to the sub package
-pub fn get_cargo_workspace_root() -> PathBuf {
-    let output = Command::new("cargo")
-        .args([
-            "metadata",
-            "--format-version",
-            "1",
-            "--no-deps",
-            "--quiet",
-            "--offline",
-        ])
-        .current_dir(env!("CARGO_MANIFEST_DIR"))
-        .output()
-        .expect("Failed to execute `cargo metadata`");
-
-    let metadata: serde_json::Value =
-        serde_json::from_slice(&output.stdout).expect("Failed to parse `cargo metadata` output");
-
-    let workspace_root = metadata["workspace_root"]
-        .as_str()
-        .expect("`workspace_root` field is missing or not a string");
-    PathBuf::from(workspace_root)
-}
-
 /// Fixes spaces around `::` created by stringify!($function).
 pub fn get_formated_function_path(function_path: impl Into<String>) -> String {
     let function_path = function_path.into();

crates/criterion_compat/src/compat/macros.rs

@@ -4,7 +4,7 @@ macro_rules! criterion_group {
         pub fn $name(criterion: &mut $crate::Criterion) {
             let mut criterion = &mut criterion.with_patched_measurement($config);
             $(
-                criterion.set_current_file(codspeed::abs_file!());
+                criterion.set_current_file($crate::abs_file!());
                 criterion.set_macro_group(format!("{}::{}", stringify!($name), stringify!($target)));
                 $target(criterion);
             )+

crates/criterion_compat/src/lib.rs

@@ -8,6 +8,8 @@ mod compat_criterion {
 #[cfg(codspeed)]
 #[path = "."]
 mod compat_criterion {
+    pub use codspeed::abs_file;
+
     mod compat;
     pub use compat::*;