canic-core 0.35.7

Canic — a canister orchestration and management toolkit for the Internet Computer
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

//! Lifecycle adapters.
//!
//! This module is public solely so it can be referenced by
//! macro expansions in downstream crates. It is not intended
//! for direct use.
//!
//! It must remain synchronous and minimal.

pub mod init;
pub mod upgrade;

use crate::{config::schema::ConfigModel, ops::ic::IcOps};
use std::fmt;

///
/// LifecyclePhase
///

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum LifecyclePhase {
    Init,
    PostUpgrade,
}

impl fmt::Display for LifecyclePhase {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Init => f.write_str("init"),
            Self::PostUpgrade => f.write_str("post_upgrade"),
        }
    }
}

pub fn lifecycle_trap(phase: LifecyclePhase, err: impl fmt::Display) -> ! {
    crate::cdk::api::trap(format!("{phase}: {err}"))
}

fn config_with_current_root_controller(config: ConfigModel) -> ConfigModel {
    config_with_root_controller(config, IcOps::msg_caller())
}

fn config_with_root_controller(
    mut config: ConfigModel,
    controller: crate::cdk::candid::Principal,
) -> ConfigModel {
    if !config.controllers.contains(&controller) {
        config.controllers.push(controller);
    }
    config
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::cdk::candid::Principal;

    fn p(byte: u8) -> Principal {
        Principal::from_slice(&[byte])
    }

    #[test]
    fn config_with_root_controller_appends_installing_controller() {
        let config = config_with_root_controller(ConfigModel::default(), p(7));

        assert_eq!(config.controllers, vec![p(7)]);
    }

    #[test]
    fn config_with_root_controller_deduplicates_existing_controller() {
        let mut config = ConfigModel {
            controllers: vec![p(7), p(8)],
            ..Default::default()
        };

        config = config_with_root_controller(config, p(7));

        assert_eq!(config.controllers, vec![p(7), p(8)]);
    }
}