canic-host 0.111.0

Host-side App build and desired-state Fleet reconciliation library for Canic workspaces
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
153
154
155
156
157

//! Additional funding keeps earlier debit and original custody in the same approval equation.

use super::*;
use crate::fleet_ensure::{
    model::capacity_import::survey::CapacityImportSampleRecord,
    policy::capacity_import::{
        tests::{plan, principal},
        validate_plan,
    },
};

fn funded() -> CapacityImportPlanRecord {
    let mut plan = plan();
    let source = &mut plan.sources[0];
    let before = CapacityImportSampleRecord {
        binding: source.binding.clone(),
        cycles: source.observed_cycles,
        reserved_cycles: source.observed_reserved_cycles,
    };
    let mut observed = before.clone();
    observed.cycles += 80;
    plan.funding_credits
        .push(CapacityImportFundingCreditRecord {
            origin: CapacityImportFundingOrigin::Survey {
                request_sha256: [7; 32],
            },
            before,
            observed,
            credited_cycles: 100,
        });
    source.observed_cycles += 100;
    plan
}

#[test]
fn additional_credit_preserves_prior_debit_and_native_floor() {
    let mut plan = funded();
    validate_plan(&plan).unwrap();
    assert_eq!(plan.sources[0].maximum_debit_cycles, 200);
    plan.funding_credits[0].observed.cycles = 899;
    assert!(matches!(
        validate_plan(&plan),
        Err(CapacityImportPolicyError::ConservationUnproven { .. })
    ));
    plan.funding_credits[0].observed.cycles = 799;
    plan.funding_credits[0].observed.reserved_cycles = 201;
    assert_eq!(
        validate_plan(&plan),
        Err(CapacityImportPolicyError::InsufficientCycles {
            canister: principal(9),
            required_cycles: 800,
            available_cycles: 799,
            shortfall_cycles: 1,
        })
    );
}

#[test]
fn credit_rejects_custody_changes_and_fictional_baselines() {
    let original = funded();
    let mut changed = original.clone();
    changed.funding_credits[0].observed.binding.controllers = vec![principal(99)];
    assert!(matches!(
        validate_plan(&changed),
        Err(CapacityImportPolicyError::SourceChanged { .. })
    ));
    let mut changed = original.clone();
    changed.funding_credits[0].observed.cycles = 1_101;
    validate_plan(&changed).unwrap();
    let mut changed = original.clone();
    changed.sources[0].observed_cycles -= 1;
    assert!(matches!(
        validate_plan(&changed),
        Err(CapacityImportPolicyError::ConservationUnproven { .. })
    ));
    let mut changed = original.clone();
    changed
        .funding_credits
        .push(changed.funding_credits[0].clone());
    assert_eq!(
        validate_plan(&changed),
        Err(CapacityImportPolicyError::InvalidSources)
    );
    let mut changed = original;
    changed.funding_credits[0].credited_cycles = 0;
    assert_eq!(
        validate_plan(&changed),
        Err(CapacityImportPolicyError::InvalidCycleBounds)
    );
}

#[test]
fn root_credit_keeps_root_debit_and_paid_call_limits() {
    let mut plan = plan();
    let budget = plan.root_budget;
    let mut binding = plan.sources[0].binding.clone();
    binding.canister_id = plan.authority.root;
    let before = CapacityImportSampleRecord {
        binding,
        cycles: budget.observed_cycles,
        reserved_cycles: budget.observed_reserved_cycles,
    };
    let mut observed = before.clone();
    observed.cycles += 80;
    plan.root_budget.observed_cycles += 100;
    plan.funding_credits
        .push(CapacityImportFundingCreditRecord {
            origin: CapacityImportFundingOrigin::BootstrapTerminal {
                plan_sha256: "07".repeat(32),
            },
            before,
            observed,
            credited_cycles: 100,
        });
    validate_plan(&plan).unwrap();
    assert_eq!(
        plan.root_budget.maximum_debit_cycles,
        budget.maximum_debit_cycles
    );
    assert_eq!(
        plan.root_budget.maximum_paid_calls,
        budget.maximum_paid_calls
    );
    plan.funding_credits[0].observed.cycles = budget.observed_cycles - 1;
    assert!(matches!(
        validate_plan(&plan),
        Err(CapacityImportPolicyError::ConservationUnproven { .. })
    ));
}

#[test]
fn only_running_root_custody_can_advance_version_between_funding_observations() {
    let mut plan = funded();
    let root = plan.authority.root;
    let credit = &mut plan.funding_credits[0];
    credit.before.binding.stopped = false;
    credit.before.binding.controllers = vec![root];
    credit.observed.binding = credit.before.binding.clone();
    credit.observed.binding.canister_version += 1;
    validate_observation(credit, root, 200, 800).unwrap();
    credit.origin = CapacityImportFundingOrigin::BootstrapSource {
        plan_sha256: "07".repeat(32),
    };
    assert!(matches!(
        validate_observation(credit, root, 200, 800),
        Err(CapacityImportPolicyError::SourceChanged { .. })
    ));
    credit.origin = CapacityImportFundingOrigin::Survey {
        request_sha256: [7; 32],
    };
    credit.before.binding.stopped = true;
    credit.observed.binding.stopped = true;
    assert!(matches!(
        validate_observation(credit, root, 200, 800),
        Err(CapacityImportPolicyError::SourceChanged { .. })
    ));
}