canic-cli 0.35.11

Operator CLI for Canic fleet 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

use super::*;
use crate::support::path_stamp::backup_directory_stamp_from_unix;

const ROOT: &str = "aaaaa-aa";

// Ensure option parsing covers the intended dry-run command.
#[test]
fn parses_download_options() {
    let options = SnapshotDownloadOptions::parse([
        OsString::from("demo"),
        OsString::from("--canister"),
        OsString::from(ROOT),
        OsString::from("--out"),
        OsString::from("backups/test"),
        OsString::from("--root"),
        OsString::from(ROOT),
        OsString::from("--recursive"),
        OsString::from("--dry-run"),
        OsString::from("--resume-after-snapshot"),
    ])
    .expect("parse options");

    assert_eq!(options.canister.as_deref(), Some(ROOT));
    assert_eq!(options.fleet, "demo");
    assert_eq!(options.out.as_deref(), Some(Path::new("backups/test")));
    assert!(options.include_children);
    assert!(options.recursive);
    assert!(options.dry_run);
    assert_eq!(options.root.as_deref(), Some(ROOT));
    assert_eq!(options.lifecycle, SnapshotLifecycleMode::StopAndResume);
}

// Ensure --out can be omitted for the common named-fleet backup flow.
#[test]
fn download_options_default_output_directory() {
    let options = SnapshotDownloadOptions::parse([
        OsString::from("demo"),
        OsString::from("--canister"),
        OsString::from(ROOT),
        OsString::from("--recursive"),
    ])
    .expect("parse options");
    let out = default_snapshot_output_path(&options.fleet);
    let out = out.to_string_lossy();

    assert!(out.starts_with("backups/fleet-"));
    assert!(out.chars().last().is_some_and(|last| last.is_ascii_digit()));
}

// Ensure a named fleet can be selected without spelling out its root canister.
#[test]
fn parses_download_fleet_options_without_canister() {
    let options =
        SnapshotDownloadOptions::parse([OsString::from("demo"), OsString::from("--dry-run")])
            .expect("parse options");

    assert_eq!(options.fleet, "demo");
    assert_eq!(options.canister, None);
    assert!(options.dry_run);
}

// Ensure explicit fleet/canister selections fail when the registry omits the canister.
#[test]
fn fleet_membership_rejects_unknown_canister() {
    let registry = serde_json::json!({
        "Ok": [
            {
                "pid": ROOT,
                "role": "root",
                "record": { "parent_pid": null }
            }
        ]
    })
    .to_string();
    let err = validate_fleet_membership_json("demo", "missing-cai", &registry)
        .expect_err("missing canister should reject");

    assert!(matches!(
        err,
        SnapshotCommandError::CanisterNotInFleet { fleet, canister }
            if fleet == "demo" && canister == "missing-cai"
    ));
}

// Ensure generated default path labels are filesystem-friendly.
#[test]
fn snapshot_default_path_sanitizes_labels() {
    assert_eq!(file_safe_component("demo fleet/root"), "demo-fleet-root");
}

// Ensure default backup directory timestamps are compact calendar labels.
#[test]
fn backup_directory_stamp_uses_calendar_time() {
    assert_eq!(backup_directory_stamp_from_unix(0), "19700101-000000");
    assert_eq!(
        backup_directory_stamp_from_unix(1_715_090_400),
        "20240507-140000"
    );
}