test-r-core 10.0.0

Test framework for Rust (core module)
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

use crate::internal::PanicCause;
use crate::panic_hook;
use std::panic::{catch_unwind, AssertUnwindSafe};
use std::thread::JoinHandle;

#[cfg(feature = "tokio")]
use futures::FutureExt;
#[cfg(feature = "tokio")]
use std::future::Future;

#[cfg(feature = "tokio")]
/// Spawn a future on the tokio runtime with test context propagation.
/// If the spawned task panics and the test uses `DetachedPanicPolicy::FailTest` (default),
/// the panic will be reported as a test failure after the test body completes.
pub fn spawn<F>(future: F) -> tokio::task::JoinHandle<F::Output>
where
    F: Future + Send + 'static,
    F::Output: Send + 'static,
{
    let test_id = panic_hook::current_test_id();
    let collector = test_id.and_then(panic_hook::get_detached_collector);

    tokio::spawn(async move {
        if let Some(id) = test_id {
            panic_hook::set_current_test_id(id);
        }
        let result = std::panic::AssertUnwindSafe(future).catch_unwind().await;
        match result {
            Ok(value) => value,
            Err(panic_payload) => {
                let cause = panic_hook::take_current_panic_capture().unwrap_or_else(|| {
                    let message = panic_payload
                        .downcast_ref::<String>()
                        .cloned()
                        .or(panic_payload.downcast_ref::<&str>().map(|s| s.to_string()));
                    PanicCause {
                        message,
                        location: None,
                        backtrace: None,
                    }
                });

                if let Some(collector) = &collector {
                    match collector.lock() {
                        Ok(mut panics) => panics.push(cause),
                        Err(poisoned) => poisoned.into_inner().push(cause),
                    }
                }

                std::panic::resume_unwind(panic_payload);
            }
        }
    })
}

/// Spawn a thread with test context propagation.
/// If the spawned thread panics and the test uses `DetachedPanicPolicy::FailTest` (default),
/// the panic will be reported as a test failure after the test body completes.
pub fn spawn_thread<F, T>(f: F) -> JoinHandle<T>
where
    F: FnOnce() -> T + Send + 'static,
    T: Send + 'static,
{
    let test_id = panic_hook::current_test_id();
    let collector = test_id.and_then(panic_hook::get_detached_collector);

    std::thread::spawn(move || {
        if let Some(id) = test_id {
            panic_hook::set_current_test_id(id);
        }
        let result = catch_unwind(AssertUnwindSafe(f));
        match result {
            Ok(value) => value,
            Err(panic_payload) => {
                let cause = panic_hook::take_current_panic_capture().unwrap_or_else(|| {
                    let message = panic_payload
                        .downcast_ref::<String>()
                        .cloned()
                        .or(panic_payload.downcast_ref::<&str>().map(|s| s.to_string()));
                    PanicCause {
                        message,
                        location: None,
                        backtrace: None,
                    }
                });

                if let Some(collector) = &collector {
                    match collector.lock() {
                        Ok(mut panics) => panics.push(cause),
                        Err(poisoned) => poisoned.into_inner().push(cause),
                    }
                }

                std::panic::resume_unwind(panic_payload);
            }
        }
    })
}