Writing Automated Tests

How to Write Tests

cargo test 会执行所有测试，即 #[test] 下的测试

1
2
3
4
5
6
7
#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}

输出信息

1
2
3
4
running 1 test
test tests::it_works ... ok

test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

测试 panic 表示失败

assert! 宏， 当为假时，会 panic

1
2
assert!(true);
assert!(0 == 1);// false

assert_eq! 与 assert_ne! 即断言相等与不相等

断言失败会打印参数的值，要求实现了 PartialEq 和 Debug Traits （基本类型都实现了）

1
2
3
4
5
assert_eq!(1, 0);
// output
assertion `left == right` failed
  left: 1
 right: 0

添加自定义错误信息

assert!, assert_eq!, assert_ne 后面还有一个参数，自定义信息

1
2
3
4
assert!(0 == 1, "1 not eq 0");// false
// output
thread 'tests::it_works' panicked at src\lib.rs:7:9:
1 not eq 0

#[should_panic]

添加这个时， panic 才会通过（pass）

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#[cfg(test)]
mod tests {
    #[test]
    #[should_panic]
    fn it_works() {
        assert!(0 == 1, "1 not eq 0");// false
    }
}

// output
thread 'tests::it_works' panicked at src\lib.rs:8:9:
1 not eq 0
...
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.02s

让 should_panic 更精确

当 panic 信息包含should_panic 的信息才会通过

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
pub struct Node {
    value: i32,
}

impl Node {
    pub fn new(v: i32) -> Node {
        if v > 100 {
            panic!("val > 100");
        } else {
            panic!("val <= 100");
        }
        Node {value: v}
    }
}

#[cfg(test)]
mod tests {

    use super::*;

    #[test]
    #[should_panic(expected = "val > 100")]// 
    fn it_works() {
        Node::new(100);
    }
}

// output
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.03s

在测试中使用 Result<T, E>

测试返回 Ok 通过， Err 失败

1
2
3
4
5
6
7
8
9
#[cfg(test)]
mod tests {
    #[test]
    fn it_works() -> Result<(),  String> {
        Err(String::from("failed"))
    }
}
// output
test result: FAILED. 0 passed; 1 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

Controlling How Tests Are Run

改变 cargo test 的行为：添加命令行参数

默认行为：

  • 并行运行（运行快，确保测试不相互依赖）
  • 所有测试
  • 捕获（不显示）所有输出

命令行参数：

针对 cargo test 的参数：紧跟其后 cargo test --help 查看

针对 测试可执行程序：放在 – 之后 cargo test -- --help 查看

#[ignore] 忽略测试

cargo test -- --ignored 运行被忽略的测试

Test Organization

测试分类

  • 单元测试 #[cfg(test)]

  • 集成测试 处于被测试库外 面

    集成测试新建文件夹 tests，tests 目录下每个测试文件都是单独的一个 crate，需要将被测试库导入，无需标注 #[cfg(test)]，tests 目录被特殊对待

单独测试某个文件内所有测试 cargo test --test 文件名