rustic 0.1.9

Library for building canisters on 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
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
158
159

#![cfg(any(test, doc))]
//! Utils for unit testing.
//!
//! In order to use the mock features, use [`crate::utils::canister_caller()`] instead of `ic_cdk::api::caller()`
//! and [`crate::utils::canister_id()`] instead of `ic_cdk::api::id()`, etc.

use candid::Principal;
use std::cell::RefCell;

struct MockData {
    caller: Principal,
    id: Principal,
    version: u64,
    canister_balance: u128,
    time: Option<u64>,
    instruction_counter: Option<u64>,
    controllers: Vec<Principal>,
}

impl MockData {
    fn new() -> Self {
        Self {
            caller: Principal::anonymous(),
            id: Principal::from_text(MOCK_ID).unwrap(),
            version: 0,
            canister_balance: 1000000000000,
            time: None,
            instruction_counter: Some(1000000),
            controllers: vec![],
        }
    }
}

thread_local!(static MOCK_DATA: RefCell<MockData> = RefCell::new(MockData::new()));

/// Sets the mock caller for unit testing.
pub fn set_mock_caller(caller: Principal) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().caller = caller;
    });
}

/// Sets the mock canister id for unit testing.
pub fn set_mock_id(id: Principal) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().id = id;
    });
}

/// Sets the mock system canister version for unit testing.
pub fn set_mock_version(version: u64) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().version = version;
    });
}

/// Sets the mock canister balance for unit testing.
pub fn set_mock_balance(balance: u128) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().canister_balance = balance;
    });
}

/// Sets the mock time for unit testing.
pub fn set_mock_time(time: u64) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().time = Some(time);
    });
}

/// Sets the mock instruction counter for unit testing.
pub fn set_mock_instruction_counter(counter: u64) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().instruction_counter = Some(counter);
    });
}

/// Adds a mock controller for unit testing.
pub fn add_mock_controller(controller: Principal) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().controllers.push(controller);
    });
}

/// Removes a mock controller for unit testing.
pub fn remove_mock_controller(controller: Principal) {
    MOCK_DATA.with(|data| {
        data.borrow_mut().controllers.retain(|c| *c != controller);
    });
}

/// Gets the mock controller for unit testing.
pub fn mock_caller() -> Principal {
    MOCK_DATA.with(|data| data.borrow().caller)
}

/// Gets the mock canister id for unit testing.
pub fn mock_id() -> Principal {
    MOCK_DATA.with(|data| data.borrow().id)
}

/// Gets the mock system canister version for unit testing.
pub fn mock_version() -> u64 {
    MOCK_DATA.with(|data| data.borrow().version)
}

/// Gets the mock canister balance for unit testing.
pub fn mock_balance() -> u128 {
    MOCK_DATA.with(|data| data.borrow().canister_balance)
}

/// Gets the mock time for unit testing.
pub fn mock_time() -> u64 {
    MOCK_DATA.with(|data| {
        if let Some(time) = data.borrow().time {
            time
        } else {
            std::time::SystemTime::now()
                .duration_since(std::time::SystemTime::UNIX_EPOCH)
                .unwrap()
                .as_nanos() as u64
        }
    })
}

/// Gets the mock instruction counter for unit testing.
pub fn mock_instruction_counter() -> u64 {
    MOCK_DATA.with(|data| {
        if let Some(counter) = data.borrow().instruction_counter {
            counter
        } else {
            0
        }
    })
}

/// Checks if the given principal is a mock controller for unit testing.
pub fn is_mock_controller(controller: &Principal) -> bool {
    MOCK_DATA.with(|data| data.borrow().controllers.contains(controller))
}

/// The mock canister id for unit testing.
pub const MOCK_ID: &str = "732uv-piaaa-aaaag-abkoq-cai";
/// The mock canister id for canister 0.
pub const MOCK_CANISTER_0: &str = "a4gq6-oaaaa-aaaab-qaa4q-cai";
/// The mock canister id for canister 1.
pub const MOCK_CANISTER_1: &str = "mxzaz-hqaaa-aaaar-qaada-cai";
/// The mock canister id for canister 2.
pub const MOCK_CANISTER_2: &str = "3e3x2-xyaaa-aaaaq-aaalq-cai";
/// The mock canister id for canister 3.
pub const MOCK_CANISTER_3: &str = "2jvtu-yqaaa-aaaaq-aaama-cai";
/// The mock canister id for EOA 0.
pub const MOCK_USER_0: &str = "4wcqb-taebw-q5ohj-iwsve-rkznz-aep3a-iv7wl-a5ycz-ajkay-3wmxt-eae";
/// The mock canister id for EOA 1.
pub const MOCK_USER_1: &str = "zlyyc-cf25m-zxq5j-xxy2p-2mmg2-5bv7b-4urrf-tmhkd-reoee-exfr6-kae";
/// The mock canister id for EOA 2.
pub const MOCK_USER_2: &str = "z7zpk-qms36-hlrrb-ofttm-4jais-bk2be-kpyi4-s2w4g-mso4z-h72do-gqe";
/// The mock canister id for EOA 3.
pub const MOCK_USER_3: &str = "ocm3z-6jyo2-xypcq-uchk4-7mhnj-q3wyb-slscx-37fbv-zjeuh-5mfqm-eae";