Rust / 系统课时

测试如何断言错误变体与来源

测试如何断言错误变体与来源

错误测试的重点不是把整段报错文本“拍快照”,而是验证稳定契约:错误属于哪个变体、关键字段是什么、source 链是否保留,以及公开接口在失败时呈现什么行为。本节用一个最小 Rust crate 展示单元测试与集成测试的分工。

学习目标

  • 用模式匹配断言错误变体和关键字段,避免脆弱的字符串比较。
  • 验证 std::error::Error::source 是否正确串起底层原因。
  • 用集成测试检查 crate 对外暴露的失败行为,而不是内部实现细节。

单元测试直接断言错误结构

先建立一个最小 crate。ParseConfigError 表示具体解析失败,LoadConfigError 是对外层错误;外层通过 source 暴露底层原因。

Cargo.toml:

toml
[package]
name = "error-contract-tests"
version = "0.1.0"
edition = "2021"

生效行为:Cargo 会把包名 error-contract-tests 映射为代码中的 crate 名 error_contract_tests。后续执行 cargo test 即可同时编译库、单元测试和 tests/ 下的集成测试。

文件示例:以下是完整的 src/lib.rs,依赖上面的 crate 上下文,由后面的 cargo test 统一编译和执行,本文件本身不单独产生控制台输出。

rust
use std::error::Error;
use std::fmt;

#[derive(Debug, PartialEq)]
pub enum ParseConfigError {
    MissingField(&'static str),
    InvalidPort { value: String },
}

impl fmt::Display for ParseConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::MissingField(name) => write!(f, "missing required field: {name}"),
            Self::InvalidPort { value } => write!(f, "invalid port: {value}"),
        }
    }
}

impl Error for ParseConfigError {}

#[derive(Debug)]
pub enum LoadConfigError {
    Parse(ParseConfigError),
}

impl fmt::Display for LoadConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Parse(_) => write!(f, "failed to load config"),
        }
    }
}

impl Error for LoadConfigError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            Self::Parse(source) => Some(source),
        }
    }
}

pub fn load_port(input: Option<&str>) -> Result<u16, LoadConfigError> {
    let raw = input
        .ok_or(ParseConfigError::MissingField("port"))
        .map_err(LoadConfigError::Parse)?;

    raw.parse::<u16>()
        .map_err(|_| ParseConfigError::InvalidPort {
            value: raw.to_owned(),
        })
        .map_err(LoadConfigError::Parse)
}

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

    #[test]
    fn asserts_variant_and_key_field() {
        let err = load_port(Some("abc")).unwrap_err();

        match err {
            LoadConfigError::Parse(ParseConfigError::InvalidPort { value }) => {
                assert_eq!(value, "abc");
            }
            other => panic!("unexpected error: {other:?}"),
        }
    }

    #[test]
    fn preserves_source_chain() {
        let err = load_port(None).unwrap_err();
        let source = Error::source(&err).expect("outer error should expose source");
        let parse_error = source
            .downcast_ref::<ParseConfigError>()
            .expect("source should be ParseConfigError");

        assert_eq!(parse_error, &ParseConfigError::MissingField("port"));
        assert!(source.source().is_none());
    }
}

第一条测试锁定的是“错误类别 + 关键字段”,即使以后修改 Display 文案,测试仍然成立。第二条测试先沿 source() 取得底层错误,再通过 downcast_ref 断言具体类型和变体,因此能发现包装时漏掉来源链的问题。

source 链要断言结构而不是整段文案

source() 的价值是保留因果关系,让日志或边界层可以逐层查看“外层操作失败”与“底层具体原因”。测试时应至少确认外层存在来源,并在需要时检查来源的类型或关键字段。

如果来源类型是你自己的公开类型,可以像上面的测试一样使用 downcast_ref;如果来源来自第三方库,则只固定调用方真正依赖的稳定属性,避免测试绑死其展示文本或版本相关细节。

集成测试只看公开行为

文件示例:在 tests/public_behavior.rs 中只通过 crate 的公开 API 触发失败。它依赖前面的 src/lib.rs,由 cargo test 统一执行,用来验证内部重构后外部调用者仍能收到相同类别的错误和可追踪来源。

rust
use error_contract_tests::{load_port, LoadConfigError, ParseConfigError};
use std::error::Error;

#[test]
fn public_api_keeps_error_contract() {
    let err = load_port(Some("not-a-number")).unwrap_err();

    match &err {
        LoadConfigError::Parse(ParseConfigError::InvalidPort { value }) => {
            assert_eq!(value.as_str(), "not-a-number");
        }
        other => panic!("unexpected error: {other:?}"),
    }

    assert!(err.source().is_some());
}

运行全部测试:

bash
cargo test --quiet

预期输出:

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

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

running 0 tests

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

<TIME> 会随机器和构建缓存变化;首次运行还可能先出现编译信息,因此应以测试数量和 ok 结果为验证重点。

哪些断言容易变脆

最常见的问题是直接写 assert_eq!(err.to_string(), "..."),然后任何文案优化都会导致测试失败。另一种问题是集成测试依赖私有辅助函数,使测试实际上锁住了实现而不是对外契约。

更稳妥的顺序是:先断言变体,再检查调用者真正依赖的字段;如果错误经过包装,再验证 source 链没有断;最后由集成测试确认公开 API 的失败行为。这样既能发现错误分类被改坏,也允许内部实现和展示文本正常演进。

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

目录与阅读设置

阅读设置

17

记录一个想法

测试如何断言错误变体与来源

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

登录哪都通