ic-backup 0.63.0

Host-side snapshot backup and same-release recovery for Internet Computer canisters
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

//! Shared original-plan fixture builders; assertions remain beside their owners.

use crate::model::artifacts::ArtifactChecksumRecord;
use crate::model::operation_plan::*;
use crate::model::{
    attempt_journal::AttemptBudgetRecord,
    inventory::{InventoryRecord, InventoryTargetRecord, InventoryTargetRequest},
};

pub(crate) const ROOT: &str = "aaaaa-aa";
pub(crate) const APP: &str = "renrk-eyaaa-aaaaa-aaada-cai";
pub(crate) fn request() -> OperationPlanRequest {
    let inventory = InventoryRecord::new(
        [(ROOT, None), (APP, Some(ROOT))]
            .into_iter()
            .map(|(id, parent)| {
                InventoryTargetRecord::new(&InventoryTargetRequest {
                    canister_id: id.into(),
                    parent_canister_id: parent.map(str::to_owned),
                    role: None,
                    module_hash: None,
                })
                .expect("row")
            })
            .collect(),
    )
    .expect("inventory");
    OperationPlanRequest {
        context: PlanContextRecord::new(&PlanContextRequest {
            network: "ab".repeat(32),
            caller: "2vxsx-fae".into(),
            release: "cd".repeat(32),
        })
        .expect("context"),
        inventory,
        selected_targets: vec![APP.into()],
        operations: vec![
            operation(0, APP, "ef", 1, 1),
            PlannedOperationRecord::new(PlannedOperationRequest {
                depends_on: vec![0],
                ..operation_request(&operation(7, APP, "01", 2, 1))
            })
            .unwrap(),
        ],
        budget: PlanBudgetRecord::new(3, 2).expect("aggregate ceilings"),
    }
}
/// Replace the operation catalog and aggregate budget together.
/// Context, inventory and selected targets stay with the fixture's declaration.
pub(crate) fn single_operation_request(
    mut original: OperationPlanRequest,
    mut operation: PlannedOperationRequest,
) -> OperationPlanRequest {
    operation.depends_on.clear();
    original.budget = PlanBudgetRecord::new(
        operation.budget.mutations(),
        operation.budget.observations(),
    )
    .unwrap();
    original.operations = vec![PlannedOperationRecord::new(operation).unwrap()];
    original
}

pub(crate) fn operation(
    id: u64,
    target: &str,
    hash: &str,
    mutations: u32,
    observations: u32,
) -> PlannedOperationRecord {
    PlannedOperationRecord::new(PlannedOperationRequest {
        depends_on: vec![],
        operation_sequence: id,
        target: target.into(),
        request: hash.repeat(32),
        budget: AttemptBudgetRecord::new(mutations, observations).expect("finite operation"),
    })
    .expect("operation")
}

/// Copy a valid declaration for typed fixture changes, without a JSON round trip.
pub(crate) fn declaration(plan: &OperationPlanRecord) -> OperationPlanRequest {
    OperationPlanRequest {
        context: plan.context().clone(),
        inventory: plan.inventory().clone(),
        selected_targets: plan.selected_targets().to_vec(),
        operations: plan.operations().to_vec(),
        budget: plan.budget().clone(),
    }
}

pub(crate) fn operation_request(operation: &PlannedOperationRecord) -> PlannedOperationRequest {
    PlannedOperationRequest {
        depends_on: operation.depends_on().to_vec(),
        operation_sequence: operation.operation_sequence(),
        target: operation.target().into(),
        request: operation.request().into(),
        budget: operation.budget().clone(),
    }
}

pub(crate) fn set_dependencies(
    plan: &mut OperationPlanRequest,
    dependencies: impl IntoIterator<Item = (u64, Vec<u64>)>,
) {
    for (sequence, depends_on) in dependencies {
        let row = plan
            .operations
            .iter_mut()
            .find(|row| row.operation_sequence() == sequence)
            .unwrap();
        let mut request = operation_request(row);
        request.depends_on = depends_on;
        *row = PlannedOperationRecord::new(request).unwrap();
    }
}

pub fn plan() -> OperationPlanRecord {
    OperationPlanRecord::new(request()).expect("original qualified plan fixture")
}

pub(crate) fn plan_for_request(
    digest: &crate::model::artifacts::ArtifactChecksumRecord,
) -> OperationPlanRecord {
    let mut original = request();
    original.operations[1] = PlannedOperationRecord::new(PlannedOperationRequest {
        request: digest.hash().into(),
        ..operation_request(&original.operations[1])
    })
    .unwrap();
    OperationPlanRecord::new(original).unwrap()
}

pub fn hash(pair: &str) -> crate::model::artifacts::ArtifactChecksumRecord {
    ArtifactChecksumRecord::from_hash(&pair.repeat(32)).expect("opaque exact SHA-256")
}