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

use std::{
    cell::{Cell, RefCell},
    num::NonZeroUsize,
    time::Duration,
};

use crate::pocket_ic::{ErrorCode, RejectCode, RejectResponse};

use super::{ClientError, RetryPolicy, retry_install_code_with};

fn rejection(error_code: ErrorCode, message: &str) -> ClientError {
    ClientError::Canister(RejectResponse {
        reject_code: RejectCode::SysTransient,
        reject_message: message.to_string(),
        error_code,
        certified: false,
    })
}

#[test]
fn retry_policy_counts_the_first_attempt() {
    for max_attempts in [1, 3] {
        let attempts = Cell::new(0);
        let waits = Cell::new(0);
        let result = retry_install_code_with(
            RetryPolicy {
                max_attempts: NonZeroUsize::new(max_attempts).unwrap(),
                cooldown: Duration::from_secs(1),
            },
            || {
                attempts.set(attempts.get() + 1);
                Err::<(), _>(rejection(
                    ErrorCode::CanisterInstallCodeRateLimited,
                    &format!("rate limit on attempt {}", attempts.get()),
                ))
            },
            || {
                waits.set(waits.get() + 1);
                Ok(())
            },
        );

        assert_eq!(
            result.unwrap_err().to_string(),
            rejection(
                ErrorCode::CanisterInstallCodeRateLimited,
                &format!("rate limit on attempt {max_attempts}"),
            )
            .to_string()
        );
        assert_eq!(attempts.get(), max_attempts);
        assert_eq!(waits.get(), max_attempts - 1);
    }
}

#[test]
fn retry_policy_waits_only_between_retryable_attempts() {
    for success_attempt in [1, 3] {
        let events = RefCell::new(Vec::new());
        let attempts = Cell::new(0);
        let result = retry_install_code_with(
            RetryPolicy {
                max_attempts: NonZeroUsize::new(3).unwrap(),
                cooldown: Duration::from_secs(1),
            },
            || {
                events.borrow_mut().push("attempt");
                attempts.set(attempts.get() + 1);
                if attempts.get() == success_attempt {
                    Ok(42)
                } else {
                    Err(rejection(
                        ErrorCode::CanisterInstallCodeRateLimited,
                        "rate limit",
                    ))
                }
            },
            || {
                events.borrow_mut().push("wait");
                Ok(())
            },
        );
        assert_eq!(result.unwrap(), 42);
        assert_eq!(attempts.get(), success_attempt);
        assert_eq!(
            events.into_inner(),
            if success_attempt == 1 {
                vec!["attempt"]
            } else {
                vec!["attempt", "wait", "attempt", "wait", "attempt"]
            }
        );
    }
}

#[test]
fn retry_policy_stops_on_non_rate_limit_failure() {
    let attempts = Cell::new(0);
    let not_retryable = rejection(ErrorCode::CanisterRejectedMessage, "not retryable");
    let result = retry_install_code_with(
        RetryPolicy {
            max_attempts: NonZeroUsize::new(3).unwrap(),
            cooldown: Duration::from_secs(1),
        },
        || {
            attempts.set(attempts.get() + 1);
            Err::<(), _>(rejection(
                ErrorCode::CanisterRejectedMessage,
                "not retryable",
            ))
        },
        || panic!("non-rate-limit failure must not wait"),
    );

    assert_eq!(result.unwrap_err().to_string(), not_retryable.to_string());
    assert_eq!(attempts.get(), 1);
}

#[test]
fn client_and_cooldown_failures_stop_without_replaying_installation() {
    for fail_during_cooldown in [false, true] {
        let attempts = Cell::new(0);
        let error = retry_install_code_with(
            RetryPolicy {
                max_attempts: NonZeroUsize::new(3).unwrap(),
                cooldown: Duration::from_secs(1),
            },
            || {
                attempts.set(attempts.get() + 1);
                Err::<(), _>(if fail_during_cooldown {
                    rejection(ErrorCode::CanisterInstallCodeRateLimited, "rate limit")
                } else {
                    ClientError::Protocol("uncertain operation".into())
                })
            },
            || Err(ClientError::Protocol("cooldown failed".into())),
        )
        .unwrap_err();
        assert_eq!(attempts.get(), 1);
        assert!(
            matches!(error, ClientError::Protocol(message) if message == if fail_during_cooldown { "cooldown failed" } else { "uncertain operation" })
        );
    }
}