use std::any::TypeId;
use std::collections::HashSet;
use anyhow::{Context, bail};
use clap::error::ErrorKind;
use clap::{ArgAction, Command, Parser};
use moqros::ros::r2r;
use moqros::ros::r2r::ParameterValue;
pub fn init<T: Parser>(node_name: &str) -> anyhow::Result<(T, r2r::Node)> {
let args = strip_ros_args(std::env::args());
if let Some(err) = help_or_version(T::command(), &args) {
err.exit();
}
let ctx = r2r::Context::create().context("failed to create ROS context")?;
let node = r2r::Node::create(ctx, node_name, "").context("failed to create ROS node")?;
let flags = param_flags(
&T::command(),
node.params
.lock()
.unwrap()
.iter()
.map(|(name, param)| (name.as_str(), ¶m.value)),
)?;
let cli = match parse_args(args, flags) {
Ok(cli) => cli,
Err(ParseError::CommandLine(err)) => err.exit(),
Err(ParseError::Param(err)) => {
let message = err.to_string();
let message = message.lines().next().unwrap_or_default().trim_start_matches("error: ");
bail!("invalid ROS parameter: {message}");
}
};
Ok((cli, node))
}
pub fn strip_ros_args(args: impl IntoIterator<Item = String>) -> Vec<String> {
let mut in_ros_args = false;
args.into_iter()
.filter(|arg| match (in_ros_args, arg.as_str()) {
(false, "--ros-args") | (true, "--") => {
in_ros_args = !in_ros_args;
false
}
_ => !in_ros_args,
})
.collect()
}
fn help_or_version(command: Command, args: &[String]) -> Option<clap::Error> {
let err = command.try_get_matches_from(args).err()?;
matches!(err.kind(), ErrorKind::DisplayHelp | ErrorKind::DisplayVersion).then_some(err)
}
#[derive(Debug)]
enum ParseError {
CommandLine(clap::Error),
Param(clap::Error),
}
fn parse_args<T: Parser>(args: Vec<String>, param_flags: Vec<String>) -> Result<T, ParseError> {
let flag = |arg: &str| arg.split_once('=').map_or(arg, |(flag, _)| flag).to_string();
let given: HashSet<String> = args
.iter()
.skip(1)
.filter(|arg| arg.starts_with("--"))
.map(|arg| flag(arg))
.collect();
let param_flags: Vec<String> = param_flags
.into_iter()
.filter(|param| !given.contains(&flag(param)))
.collect();
let parse = |param_flags: Vec<String>| {
let mut args = args.iter().cloned();
let args = args.next().into_iter().chain(param_flags).chain(args);
let matches = T::command().args_override_self(true).try_get_matches_from(args)?;
T::from_arg_matches(&matches)
};
parse(param_flags).map_err(|err| match parse(Vec::new()) {
Ok(_) => ParseError::Param(err),
Err(err) => ParseError::CommandLine(err),
})
}
fn param_flags<'a>(
command: &Command,
params: impl IntoIterator<Item = (&'a str, &'a ParameterValue)>,
) -> anyhow::Result<Vec<String>> {
let mut flags = Vec::new();
for (name, value) in params {
let Some((long, arg)) = command
.get_arguments()
.find(|arg| arg.get_id() == name)
.and_then(|arg| Some((arg.get_long()?, arg)))
else {
if name != "use_sim_time" {
tracing::warn!(name, "ignoring unknown ROS parameter");
}
continue;
};
let value = match value {
ParameterValue::NotSet => continue,
ParameterValue::Bool(value) => value.to_string(),
ParameterValue::Integer(value) => value.to_string(),
ParameterValue::Double(value) if arg.get_value_parser().type_id() == TypeId::of::<String>() => {
format!("{value:?}")
}
ParameterValue::Double(value) => value.to_string(),
ParameterValue::String(value) => value.clone(),
ParameterValue::StringArray(values) if matches!(arg.get_action(), ArgAction::Append) => {
flags.extend(values.iter().map(|value| format!("--{long}={value}")));
continue;
}
value => bail!("ROS parameter `{name}` has unsupported type: {value:?}"),
};
flags.push(format!("--{long}={value}"));
}
Ok(flags)
}
#[cfg(test)]
mod tests {
use clap::CommandFactory;
use super::*;
use crate::{EncoderArgs, Format, QosArgs, RelayArgs, RepublishArgs, TopicSpec};
fn strip(args: &[&str]) -> Vec<String> {
strip_ros_args(args.iter().map(|arg| arg.to_string()))
}
#[derive(Debug, Parser)]
#[command(version = "1.2.3")]
struct TestCli {
#[arg(long, default_value = "/image_raw")]
topic: String,
#[arg(long)]
broadcast: Option<String>,
#[arg(long, default_value_t = 30.0)]
fps: f32,
#[arg(long, default_value_t = 2000)]
keyframe_interval_ms: u64,
#[arg(long, value_enum, default_value_t = Format::Video)]
format: Format,
#[arg(id = "type", long = "type")]
ros_type: Option<String>,
#[arg(long, default_value_t = moqros::DataMode::default())]
mode: moqros::DataMode,
#[command(flatten)]
relay: RelayArgs,
#[command(flatten)]
qos: QosArgs,
}
#[derive(Debug, Parser)]
struct MultiCli {
#[arg(long, default_value = "/image_raw")]
topic: Vec<TopicSpec>,
}
#[derive(Debug, Parser)]
struct EnvCli {
#[arg(long, env = "MOQROS_TEST_BITRATE", default_value_t = 1)]
bitrate: u32,
}
fn flags<T: Parser>(params: &[(&str, ParameterValue)]) -> anyhow::Result<Vec<String>> {
param_flags(&T::command(), params.iter().map(|(name, value)| (*name, value)))
}
fn args(args: &[&str]) -> Vec<String> {
std::iter::once("bin")
.chain(args.iter().copied())
.map(String::from)
.collect()
}
fn parse<T: Parser>(args_: &[&str], params: &[(&str, ParameterValue)]) -> Result<T, ParseError> {
parse_args(args(args_), flags::<T>(params).unwrap())
}
fn string(value: &str) -> ParameterValue {
ParameterValue::String(value.to_string())
}
#[test]
fn strips_ros_args() {
assert_eq!(strip(&["bin", "--topic", "a"]), ["bin", "--topic", "a"]);
assert_eq!(
strip(&[
"bin",
"--topic",
"a",
"--ros-args",
"-r",
"__node:=n",
"-p",
"bitrate:=1"
]),
["bin", "--topic", "a"]
);
assert_eq!(
strip(&[
"bin",
"--ros-args",
"-r",
"__ns:=/x",
"--",
"--reliable",
"--ros-args",
"-p",
"a:=1"
]),
["bin", "--reliable"]
);
}
#[test]
fn params_fill_flags() {
let cli: TestCli = parse(
&[],
&[
("topic", string("/front/image_raw")),
("keyframe_interval_ms", ParameterValue::Integer(500)),
("reliable", ParameterValue::Bool(true)),
("url", string("http://relay:4443/anon")),
],
)
.unwrap();
assert_eq!(cli.topic, "/front/image_raw");
assert_eq!(cli.keyframe_interval_ms, 500);
assert!(cli.qos.reliable);
assert_eq!(cli.relay.url.as_str(), "http://relay:4443/anon");
assert!(!cli.relay.insecure);
assert_eq!(cli.broadcast, None);
}
#[test]
fn client_cert_flags_come_in_pairs() {
let cli: TestCli = parse(
&["--tls-cert", "/certs/robot.pem"],
&[("tls_key", string("/certs/robot.key"))],
)
.unwrap();
let config = cli.relay.config();
assert_eq!(
config.tls_cert.as_deref(),
Some(std::path::Path::new("/certs/robot.pem"))
);
assert_eq!(
config.tls_key.as_deref(),
Some(std::path::Path::new("/certs/robot.key"))
);
assert!(parse::<TestCli>(&["--tls-cert", "/certs/robot.pem"], &[]).is_err());
assert!(parse::<TestCli>(&["--tls-key", "/certs/robot.key"], &[]).is_err());
}
#[test]
fn data_params_fill_flags() {
let cli: TestCli = parse(&[], &[]).unwrap();
assert_eq!(
(cli.format, cli.ros_type, cli.mode),
(Format::Video, None, moqros::DataMode::Snapshot)
);
let cli: TestCli = parse(
&[],
&[
("format", string("json")),
("type", string("sensor_msgs/msg/Imu")),
("mode", string("stream")),
],
)
.unwrap();
assert_eq!(cli.format, Format::Json);
assert_eq!(cli.format.data(), Some(moqros::DataFormat::Json));
assert_eq!(cli.ros_type.as_deref(), Some("sensor_msgs/msg/Imu"));
assert_eq!(cli.mode, moqros::DataMode::Stream);
let cli: TestCli = parse(&["--format", "cdr", "--type", "std_msgs/msg/String"], &[]).unwrap();
assert_eq!(cli.format.data(), Some(moqros::DataFormat::Cdr));
assert_eq!(cli.ros_type.as_deref(), Some("std_msgs/msg/String"));
assert!(matches!(
parse::<TestCli>(&[], &[("format", string("xml"))]),
Err(ParseError::Param(_))
));
}
#[derive(Debug, Parser)]
struct EncoderCli {
#[command(flatten)]
encoder: EncoderArgs,
}
#[test]
fn encoder_params_fill_flags() {
let cli: EncoderCli = parse(&[], &[]).unwrap();
assert_eq!(cli.encoder.settings().hardware, moqros::Hardware::Auto);
let params = [("codec", string("av1")), ("hw", string("off"))];
let settings = parse::<EncoderCli>(&[], ¶ms).unwrap().encoder.settings();
assert_eq!(
(settings.codec, settings.hardware),
(moqros::Codec::Av1, moqros::Hardware::Off)
);
let cli: EncoderCli = parse(&["--hw", "require"], ¶ms).unwrap();
assert_eq!(cli.encoder.hw, moqros::Hardware::Require);
assert!(parse::<EncoderCli>(&["--hw", "gpu"], &[]).is_err());
}
#[derive(Debug, Parser)]
struct RepublishCli {
#[command(flatten)]
republish: RepublishArgs,
}
#[test]
fn republish_params_fill_flags() {
let params = [
("frame_id", string("camera")),
("stamp", string("receive")),
("max_height", ParameterValue::Integer(480)),
("encoding", string("bgr8")),
];
let options = parse::<RepublishCli>(&[], ¶ms).unwrap().republish.options();
assert_eq!(
options,
crate::RepublishOptions {
frame_id: Some("camera".into()),
stamp: moqros::ros::StampSource::Receive,
max_height: Some(480),
encoding: moqros::PixelFormat::Bgr8,
}
);
let cli: RepublishCli = parse(&["--max-height", "360"], ¶ms).unwrap();
assert_eq!(cli.republish.max_height, Some(360));
assert!(parse::<RepublishCli>(&[], &[("encoding", string("yuyv"))]).is_err());
}
#[test]
fn command_line_overrides_params() {
let params = [
("topic", string("/param")),
("reliable", ParameterValue::Bool(true)),
("insecure", ParameterValue::Bool(false)),
];
let cli: TestCli = parse(&["--topic", "/flag", "--reliable=false", "--insecure"], ¶ms).unwrap();
assert_eq!(cli.topic, "/flag");
assert!(!cli.qos.reliable);
assert!(cli.relay.insecure);
}
#[test]
fn params_override_env() {
const VAR: &str = "MOQROS_TEST_BITRATE";
let bitrate = ("bitrate", ParameterValue::Integer(2));
match std::env::var(VAR).ok().as_deref() {
None => {
for value in ["bogus", "4"] {
let output = std::process::Command::new(std::env::current_exe().unwrap())
.args(["--exact", "params::tests::params_override_env"])
.env(VAR, value)
.output()
.unwrap();
let stdout = String::from_utf8_lossy(&output.stdout);
assert!(
output.status.success() && stdout.contains("1 passed"),
"{VAR}={value}:\n{stdout}"
);
}
}
Some("bogus") => {
assert_eq!(parse::<EnvCli>(&[], std::slice::from_ref(&bitrate)).unwrap().bitrate, 2);
assert_eq!(parse::<EnvCli>(&["--bitrate", "3"], &[]).unwrap().bitrate, 3);
assert!(matches!(parse::<EnvCli>(&[], &[]), Err(ParseError::CommandLine(_))));
let help = help_or_version(EnvCli::command(), &args(&["--help"]));
assert_eq!(help.map(|err| err.kind()), Some(ErrorKind::DisplayHelp));
}
Some(value) => {
assert_eq!(value, "4");
assert_eq!(parse::<EnvCli>(&[], &[]).unwrap().bitrate, 4);
assert_eq!(parse::<EnvCli>(&[], std::slice::from_ref(&bitrate)).unwrap().bitrate, 2);
assert_eq!(parse::<EnvCli>(&["--bitrate=3"], &[bitrate]).unwrap().bitrate, 3);
}
}
}
#[test]
fn doubles_keep_their_fraction() {
let cli: TestCli = parse(
&[],
&[
("broadcast", ParameterValue::Double(1.0)),
("fps", ParameterValue::Double(12.5)),
],
)
.unwrap();
assert_eq!(cli.broadcast.as_deref(), Some("1.0"));
assert_eq!(cli.fps, 12.5);
let cli: TestCli = parse(&[], &[("keyframe_interval_ms", ParameterValue::Double(500.0))]).unwrap();
assert_eq!(cli.keyframe_interval_ms, 500);
let cli: TestCli = parse(&[], &[("fps", ParameterValue::Integer(15))]).unwrap();
assert_eq!(cli.fps, 15.0);
}
#[test]
fn values_starting_with_a_dash_stay_values() {
let cli: TestCli = parse(&[], &[("broadcast", string("-x"))]).unwrap();
assert_eq!(cli.broadcast.as_deref(), Some("-x"));
}
#[test]
fn unset_and_unknown_params_are_ignored() {
let params = [
("broadcast", ParameterValue::NotSet),
("use_sim_time", ParameterValue::Bool(false)),
("bitrat", ParameterValue::Integer(1)),
("keyframe-interval-ms", ParameterValue::Integer(1)),
("help", ParameterValue::Bool(true)),
("version", string("2")),
];
assert!(flags::<TestCli>(¶ms).unwrap().is_empty());
}
#[test]
fn arrays_fill_repeatable_flags() {
let topics = |cli: MultiCli| cli.topic.into_iter().map(|spec| spec.topic).collect::<Vec<_>>();
assert_eq!(topics(parse(&[], &[]).unwrap()), ["/image_raw"]);
let params = [(
"topic",
ParameterValue::StringArray(vec!["/a".into(), "/b,format=json".into()]),
)];
let cli: MultiCli = parse(&[], ¶ms).unwrap();
assert_eq!(cli.topic[1].format, Some(Format::Json));
assert_eq!(topics(cli), ["/a", "/b"]);
assert_eq!(topics(parse(&[], &[("topic", string("/c"))]).unwrap()), ["/c"]);
assert_eq!(topics(parse(&["--topic", "/d"], ¶ms).unwrap()), ["/d"]);
}
#[test]
fn arrays_are_rejected() {
let params = [("topic", ParameterValue::StringArray(vec!["/a".into()]))];
let err = flags::<TestCli>(¶ms).unwrap_err();
assert!(err.to_string().contains("`topic`"), "{err}");
}
#[test]
fn invalid_param_values_are_blamed_on_the_param() {
for (name, value) in [("keyframe_interval_ms", "soon"), ("url", "not a url")] {
match parse::<TestCli>(&[], &[(name, string(value))]) {
Err(ParseError::Param(err)) => assert_eq!(err.kind(), ErrorKind::ValueValidation, "{name}"),
other => panic!("{name}: {other:?}"),
}
}
}
#[test]
fn invalid_command_lines_are_blamed_on_the_command_line() {
let params = [("keyframe_interval_ms", string("soon"))];
for args in [&["--fps=fast"][..], &["--unknown"]] {
assert!(
matches!(parse::<TestCli>(args, ¶ms), Err(ParseError::CommandLine(_))),
"{args:?}"
);
}
}
#[test]
fn detects_help_and_version() {
let kind = |args_: &[&str]| help_or_version(TestCli::command(), &args(args_)).map(|err| err.kind());
assert_eq!(kind(&["--help"]), Some(ErrorKind::DisplayHelp));
assert_eq!(kind(&["-V"]), Some(ErrorKind::DisplayVersion));
assert_eq!(kind(&["-h", "--fps=fast"]), Some(ErrorKind::DisplayHelp));
assert_eq!(kind(&["--topic", "/a"]), None);
assert_eq!(kind(&["--fps=fast"]), None);
}
}