canic 0.110.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

//! Module: testing::managed_component_group::model
//!
//! Responsibility: define the bounded public inputs and read-only fixture catalogue.
//! Does not own: authority compilation, PocketIC effects, or application assertions.
//! Boundary: callers provide role Wasms; Canic derives every protected identity from config.

use crate::ids::{CanisterRole, ComponentGroupMemberPath, ComponentSpecId};
use candid::Principal;

use super::DEFAULT_INSTALL_CYCLES;

/// Exact built Wasm and optional application init bytes for one configured role.
#[derive(Clone, Debug)]
pub struct ManagedRoleQualificationArtifact {
    /// Application init bytes passed after Canic's protected init payload.
    pub application_init_args: Option<Vec<u8>>,
    /// Cycles added to each fixture canister using this role.
    pub install_cycles: u128,
    /// Exact configured role implemented by the Wasm.
    pub role: CanisterRole,
    /// Exact managed Wasm under qualification.
    pub wasm: Vec<u8>,
}

impl ManagedRoleQualificationArtifact {
    /// Construct one role artifact with bounded test defaults.
    #[must_use]
    pub const fn new(role: CanisterRole, wasm: Vec<u8>) -> Self {
        Self {
            application_init_args: None,
            install_cycles: DEFAULT_INSTALL_CYCLES,
            role,
            wasm,
        }
    }
}

/// Exact downstream inputs for one managed Component Group qualification fixture.
pub struct ManagedComponentGroupQualificationInput<'a> {
    /// Fleet-admitted callers embedded in every enrolled local projection.
    pub admitted_principals: Vec<Principal>,
    /// Exact Canic configuration source compiled into every tested Wasm.
    /// The caller must retain and compare these build-input bytes before constructing this input;
    /// the release manifest binds artifacts and topology, not every runtime publication setting.
    /// This source never overrides configuration embedded in the supplied Wasms.
    pub app_config_source: &'a str,
    /// Exact Component Group deployment materialized by the fixture.
    pub component_group_deployment: &'a str,
    /// Placement ordinal used by the synthetic local group authority.
    pub component_group_ordinal: u32,
    /// Exact artifact for every role contained by the selected Component Specs.
    pub role_artifacts: Vec<ManagedRoleQualificationArtifact>,
    /// Finalized release-build identity embedded in every managed init payload.
    pub release_build_id: &'a str,
}

impl<'a> ManagedComponentGroupQualificationInput<'a> {
    /// Construct one complete group input with the first placement ordinal.
    #[must_use]
    pub const fn new(
        app_config_source: &'a str,
        component_group_deployment: &'a str,
        release_build_id: &'a str,
        admitted_principals: Vec<Principal>,
        role_artifacts: Vec<ManagedRoleQualificationArtifact>,
    ) -> Self {
        Self {
            admitted_principals,
            app_config_source,
            component_group_deployment,
            component_group_ordinal: 0,
            role_artifacts,
            release_build_id,
        }
    }
}

/// One installed node in the caller-readable managed Component tree catalogue.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ManagedComponentNode {
    /// Complete protected binding installed into the node.
    pub binding: crate::ids::ManagedCanisterBinding,
    /// Exact installed Principal.
    pub canister_id: Principal,
    /// Component Group member path owning the complete Component tree.
    pub component_group_member: ComponentGroupMemberPath,
    /// Exact Component Spec owning the tree.
    pub component_spec: ComponentSpecId,
    /// Direct parent for a managed child; absent for a top-level Component.
    pub parent_canister_id: Option<Principal>,
    /// Exact configured role installed at this Principal.
    pub role: CanisterRole,
}