单元测试

测试（test）是这样一种 Rust 函数：它保证其他部分的代码按照所希望的行为正常 运行。测试函数的函数体通常会进行一些配置，运行我们想要测试的代码，然后 断言（assert）结果是不是我们所期望的。

大多数单元测试都会被放到一个叫 tests 的、带有 #[cfg(test)] 属性 的模块中，测试函数要加上 #[test] 属性。

当测试函数中有什么东西 panic 了，测试就失败。有一些这方面的 辅助宏：

  • assert!(expression) - 如果表达式的值是 false 则 panic。
  • assert_eq!(left, right) 和 assert_ne!(left, right) - 检验左右两边是否 相等/不等。
  1. pub fn add(a: i32, b: i32) -> i32 {
  2.     a + b
  3. }
  5. // 这个加法函数写得很差，本例中我们会使它失败。
  6. #[allow(dead_code)]
  7. fn bad_add(a: i32, b: i32) -> i32 {
  8.     a - b
  9. }
  11. #[cfg(test)]
  12. mod tests {
  13.     // 注意这个惯用法：在 tests 模块中，从外部作用域导入所有名字。
  14.     use super::*;
  16.     #[test]
  17.     fn test_add() {
  18.         assert_eq!(add(1, 2), 3);
  19.     }
  21.     #[test]
  22.     fn test_bad_add() {
  23.         // 这个断言会导致测试失败。注意私有的函数也可以被测试！
  24.         assert_eq!(bad_add(1, 2), 3);
  25.     }
  26. }

可以使用 cargo test 来运行测试。

  1. $ cargo test
  3. running 2 tests
  4. test tests::test_bad_add ... FAILED
  5. test tests::test_add ... ok
  7. failures:
  9. ---- tests::test_bad_add stdout ----
  10.         thread 'tests::test_bad_add' panicked at 'assertion failed: `(left == right)`
  11.   left: `-1`,
  12.  right: `3`', src/lib.rs:21:8
  13. note: Run with `RUST_BACKTRACE=1` for a backtrace.
  16. failures:
  17.     tests::test_bad_add
  19. test result: FAILED. 1 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out

测试 panic

一些函数应当在特定条件下 panic。为测试这种行为，请使用 #[should_panic] 属性。这 个属性接受可选参数 expected = 以指定 panic 时的消息。如果你的函数能以多种方式 panic，这个属性就保证了你在测试的确实是所指定的 panic。

  1. pub fn divide_non_zero_result(a: u32, b: u32) -> u32 {
  2.     if b == 0 {
  3.         panic!("Divide-by-zero error");
  4.     } else if a < b {
  5.         panic!("Divide result is zero");
  6.     }
  7.     a / b
  8. }
  10. #[cfg(test)]
  11. mod tests {
  12.     use super::*;
  14.     #[test]
  15.     fn test_divide() {
  16.         assert_eq!(divide_non_zero_result(10, 2), 5);
  17.     }
  19.     #[test]
  20.     #[should_panic]
  21.     fn test_any_panic() {
  22.         divide_non_zero_result(1, 0);
  23.     }
  25.     #[test]
  26.     #[should_panic(expected = "Divide result is zero")]
  27.     fn test_specific_panic() {
  28.         divide_non_zero_result(1, 10);
  29.     }
  30. }

运行这些测试会输出：

  1. $ cargo test
  3. running 3 tests
  4. test tests::test_any_panic ... ok
  5. test tests::test_divide ... ok
  6. test tests::test_specific_panic ... ok
  8. test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
  10.    Doc-tests tmp-test-should-panic
  12. running 0 tests
  14. test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

运行特定的测试

要运行特定的测试，只要把测试名称传给 cargo test 命令就可以了。

  1. $ cargo test test_any_panic
  2. running 1 test
  3. test tests::test_any_panic ... ok
  5. test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 2 filtered out
  7.    Doc-tests tmp-test-should-panic
  9. running 0 tests
  11. test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

要运行多个测试，可以仅指定测试名称中的一部分，用它来匹配所有要运行的测试。

  1. $ cargo test panic
  2. running 2 tests
  3. test tests::test_any_panic ... ok
  4. test tests::test_specific_panic ... ok
  6. test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 1 filtered out
  8.    Doc-tests tmp-test-should-panic
  10. running 0 tests
  12. test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

忽略测试

可以把属性 #[ignore] 赋予测试以排除某些测试，或者使用 cargo test -- --ignored 命令来运行它们。

  1. pub fn add(a: i32, b: i32) -> i32 {
  2.     a + b
  3. }
  5. #[cfg(test)]
  6. mod tests {
  7.     use super::*;
  9.     #[test]
  10.     fn test_add() {
  11.         assert_eq!(add(2, 2), 4);
  12.     }
  14.     #[test]
  15.     fn test_add_hundred() {
  16.         assert_eq!(add(100, 2), 102);
  17.         assert_eq!(add(2, 100), 102);
  18.     }
  20.     #[test]
  21.     #[ignore]
  22.     fn ignored_test() {
  23.         assert_eq!(add(0, 0), 0);
  24.     }
  25. }
  1. $ cargo test
  2. running 1 test
  3. test tests::ignored_test ... ignored
  5. test result: ok. 0 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out
  7.    Doc-tests tmp-ignore
  9. running 0 tests
  11. test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
  13. $ cargo test -- --ignored
  14. running 1 test
  15. test tests::ignored_test ... ok
  17. test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
  19.    Doc-tests tmp-ignore
  21. running 0 tests
  23. test result: ok. 0 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out