如何解决Cargo测试中切换目录引发的竞态条件问题？

问题背景 #

你的项目里，config.rs中的两个测试用例会修改全局当前目录来模拟用户场景，但Rust测试默认多线程执行时，会出现竞态条件：两个测试的目录切换操作互相干扰，导致生成examples/test1_dir/examples/test2_dir这类错误路径。单线程执行虽能解决问题，但会拖慢其他测试的执行效率。

可行解决方案 #

方案1：给目录相关测试加全局互斥锁 #

通过全局互斥锁让这两个涉及目录切换的测试串行执行，其他测试仍保持多线程并行，不影响整体测试效率。

在config.rs中添加全局锁，并在测试中获取锁：

use std::sync::Mutex;
use std::env;

// 定义全局互斥锁，用于同步目录切换的测试
static DIR_TEST_LOCK: Mutex<()> = Mutex::new(());

#[test]
fn config_find_file() {
    // 获取锁，其他测试会阻塞直到当前测试释放锁
    let _lock = DIR_TEST_LOCK.lock().unwrap();
    
    let original_dir = env::current_dir().unwrap();
    env::set_current_dir("examples/test1_dir").unwrap();

    // ... 你的测试逻辑

    // 恢复原目录
    env::set_current_dir(original_dir).unwrap();
} 

#[test]
fn config_find_file_2() {
    let _lock = DIR_TEST_LOCK.lock().unwrap();
    
    let original_dir = env::current_dir().unwrap();
    env::set_current_dir("examples/test2_dir").unwrap();

    // ... 你的测试逻辑

    env::set_current_dir(original_dir).unwrap();
} 

方案2：重构逻辑，避免修改全局当前目录（推荐） #

从根源上消除全局状态依赖，修改业务函数支持传入目录路径，测试时直接传递目标目录的绝对路径，完全不需要切换当前目录。

比如重构你的配置查找函数：

use std::path::Path;
use std::fs;

// 修改后（支持指定目录）
fn load_config<P: AsRef<Path>>(dir: P) -> Result<Config, Box<dyn std::error::Error>> {
    let config_path = dir.as_ref().join("config.toml");
    let content = fs::read_to_string(config_path)?;
    Ok(serde_json::from_str(&content)?)
}

// 测试用例修改为直接传绝对路径
#[test]
fn config_find_file() {
    let project_root = env::current_dir().unwrap();
    let test_dir = project_root.join("examples/test1_dir");
    
    let config = load_config(test_dir).unwrap();
    // ... 你的断言逻辑
}

#[test]
fn config_find_file_2() {
    let project_root = env::current_dir().unwrap();
    let test_dir = project_root.join("examples/test2_dir");
    
    let config = load_config(test_dir).unwrap();
    // ... 你的断言逻辑
}

这种方式彻底避免了全局状态的修改，测试之间完全独立，不会有竞态问题，同时保持所有测试的并行能力。

方案3：分批次执行测试（脚本化） #

如果不想修改代码，可以通过两次测试命令分别执行非config测试和config测试，将命令封装成脚本简化操作。

创建run_tests.sh脚本：

#!/bin/bash
# 执行除config模块外的所有测试，使用多线程
cargo test --lib 'not config' -- --test-threads=auto

# 执行config模块的测试，使用单线程
cargo test --lib config -- --test-threads=1

给脚本添加执行权限：chmod +x run_tests.sh，之后直接运行./run_tests.sh即可完成全部测试。

内容的提问来源于stack exchange，提问作者Nishant Jalan