canic-backup 0.94.12

Manifest and orchestration primitives for Canic deployment backup and restore
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

use super::{
    BackupExecutionJournalError, BackupExecutionJournalOperation, BackupExecutionOperationState,
    validation::{validate_nonempty, validate_optional_nonempty},
};

impl BackupExecutionJournalOperation {
    pub(super) fn from_plan_operation(operation: &crate::plan::BackupOperation) -> Self {
        Self {
            sequence: usize::try_from(operation.order).unwrap_or(usize::MAX),
            operation_id: operation.operation_id.clone(),
            kind: operation.kind.clone(),
            target_canister_id: operation.target_canister_id.clone(),
            state: BackupExecutionOperationState::Ready,
            state_updated_at: None,
            snapshot_ids_before: None,
            blocking_reasons: Vec::new(),
        }
    }

    pub(super) fn validate(&self) -> Result<(), BackupExecutionJournalError> {
        validate_nonempty("operations[].operation_id", &self.operation_id)?;
        validate_optional_nonempty(
            "operations[].state_updated_at",
            self.state_updated_at.as_deref(),
        )?;
        validate_optional_nonempty(
            "operations[].target_canister_id",
            self.target_canister_id.as_deref(),
        )?;
        self.validate_snapshot_inventory()?;
        if matches!(
            self.state,
            BackupExecutionOperationState::Pending
                | BackupExecutionOperationState::Completed
                | BackupExecutionOperationState::Failed
                | BackupExecutionOperationState::Skipped
        ) && self.state_updated_at.is_none()
        {
            return Err(BackupExecutionJournalError::MissingField(
                "operations[].state_updated_at",
            ));
        }
        match self.state {
            BackupExecutionOperationState::Blocked | BackupExecutionOperationState::Failed
                if self.blocking_reasons.is_empty() =>
            {
                Err(BackupExecutionJournalError::OperationMissingReason(
                    self.sequence,
                ))
            }
            BackupExecutionOperationState::Ready
            | BackupExecutionOperationState::Pending
            | BackupExecutionOperationState::Completed
            | BackupExecutionOperationState::Skipped
                if !self.blocking_reasons.is_empty() =>
            {
                Err(BackupExecutionJournalError::UnblockedOperationHasReasons(
                    self.sequence,
                ))
            }
            BackupExecutionOperationState::Ready
            | BackupExecutionOperationState::Pending
            | BackupExecutionOperationState::Blocked
            | BackupExecutionOperationState::Completed
            | BackupExecutionOperationState::Failed
            | BackupExecutionOperationState::Skipped => Ok(()),
        }
    }

    fn validate_snapshot_inventory(&self) -> Result<(), BackupExecutionJournalError> {
        let Some(snapshot_ids) = &self.snapshot_ids_before else {
            if self.kind == crate::plan::BackupOperationKind::CreateSnapshot
                && matches!(
                    self.state,
                    BackupExecutionOperationState::Pending
                        | BackupExecutionOperationState::Completed
                        | BackupExecutionOperationState::Failed
                )
            {
                return Err(BackupExecutionJournalError::MissingField(
                    "operations[].snapshot_ids_before",
                ));
            }
            return Ok(());
        };
        if self.kind != crate::plan::BackupOperationKind::CreateSnapshot {
            return Err(BackupExecutionJournalError::UnexpectedSnapshotInventory(
                self.sequence,
            ));
        }
        let mut unique = std::collections::BTreeSet::new();
        for snapshot_id in snapshot_ids {
            validate_nonempty("operations[].snapshot_ids_before[]", snapshot_id)?;
            if !unique.insert(snapshot_id) {
                return Err(BackupExecutionJournalError::DuplicateSnapshotIdentity {
                    sequence: self.sequence,
                    snapshot_id: snapshot_id.clone(),
                });
            }
        }
        Ok(())
    }
}