canic-cli 0.80.5

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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use super::*;
use crate::{CliError, cli_error_exit_code};

#[test]
fn state_command_exposes_audit_and_manifest_subcommands() {
    let parsed = parse_required_subcommand(
        state_command(),
        [OsString::from(AUDIT_COMMAND), OsString::from("--json")],
    )
    .expect("parse state audit");

    assert_eq!(parsed.0, AUDIT_COMMAND);
    assert_eq!(parsed.1, vec![OsString::from("--json")]);

    let help = usage();
    assert!(help.contains("canic state audit"));
    assert!(help.contains("canic state manifest"));
    assert!(help.contains("diagnostic-only"));
    assert!(help.contains("do not read stable"));
    assert!(help.contains("write generated files"));
    assert!(help.contains("mutate canisters"));
}

#[test]
fn parses_supported_audit_options() {
    let options = StateOptions::parse_audit([
        OsString::from("--role"),
        OsString::from("root"),
        OsString::from("--json"),
    ])
    .expect("parse audit options");

    assert_eq!(options.role.as_deref(), Some("root"));
    assert!(options.json);
}

#[test]
fn parses_supported_manifest_options() {
    let options = StateOptions::parse_manifest([
        OsString::from("--role"),
        OsString::from("root"),
        OsString::from("--json"),
    ])
    .expect("parse manifest options");

    assert_eq!(options.role.as_deref(), Some("root"));
    assert!(options.json);
}

#[test]
fn rejects_hard_cut_state_forms() {
    assert!(matches!(run([]), Err(StateCommandError::Usage(_))));
    for command in ["migrate", "repair", "explore", "dump"] {
        assert!(matches!(
            run([OsString::from(command)]),
            Err(StateCommandError::Usage(_))
        ));
        assert!(parse_required_subcommand(state_command(), [OsString::from(command)]).is_err());
    }

    for args in [
        vec![OsString::from("root")],
        vec![OsString::from("--force")],
        vec![OsString::from("--format"), OsString::from("json")],
        vec![OsString::from("--out"), OsString::from("state.json")],
    ] {
        assert!(matches!(
            StateOptions::parse_audit(args.clone()),
            Err(StateCommandError::Usage(_))
        ));
        assert!(matches!(
            StateOptions::parse_manifest(args),
            Err(StateCommandError::Usage(_))
        ));
    }

    for args in [
        vec![OsString::from(AUDIT_COMMAND), OsString::from("root")],
        vec![OsString::from(MANIFEST_COMMAND), OsString::from("root")],
        vec![
            OsString::from(AUDIT_COMMAND),
            OsString::from("--format"),
            OsString::from("json"),
        ],
        vec![
            OsString::from(MANIFEST_COMMAND),
            OsString::from("--format"),
            OsString::from("json"),
        ],
    ] {
        assert!(matches!(run(args), Err(StateCommandError::Usage(_))));
    }
}

#[test]
fn audit_json_uses_schema_version_one() {
    let report = build_state_audit_report(Some("root"));
    let json = serde_json::to_value(&report).expect("state audit report serializes");

    assert_eq!(json["schema_version"], 1);
    assert_eq!(json["command"], "canic state audit");
    assert_eq!(json["scope"], "role");
    assert_eq!(json["role"], "root");
    assert_eq!(json["status"], "warn");
    assert!(
        json["checks"]
            .as_array()
            .expect("checks")
            .iter()
            .any(|check| check["code"] == "snapshot_name_invalid")
    );
}

#[test]
fn manifest_json_is_manifest_directly() {
    let manifest = declared_state_manifest(Some("root"));
    let json = serde_json::to_value(&manifest).expect("state manifest serializes");

    assert_eq!(json["schema_version"], 1);
    assert!(json.get("command").is_none());
    assert_eq!(json["roles"][0]["canister_role"], "root");
}

#[test]
fn text_renderers_include_stable_fields() {
    let report = build_state_audit_report(Some("root"));
    let audit = render_audit_text(&report);
    let manifest = render_manifest_text(&declared_state_manifest(Some("root")));

    assert!(audit.contains("schema_version: 1"));
    assert!(audit.contains("scope: role"));
    assert!(audit.contains("snapshot [warn] snapshot_name_invalid"));
    assert!(audit.contains("source: state_manifest"));
    assert!(manifest.contains("canic state manifest"));
    assert!(manifest.contains("migration_policy: new_domain"));
    assert!(manifest.contains("removed_state"));
}

#[test]
fn failing_state_audit_uses_exit_code_one() {
    let err = run_audit(vec![OsString::from("--role"), OsString::from("missing")])
        .expect_err("missing role fails audit");

    assert!(matches!(err, StateCommandError::AuditFailed));
    assert_eq!(
        cli_error_exit_code(&CliError::State(err)),
        i32::from(StateCommandError::AuditFailed.exit_code())
    );
}