Rust / 系统课时

用故障注入验证错误路径

用故障注入验证错误路径

错误处理代码只有在失败真正发生时才有价值。与其等线上偶发故障暴露问题,不如在测试中主动制造文件缺失、格式错误和非法配置,检查错误类型、上下文和边界条件是否都符合预期。

学习目标

  • 用可控输入主动触发三类典型配置故障。
  • 断言具体错误分支,而不是只检查 is_err()。
  • 让故障测试可重复运行,并避免依赖机器上的真实配置。

先把失败路径设计成可观察结果

为了测试错误路径,函数需要返回可区分的错误类型。下面的 load_port 把读取失败、数字解析失败和端口范围非法拆成三个分支;允许的端口范围定义为 1024..=65535。

rust
use std::fmt;
use std::fs;
use std::num::ParseIntError;
use std::path::Path;

#[derive(Debug)]
pub enum ConfigError {
    Read {
        path: String,
        source: std::io::Error,
    },
    Parse {
        raw: String,
        source: ParseIntError,
    },
    OutOfRange {
        port: u16,
    },
}

impl fmt::Display for ConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConfigError::Read { path, source } => {
                write!(f, "cannot read {path}: {source}")
            }
            ConfigError::Parse { raw, source } => {
                write!(f, "invalid number {raw:?}: {source}")
            }
            ConfigError::OutOfRange { port } => {
                write!(f, "port {port} must be in 1024..=65535")
            }
        }
    }
}

pub fn load_port(path: &Path) -> Result<u16, ConfigError> {
    let text = fs::read_to_string(path).map_err(|source| ConfigError::Read {
        path: path.display().to_string(),
        source,
    })?;

    let raw = text.trim().to_owned();
    let port = raw.parse::<u16>().map_err(|source| ConfigError::Parse {
        raw,
        source,
    })?;

    if !(1024..=65535).contains(&port) {
        return Err(ConfigError::OutOfRange { port });
    }

    Ok(port)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::fs;
    use std::path::PathBuf;

    fn temp_file(name: &str) -> PathBuf {
        std::env::temp_dir().join(format!(
            "rust-error-path-{}-{name}.txt",
            std::process::id()
        ))
    }

    #[test]
    fn missing_file_is_read_error() {
        let path = temp_file("missing");
        let _ = fs::remove_file(&path);

        let err = load_port(&path).unwrap_err();
        assert!(matches!(err, ConfigError::Read { .. }));
    }

    #[test]
    fn malformed_text_is_parse_error() {
        let path = temp_file("malformed");
        fs::write(&path, "abc").unwrap();

        let err = load_port(&path).unwrap_err();
        assert!(matches!(err, ConfigError::Parse { .. }));

        fs::remove_file(path).unwrap();
    }

    #[test]
    fn privileged_port_is_range_error() {
        let path = temp_file("range");
        fs::write(&path, "80").unwrap();

        let err = load_port(&path).unwrap_err();
        assert!(matches!(err, ConfigError::OutOfRange { port: 80 }));

        fs::remove_file(path).unwrap();
    }
}

预期结果

text
将代码保存为 src/lib.rs 后可由 cargo test 编译并执行;三个测试分别命中 Read、Parse 和 OutOfRange 分支。

这里故意不只写 assert!(result.is_err())。如果解析错误意外被改成范围错误,笼统断言仍会通过;匹配具体枚举分支才能确认错误分类没有退化。

运行三种故障注入

执行测试时加上单线程参数可以让输出顺序更稳定,也能避免未来多个测试误用同一路径时互相干扰。

bash
cargo test -- --test-threads=1

预期输出

text
running 3 tests
test tests::malformed_text_is_parse_error ... ok
test tests::missing_file_is_read_error ... ok
test tests::privileged_port_is_range_error ... ok

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

<TIME> 每次运行都可能不同。真正需要关注的是三条故障路径都被执行,而且没有测试失败。

为什么要用真实文件而不是只做 Mock

这组三种故障里,文件缺失属于 I/O 边界问题,格式错误和非法值属于内容边界问题。使用临时目录中的真实文件,可以同时验证“路径读取”和“内容解析”两层逻辑,而又不会依赖开发机上的固定配置文件。

测试文件名加入进程 ID 和场景名,是为了降低并行运行时的冲突概率。测试结束后删除成功创建的文件,避免把临时状态留给下一次运行。

继续检查诊断信息是否够用

错误分支命中只是最低要求。工程中还应检查错误是否携带排障需要的上下文,例如读取失败包含路径、解析失败保留原始文本、范围错误保留非法端口值。

如果某次重构把 ConfigError::Read 简化成没有路径的字符串,测试虽然可能仍能通过,但现场排障会失去关键线索。因此,错误测试既要验证“会失败”,也要验证“失败时留下了正确的信息”。

把故障注入纳入重构回归

错误处理重构最容易出现两类回归:某个 ? 把原本可区分的错误压成同一种类型,或者边界检查顺序变化后命中了错误分支。把典型故障固定成测试,可以在每次修改后快速验证这些路径。

当三类输入都能稳定触发预期错误、测试不依赖外部环境,并且诊断字段仍然完整时,错误路径才真正具备“可测试、可诊断、可维护”的工程属性。

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

目录与阅读设置

阅读设置

17

记录一个想法

用故障注入验证错误路径

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

登录哪都通