单元测试与集成测试

Rust 怎么写测试

assert 等宏用法

assert!(false); // bool 型
assert_eq!(s.peek(), s.peek()); // 等于 要实现 PartialEq
assert_ne!(s.peek(), None); // 不等 要实现 PartialEq
assert_eq!(s.peek(), s.peek(), "twice peek should get same result"); // 可以加上报错显示的额外信息

assert_eq!(&4, 4); // 小心借用类型 no implementation for `&{integer} == {integer}`
assert_eq!(s.iter().collect::<Vec<&i32>>(), [&0i32;0]); // 带类型的空数组

文档测试(doctest)

通用写法

impl LinkedStack<T> {
    /// Create a new empty LinkedStack.
    /// # Examples
    /// ```
    /// use too_many_linked_list::linked_stack::*;
    /// let mut s = LinkedStack::<i32>::new();
    /// assert_eq!(s.iter().collect::<Vec<&i32>>(), [&0i32;0]);
    /// ```
    pub fn new() -> Self {
        Self
    }
}

特殊用法 doctest Attributes

1. should_panic 常用

/// ```should_panic
/// assert!(false);
/// ```

对应单元测试函数的 #[should_panic]
#[should_panic(expected = "{error message}")] 暂时无法在 doctest 内表达

2. compile_fail 常用

/// ```compile_fail
/// let x = 5;
/// x += 2; // shouldn't compile!
/// ```

3. 不常用
   • ignore 不编译 对应单元测试函数的 #[ignore]
   • no_run 不运行 有编译错误会报错
   • edition2018 edition2015 选择特定版本语法
4. 多个同时使用

/// ```should_panic, ignore
/// assert!(true);
/// ```
pub fn x() {}

使用 ? 语法返回 Result<_> 与隐藏代码

要用 ? 语法, 必须追加返回值
返回语句可以用 # 在文档中隐藏
# 常用于隐藏不重要的语句以突出重点

/// ```
/// use std::io;
/// let mut input = String::new();
/// io::stdin().read_line(&mut input)?;
/// # Ok::<(), io::Error>(())
/// ```

测试外部文档内的代码 与 仅在 doctest 有效的代码

// 1.54 稳定版
#[cfg(doctest)]
#[doc = include_str!("../README.md")] // 引入外部文档作为被注解的项目的文档, 如果包含代码则作为 doctest
struct ReadmeDoctests; // 仅在 doctest 有效的代码

直接引入外部 rs 文件作为 doctest

#[cfg(doctest)]
/// ```compile_fail
#[doc = include_str!("compile_fail.rs")]
/// ```
mod doc_test {}

运行与结果

测试常用命令

# 运行所有测试 包括 doctest
cargo test

# 仅运行 doctest
cargo test --doc

# 仅运行名称包括参数的测试
cargo test bad_safe_deque::test::test_push

# 仅运行名称包括参数的 doctest
cargo test --doc SelfContainedList

测试名称可由 cargo test 得到. 命名规则见下一部分.

测试结果与测试命名

单元测试#[test]命名如下, 不含 crate name 的函数全名, bad_safe_deque::test::peek

test bad_safe_deque::test::peek ... ignored
test bad_safe_deque::test::test_push_front_pop_back ... ok
test bad_safe_deque::test::test_push_pop_back ... ok
test bad_safe_deque::test::into_iter ... ok

文档测试 doctest 命名如下, 文档对应元素的不含 crate name 的全名, 附加行号
同一元素文档有多个文档测试的, 只能靠行号区分
同一类型的不同 impl 内的同名函数，也只能靠行号区分
#[doc = include_str!("readme.md")]引入的 doctest 显示readme.md的行号, 可能导致不同测试有相同的行号

test src\linked_stack\mod.rs - linked_stack::LinkedStack<T>::peek_back (line 104) ... ok
test src\linked_stack\mod.rs - linked_stack::LinkedStack<T>::peek (line 55) ... ok
test src\bad.rs - bad::SelfContainedList (line 5) - compile fail ... ok
test src\mod.rs - Struct1::fmt (line 145) ... ok 对应 impl Struct1 { fn fmt() {} }
test src\mod.rs - Struct1::fmt (line 126) ... ok 对应 impl Format for Struct1 { fn fmt() {} }

目前应该没有 doctest 的自定义命名方法