canic-core 0.27.1

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

//! Environment (self) access checks.
//!
//! This bucket is strictly about the canister's own environment state
//! (prime subnet/root status) and build-time structural rules.

use crate::{
    access::AccessError,
    ids::BuildNetwork,
    ops::{ic::network::NetworkOps, runtime::env::EnvOps},
};

///
/// Env Checks
///

pub fn is_prime_root() -> Result<(), AccessError> {
    if EnvOps::is_prime_root() {
        Ok(())
    } else {
        Err(AccessError::Denied(
            "this endpoint is only available on prime root".to_string(),
        ))
    }
}

pub fn is_prime_subnet() -> Result<(), AccessError> {
    if EnvOps::is_prime_subnet() {
        Ok(())
    } else {
        Err(AccessError::Denied(
            "this endpoint is only available on the prime subnet".to_string(),
        ))
    }
}

/// build_network_ic
/// Permits access only when `DFX_NETWORK=ic` was set at build time.
pub fn build_network_ic() -> Result<(), AccessError> {
    check_build_network(BuildNetwork::Ic)
}

/// build_network_local
/// Permits access only when `DFX_NETWORK=local` was set at build time.
pub fn build_network_local() -> Result<(), AccessError> {
    check_build_network(BuildNetwork::Local)
}

///
/// Helpers
///

pub fn check_build_network(expected: BuildNetwork) -> Result<(), AccessError> {
    let actual = NetworkOps::build_network();

    match actual {
        Some(actual) if actual == expected => Ok(()),
        Some(actual) => Err(AccessError::Denied(format!(
            "this endpoint is only available when built for '{expected}' (DFX_NETWORK), but was built for '{actual}'"
        ))),
        None => Err(AccessError::Denied(
            "this endpoint requires a build-time network (DFX_NETWORK) of either 'ic' or 'local'"
                .to_string(),
        )),
    }
}

///
/// TESTS
///

#[cfg(test)]
mod tests {
    use super::*;

    fn check(expected: BuildNetwork, actual: Option<BuildNetwork>) -> Result<(), AccessError> {
        // Inline the same logic but with injected `actual`.
        match actual {
            Some(actual) if actual == expected => Ok(()),
            Some(actual) => Err(AccessError::Denied(format!(
                "this endpoint is only available when built for '{expected}' (DFX_NETWORK), but was built for '{actual}'"
            ))),
            None => Err(AccessError::Denied(
                "this endpoint requires a build-time network (DFX_NETWORK) of either 'ic' or 'local'"
                    .to_string(),
            )),
        }
    }

    #[test]
    fn build_network_matches_expected() {
        assert!(check(BuildNetwork::Ic, Some(BuildNetwork::Ic)).is_ok());
        assert!(check(BuildNetwork::Local, Some(BuildNetwork::Local)).is_ok());
    }

    #[test]
    fn build_network_mismatch_errors() {
        let err = check(BuildNetwork::Ic, Some(BuildNetwork::Local))
            .unwrap_err()
            .to_string();
        assert!(
            err.contains("this endpoint is only available when built for 'ic' (DFX_NETWORK)"),
            "unexpected error: {err}"
        );
    }

    #[test]
    fn build_network_unknown_errors() {
        let err = check(BuildNetwork::Ic, None).unwrap_err().to_string();
        assert!(
            err.contains("this endpoint requires a build-time network (DFX_NETWORK)"),
            "unexpected error: {err}"
        );
    }
}