ic-testkit 0.87.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
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

// Each integration target uses only the fixtures it needs.
#![expect(
    dead_code,
    reason = "integration targets use different subsets of the shared server/wait helpers"
)]

pub mod wait;

pub fn startup_config() -> ic_testkit::pic::PocketIcStartupConfig {
    ic_testkit::pic::PocketIcStartupConfig::from_env(std::time::Duration::from_secs(30))
        .expect("prepare POCKET_IC_BIN or configure IC_TESTKIT_POCKET_IC_URL for live tests")
}

pub async fn pocket_ic() -> ic_testkit::pic::PocketIcInstance<ic_testkit::pocket_ic::PocketIc> {
    startup_config()
        .build_instance(ic_testkit::pocket_ic::PocketIcBuilder::new().with_application_subnet())
        .await
        .expect("construct explicitly configured test instance")
}

#[cfg(feature = "held-reply-fixtures")]
pub fn wat_bytes(bytes: &[u8]) -> String {
    use std::fmt::Write as _;
    let mut escaped = String::new();
    for byte in bytes {
        write!(escaped, "\\{byte:02x}").unwrap();
    }
    escaped
}

#[cfg(feature = "held-reply-fixtures")]
pub async fn install_wat(
    pic: &ic_testkit::pocket_ic::PocketIc,
    canister: ic_platform_types::principal::ExternalPrincipal,
    source: &str,
    module_bytes: usize,
) {
    let wasm = ic_host_artifacts::wasm_text::compile(
        source,
        ic_host_artifacts::wasm_text::CompileLimits {
            source_bytes: source.len(),
            module_bytes,
        },
    )
    .unwrap();
    ic_host_artifacts::wasm::validate(&wasm, module_bytes).unwrap();
    pic.install_canister(canister, wasm, vec![], None)
        .await
        .unwrap();
}

/// Catch an async caller panic on its own runtime, retaining borrowed test inputs.
pub fn catch_async_panic<T: Send>(
    operation: impl AsyncFnOnce() -> T + Send,
) -> std::thread::Result<T> {
    let runtime = tokio::runtime::Handle::current();
    std::thread::scope(|scope| {
        scope
            .spawn(|| {
                std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                    runtime.block_on(operation())
                }))
            })
            .join()
            .expect("panic catcher itself should remain live")
    })
}

/// Each blocking test coordinator delegates async simulator work to a caller-owned runtime.
pub fn spawn_async<T: Send + 'static>(
    operation: impl AsyncFnOnce() -> T + Send + 'static,
) -> std::thread::JoinHandle<T> {
    let runtime = tokio::runtime::Handle::current();
    std::thread::spawn(move || runtime.block_on(operation()))
}

#[cfg(feature = "held-reply-fixtures")]
pub async fn await_held_slot(
    pic: &ic_testkit::pocket_ic::PocketIc,
    fixture: &ic_testkit::pic::fixtures::held::HeldReplyFixture,
    slot: usize,
) {
    for _ in 0..20 {
        pic.tick().await.unwrap();
        if fixture
            .pending(pic)
            .await
            .unwrap()
            .iter()
            .any(|request| request.slot() == slot)
        {
            return;
        }
    }
    panic!("slot {slot} must reach the real HTTP barrier");
}