如何编写Rust单元测试以确保发生恐慌？

Question

我有一个panic在某些条件下的Rust函数,我希望编写一个测试用例来验证函数是否恐慌.除了assert!和assert_eq!宏之外我找不到任何东西.有没有一些机制来测试这个？

我可以生成一个新任务并检查该任务是否会发生恐慌.是否有意义？

---

返回a Result<T, E>不适合我的情况.

我希望将这种Add特性的支持添加到Matrix我正在实施的类型中.这种添加的理想语法如下:

let m = m1 + m2 + m3;

其中m1,m2,m3都是矩阵.因此,结果类型add应该是Matrix.像下面这样的东西会太神秘:

let m = ((m1 + m2).unwrap() + m3).unwrap()

同时,该add()函数需要验证添加的两个矩阵是否具有相同的维度.因此,add()如果尺寸不匹配则需要恐慌.可用选项是panic!().

Answer 1

您可以在Rust书的测试部分找到答案.更具体地说,您需要#[should_panic]属性:

#[test]
#[should_panic]
fn test_invalid_matrices_multiplication() {
    let m1 = Matrix::new(3, 4);  // assume these are dimensions
    let m2 = Matrix::new(5, 6);
    m1 * m2
}

Answer 2

正如FrancisGagné在他的回答中提到的那样,我也发现该#[should_panic]属性对于更复杂的测试来说还不够精细 - 例如,如果我的测试设置由于某种原因而失败(即我写了一个糟糕的测试),我做希望恐慌被视为失败!

从Rust 1.9.0开始,std::panic::catch_unwind()可以使用.它允许您将您期望的代码置于闭包中,并且只会考虑该代码抛出的恐慌(即通过测试).

#[test]
fn test_something() {
    ... //<-- Any panics here will cause test failure (good)
    let result = std::panic::catch_unwind(|| <expected_to_panic_operation_here>);
    assert!(result.is_err());  //probe further for specific error type here, if desired
}

请注意,它无法捕获非展开恐慌(例如std::process::abort()).

Answer 3

如果要断言只有测试函数的特定部分失败,请使用std::panic::catch_unwind()并检查它是否返回Err,例如with is_err().在复杂的测试功能中,这有助于确保测试不会因为早期故障而错误地通过.

Rust标准库本身的几个测试使用这种技术.

Answer 4

作为附录：@U007D 提出的解决方案也适用于 doctests：

/// My identity function that panic for an input of 42.
///
/// ```
/// assert_eq!(my_crate::my_func(23), 23);
///
/// let result = std::panic::catch_unwind(|| my_crate::my_func(42));
/// assert!(result.is_err());
/// ```
pub fn my_func(input: u32) -> u32 {
    if input == 42 {
        panic!("Error message.");
    } else {
        input
    }
}

Answer 5

使用以下catch_unwind_silent而不是常规catch_unwind来实现预期异常的输出静音：

use std::panic;

fn catch_unwind_silent<F: FnOnce() -> R + panic::UnwindSafe, R>(f: F) -> std::thread::Result<R> {
    let prev_hook = panic::take_hook();
    panic::set_hook(Box::new(|_| {}));
    let result = panic::catch_unwind(f);
    panic::set_hook(prev_hook);
    result
}