Rust测试辅助库test-with的使用：简化单元测试与集成测试的编写与执行

test-with是一个帮助你在特定条件下运行测试的库，如果条件不满足则会清晰地显示忽略信息。它还能让你更轻松地使用自定义测试环境或模拟服务运行测试。

安装

在项目的dev-dependencies中添加：

[dev-dependencies]
test-with = "*"

如果要减少依赖大小和编译时间，可以禁用默认功能并只启用特定功能：

[dev-dependencies]
test-with = { version = "*", default-features = false, features = ["http"] }

可用功能包括：net(http, icmp), resource, user, executable。

环境变量测试

// PWD环境变量存在时运行测试
#[test_with::env(PWD)]
#[test]
fn test_works() {
    assert!(true);
}

// NOTHING环境变量不存在时运行测试
#[test_with::env(NOTHING)]
#[test]
fn test_ignored() {
    panic!("should be ignored")
}

完整示例：

#[test_with::env(PWD)]
#[test]
fn test_with_env_var() {
    // 这个测试只会在PWD环境变量存在时运行
    assert!(true);
}

#[test_with::no_env(GITHUB_ACTIONS)]
#[test]
fn test_ignore_in_github_action() {
    // 这个测试在GITHUB_ACTIONS环境变量存在时会被忽略
    println!("Should be ignored in GITHUB_ACTION");
}

文件/文件夹测试

// /etc/hostname文件存在时运行测试
#[test_with::file(/etc/hostname)]
#[test]
fn test_works() {
    assert!(true);
}

// /etc/nothing文件不存在时运行测试
#[test_with::file(/etc/nothing)]
#[test]
fn test_ignored() {
    panic!("should be ignored")
}

// /etc目录存在时运行测试
#[test_with::path(/etc)]
#[test]
fn test_works_for_path() {
    assert!(true);
}

完整示例：

#[test_with::file(Cargo.toml)]
#[test]
fn test_with_file() {
    // 这个测试只会在Cargo.toml文件存在时运行
    assert!(true);
}

#[test_with::path(src)]
#[test]
fn test_with_directory() {
    // 这个测试只会在src目录存在时运行
    assert!(true);
}

HTTP/HTTPS服务测试

// https服务存在时运行测试
#[test_with::https(www.rust-lang.org)]
#[test]
fn test_works() {
    assert!(true);
}

// not.exist.com不存在时运行测试
#[test_with::https(not.exist.com)]
#[test]
fn test_ignored() {
    panic!("should be ignored")
}

完整示例：

#[test_with::http(localhost:8080)]
#[test]
fn test_with_http_service() {
    // 这个测试只会在localhost:8080 HTTP服务可用时运行
    assert!(true);
}

#[test_with::https(api.example.com)]
#[test]
fn test_with_https_service() {
    // 这个测试只会在api.example.com HTTPS服务可用时运行
    assert!(true);
}

TCP套接字测试

// TCP端口53可用时运行测试
#[test_with::tcp(8.8.8.8:53)]
#[test]
fn test_works() {
    assert!(true);
}

// 193.194.195.196不可用时运行测试
#[test_with::tcp(193.194.195.196)]
#[test]
fn test_ignored() {
    panic!("should be ignored")
}

完整示例：

#[test_with::tcp(127.0.0.1:6379)]
#[test]
fn test_with_redis() {
    // 这个测试只会在本地Redis服务(6379端口)可用时运行
    assert!(true);
}

运行时测试

启用runtime功能：

test-with = { version = "0.15.0", features = ["runtime"] }
libtest-with = { version = "0.8.1-10", features = ["net", "resource", "user", "executable"] }

示例：

test_with::runner!(module_name);

#[test_with::module]
mod module_name {
    #[test_with::runtime_env(PWD)]
    fn test_works() {
    }
}

完整示例：

test_with::runner!(custom_mod);

fn something_happened() -> Option<String> {
    Some("because something happened".to_string())
}

#[test_with::module]
mod custom_mod {
    #[test_with::runtime_ignore_if(something_happened)]
    fn test_ignored() {
        assert!(false);
    }
}

锁测试

// 使用文件锁确保测试顺序执行
#[test_with::lock(LOCK)]
fn test_1() {
    assert!(true);
}

#[test_with::lock(LOCK)]
fn test_2() {
    assert!(true);
}

完整示例：

#[test_with::lock(DATABASE_LOCK, 10)]  // 10秒等待时间
#[test]
fn test_database_operation1() {
    // 这个测试会获取DATABASE_LOCK锁
    assert!(true);
}

#[test_with::lock(DATABASE_LOCK, 10)]
#[test]
fn test_database_operation2() {
    // 这个测试会等待前一个测试释放锁
    assert!(true);
}

时区测试

// UTC时区运行测试
#[test_with::timezone(0)]
#[test]
fn test_works() {
    assert!(true);
}

// GMT+8时区运行测试
#[test_with::timezone(+8)]
#[test]
fn test_run_in_TW() {
    assert!(true)
}

完整示例：

#[test_with::timezone(+8)]
#[test]
fn test_in_taiwan_timezone() {
    // 这个测试只会在GMT+8时区运行
    assert!(true);
}

用户/组条件测试

#[test_with::root()]
#[test]
fn test_ignored() {
    panic!("should be ignored")
}

#[test_with::group(avengers)]
#[test]
fn test_ignored2() {
    panic!("should be ignored")
}

#[test_with::user(spider)]
#[test]
fn test_ignored3() {
    panic!("should be ignored")
}

完整示例：

#[test_with::user(admin)]
#[test]
fn test_admin_only() {
    // 这个测试只会在admin用户下运行
    assert!(true);
}

可执行文件测试

// `pwd`命令存在时运行测试
#[test_with::executable(pwd)]
#[test]
fn test_executable() {
    assert!(true);
}

// `/bin/sh`存在时运行测试
#[test_with::executable(/bin/sh)]
#[test]
fn test_executable_with_path() {
    assert!(true);
}

完整示例：

#[test_with::executable(docker)]
#[test]
fn test_with_docker() {
    // 这个测试只会在docker命令可用时运行
    assert!(true);
}

test-with库提供了多种条件测试方式，可以大大简化Rust项目中单元测试和集成测试的编写与执行，特别是在需要特定环境或依赖服务的测试场景中。