canic-core 0.99.25

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

// Category A - Internal runtime-configured tests (ConfigTestBuilder when needed).

use crate::{
    cdk::candid::Principal,
    cdk::types::Cycles,
    config::schema::{
        CanisterAuthConfig, CanisterConfig, CanisterKind, CyclesFundingPolicyConfig,
        DiagnosticsCanisterConfig, MetricsCanisterConfig, ShardPool, ShardPoolPolicy,
        ShardingConfig, StandardsCanisterConfig,
    },
    ids::{CanisterRole, CanonicalNetworkId, FleetId, FleetKey, SubnetSlotId},
    ops::runtime::env::EnvOps,
    storage::stable::env::{EnvData, EnvRecord},
    test::config::ConfigTestBuilder,
};

#[must_use]
pub fn fleet_key(byte: u8) -> FleetKey {
    FleetKey {
        network: CanonicalNetworkId::public_ic(),
        fleet_id: FleetId::from_generated_bytes([byte.saturating_add(1); 32]),
    }
}

pub fn init_sharding_test_config() {
    let mut sharding = ShardingConfig::default();
    sharding.pools.insert(
        "primary".to_string(),
        ShardPool {
            canister_role: CanisterRole::from("shard"),
            policy: ShardPoolPolicy {
                capacity: 1,
                initial_shards: 1,
                max_shards: 2,
            },
        },
    );

    let root_cfg = CanisterConfig {
        kind: CanisterKind::Root,
        initial_cycles: Cycles::new(5_000_000_000_000),
        topup: None,
        icp_refill: None,
        cycles_funding: CyclesFundingPolicyConfig::default(),
        scaling: None,
        sharding: None,
        binding: None,
        auth: CanisterAuthConfig::default(),
        standards: StandardsCanisterConfig::default(),
        diagnostics: DiagnosticsCanisterConfig::default(),
        metrics: MetricsCanisterConfig::default(),
    };

    let manager_cfg = CanisterConfig {
        kind: CanisterKind::Service,
        initial_cycles: Cycles::new(5_000_000_000_000),
        topup: None,
        icp_refill: None,
        cycles_funding: CyclesFundingPolicyConfig::default(),
        scaling: None,
        sharding: Some(sharding),
        binding: None,
        auth: CanisterAuthConfig::default(),
        standards: StandardsCanisterConfig::default(),
        diagnostics: DiagnosticsCanisterConfig::default(),
        metrics: MetricsCanisterConfig::default(),
    };

    let shard_cfg = CanisterConfig {
        kind: CanisterKind::Shard,
        initial_cycles: Cycles::new(5_000_000_000_000),
        topup: None,
        icp_refill: None,
        cycles_funding: CyclesFundingPolicyConfig::default(),
        scaling: None,
        sharding: None,
        binding: None,
        auth: CanisterAuthConfig::default(),
        standards: StandardsCanisterConfig::default(),
        diagnostics: DiagnosticsCanisterConfig::default(),
        metrics: MetricsCanisterConfig::default(),
    };

    let _config = ConfigTestBuilder::new()
        .with_default_canister(CanisterRole::ROOT, root_cfg)
        .with_default_canister("manager", manager_cfg)
        .with_default_canister("shard", shard_cfg)
        .install();

    // Single synthetic principal for root/subnet/parent roles in tests.
    let root_pid = Principal::from_slice(&[1; 29]);
    import_test_env("manager", SubnetSlotId::DEFAULT, root_pid);
}

/// Imports a synthetic runtime env for unit tests.
///
/// # Panics
///
/// Panics if the synthetic environment snapshot fails runtime import.
pub fn import_test_env(
    canister_role: impl Into<CanisterRole>,
    subnet_slot: impl Into<SubnetSlotId>,
    root_pid: Principal,
) {
    let snapshot = EnvRecord {
        canister_role: Some(canister_role.into()),
        subnet_slot: Some(subnet_slot.into()),
        root_pid: Some(root_pid),
        fleet_root_pid: Some(root_pid),
        subnet_pid: Some(root_pid),
        parent_pid: Some(root_pid),
    };

    EnvOps::import(EnvData { record: snapshot }).expect("import test env");
}