Skip to content

Collapse redundant run-arg id lists in benchmark_runner cli #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alamb wants to merge 1 commit into
base: benchmark-runner-info-query
Choose a base branch
from
Open

Collapse redundant run-arg id lists in benchmark_runner cli #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 6 additions & 21 deletions benchmarks/src/benchmark_runner/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ const BENCHMARK_TARGET_HEADING: &str = "SQL Benchmark Target";
const RUNNER_OPTIONS_HEADING: &str = "Runner Options";
const DATAFUSION_OPTIONS_HEADING: &str = "DataFusion Options";
const SUITE_OPTIONS_HEADING: &str = "Suite Options";
/// `CommonOpt` arguments shown under the DataFusion Options heading. This is
/// every `CommonOpt` field except `iterations`, which is a runner option.
const DATAFUSION_ARG_IDS: &[&str] = &[
"partitions",
"batch_size",
Expand All @@ -48,16 +50,7 @@ const DATAFUSION_ARG_IDS: &[&str] = &[
"debug",
"simulate_latency",
];
const RUN_ENV_ARG_IDS: &[&str] = &[
"iterations",
"partitions",
"batch_size",
"mem_pool_type",
"memory_limit",
"sort_spill_reservation_bytes",
"debug",
"simulate_latency",
];
/// `CommonOpt` arguments hidden from `run` help entirely.
const HIDDEN_RUN_ARG_IDS: &[&str] = &["debug", "sort_spill_reservation_bytes"];

/// Parsed top-level command selected by clap and dynamic suite metadata.
Expand Down Expand Up @@ -320,7 +313,9 @@ fn base_run_command() -> Command {
.help_heading(RUNNER_OPTIONS_HEADING),
);
let run = set_help_heading(run, DATAFUSION_ARG_IDS, DATAFUSION_OPTIONS_HEADING);
let run = hide_env_annotations(run, RUN_ENV_ARG_IDS);
// Every CommonOpt arg exposes an `env`; the runner help suppresses all of
// them. No hand-added run arg has an env, so this is a no-op for those.
let run = run.mut_args(|arg| arg.hide_env(true));

hide_help_entries(run, HIDDEN_RUN_ARG_IDS)
}
Expand Down Expand Up @@ -671,16 +666,6 @@ fn set_help_heading(
command
}

/// Hides environment-variable annotations from help while preserving the
/// underlying argument behavior.
fn hide_env_annotations(mut command: Command, arg_ids: &[&str]) -> Command {
for id in arg_ids {
command = command.mut_arg(id, |arg| arg.hide_env(true));
}

command
}

/// Hides selected inherited options from help while keeping them parseable.
fn hide_help_entries(mut command: Command, arg_ids: &[&str]) -> Command {
for id in arg_ids {
Expand Down