feat: make codspeed target path different depending on measurement mode

Author: GuillaumeLagrange

crates/cargo-codspeed/src/build.rs

@@ -26,7 +26,7 @@ impl BuildOptions<'_> {
         &self,
         metadata: &Metadata,
         quiet: bool,
-        measurement_mode: MeasurementMode,
+        measurement_mode: &MeasurementMode,
     ) -> Result<Vec<BuiltBench>> {
         let workspace_packages = metadata.workspace_packages();
 
@@ -106,7 +106,7 @@ impl BuildOptions<'_> {
 
     /// Generates a subcommand to build the benchmarks by invoking cargo and forwarding the filters
     /// This command explicitly ignores the `self.benches`: all benches are built
-    fn build_command(&self, measurement_mode: MeasurementMode) -> Command {
+    fn build_command(&self, measurement_mode: &MeasurementMode) -> Command {
         let mut cargo = Command::new("cargo");
         cargo.args(["build", "--benches"]);
 
@@ -115,7 +115,7 @@ impl BuildOptions<'_> {
         rust_flags.push_str(" -C debuginfo=2");
 
         // Add the codspeed cfg flag if instrumentation mode is enabled
-        if measurement_mode == MeasurementMode::Instrumentation {
+        if *measurement_mode == MeasurementMode::Instrumentation {
             rust_flags.push_str(" --cfg codspeed");
         }
         cargo.env("RUSTFLAGS", rust_flags);
@@ -165,7 +165,7 @@ pub fn build_benches(
         features: &features,
         profile: &profile,
     }
-    .build(metadata, quiet, measurement_mode)?;
+    .build(metadata, quiet, &measurement_mode)?;
 
     if built_benches.is_empty() {
         bail!(
@@ -174,7 +174,7 @@ pub fn build_benches(
         );
     }
 
-    let codspeed_target_dir = get_codspeed_target_dir(metadata);
+    let codspeed_target_dir = get_codspeed_target_dir(metadata, &measurement_mode);
     let built_bench_count = built_benches.len();
 
     // Create and clear packages codspeed target directories

crates/cargo-codspeed/src/helpers.rs

@@ -1,9 +1,11 @@
-use crate::prelude::*;
+use crate::{measurement_mode::MeasurementMode, prelude::*};
 use cargo_metadata::Metadata;
 use std::path::{Path, PathBuf};
 
-pub fn get_codspeed_target_dir(metadata: &Metadata) -> PathBuf {
-    metadata.target_directory.join("codspeed").into()
+pub fn get_codspeed_target_dir(metadata: &Metadata, measurement_mode: &MeasurementMode) -> PathBuf {
+    let target_dir: PathBuf = metadata.target_directory.join("codspeed").into();
+
+    target_dir.join(measurement_mode)
 }
 
 pub fn clear_dir<P>(dir: P) -> Result<()>

crates/cargo-codspeed/src/measurement_mode.rs

@@ -1,6 +1,6 @@
 use clap::ValueEnum;
 use serde::Serialize;
-use std::env;
+use std::{env, path::Path};
 
 #[derive(Debug, Clone, ValueEnum, Serialize, PartialEq, Eq)]
 #[serde(rename_all = "lowercase")]
@@ -18,3 +18,12 @@ impl Default for MeasurementMode {
         }
     }
 }
+
+impl AsRef<Path> for MeasurementMode {
+    fn as_ref(&self) -> &Path {
+        match self {
+            MeasurementMode::Walltime => Path::new("walltime"),
+            MeasurementMode::Instrumentation => Path::new("instrumentation"),
+        }
+    }
+}

crates/cargo-codspeed/src/run.rs

@@ -99,7 +99,7 @@ pub fn run_benches(
     filters: Filters,
     measurement_mode: MeasurementMode,
 ) -> Result<()> {
-    let codspeed_target_dir = get_codspeed_target_dir(metadata);
+    let codspeed_target_dir = get_codspeed_target_dir(metadata, &measurement_mode);
     let workspace_root = metadata.workspace_root.as_std_path();
     if measurement_mode == MeasurementMode::Walltime {
         clear_raw_walltime_data(workspace_root)?;

crates/codspeed/src/walltime.rs

@@ -65,6 +65,8 @@ pub fn collect_raw_walltime_results(
     data.dump_to_results(&workspace_root, scope);
 }
 
+// FIXME: This assumes that the cargo target dir is `target`, and duplicates information with
+// `cargo-codspeed::helpers::get_codspeed_target_dir`
 pub fn get_raw_result_dir_from_workspace_root(workspace_root: &Path) -> PathBuf {
     workspace_root
         .join("target")