ic_query_cli/
lib.rs

1mod cli;
2mod icrc;
3mod nns;
4mod output;
5mod progress;
6mod project;
7mod sns;
8
9#[cfg(test)]
10mod test_support;
11
12use crate::cli::clap::{
13    parse_matches_or_usage, passthrough_args, passthrough_subcommand, string_option,
14};
15use clap::{Arg, ArgAction, Command};
16use ic_query::subnet_catalog::MAINNET_NETWORK;
17use std::ffi::OsString;
18use thiserror::Error as ThisError;
19
20const TOP_LEVEL_HELP_TEMPLATE: &str = "{name} {version}\n{about-with-newline}\n{usage-heading} {usage}\n\nCommands:\n{subcommands}\n\nOptions:\n{options}{after-help}\n";
21const VERSION_TEXT: &str = concat!("icq ", env!("CARGO_PKG_VERSION"));
22const INTERNAL_NETWORK_OPTION: &str = "--__icq-network";
23
24const fn version_text() -> &'static str {
25    VERSION_TEXT
26}
27
28///
29/// IcqCliError
30///
31/// Top-level CLI dispatch error.
32///
33
34#[derive(Debug, ThisError)]
35pub enum IcqCliError {
36    #[error("{0}")]
37    Usage(String),
38
39    #[error("nns: {0}")]
40    Nns(#[from] nns::NnsCommandError),
41
42    #[error("icrc: {0}")]
43    Icrc(#[from] icrc::IcrcCommandError),
44
45    #[error("sns: {0}")]
46    Sns(#[from] sns::SnsCommandError),
47}
48
49impl IcqCliError {
50    /// Whether stdout closed before the command finished writing its report.
51    #[must_use]
52    pub fn is_broken_pipe(&self) -> bool {
53        match self {
54            Self::Nns(nns::NnsCommandError::Io(err))
55            | Self::Icrc(icrc::IcrcCommandError::Io(err))
56            | Self::Sns(sns::SnsCommandError::Io(err)) => {
57                err.kind() == std::io::ErrorKind::BrokenPipe
58            }
59            Self::Usage(_) | Self::Nns(_) | Self::Icrc(_) | Self::Sns(_) => false,
60        }
61    }
62
63    /// Process exit code for this command error.
64    #[must_use]
65    pub const fn exit_code(&self) -> i32 {
66        match self {
67            Self::Usage(_)
68            | Self::Nns(nns::NnsCommandError::Usage(_))
69            | Self::Icrc(icrc::IcrcCommandError::Usage(_))
70            | Self::Sns(sns::SnsCommandError::Usage(_)) => 2,
71            Self::Nns(_) | Self::Icrc(_) | Self::Sns(_) => 1,
72        }
73    }
74}
75
76/// Run the CLI from process arguments.
77pub fn run_from_env() -> Result<(), IcqCliError> {
78    run(std::env::args_os().skip(1))
79}
80
81/// Run the CLI from an argument iterator.
82pub fn run<I>(args: I) -> Result<(), IcqCliError>
83where
84    I: IntoIterator<Item = OsString>,
85{
86    let Some(args) = collect_args_or_print_help(args, usage) else {
87        return Ok(());
88    };
89    if let Some((command, option)) = command_local_global_option(&args) {
90        if command == "icrc" {
91            return Err(unsupported_global_network_error(command));
92        }
93        return Err(IcqCliError::Usage(format!(
94            "{option} is a top-level option; put it before the command\n\n{}",
95            usage()
96        )));
97    }
98
99    let matches = parse_matches_or_usage(top_level_dispatch_command(), args, usage)
100        .map_err(IcqCliError::Usage)?;
101    if matches.get_flag("version") {
102        println!("{VERSION_TEXT}");
103        return Ok(());
104    }
105    let global_network = string_option(&matches, "network");
106
107    let Some((command, subcommand_matches)) = matches.subcommand() else {
108        return Err(IcqCliError::Usage(usage()));
109    };
110    let mut tail = passthrough_args(subcommand_matches);
111    apply_global_network(command, &mut tail, global_network)?;
112    let tail = tail.into_iter();
113
114    match command {
115        "icrc" => Ok(icrc::run(tail)?),
116        "nns" => Ok(nns::run(tail)?),
117        "sns" => Ok(sns::run(tail)?),
118        _ => unreachable!("top-level dispatch command only defines known commands"),
119    }
120}
121
122fn collect_args_or_print_help<I>(args: I, usage: impl FnOnce() -> String) -> Option<Vec<OsString>>
123where
124    I: IntoIterator<Item = OsString>,
125{
126    let args = args.into_iter().collect::<Vec<_>>();
127    if top_level_help_requested(&args) {
128        println!("{}", usage());
129        return None;
130    }
131    Some(args)
132}
133
134fn top_level_help_requested(args: &[OsString]) -> bool {
135    let mut index = 0;
136    while index < args.len() {
137        let Some(arg) = args[index].to_str() else {
138            return false;
139        };
140        if command_family(arg).is_some() {
141            return false;
142        }
143        if matches!(arg, "help" | "--help" | "-h") {
144            return true;
145        }
146        index += if arg == "--network" { 2 } else { 1 };
147    }
148    false
149}
150
151fn network_arg() -> Arg {
152    Arg::new("network")
153        .num_args(1)
154        .long("network")
155        .value_name("name")
156        .help("Network identity for NNS and SNS commands; currently only ic")
157}
158
159fn top_level_command() -> Command {
160    Command::new("icq")
161        .version(env!("CARGO_PKG_VERSION"))
162        .about("Internet Computer metadata query CLI")
163        .disable_help_subcommand(true)
164        .disable_version_flag(true)
165        .arg(
166            Arg::new("version")
167                .short('V')
168                .long("version")
169                .action(ArgAction::SetTrue)
170                .help("Print version"),
171        )
172        .arg(network_arg().global(true))
173        .subcommand_help_heading("Commands")
174        .help_template(TOP_LEVEL_HELP_TEMPLATE)
175        .after_help("Run `icq <command> help` for command-specific help.")
176        .subcommands(
177            COMMAND_FAMILIES
178                .iter()
179                .map(|family| Command::new(family.name).about(family.about)),
180        )
181}
182
183fn top_level_dispatch_command() -> Command {
184    let command = Command::new("icq")
185        .disable_help_flag(true)
186        .disable_help_subcommand(true)
187        .disable_version_flag(true)
188        .arg(
189            Arg::new("version")
190                .short('V')
191                .long("version")
192                .action(ArgAction::SetTrue),
193        )
194        .arg(network_arg().global(true));
195
196    COMMAND_FAMILIES.iter().fold(command, |command, family| {
197        command.subcommand(passthrough_subcommand(
198            Command::new(family.name).about(family.about),
199        ))
200    })
201}
202
203fn usage() -> String {
204    let mut command = top_level_command();
205    command.render_help().to_string()
206}
207
208fn command_local_global_option(args: &[OsString]) -> Option<(&'static str, &'static str)> {
209    let mut index = 0;
210    while index < args.len() {
211        let arg = args[index].to_str()?;
212        if let Some(family) = command_family(arg) {
213            return args[index + 1..]
214                .iter()
215                .filter_map(|arg| arg.to_str())
216                .find_map(global_option_name)
217                .map(|option| (family.name, option));
218        }
219        index += if arg == "--network" { 2 } else { 1 };
220    }
221    None
222}
223
224fn global_option_name(arg: &str) -> Option<&'static str> {
225    match arg {
226        "--network" => Some("--network"),
227        _ if arg.starts_with("--network=") => Some("--network"),
228        _ => None,
229    }
230}
231
232fn apply_global_network(
233    command: &str,
234    tail: &mut Vec<OsString>,
235    global_network: Option<String>,
236) -> Result<(), IcqCliError> {
237    let Some(global_network) = global_network else {
238        return Ok(());
239    };
240    if tail_requests_help_or_version(tail) {
241        return Ok(());
242    }
243    if !command_accepts_global_network(command, tail) {
244        return Err(unsupported_global_network_error(command));
245    }
246    if global_network != MAINNET_NETWORK {
247        return Err(unsupported_mainnet_network_error(command, &global_network));
248    }
249    if tail_has_option(tail, INTERNAL_NETWORK_OPTION) {
250        return Ok(());
251    }
252
253    tail.push(OsString::from(INTERNAL_NETWORK_OPTION));
254    tail.push(OsString::from(global_network));
255    Ok(())
256}
257
258fn unsupported_global_network_error(command: &str) -> IcqCliError {
259    let guidance = if command == "icrc" {
260        " use the command's --source-endpoint option to select the IC API endpoint"
261    } else {
262        ""
263    };
264    IcqCliError::Usage(format!(
265        "--network is not supported by `icq {command}`;{guidance}\n\n{}",
266        usage()
267    ))
268}
269
270fn unsupported_mainnet_network_error(command: &str, network: &str) -> IcqCliError {
271    IcqCliError::Usage(format!(
272        "`icq {command}` currently supports only the mainnet `{MAINNET_NETWORK}` network; received `{network}`\n\n{}",
273        usage()
274    ))
275}
276
277fn command_accepts_global_network(command: &str, tail: &[OsString]) -> bool {
278    command_family(command).is_some_and(|family| (family.accepts_global_network)(tail))
279}
280
281fn tail_has_option(tail: &[OsString], name: &str) -> bool {
282    tail.iter().any(|arg| arg.to_str() == Some(name))
283}
284
285fn tail_requests_help_or_version(tail: &[OsString]) -> bool {
286    tail.iter()
287        .filter_map(|arg| arg.to_str())
288        .any(|arg| matches!(arg, "help" | "--help" | "-h" | "--version" | "-V"))
289}
290
291#[derive(Clone, Copy, Debug)]
292struct CommandFamily {
293    name: &'static str,
294    about: &'static str,
295    accepts_global_network: fn(&[OsString]) -> bool,
296}
297
298const COMMAND_FAMILIES: &[CommandFamily] = &[
299    CommandFamily {
300        name: "icrc",
301        about: "Inspect generic ICRC ledger metadata",
302        accepts_global_network: icrc_accepts_global_network,
303    },
304    CommandFamily {
305        name: "nns",
306        about: "Inspect NNS metadata",
307        accepts_global_network: nns_accepts_global_network,
308    },
309    CommandFamily {
310        name: "sns",
311        about: "Inspect SNS metadata",
312        accepts_global_network: sns_accepts_global_network,
313    },
314];
315
316fn command_family(name: &str) -> Option<&'static CommandFamily> {
317    COMMAND_FAMILIES.iter().find(|family| family.name == name)
318}
319
320fn nns_accepts_global_network(tail: &[OsString]) -> bool {
321    matches!(
322        tail.first().and_then(|arg| arg.to_str()),
323        Some(
324            "data-center"
325                | "node"
326                | "node-operator"
327                | "node-provider"
328                | "proposal"
329                | "registry"
330                | "subnet"
331                | "topology"
332        )
333    )
334}
335
336const fn icrc_accepts_global_network(_tail: &[OsString]) -> bool {
337    false
338}
339
340fn sns_accepts_global_network(tail: &[OsString]) -> bool {
341    matches!(
342        tail.first().and_then(|arg| arg.to_str()),
343        Some("list" | "info" | "token" | "params" | "proposal" | "proposals" | "neurons")
344    )
345}
346
347#[cfg(test)]
348mod tests {
349    use super::*;
350
351    #[test]
352    fn usage_lists_query_families() {
353        let text = usage();
354
355        assert!(text.contains("Usage: icq [OPTIONS] [COMMAND]"));
356        assert!(text.contains("icrc"));
357        assert!(text.contains("Inspect generic ICRC ledger metadata"));
358        assert!(text.contains("nns"));
359        assert!(text.contains("Inspect NNS metadata"));
360        assert!(text.contains("sns"));
361        assert!(text.contains("Inspect SNS metadata"));
362        assert!(text.contains("Run `icq <command> help`"));
363    }
364
365    #[test]
366    fn top_level_usage_snapshot() {
367        let expected = format!(
368            "\
369icq {}
370Internet Computer metadata query CLI
371
372Usage: icq [OPTIONS] [COMMAND]
373
374Commands:
375  icrc  Inspect generic ICRC ledger metadata
376  nns   Inspect NNS metadata
377  sns   Inspect SNS metadata
378
379Options:
380  -V, --version         Print version
381      --network <name>  Network identity for NNS and SNS commands; currently only ic
382  -h, --help            Print help
383
384Run `icq <command> help` for command-specific help.
385",
386            env!("CARGO_PKG_VERSION")
387        );
388
389        assert_eq!(usage(), expected);
390    }
391
392    #[test]
393    fn command_family_help_returns_ok() {
394        for args in [
395            &["icrc", "help"][..],
396            &["icrc", "token", "help"],
397            &["icrc", "balance", "help"],
398            &["icrc", "allowance", "help"],
399            &["icrc", "index", "help"],
400            &["nns", "help"][..],
401            &["nns", "data-center", "help"],
402            &["nns", "data-center", "list", "help"],
403            &["nns", "data-center", "info", "help"],
404            &["nns", "data-center", "refresh", "help"],
405            &["nns", "node", "help"],
406            &["nns", "node", "list", "help"],
407            &["nns", "node", "info", "help"],
408            &["nns", "node", "refresh", "help"],
409            &["nns", "node-provider", "help"],
410            &["nns", "node-provider", "list", "help"],
411            &["nns", "node-provider", "info", "help"],
412            &["nns", "node-provider", "refresh", "help"],
413            &["nns", "node-operator", "help"],
414            &["nns", "node-operator", "list", "help"],
415            &["nns", "node-operator", "info", "help"],
416            &["nns", "node-operator", "refresh", "help"],
417            &["nns", "proposal", "help"],
418            &["nns", "proposal", "list", "help"],
419            &["nns", "proposal", "info", "help"],
420            &["nns", "registry", "help"],
421            &["nns", "registry", "version", "help"],
422            &["nns", "subnet", "help"],
423            &["nns", "subnet", "list", "help"],
424            &["nns", "subnet", "info", "help"],
425            &["nns", "subnet", "refresh", "help"],
426            &["nns", "topology", "help"],
427            &["nns", "topology", "summary", "help"],
428            &["nns", "topology", "coverage", "help"],
429            &["nns", "topology", "versions", "help"],
430            &["nns", "topology", "health", "help"],
431            &["nns", "topology", "gaps", "help"],
432            &["nns", "topology", "capacity", "help"],
433            &["nns", "topology", "regions", "help"],
434            &["nns", "topology", "providers", "help"],
435            &["nns", "topology", "refresh", "help"],
436            &["sns", "help"],
437            &["sns", "list", "help"],
438            &["sns", "info", "help"],
439            &["sns", "token", "help"],
440            &["sns", "params", "help"],
441            &["sns", "proposal", "help"],
442            &["sns", "proposals", "help"],
443            &["sns", "neurons", "help"],
444            &["sns", "neurons", "cache", "help"],
445            &["sns", "neurons", "cache", "list", "help"],
446            &["sns", "neurons", "cache", "status", "help"],
447            &["sns", "neurons", "refresh", "help"],
448        ] {
449            assert_run_ok(args);
450        }
451    }
452
453    #[test]
454    fn version_flags_return_ok() {
455        assert_eq!(VERSION_TEXT, concat!("icq ", env!("CARGO_PKG_VERSION")));
456        assert!(run([OsString::from("--version")]).is_ok());
457        assert!(run([OsString::from("icrc"), OsString::from("--version")]).is_ok());
458        assert!(run([OsString::from("nns"), OsString::from("--version")]).is_ok());
459        assert!(run([OsString::from("sns"), OsString::from("--version")]).is_ok());
460        assert!(
461            run([
462                OsString::from("nns"),
463                OsString::from("subnet"),
464                OsString::from("list"),
465                OsString::from("--version")
466            ])
467            .is_ok()
468        );
469
470        let mut sns_info_tail = vec![OsString::from("info"), OsString::from("1")];
471
472        apply_global_network("sns", &mut sns_info_tail, Some("ic".to_string()))
473            .expect("SNS supports global network");
474
475        assert_eq!(
476            sns_info_tail,
477            vec![
478                OsString::from("info"),
479                OsString::from("1"),
480                OsString::from(INTERNAL_NETWORK_OPTION),
481                OsString::from("ic")
482            ]
483        );
484    }
485
486    #[test]
487    fn typed_cli_errors_preserve_exit_and_broken_pipe_semantics() {
488        let usage = IcqCliError::Icrc(icrc::IcrcCommandError::Usage("bad input".to_string()));
489        assert_eq!(usage.exit_code(), 2);
490        assert!(!usage.is_broken_pipe());
491
492        let broken_pipe = IcqCliError::Icrc(icrc::IcrcCommandError::Io(std::io::Error::from(
493            std::io::ErrorKind::BrokenPipe,
494        )));
495        assert_eq!(broken_pipe.exit_code(), 1);
496        assert!(broken_pipe.is_broken_pipe());
497    }
498
499    #[test]
500    fn global_network_is_forwarded_to_networked_leaf_commands() {
501        let mut nns_tail = vec![OsString::from("data-center"), OsString::from("list")];
502
503        apply_global_network("nns", &mut nns_tail, Some("ic".to_string()))
504            .expect("NNS data-center supports global network");
505
506        assert_eq!(
507            nns_tail,
508            vec![
509                OsString::from("data-center"),
510                OsString::from("list"),
511                OsString::from(INTERNAL_NETWORK_OPTION),
512                OsString::from("ic")
513            ]
514        );
515
516        let mut sns_tail = vec![OsString::from("list")];
517
518        apply_global_network("sns", &mut sns_tail, Some("ic".to_string()))
519            .expect("SNS list supports global network");
520
521        assert_eq!(
522            sns_tail,
523            vec![
524                OsString::from("list"),
525                OsString::from(INTERNAL_NETWORK_OPTION),
526                OsString::from("ic")
527            ]
528        );
529
530        let mut nns_proposal_tail = vec![OsString::from("proposal"), OsString::from("list")];
531
532        apply_global_network("nns", &mut nns_proposal_tail, Some("ic".to_string()))
533            .expect("NNS proposal supports global network");
534
535        assert_eq!(
536            nns_proposal_tail,
537            vec![
538                OsString::from("proposal"),
539                OsString::from("list"),
540                OsString::from(INTERNAL_NETWORK_OPTION),
541                OsString::from("ic")
542            ]
543        );
544    }
545
546    #[test]
547    fn non_mainnet_network_is_rejected_before_nns_or_sns_dispatch() {
548        for command in ["nns", "sns"] {
549            let mut tail = if command == "nns" {
550                vec![OsString::from("proposal"), OsString::from("list")]
551            } else {
552                vec![OsString::from("list")]
553            };
554
555            let error = apply_global_network(command, &mut tail, Some("local".to_string()))
556                .expect_err("current NNS and SNS adapters are mainnet-only");
557
558            assert_eq!(error.exit_code(), 2);
559            assert!(error.to_string().contains("supports only the mainnet `ic`"));
560            assert!(error.to_string().contains("received `local`"));
561            assert!(!tail_has_option(&tail, INTERNAL_NETWORK_OPTION));
562        }
563
564        let mut preforwarded_tail = vec![
565            OsString::from("proposal"),
566            OsString::from("list"),
567            OsString::from(INTERNAL_NETWORK_OPTION),
568            OsString::from(MAINNET_NETWORK),
569        ];
570        let error = apply_global_network("nns", &mut preforwarded_tail, Some("local".to_string()))
571            .expect_err("an internal forwarded value must not bypass global validation");
572        assert!(error.to_string().contains("received `local`"));
573
574        for args in [
575            vec![
576                OsString::from("--network"),
577                OsString::from("local"),
578                OsString::from("nns"),
579                OsString::from("proposal"),
580                OsString::from("list"),
581            ],
582            vec![
583                OsString::from("--network"),
584                OsString::from("local"),
585                OsString::from("sns"),
586                OsString::from("list"),
587            ],
588        ] {
589            let command = args[2].to_string_lossy().into_owned();
590            let error = run(args).expect_err("non-mainnet network must fail before dispatch");
591
592            assert_eq!(error.exit_code(), 2);
593            assert!(
594                error
595                    .to_string()
596                    .starts_with(&format!("`icq {command}` currently"))
597            );
598        }
599    }
600
601    #[test]
602    fn global_network_is_rejected_when_the_family_uses_endpoint_identity() {
603        let mut icrc_tail = vec![OsString::from("token")];
604
605        let error = apply_global_network("icrc", &mut icrc_tail, Some("ic".to_string()))
606            .expect_err("ICRC must reject an inapplicable global network");
607
608        assert_eq!(error.exit_code(), 2);
609        assert!(error.to_string().contains("--network is not supported"));
610        assert!(error.to_string().contains("icq icrc"));
611        assert!(error.to_string().contains("--source-endpoint"));
612        assert_eq!(icrc_tail, vec![OsString::from("token")]);
613
614        let error = run([
615            OsString::from("--network"),
616            OsString::from("ic"),
617            OsString::from("icrc"),
618            OsString::from("token"),
619            OsString::from("ryjl3-tyaaa-aaaaa-aaaba-cai"),
620        ])
621        .expect_err("ICRC global network must fail before dispatch");
622
623        assert_eq!(error.exit_code(), 2);
624        assert!(error.to_string().contains("--source-endpoint"));
625
626        let error = run([
627            OsString::from("icrc"),
628            OsString::from("token"),
629            OsString::from("ryjl3-tyaaa-aaaaa-aaaba-cai"),
630            OsString::from("--network"),
631            OsString::from("ic"),
632        ])
633        .expect_err("command-local ICRC network must use the same rejection");
634
635        assert_eq!(error.exit_code(), 2);
636        assert!(error.to_string().contains("--network is not supported"));
637        assert!(!error.to_string().contains("put it before the command"));
638
639        assert!(
640            run([
641                OsString::from("--network"),
642                OsString::from("ic"),
643                OsString::from("icrc"),
644                OsString::from("token"),
645                OsString::from("help"),
646            ])
647            .is_ok(),
648            "help must remain available without dispatching a query"
649        );
650    }
651
652    #[test]
653    fn sns_nested_commands_dispatch_through_clap_subcommands() {
654        assert!(
655            run([
656                OsString::from("sns"),
657                OsString::from("neurons"),
658                OsString::from("refresh"),
659                OsString::from("--help")
660            ])
661            .is_ok()
662        );
663        assert!(
664            run([
665                OsString::from("sns"),
666                OsString::from("proposals"),
667                OsString::from("cache"),
668                OsString::from("status"),
669                OsString::from("--help")
670            ])
671            .is_ok()
672        );
673    }
674
675    fn assert_run_ok(args: &[&str]) {
676        let args = args.iter().copied().map(OsString::from).collect::<Vec<_>>();
677        if let Err(err) = run(args.clone()) {
678            panic!("expected {args:?} to succeed, got {err}");
679        }
680    }
681}
ic_query_cli/lib.rs

ic_query_cli/
lib.rs
