Rust / 系统课时

编写单元测试

编写单元测试

本课通过一个可运行的 Rust 项目示例,演示如何使用 #[test] 标记测试函数,并用 assert_eq!、assert! 验证正常输入下的返回结果,最终能够独立运行和判断单元测试是否通过。

学习目标

  • 知道单元测试应放在哪里,以及 #[cfg(test)] 的作用
  • 使用常见断言宏验证返回值和布尔条件
  • 运行指定测试并理解测试结果

单元测试的基本结构

Rust 通常把单元测试写在被测代码所在文件的 tests 模块中。#[cfg(test)] 表示该模块只在执行测试时参与编译,#[test] 则把普通函数标记为测试用例。

测试函数应聚焦一个明确行为:准备输入、调用被测函数、断言结果。只要断言失败,当前测试就会失败,并显示实际值与期望值。

编写第一个测试

下面的 src/lib.rs 同时包含业务函数和测试代码,可直接放入一个库项目运行。

rust
pub fn add(left: i32, right: i32) -> i32 {
    left + right
}

pub fn is_even(value: i32) -> bool {
    value % 2 == 0
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn adds_two_positive_numbers() {
        // 等值断言适合验证确定的返回结果
        assert_eq!(add(2, 3), 5);
    }

    #[test]
    fn recognizes_even_number() {
        // 条件断言适合验证布尔性质
        assert!(is_even(8));
    }
}

预期结果:

text
保存文件后不会立即产生控制台输出;执行后文的 cargo test 时,两条测试应通过。

use super::*; 将父模块中的函数引入测试模块。assert_eq! 比较两个值,assert! 要求表达式为 true;对应地,Rust 还提供 assert_ne! 用于验证两个值不相等。

运行并验证

在项目根目录执行全部单元测试:

bash
cargo test

预期输出:

text
running 2 tests
test tests::adds_two_positive_numbers ... ok
test tests::recognizes_even_number ... ok

test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in <TIME>s

测试名称和耗时可能因环境不同而略有差异,但 2 passed 与 0 failed 表示两个测试均通过。只运行某个测试时,可以把测试名作为过滤条件:

bash
cargo test adds_two_positive_numbers

预期输出:

text
running 1 test
test tests::adds_two_positive_numbers ... ok

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

断言失败时如何定位

当期望值与实际值不一致时,测试会失败。优先检查失败用例名称、断言所在行,以及输出中的 left 和 right。为了让失败信息更清楚,可以给断言追加说明。以下是片段示例,需要放在测试函数中:

rust
assert_eq!(add(2, 3), 5, "加法函数应返回两个参数之和");

附加消息只在断言失败时显示,不会影响测试逻辑。

本课总结

  • #[cfg(test)] 用于隔离测试模块,#[test] 用于声明测试函数
  • assert_eq!、assert_ne! 和 assert! 分别适合等值、不等值与条件验证
  • cargo test 可运行全部测试,也可按名称过滤目标测试

下一课预告

下一课将测试异常分支,分别验证 Result 错误、预期发生的 panic,以及 panic 信息是否包含指定内容。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

编写单元测试

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通