Rust / 系统课时

用 integration test 验证公开 API

用 integration test 验证公开 API

本课解决“模块内部实现测试很多,但真正对外的接口仍可能失效”的问题。你会用 tests/ 下的集成测试只通过公开 API 调用代码,从而验证真实的模块协作关系。

学习目标

  • 理解 Rust 集成测试与单元测试的边界
  • 会在 tests/ 中编写只依赖公开接口的测试
  • 能用集成测试验证模块协作,而不耦合内部实现

集成测试为什么只访问公开 API

Rust 的集成测试通常放在项目根目录的 tests/ 下。它们以外部使用者的视角编译测试代码,因此不能直接访问被测库的私有函数、私有模块或内部状态。

这个限制反而很有价值:如果测试必须通过公开函数完成完整操作,它验证的是“这个 crate 对使用者是否可用”,而不是某个内部函数当前恰好怎么实现。

例如,一个订单模块可能内部包含校验、金额计算和状态转换函数,但集成测试只关心调用 Order::new、add_item、total 这样的公开接口后,整个行为是否符合预期。

最小可运行示例

下面使用一个没有第三方依赖的库 crate。src/lib.rs 暴露 Order 及其公开方法,tests/order_api.rs 只从公开 API 角度验证完整协作过程。

rust
#[derive(Debug, PartialEq)]
pub struct Order {
    items: Vec<u32>,
}

impl Order {
    pub fn new() -> Self {
        Self { items: Vec::new() }
    }

    pub fn add_item(&mut self, price: u32) {
        self.items.push(price);
    }

    pub fn total(&self) -> u32 {
        self.items.iter().sum()
    }
}

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

    #[test]
    fn total_sums_items() {
        let mut order = Order::new();
        order.add_item(10);
        order.add_item(20);
        assert_eq!(order.total(), 30);
    }
}

预期结果

text
src/lib.rs 编译成功,并通过其中的单元测试。

集成测试文件只导入 crate 名称,不使用 Order 的字段或内部函数。假设项目包名为 shop,测试可以写成:

rust
use shop::Order;

#[test]
fn creates_order_and_calculates_total_through_public_api() {
    let mut order = Order::new();
    order.add_item(12);
    order.add_item(8);

    assert_eq!(order.total(), 20);
}

预期结果

text
running 1 test
.
test creates_order_and_calculates_total_through_public_api ... ok

这里最重要的不是断言数量,而是访问路径。测试没有直接操作 items,也没有调用内部辅助函数,因此以后即使把 Vec<u32> 换成其他实现,只要公开行为不变,测试仍然成立。

集成测试应该验证什么

集成测试适合覆盖跨模块协作和对外可见行为,例如“创建对象→执行操作→读取结果”的完整路径。它特别适合发现模块连接错误、公开接口变化以及不同组件组合后产生的问题。

相反,某个字符串解析辅助函数的边界条件,通常更适合放在单元测试中。把所有细节都塞进集成测试,会让测试变慢,也更容易因为内部重构而大面积修改。

测试关注点 更适合的位置
私有辅助函数的边界条件 单元测试
单个模块内部规则 单元测试
多个公开接口协作 集成测试
从使用者视角验证 crate 行为 集成测试

一个实用判断标准

写测试时可以问自己一句:“如果我是这个 crate 的使用者,我是否能用同样的方式完成这次验证?”如果答案是可以,tests/ 下的集成测试通常是合适的选择。

集成测试的价值在于隔离实现细节。当测试只依赖公开 API 时,内部重构可以自由进行,而只要外部行为保持不变,测试就不需要跟着实现细节一起重写。

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

目录与阅读设置

阅读设置

17

记录一个想法

用 integration test 验证公开 API

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

登录哪都通