Rust测试工具库test-binary使用指南

test-binary是一个Rust测试工具库，专门用于测试二进制程序，提供了一套完整的二进制测试框架和自动化测试功能。它特别适合测试命令行应用程序和其他可执行程序。

主要特性

• 执行二进制程序并捕获输出
• 验证退出状态码
• 检查标准输出和标准错误内容
• 提供断言宏用于测试验证
• 支持测试环境设置和清理

安装方法

在Cargo.toml中添加依赖：

[dev-dependencies]
test-binary = "0.4"

基本使用方法

1. 简单测试示例

use test_binary::build_test_binary;

#[test]
fn test_hello_world() {
    // 构建要测试的二进制程序
    let bin = build_test_binary!("../path/to/your/binary")
        .expect("failed to build test binary");
    
    // 执行程序并捕获输出
    let output = bin.output().expect("failed to execute binary");
    
    // 验证退出码是否为0(成功)
    assert!(output.status.success());
    
    // 验证标准输出是否包含特定文本
    assert!(String::from_utf8_lossy(&output.stdout).contains("Hello, world!"));
}

2. 带参数测试

use test_binary::build_test_binary;

#[test]
fn test_with_args() {
    let bin = build_test_binary!("../path/to/your/binary")
        .expect("failed to build test binary");
    
    // 执行带参数的程序
    let output = bin.args(&["--name", "Rust"]).output().unwrap();
    
    assert!(String::from_utf8_lossy(&output.stdout).contains("Hello, Rust!"));
}

3. 测试错误情况

use test_binary::build_test_binary;

#[test]
fn test_error_case() {
    let bin = build_test_binary!("../path/to/your/binary")
        .expect("failed to build test binary");
    
    let output = bin.args(&["--invalid-arg"]).output().unwrap();
    
    // 验证程序是否以错误码退出
    assert!(!output.status.success());
    
    // 验证错误输出
    assert!(String::from_utf8_lossy(&output.stderr).contains("invalid argument"));
}

高级功能

1. 测试环境设置

use test_binary::{build_test_binary, TestBinary};
use tempfile::tempdir;

#[test]
fn test_with_environment() {
    // 创建临时目录
    let temp_dir = tempdir().unwrap();
    
    let bin = build_test_binary!("../path/to/your/binary")
        .current_dir(temp_dir.path())  // 设置工作目录
        .env("MY_VAR", "test_value")   // 设置环境变量
        .expect("failed to build test binary");
    
    let output = bin.output().unwrap();
    // 进行断言...
}

2. 测试交互式程序

use test_binary::build_test_binary;
use std::io::Write;

#[test]
fn test_interactive() {
    let mut bin = build_test_binary!("../path/to/your/binary")
        .spawn()
        .expect("failed to spawn binary");
    
    // 向程序标准输入写入数据
    bin.stdin.as_mut().unwrap().write_all(b"input data\n").unwrap();
    
    // 等待程序结束
    let output = bin.wait_with_output().unwrap();
    
    // 进行断言...
}

最佳实践

1. 将测试二进制程序放在项目的tests/目录中
2. 为每个主要功能编写单独的测试用例
3. 使用临时目录和文件进行需要文件系统操作的测试
4. 清理测试创建的任何资源
5. 测试正常情况和各种错误情况

test-binary库为Rust程序的二进制测试提供了强大而灵活的工具，特别适合测试命令行应用程序和其他需要执行环境验证的程序。

完整示例demo

下面是一个完整的测试示例，展示如何使用test-binary测试一个简单的命令行程序：

// 测试一个简单的命令行计算器程序

use test_binary::build_test_binary;
use tempfile::tempdir;

#[test]
fn test_calculator() {
    // 1. 测试加法功能
    let bin = build_test_binary!("../target/debug/calculator")
        .expect("failed to build test binary");
    
    let output = bin.args(&["add", "5", "3"]).output().unwrap();
    
    assert!(output.status.success());
    assert_eq!(String::from_utf8_lossy(&output.stdout).trim(), "8");
    
    // 2. 测试减法功能
    let output = bin.args(&["sub", "10", "4"]).output().unwrap();
    
    assert!(output.status.success());
    assert_eq!(String::from_utf8_lossy(&output.stdout).trim(), "6");
    
    // 3. 测试错误情况 - 缺少参数
    let output = bin.args(&["add", "5"]).output().unwrap();
    
    assert!(!output.status.success());
    assert!(String::from_utf8_lossy(&output.stderr).contains("not enough arguments"));
    
    // 4. 测试文件操作功能
    let temp_dir = tempdir().unwrap();
    let file_path = temp_dir.path().join("test.txt");
    
    let bin = build_test_binary!("../target/debug/calculator")
        .current_dir(temp_dir.path())
        .expect("failed to build test binary");
    
    let output = bin.args(&["create-file", "test.txt"]).output().unwrap();
    
    assert!(output.status.success());
    assert!(file_path.exists());
}

这个完整示例演示了：

1. 测试不同的命令行参数组合
2. 验证正常情况和错误情况的输出
3. 使用临时目录进行文件系统操作测试
4. 检查程序的退出状态码和输出内容