fix(go-runner): use git-relative file paths

Author: not-matthias

go-runner/src/integration_tests.rs

@@ -60,6 +60,7 @@ fn assert_results_snapshots(profile_dir: &Path, project_name: &str) {
 // Currently not producing results:
 #[case::fuego("fuego")]
 #[case::cli_runtime("cli-runtime")]
+#[case::example("example")]
 fn test_build_and_run(#[case] project_name: &str) {
     let project_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
         .join("testdata/projects")

go-runner/src/lib.rs

@@ -27,7 +27,10 @@ pub fn run_benchmarks(project_dir: &Path, cli: &crate::cli::Cli) -> anyhow::Resu
     let mut bench_name_to_path = HashMap::new();
     for package in &packages {
         for benchmark in &package.benchmarks {
-            bench_name_to_path.insert(benchmark.name.clone(), benchmark.file_path.clone());
+            // Create absolute path and immediately convert to git-relative path
+            let abs_path = package.module.dir.join(&benchmark.file_path);
+            let git_relative_path = crate::utils::get_git_relative_path(&abs_path);
+            bench_name_to_path.insert(benchmark.name.clone(), git_relative_path);
         }
     }
 

go-runner/src/snapshots/go_runner__integration_tests__assert_results_snapshots@example_0.snap

@@ -0,0 +1,126 @@
+---
+source: go-runner/src/integration_tests.rs
+expression: content
+---
+{
+  "creator": {
+    "name": "codspeed-go",
+    "version": "0.1.0",
+    "pid": "[pid]"
+  },
+  "instrument": {
+    "type": "walltime"
+  },
+  "benchmarks": [
+    {
+      "name": "BenchmarkFibonacci10::fibonacci(10)::fibonacci(10)",
+      "uri": "example/fib_test.go::BenchmarkFibonacci10::fibonacci(10)::fibonacci(10)",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkFibonacci20_Loop",
+      "uri": "example/fib_test.go::BenchmarkFibonacci20_Loop",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkFibonacci20_bN",
+      "uri": "example/fib_test.go::BenchmarkFibonacci20_bN",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkSleep100ns",
+      "uri": "example/sleep_test.go::BenchmarkSleep100ns",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkSleep100us",
+      "uri": "example/sleep_test.go::BenchmarkSleep100us",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkSleep10ms",
+      "uri": "example/sleep_test.go::BenchmarkSleep10ms",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkSleep10us",
+      "uri": "example/sleep_test.go::BenchmarkSleep10us",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkSleep1ms",
+      "uri": "example/sleep_test.go::BenchmarkSleep1ms",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkSleep1us",
+      "uri": "example/sleep_test.go::BenchmarkSleep1us",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    },
+    {
+      "name": "BenchmarkSleep50ms",
+      "uri": "example/sleep_test.go::BenchmarkSleep50ms",
+      "config": {
+        "warmup_time_ns": null,
+        "min_round_time_ns": null,
+        "max_time_ns": null,
+        "max_rounds": null
+      },
+      "stats": "[stats]"
+    }
+  ]
+}

go-runner/src/utils.rs

@@ -1,4 +1,4 @@
-use std::path::Path;
+use std::path::{Path, PathBuf};
 use std::{fs, io};
 
 pub fn copy_dir_recursively(src: impl AsRef<Path>, dst: impl AsRef<Path>) -> io::Result<()> {
@@ -18,3 +18,36 @@ pub fn copy_dir_recursively(src: impl AsRef<Path>, dst: impl AsRef<Path>) -> io:
     }
     Ok(())
 }
+
+// WARN: Git-related helper functions have been taken from codspeed-rust. Keep in sync!
+
+fn get_parent_git_repo_path(abs_path: &Path) -> io::Result<PathBuf> {
+    if abs_path.join(".git").exists() {
+        Ok(abs_path.to_path_buf())
+    } else {
+        get_parent_git_repo_path(
+            abs_path
+                .parent()
+                .ok_or(io::Error::from(io::ErrorKind::NotFound))?,
+        )
+    }
+}
+
+pub fn get_git_relative_path<P>(abs_path: P) -> PathBuf
+where
+    P: AsRef<Path>,
+{
+    if let Ok(canonicalized_abs_path) = abs_path.as_ref().canonicalize() {
+        // `repo_path` is still canonicalized as it is a subpath of `canonicalized_abs_path`
+        if let Ok(repo_path) = get_parent_git_repo_path(&canonicalized_abs_path) {
+            canonicalized_abs_path
+                .strip_prefix(repo_path)
+                .expect("Repository path is malformed.")
+                .to_path_buf()
+        } else {
+            canonicalized_abs_path
+        }
+    } else {
+        abs_path.as_ref().to_path_buf()
+    }
+}

go-runner/testdata/projects/example

@@ -0,0 +1 @@
+../../../example