canic-cli 0.65.17

Operator CLI for Canic fleet setup, builds, evidence, catalog, backup, and restore workflows
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

use super::{DeployCommandError, catalog, compare, resume_report, root, truth};
use crate::{
    cli::{
        clap::{parse_subcommand, passthrough_subcommand, render_usage},
        help::print_help_or_version,
    },
    version_text,
};
use clap::Command as ClapCommand;
use std::ffi::OsString;

const DEPLOY_INSPECT_HELP_AFTER: &str = "\
Examples:
  canic deploy inspect plan demo
  canic deploy inspect inventory demo
  canic deploy inspect diff demo
  canic deploy inspect report demo
  canic deploy inspect compare --left staging-check.json --right prod-check.json
  canic deploy inspect catalog list
  canic deploy inspect root --request root-verification.json
  canic deploy inspect resume-report --receipt receipt.json demo

These commands print raw deployment-truth JSON artifacts without installing,
resuming, or mutating state. Use `canic deploy check --format text` for the
compact operator summary.";

pub(super) fn run<I>(args: I) -> Result<(), DeployCommandError>
where
    I: IntoIterator<Item = OsString>,
{
    let args = args.into_iter().collect::<Vec<_>>();
    if print_help_or_version(&args, usage, version_text()) {
        return Ok(());
    }

    match parse_subcommand(command(), args).map_err(|_| DeployCommandError::Usage(usage()))? {
        None => {
            println!("{}", usage());
            Ok(())
        }
        Some((command, args)) => match command.as_str() {
            "plan" => truth::run_plan(args),
            "inventory" => truth::run_inventory(args),
            "diff" => truth::run_diff(args),
            "report" => truth::run_report(args),
            "compare" => compare::run(args),
            "catalog" => catalog::run(args),
            "root" => root::run_inspect(args),
            "resume-report" => resume_report::run(args),
            _ => unreachable!("deploy inspect dispatch only defines known commands"),
        },
    }
}

pub(super) fn command() -> ClapCommand {
    [
        "plan",
        "inventory",
        "diff",
        "report",
        "compare",
        "catalog",
        "root",
        "resume-report",
    ]
    .into_iter()
    .fold(
        ClapCommand::new("inspect")
            .bin_name("canic deploy inspect")
            .about("Inspect raw deployment truth artifacts")
            .disable_help_flag(true),
        |command, name| command.subcommand(passthrough_subcommand(ClapCommand::new(name))),
    )
    .after_help(DEPLOY_INSPECT_HELP_AFTER)
}

pub(super) fn usage() -> String {
    render_usage(command)
}