repositories / smith
smith
There are many coding harnesses - but this one is fast
owned by admin
smith-bench/src/bin/clap-calibration.rs
Raw//! Dynamic Clap help fixture for startup-surface calibration (`SMH-SPEC-SPEC0001`).
//!
//! The timed path is the same root short-help parse as `smith --help`.
//! Surface collection is a separate invocation and never runs in that path.
#![deny(unsafe_code)]
use clap::{Arg, ArgAction, Command, error::ErrorKind};
const ROOT_NAME: &str = "smith";
const DEFAULT_COMMAND_COUNT: usize = 8;
const DEFAULT_ARGUMENT_COUNT: usize = 12;
const DEFAULT_TEXT_BYTES: usize = 256;
const MAX_COMMAND_COUNT: usize = 32;
const MAX_ARGUMENT_COUNT: usize = 64;
const MAX_TEXT_BYTES: usize = 2048;
const HELP_ARGUMENTS: [&str; 2] = [ROOT_NAME, "--help"];
const COMMAND_NAMES: [&str; MAX_COMMAND_COUNT] = [
"surface-00",
"surface-01",
"surface-02",
"surface-03",
"surface-04",
"surface-05",
"surface-06",
"surface-07",
"surface-08",
"surface-09",
"surface-10",
"surface-11",
"surface-12",
"surface-13",
"surface-14",
"surface-15",
"surface-16",
"surface-17",
"surface-18",
"surface-19",
"surface-20",
"surface-21",
"surface-22",
"surface-23",
"surface-24",
"surface-25",
"surface-26",
"surface-27",
"surface-28",
"surface-29",
"surface-30",
"surface-31",
];
const ARGUMENT_NAMES: [&str; MAX_ARGUMENT_COUNT] = [
"option-00",
"option-01",
"option-02",
"option-03",
"option-04",
"option-05",
"option-06",
"option-07",
"option-08",
"option-09",
"option-10",
"option-11",
"option-12",
"option-13",
"option-14",
"option-15",
"option-16",
"option-17",
"option-18",
"option-19",
"option-20",
"option-21",
"option-22",
"option-23",
"option-24",
"option-25",
"option-26",
"option-27",
"option-28",
"option-29",
"option-30",
"option-31",
"option-32",
"option-33",
"option-34",
"option-35",
"option-36",
"option-37",
"option-38",
"option-39",
"option-40",
"option-41",
"option-42",
"option-43",
"option-44",
"option-45",
"option-46",
"option-47",
"option-48",
"option-49",
"option-50",
"option-51",
"option-52",
"option-53",
"option-54",
"option-55",
"option-56",
"option-57",
"option-58",
"option-59",
"option-60",
"option-61",
"option-62",
"option-63",
];
const DESCRIPTOR: &str = concat!(
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
);
fn main() {
let (dimensions, surface_report) = Dimensions::from_environment();
if surface_report {
let surface = report_surface(dimensions);
eprintln!(
"surface commands={} arguments={} descriptor_bytes={} rendered_bytes={}",
surface.command_count,
surface.argument_placements,
surface.descriptor_bytes,
surface.rendered_bytes,
);
return;
}
surface_command(dimensions).get_matches_from(HELP_ARGUMENTS);
}
#[derive(Clone, Copy)]
struct Dimensions {
command_count: usize,
argument_count: usize,
text_bytes: usize,
}
impl Dimensions {
fn from_environment() -> (Self, bool) {
let mut dimensions = Self {
command_count: DEFAULT_COMMAND_COUNT,
argument_count: DEFAULT_ARGUMENT_COUNT,
text_bytes: DEFAULT_TEXT_BYTES,
};
let mut surface_report = false;
let mut values = std::env::args_os().skip(1);
while let Some(flag) = values.next() {
if flag == "--surface-report" {
surface_report = true;
continue;
}
let Some(value) = values.next() else {
usage_error("calibration fixture option requires a value");
};
let Ok(value) = value.into_string() else {
usage_error("calibration fixture option must be valid Unicode");
};
let Ok(value) = value.parse() else {
usage_error("calibration fixture option must be an unsigned integer");
};
match flag.to_str() {
Some("--commands") if value <= MAX_COMMAND_COUNT => {
dimensions.command_count = value
}
Some("--arguments") if value <= MAX_ARGUMENT_COUNT => {
dimensions.argument_count = value
}
Some("--text-bytes") if value <= MAX_TEXT_BYTES => dimensions.text_bytes = value,
Some("--commands") | Some("--arguments") | Some("--text-bytes") => {
usage_error("calibration fixture option exceeds its declared bound");
}
_ => usage_error("calibration fixture option is unknown"),
}
}
(dimensions, surface_report)
}
}
#[cold]
fn usage_error(message: &str) -> ! {
eprintln!("{message}");
std::process::exit(2);
}
#[derive(Debug, Eq, PartialEq)]
struct Surface {
command_count: usize,
argument_placements: usize,
descriptor_bytes: usize,
rendered_bytes: usize,
}
fn report_surface(dimensions: Dimensions) -> Surface {
let mut command = surface_command(dimensions);
let error = command
.try_get_matches_from_mut(HELP_ARGUMENTS)
.expect_err("root --help returns Clap DisplayHelp");
assert_eq!(
error.kind(),
ErrorKind::DisplayHelp,
"root --help is display help"
);
let mut surface = Surface {
command_count: 0,
argument_placements: 0,
descriptor_bytes: 0,
rendered_bytes: error.to_string().len(),
};
inspect_surface(&command, &mut surface);
surface
}
fn surface_command(dimensions: Dimensions) -> Command {
let text = descriptor_text(dimensions.text_bytes);
let mut command = Command::new(ROOT_NAME)
.version("0")
.about(text)
.subcommand_required(true)
.arg_required_else_help(true)
.propagate_version(true)
.disable_help_subcommand(true);
for index in 0..dimensions.argument_count {
command = command.arg(option(index, text));
}
for index in 0..dimensions.command_count {
command = command.subcommand(subcommand(index, text));
}
command
}
fn descriptor_text(bytes: usize) -> &'static str {
&DESCRIPTOR[..bytes]
}
fn inspect_surface(command: &Command, surface: &mut Surface) {
surface.command_count += 1;
surface.descriptor_bytes += command
.get_about()
.map_or(0, |about| about.to_string().len());
surface.descriptor_bytes += command
.get_long_about()
.map_or(0, |about| about.to_string().len());
for argument in command.get_arguments() {
if argument.get_id().as_str().starts_with("option-") {
surface.argument_placements += 1;
surface.descriptor_bytes +=
argument.get_help().map_or(0, |help| help.to_string().len());
surface.descriptor_bytes += argument
.get_long_help()
.map_or(0, |help| help.to_string().len());
}
}
for child in command.get_subcommands() {
inspect_surface(child, surface);
}
}
fn option(index: usize, text: &'static str) -> Arg {
let name = ARGUMENT_NAMES[index];
let argument = Arg::new(name)
.long(name)
.global(true)
.help(text)
.long_help(text);
match index % 5 {
0 => argument.action(ArgAction::SetTrue),
1 => argument.action(ArgAction::Set).value_name("MODEL"),
2 => argument
.action(ArgAction::Append)
.value_name("PATH")
.num_args(1..),
3 => argument.action(ArgAction::Count),
_ => argument.action(ArgAction::Set).value_name("PROFILE"),
}
}
fn subcommand(index: usize, text: &'static str) -> Command {
Command::new(COMMAND_NAMES[index])
.about(text)
.long_about(text)
.subcommand_required(true)
.arg_required_else_help(true)
.subcommand(Command::new("inspect").about(text).long_about(text))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn report_counts_actual_post_parse_propagated_argument_placements() {
let surface = report_surface(Dimensions {
command_count: 2,
argument_count: 3,
text_bytes: 7,
});
assert_eq!(surface.command_count, 5);
assert_eq!(surface.argument_placements, 9);
assert_eq!(surface.descriptor_bytes, 189);
}
#[test]
fn report_short_help_matches_root_help_argv() {
let surface = report_surface(Dimensions {
command_count: 1,
argument_count: 3,
text_bytes: 4,
});
let mut command = surface_command(Dimensions {
command_count: 1,
argument_count: 3,
text_bytes: 4,
});
let error = command
.try_get_matches_from_mut(HELP_ARGUMENTS)
.expect_err("root --help returns DisplayHelp");
assert_eq!(error.kind(), ErrorKind::DisplayHelp);
let help = error.to_string();
assert_eq!(surface.rendered_bytes, help.len());
assert!(help.contains("Print help (see a summary with '-h')"));
assert!(help.contains("--option-00"));
assert!(help.contains("--option-01 <MODEL>"));
assert!(help.contains("--option-02 <PATH>..."));
assert!(!help.contains("x\nx\nx\nx"));
}
#[test]
fn timed_path_inputs_are_static_and_metadata_is_report_only() {
let text = descriptor_text(MAX_TEXT_BYTES);
assert_eq!(DESCRIPTOR.len(), MAX_TEXT_BYTES);
assert_eq!(text, DESCRIPTOR);
assert_eq!(HELP_ARGUMENTS, [ROOT_NAME, "--help"]);
assert!(!HELP_ARGUMENTS.contains(&"--surface-report"));
assert_eq!(ARGUMENT_NAMES.len(), MAX_ARGUMENT_COUNT);
assert_eq!(COMMAND_NAMES.len(), MAX_COMMAND_COUNT);
assert_eq!(ARGUMENT_NAMES[0], "option-00");
assert_eq!(COMMAND_NAMES[MAX_COMMAND_COUNT - 1], "surface-31");
}
}