如何仅在Rust测试失败时输出目标函数的调试信息？

你可以通过自定义宏结合线程本地存储与 panic 钩子，实现仅在测试失败时输出调试信息的testprint!宏，完全满足你的需求：

实现步骤 #

1. 定义核心逻辑与宏 #

在你的 crate 中添加以下代码（可放在src/lib.rs或单独模块）：

#[cfg(test)]
use std::cell::RefCell;
#[cfg(test)]
use std::fmt::Write;
#[cfg(test)]
use std::sync::Once;

// 线程本地存储：存储调试信息的缓冲区和失败标记
#[cfg(test)]
thread_local! {
    static TEST_DEBUG_BUFFER: RefCell<String> = RefCell::new(String::new());
    static TEST_FAILED: RefCell<bool> = RefCell::new(false);
}

#[cfg(test)]
fn setup_test_hooks() {
    // 设置 panic 钩子：测试 panic 时标记失败状态
    let original_panic_hook = std::panic::take_hook();
    std::panic::set_hook(Box::new(move |panic_info| {
        TEST_FAILED.with(|tf| *tf.borrow_mut() = true);
        original_panic_hook(panic_info);
    }));

    // 测试结束清理 guard：线程退出时检查失败状态并输出缓冲区内容
    struct TestGuard;

    impl Drop for TestGuard {
        fn drop(&mut self) {
            let failed = TEST_FAILED.with(|tf| *tf.borrow());
            if failed {
                let mut buffer = TEST_DEBUG_BUFFER.with(|b| b.take());
                if !buffer.is_empty() {
                    eprintln!("\n=== 测试调试输出 ===");
                    eprint!("{}", buffer);
                    eprintln!("===================");
                }
            }
        }
    }

    // 初始化 guard，确保每个测试线程都有一个实例
    thread_local! {
        static TEST_GUARD: RefCell<Option<TestGuard>> = RefCell::new(Some(TestGuard));
    }

    TEST_GUARD.with(|g| { let _ = g.borrow_mut(); });
}

// 自定义 testprint! 宏
#[macro_export]
macro_rules! testprint {
    ($($arg:tt)*) => {
        #[cfg(test)]
        {
            // 确保钩子仅初始化一次
            static HOOK_SETUP: Once = Once::new();
            HOOK_SETUP.call_once(|| $crate::setup_test_hooks());

            // 将调试信息写入线程本地缓冲区
            let mut buffer = $crate::TEST_DEBUG_BUFFER.with(|b| b.borrow_mut());
            let _ = write!(buffer, $($arg)*);
        }
        // 非测试构建下无任何操作
        #[cfg(not(test))]
        {}
    };
}

2. 在foo()中使用宏 #

直接在foo()函数内调用testprint!即可，无需修改测试代码：

fn foo() {
    // 仅在测试失败时输出此调试信息
    testprint!("foo() 执行到关键步骤，当前值：{}\n", 42);
    
    // 函数原有业务逻辑
    // ...
}

工作原理 #

• 非测试构建（debug/release）：testprint!宏会被编译为空语句，完全没有运行时开销或输出。
• 测试构建（cargo test）：
  1. 首次调用testprint!时，自动初始化 panic 钩子和线程本地的测试清理 guard。
  2. 每次调用testprint!都会将调试信息写入线程本地缓冲区，不会立即输出。
  3. 如果测试触发 panic（例如assert_eq!失败、unwrap()出错），panic 钩子会标记测试为失败状态。
  4. 测试线程退出时，guard 的drop方法会检查测试是否失败：若失败，则将缓冲区中的所有调试信息输出到 stderr。

注意事项 #

• 此方案主要处理基于 panic 的测试失败（如assert!、assert_eq!、unwrap()等导致的失败）。
• 对于返回Result<(), E>的测试：若测试返回Err但未触发 panic，当前方案无法检测到失败状态，因此不会输出调试信息。若需要支持这种场景，需在测试代码中手动标记失败（但这不符合你无需修改测试代码的要求）。

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