fix: benchmarks

* fix prg name and parameters
* added feature to enable some benches as they should not run during github checks

Author: Gunter Schmidt

src/uu/cmp/Cargo.toml

@@ -26,6 +26,11 @@ path = "src/cmp.rs"
 # TODO How to sync over all modules?
 # instead of limiting to KiB, MiB, etc, one can write kib, mib, Mb or whatever case.
 feat_allow_case_insensitive_number_units = []
+# default = ["feat_run_binary_bench" ]
+# The cmd benchmarks start the binaries and take a lot of runtime on the github checks.
+# Only run them locally.
+feat_run_binary_bench = []
+
 
 [dependencies]
 # const_format = { workspace = true }

src/uu/cmp/benches/cmp_bench.rs

@@ -24,7 +24,7 @@ use divan::Bencher;
 use tempfile::TempDir;
 use uu_cmp::parse_params;
 use uudiff::benchmark::{
-    binary,
+    bench_binary,
     prepare_bench::{generate_test_files_bytes, BenchContext},
     str_to_args,
 };
@@ -74,32 +74,34 @@ fn cmp_compare_files_different(bencher: Bencher, kb: u64) {
 }
 
 // bench original GNU cmp
+#[cfg(feature = "feat_run_binary_bench")]
 #[divan::bench(args = FILE_SIZES_IN_KILO_BYTES)]
 fn cmd_cmp_gnu_equal(bencher: Bencher, kb: u64) {
     let fp = get_context().get_files_equal_kb(kb).unwrap();
     let args_str = format!("{} {}", fp.from, fp.to);
     bencher
         // .with_inputs(|| prepare::cmp_params_identical_testfiles(lines))
         .with_inputs(|| args_str.clone())
-        .bench_refs(|cmd_args| binary::bench_binary("cmp", cmd_args));
+        .bench_refs(|cmd_args| bench_binary::bench_binary("cmp", cmd_args));
 }
 
 // bench the compiled release version
+#[cfg(feature = "feat_run_binary_bench")]
 #[divan::bench(args = FILE_SIZES_IN_KILO_BYTES)]
 fn cmd_cmp_release_equal(bencher: Bencher, kb: u64) {
     // search for src, then shorten path
     let dir = std::env::current_dir().unwrap();
     let path = dir.to_string_lossy();
     let path = path.trim_end_matches("src/uu/cmp");
-    let prg = path.to_string() + "target/release/diffutils";
+    let prg = path.to_string() + "target/release/cmp";
 
     let fp = get_context().get_files_equal_kb(kb).unwrap();
-    let args_str = format!("cmp {} {}", fp.from, fp.to);
+    let args_str = format!("{} {}", fp.from, fp.to);
 
     bencher
         // .with_inputs(|| prepare::cmp_params_identical_testfiles(lines))
         .with_inputs(|| args_str.clone())
-        .bench_refs(|cmd_args| binary::bench_binary(&prg, cmd_args));
+        .bench_refs(|cmd_args| bench_binary::bench_binary(&prg, cmd_args));
 }
 
 // Since each bench function is separate in Divan it is more difficult to dynamically create test data.

src/uu/diff/Cargo.toml

@@ -22,6 +22,12 @@ path = "src/main.rs"
 [lib]
 path = "src/diff.rs"
 
+[features]
+# default = ["feat_run_binary_bench" ]
+# The cmd benchmarks start the binaries and take a lot of runtime on the github checks.
+# Only run them locally.
+feat_run_binary_bench = []
+
 [dependencies]
 # const_format = { workspace = true }
 diff_crate = { workspace = true }

src/uu/diff/benches/diff_bench.rs

@@ -22,7 +22,7 @@ use divan::Bencher;
 use std::{path::Path, sync::OnceLock};
 use tempfile::TempDir;
 use uudiff::benchmark::{
-    binary,
+    bench_binary,
     prepare_bench::{generate_test_files_bytes, BenchContext},
     str_to_args,
 };
@@ -52,32 +52,34 @@ fn diff_compare_files_equal(bencher: Bencher, kb: u64) {
 }
 
 // bench original GNU diff
+#[cfg(feature = "feat_run_binary_bench")]
 #[divan::bench(args = FILE_SIZES_IN_KILO_BYTES)]
 fn cmd_diff_gnu_equal(bencher: Bencher, kb: u64) {
     let fp = get_context().get_files_equal_kb(kb).unwrap();
     let args_str = format!("{} {}", fp.from, fp.to);
     bencher
         // .with_inputs(|| prepare::cmp_params_identical_testfiles(lines))
         .with_inputs(|| args_str.clone())
-        .bench_refs(|cmd_args| binary::bench_binary("diff", cmd_args));
+        .bench_refs(|cmd_args| bench_binary::bench_binary("diff", cmd_args));
 }
 
 // bench the compiled release version
+#[cfg(feature = "feat_run_binary_bench")]
 #[divan::bench(args = FILE_SIZES_IN_KILO_BYTES)]
 fn cmd_diff_release_equal(bencher: Bencher, kb: u64) {
     // search for src, then shorten path
     let dir = std::env::current_dir().unwrap();
     let path = dir.to_string_lossy();
     let path = path.trim_end_matches("src/uu/diff");
-    let prg = path.to_string() + "target/release/diffutils";
+    let prg = path.to_string() + "target/release/diff";
 
     let fp = get_context().get_files_equal_kb(kb).unwrap();
-    let args_str = format!("diff {} {}", fp.from, fp.to);
+    let args_str = format!("{} {}", fp.from, fp.to);
 
     bencher
         // .with_inputs(|| prepare::cmp_params_identical_testfiles(lines))
         .with_inputs(|| args_str.clone())
-        .bench_refs(|cmd_args| binary::bench_binary(&prg, cmd_args));
+        .bench_refs(|cmd_args| bench_binary::bench_binary(&prg, cmd_args));
 }
 
 // Since each bench function is separate in Divan it is more difficult to dynamically create test data.

src/uudiff/src/lib/features/benchmark.rs

@@ -215,7 +215,7 @@ pub mod prepare_bench {
 }
 
 /// Benchmark tools which are designed to call the compiled executable.
-pub mod binary {
+pub mod bench_binary {
     use std::process::Command;
 
     use crate::benchmark::str_to_args;