ic-testkit 0.4.2

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
58
59
60
61
62
63
64
65
66
67
68

//! Focused PocketIC test-harness utilities for Internet Computer canisters.
//!
//! `ic-testkit` keeps PocketIC itself visible: [`pic`] re-exports the upstream
//! `PocketIc` and `PocketIcBuilder` types and adds extension traits for typed
//! Candid calls, generic installation, diagnostics, snapshots, startup errors,
//! and a small time conversion. It does not provide a simulator wrapper or a
//! host-wide runtime lock.
//!
//! The crate also provides:
//!
//! - host-only Wasm build and freshness helpers in [`artifacts`];
//! - marker parsing, aggregation, comparison, and reports in [`benchmark`];
//! - canister-side marker emission in [`performance`];
//! - deterministic test principals through [`Fake`].
//!
//! The [`pic`] and [`artifacts`] modules 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 artifacts;

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

pub mod performance;
use candid::Principal;

/// Deterministic principal generator for tests.
///
/// Values are derived directly from a numeric seed, making fixtures stable
/// without embedding textual principal literals.
pub struct Fake;

impl Fake {
    /// Deterministically derive a [`Principal`] from `seed`.
    #[must_use]
    pub fn principal(seed: u32) -> Principal {
        let mut buf = [0u8; 29];
        buf[..4].copy_from_slice(&seed.to_be_bytes());

        Principal::from_slice(&buf)
    }
}

///
/// TESTS
///

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

    #[test]
    fn fake_principal_is_deterministic_and_unique() {
        let p1 = 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");
    }
}