ic-query-cli 0.25.3

Command-line wrapper for read-only Internet Computer metadata queries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! Module: ic
//!
//! Responsibility: compose and dispatch official IC Dashboard command families.
//! Does not own: family-specific parsing, REST transport, report construction, or rendering.
//! Boundary: exposes bounded live Dashboard command wiring to the top-level CLI.

mod canister;
mod metrics;
mod network;

use crate::cli::common::CurrentUnixSecsError;
use clap::{ArgMatches, Command as ClapCommand};
use ic_query::ic::IcHostError;
use std::io;
use thiserror::Error as ThisError;

///
/// IcCommandError
///
/// Errors surfaced while parsing or running an `icq ic` command.
///

#[derive(Debug, ThisError)]
pub enum IcCommandError {
    #[error("{0}")]
    Usage(String),

    #[error(transparent)]
    Host(#[from] IcHostError),

    #[error(transparent)]
    Clock(#[from] CurrentUnixSecsError),

    #[error(transparent)]
    Io(#[from] io::Error),

    #[error(transparent)]
    Json(#[from] serde_json::Error),
}

pub fn run_matches(matches: &ArgMatches) -> Result<(), IcCommandError> {
    match matches.subcommand() {
        Some(("canister", matches)) => canister::run_matches(matches),
        Some(("metrics", matches)) => metrics::run_matches(matches),
        Some(("network", matches)) => network::run_matches(matches),
        _ => unreachable!("clap requires a known ic subcommand"),
    }
}

pub fn command() -> ClapCommand {
    ClapCommand::new("ic")
        .bin_name("icq ic")
        .about("Inspect official IC Dashboard data")
        .subcommand_required(true)
        .subcommand(canister::command())
        .subcommand(metrics::command())
        .subcommand(network::command())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cli::clap::render_help;
    use std::ffi::OsString;

    #[test]
    fn usage_discloses_dashboard_command_families() {
        let usage = render_help(command());

        assert!(usage.contains("Usage: icq ic <COMMAND>"));
        assert!(usage.contains("canister"));
        assert!(usage.contains("metrics"));
        assert!(usage.contains("network"));
    }

    #[test]
    fn family_and_nested_help_return_without_network_calls() {
        for args in [
            &["ic", "--help"][..],
            &["ic", "canister", "--help"],
            &["ic", "canister", "info", "--help"],
            &["ic", "canister", "count", "--help"],
            &["ic", "canister", "page", "--help"],
            &["ic", "metrics", "--help"],
            &["ic", "network", "--help"],
            &["ic", "network", "boundary-node-data-centers", "--help"],
            &["ic", "network", "daily-stats", "--help"],
        ] {
            assert!(crate::run(args.iter().map(OsString::from)).is_ok());
        }
    }
}