awaitility 0.4.1

Awaitility for Rust
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

use crate::error::Timeout;
use super::backend::Backend;
use std::future::Future;
use std::time::{Duration, Instant};
use std::panic::{AssertUnwindSafe, self};

pub struct MostWait<'a> {
    duration: Duration,
    backend: Backend<'a>,
}

pub fn at_most(duration: Duration) -> MostWait<'static> {
    MostWait {
        duration,
        backend: Backend::default(),
    }
}

pub fn at_most_backend<'a>(duration: Duration, backend: Backend<'a>) -> MostWait<'a> {
    MostWait {
        duration,
        backend,
    }
}

impl<'a> MostWait<'a> {
    pub fn poll_interval(&mut self, interval: Duration) -> &mut Self {
        self.backend.set_interval(interval);
        self
    }

    pub fn describe<'b: 'a>(&mut self, desc: &'b str) -> &mut Self {
        self.backend.set_description(desc);
        self
    }

    pub fn result(&self) -> Result<(), Timeout> {
        self.backend.result.clone()
    }

    pub fn until(&mut self, f: impl Fn() -> bool) -> &Self {
        let now = Instant::now();
        while !f() {
            if self.is_timeout_or_wait(&now) {
                break;
            }
        }
        self
    }

    pub async fn until_async<Fut>(&mut self, f: impl Fn() -> Fut) -> &Self where Fut: Future<Output = bool> {
        let now = Instant::now();
        while !f().await {
            if self.is_timeout_or_wait(&now) {
                break;
            }
        }
        self
    }

    pub fn until_no_panic(&mut self, f: impl Fn()) -> &Self {
        let now = Instant::now();
        while panic::catch_unwind(AssertUnwindSafe(|| f())).is_err() {
            let elapsed = now.elapsed();
            if elapsed > self.duration {
                f();
                break;
            }
            std::thread::sleep(self.backend.interval);
        }
        self
    }

    fn is_timeout_or_wait(&mut self, now: &Instant) -> bool {
        let elapsed = now.elapsed();
        if elapsed > self.duration {
            let desc = format!("Condition not satisfied after {:?}.", elapsed);
            self.backend.fail(&desc);
            return true;
        }
        std::thread::sleep(self.backend.interval);
        return false;
    }
}

#[cfg(test)]
mod most_test {
    use std::sync::atomic::{AtomicUsize, Ordering};
    use std::sync::Arc;
    use std::{thread, time};
    use std::time::Duration;

    #[test]
    fn at_most_test() {
        let counter = Arc::new(AtomicUsize::new(5));
        let tcounter = counter.clone();
        std::thread::spawn(move || {
            while tcounter.load(Ordering::SeqCst) < 15 {
                tcounter.fetch_add(1, Ordering::SeqCst);
            }
        });
        super::at_most(Duration::from_millis(100)).until(|| counter.load(Ordering::SeqCst) > 10);
    }

    #[test]
    #[should_panic]
    fn at_most_using_assert() {
        let counter = Arc::new(AtomicUsize::new(5));
        let tcounter = counter.clone();
        std::thread::spawn(move || {
            while tcounter.load(Ordering::SeqCst) < 15 {
                let ten_millis = time::Duration::from_millis(10);
                thread::sleep(ten_millis);
                tcounter.fetch_add(1, Ordering::SeqCst);
            }
        });
        super::at_most(Duration::from_millis(1000)).until_no_panic(|| assert!(counter.load(Ordering::SeqCst) < 3));
    }

    #[test]
    #[should_panic]
    fn at_most_panic() {
        super::at_most(Duration::from_millis(30)).until(|| 1 > 2);
    }

    #[tokio::test]
    async fn at_most_async_fn() {
        let counter = Arc::new(AtomicUsize::new(5));
        let tcounter = counter.clone();
        std::thread::spawn(move || {
            while tcounter.load(Ordering::SeqCst) < 15 {
                tcounter.fetch_add(1, Ordering::SeqCst);
            }
        });
        super::at_most(Duration::from_millis(1000)).until_async(|| async {
            counter.load(Ordering::SeqCst) > 10
        }).await;
    }

    #[tokio::test]
    #[should_panic]
    async fn at_most_async_panic() {
        async fn async_sum(a: i8, b: i8) -> i8 {
            a + b
        }
        super::at_most(Duration::from_millis(30)).until_async(|| async {
            async_sum(1, 2).await == 4
        }).await;
    }
}