canic-cli 0.68.0

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
150
151
152

//! Module: backup::create::persistence
//!
//! Responsibility: persist and validate backup create execution layouts.
//! Does not own: backup planning, CLI option parsing, or runner execution.
//! Boundary: backup plan/journal filesystem state for create and resume.

use super::super::{BackupCommandError, layout::ensure_execution_journal_exists};
use canic_backup::{
    execution::BackupExecutionJournal, persistence::BackupLayout, plan::BackupPlan,
};
use std::path::Path;

pub(super) struct PersistedBackupCreateLayout {
    pub(super) plan: BackupPlan,
    pub(super) reused_existing: bool,
}

pub(super) fn persist_backup_create_layout(
    out: &Path,
    plan: &BackupPlan,
) -> Result<PersistedBackupCreateLayout, BackupCommandError> {
    let layout = BackupLayout::new(out.to_path_buf());
    if layout.backup_plan_path().is_file() {
        let existing = layout.read_backup_plan()?;
        ensure_resume_plan_compatible(&existing, plan)?;
        if !layout.execution_journal_path().is_file() {
            if layout.manifest_path().is_file() {
                ensure_execution_journal_exists(&layout)?;
            }
            let journal = BackupExecutionJournal::from_plan(&existing)?;
            layout.write_execution_journal(&journal)?;
        }
        layout.verify_execution_integrity()?;
        return Ok(PersistedBackupCreateLayout {
            plan: existing,
            reused_existing: true,
        });
    }

    let journal = BackupExecutionJournal::from_plan(plan)?;
    layout.write_backup_plan(plan)?;
    layout.write_execution_journal(&journal)?;
    layout.verify_execution_integrity()?;
    Ok(PersistedBackupCreateLayout {
        plan: plan.clone(),
        reused_existing: false,
    })
}

fn ensure_resume_plan_compatible(
    existing: &BackupPlan,
    requested: &BackupPlan,
) -> Result<(), BackupCommandError> {
    compare_resume_field("deployment", &existing.fleet, &requested.fleet)?;
    compare_resume_field("network", &existing.network, &requested.network)?;
    compare_resume_field(
        "root_canister_id",
        &existing.root_canister_id,
        &requested.root_canister_id,
    )?;
    compare_resume_field(
        "selected_scope_kind",
        &format!("{:?}", existing.selected_scope_kind),
        &format!("{:?}", requested.selected_scope_kind),
    )?;
    compare_resume_field(
        "selected_subtree_root",
        &optional_string(existing.selected_subtree_root.as_ref()),
        &optional_string(requested.selected_subtree_root.as_ref()),
    )?;
    compare_resume_field(
        "requires_root_controller",
        &existing.requires_root_controller.to_string(),
        &requested.requires_root_controller.to_string(),
    )?;
    compare_resume_field(
        "snapshot_read_authority",
        &format!("{:?}", existing.snapshot_read_authority),
        &format!("{:?}", requested.snapshot_read_authority),
    )?;
    compare_resume_field(
        "quiescence_policy",
        &format!("{:?}", existing.quiescence_policy),
        &format!("{:?}", requested.quiescence_policy),
    )?;
    compare_resume_field(
        "targets",
        &target_signature(existing),
        &target_signature(requested),
    )?;
    compare_resume_field(
        "operations",
        &operation_signature(existing),
        &operation_signature(requested),
    )?;
    Ok(())
}

fn compare_resume_field(
    field: &'static str,
    existing: &str,
    requested: &str,
) -> Result<(), BackupCommandError> {
    if existing == requested {
        return Ok(());
    }

    Err(BackupCommandError::BackupLayoutMismatch {
        field,
        existing: existing.to_string(),
        requested: requested.to_string(),
    })
}

fn optional_string(value: Option<&String>) -> String {
    value.map_or_else(|| "-".to_string(), ToString::to_string)
}

fn target_signature(plan: &BackupPlan) -> String {
    plan.targets
        .iter()
        .map(|target| {
            format!(
                "{}:{}:{}:{}:{:?}:{:?}:{:?}:{}",
                target.canister_id,
                target.role.as_deref().unwrap_or("-"),
                target.parent_canister_id.as_deref().unwrap_or("-"),
                target.depth,
                target.control_authority,
                target.snapshot_read_authority,
                target.identity_mode,
                target.expected_module_hash.as_deref().unwrap_or("-")
            )
        })
        .collect::<Vec<_>>()
        .join("|")
}

fn operation_signature(plan: &BackupPlan) -> String {
    plan.phases
        .iter()
        .map(|operation| {
            format!(
                "{}:{:?}:{}",
                operation.operation_id,
                operation.kind,
                operation.target_canister_id.as_deref().unwrap_or("-")
            )
        })
        .collect::<Vec<_>>()
        .join("|")
}