canic-backup 0.94.3

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
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

//! Module: runner::operations
//!
//! Responsibility: execute one validated backup runner operation.
//! Does not own: plan construction, journal validation, or command implementation.
//! Boundary: converts executor results into durable execution receipts.

mod artifacts;
mod journal;
mod path;

use crate::{
    execution::{
        BackupExecutionJournal, BackupExecutionJournalOperation, BackupExecutionOperationReceipt,
    },
    persistence::{BackupLayout, CommandLifetimeHandle},
    plan::{BackupOperationKind, BackupPlan},
    runner::{
        BackupRunnerCommandError, BackupRunnerConfig, BackupRunnerError, BackupRunnerExecutor,
    },
    timestamp::{current_timestamp_marker, state_updated_at},
};

use artifacts::{
    execute_create_snapshot, execute_download_snapshot, execute_finalize_manifest,
    execute_verify_artifact,
};

pub(super) fn execute_operation_receipt(
    config: &BackupRunnerConfig,
    executor: &mut impl BackupRunnerExecutor,
    layout: &BackupLayout,
    plan: &BackupPlan,
    journal: &BackupExecutionJournal,
    operation: &BackupExecutionJournalOperation,
    command_lifetime: Option<CommandLifetimeHandle>,
) -> Result<BackupExecutionOperationReceipt, BackupRunnerError> {
    match operation.kind {
        BackupOperationKind::Stop => execute_stop(
            executor,
            journal,
            operation,
            required_command_lifetime(operation, command_lifetime)?,
        ),
        BackupOperationKind::CreateSnapshot => execute_create_snapshot(
            executor,
            layout,
            plan,
            journal,
            operation,
            required_command_lifetime(operation, command_lifetime)?,
        ),
        BackupOperationKind::Start => execute_start(
            executor,
            journal,
            operation,
            required_command_lifetime(operation, command_lifetime)?,
        ),
        BackupOperationKind::DownloadSnapshot => execute_download_snapshot(
            executor,
            layout,
            journal,
            operation,
            required_command_lifetime(operation, command_lifetime)?,
        ),
        BackupOperationKind::VerifyArtifact => execute_verify_artifact(layout, journal, operation),
        BackupOperationKind::FinalizeManifest => {
            execute_finalize_manifest(config, layout, plan, journal, operation)
        }
        BackupOperationKind::ValidateTopology
        | BackupOperationKind::ValidateControlAuthority
        | BackupOperationKind::ValidateSnapshotReadAuthority
        | BackupOperationKind::ValidateQuiescencePolicy => {
            Ok(BackupExecutionOperationReceipt::completed(
                journal,
                operation,
                Some(state_updated_at(config.updated_at.as_ref())),
            ))
        }
    }
}

fn execute_stop(
    executor: &mut impl BackupRunnerExecutor,
    journal: &BackupExecutionJournal,
    operation: &BackupExecutionJournalOperation,
    command_lifetime: CommandLifetimeHandle,
) -> Result<BackupExecutionOperationReceipt, BackupRunnerError> {
    let target = operation_target(operation)?;
    executor
        .stop_canister(&target, command_lifetime)
        .map_err(|error| command_failed(operation.sequence, error))?;
    Ok(BackupExecutionOperationReceipt::completed(
        journal,
        operation,
        Some(current_timestamp_marker()),
    ))
}

fn execute_start(
    executor: &mut impl BackupRunnerExecutor,
    journal: &BackupExecutionJournal,
    operation: &BackupExecutionJournalOperation,
    command_lifetime: CommandLifetimeHandle,
) -> Result<BackupExecutionOperationReceipt, BackupRunnerError> {
    let target = operation_target(operation)?;
    executor
        .start_canister(&target, command_lifetime)
        .map_err(|error| command_failed(operation.sequence, error))?;
    Ok(BackupExecutionOperationReceipt::completed(
        journal,
        operation,
        Some(current_timestamp_marker()),
    ))
}

fn required_command_lifetime(
    operation: &BackupExecutionJournalOperation,
    command_lifetime: Option<CommandLifetimeHandle>,
) -> Result<CommandLifetimeHandle, BackupRunnerError> {
    command_lifetime.ok_or_else(|| BackupRunnerError::MissingCommandLifetime {
        sequence: operation.sequence,
        operation_id: operation.operation_id.clone(),
    })
}

fn operation_target(
    operation: &BackupExecutionJournalOperation,
) -> Result<String, BackupRunnerError> {
    operation
        .target_canister_id
        .clone()
        .ok_or(BackupRunnerError::MissingOperationTarget {
            sequence: operation.sequence,
        })
}

fn command_failed(sequence: usize, error: BackupRunnerCommandError) -> BackupRunnerError {
    BackupRunnerError::CommandFailed {
        sequence,
        status: error.status,
        message: error.message,
    }
}