ic-testkit 0.76.0

PocketIC-oriented test utilities for IC canister tests
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

//! Focused `PocketIC` test-harness utilities for Internet Computer canisters.
//!
//! Import native `PocketIC` clients and DTOs directly from `ic_platform::pocket_ic`.
//! `pic` adds optional typed Wire calls, extension traits for
//! installation, diagnostics and snapshots, startup errors, caller-owned
//! managed-server startup and bounded readiness polling. It does not provide a
//! simulator wrapper or a host-wide runtime lock.
//!
//! The crate also provides:
//!
//! - marker parsing, aggregation, comparison, and reports in [`benchmark`];
//! - canister-side marker emission in `performance` (Wasm only);
//! - deterministic test principals through [`fake_principal`].
//!
//! The `pic` helpers are unavailable
//! when compiling for `wasm32`; benchmark data types and marker emission remain
//! available to canister code.

pub mod benchmark;

#[cfg(not(target_arch = "wasm32"))]
pub mod pic;

#[cfg(target_arch = "wasm32")]
pub mod performance;

use ic_platform::principal::ExternalPrincipal as Principal;

/// Deterministically derive a test [`Principal`] from `seed`.
///
/// Values are derived directly from a numeric seed, making fixtures stable
/// without embedding textual principal literals.
#[must_use]
pub fn fake_principal(seed: u32) -> Principal {
    let mut buf = [0u8; 29];
    buf[..4].copy_from_slice(&seed.to_be_bytes());

    Principal::from_slice(&buf)
}

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

    #[test]
    fn fake_principal_is_deterministic_and_unique() {
        let p1: Principal = fake_principal(7);
        let p2 = fake_principal(7);
        let q = fake_principal(8);

        assert_eq!(p1, p2, "fake_principal should be deterministic");
        assert_ne!(p1, q, "fake_principal should differ for different seeds");

        let bytes = p1.as_slice();
        assert_eq!(bytes.len(), 29, "Principal must be 29 bytes");
    }
}