在Zig中运行测试时如何向标准输出（stdout）打印内容？

问题描述 #

运行zig test执行以下测试代码时：

const std = @import("std");

fn failingFunction() error{Oops}!void {
    return error.Oops;
}

test "returning an error" {
    failingFunction() catch |err| {
        try std.testing.expect(err == error.Oops);
        std.debug.print("return from catched error: {}", .{err});
        return;
    };
}

控制台输出会出现混乱，例如：

Test [3/6] test.returning an error...All 6 tests passed.

原因是std.debug.print和默认测试运行器均输出到标准错误（stderr），两者的输出流重叠导致内容混杂。

虽然交付给他人的库测试不建议包含打印逻辑，但在开发阶段，测试中的打印调试是实用的辅助手段。Zig文档仅说明默认测试运行器和标准库测试命名空间向stderr输出消息，并未禁止测试中使用打印功能。

解决方案 #

要实现测试中干净的标准输出（stdout）打印，核心思路是将自定义打印内容输出到与测试运行器不同的流（即stdout），以下是具体方法：

方法1：直接使用标准输出写入器 #

替换std.debug.print为std.io.getStdOut().writer().print(...)，因为测试运行器仅向stderr输出，stdout的内容会独立显示，不会与测试进度信息混杂。

修改后的测试代码：

const std = @import("std");

fn failingFunction() error{Oops}!void {
    return error.Oops;
}

test "returning an error" {
    failingFunction() catch |err| {
        try std.testing.expect(err == error.Oops);
        // 使用标准输出打印，避免与测试运行器的stderr输出混杂
        try std.io.getStdOut().writer().print("return from catched error: {}\n", .{err});
        return;
    };
}

运行zig test后，测试进度信息会输出到stderr，自定义打印内容会输出到stdout，两者不会混杂，输出效果类似：

return from catched error: Oops
All 6 tests passed.

方法2：自定义测试运行器（进阶） #

如果需要更精细地控制测试输出的行为，可以自定义测试运行器，将测试运行器的输出固定到stderr，同时在测试中自由使用stdout打印。自定义运行器的核心是实现main函数并调用std.testing.runTests，示例如下：

const std = @import("std");

fn failingFunction() error{Oops}!void {
    return error.Oops;
}

test "returning an error" {
    failingFunction() catch |err| {
        try std.testing.expect(err == error.Oops);
        try std.io.getStdOut().writer().print("return from catched error: {}\n", .{err});
        return;
    };
}

pub fn main() !void {
    // 自定义测试运行器，使用默认配置，输出到stderr
    const tests = std.testing.refAllDecls(@This());
    _ = try std.testing.runTests(std.testing.defaultConfig, tests);
}

运行zig run test_file.zig（而非zig test）即可使用自定义运行器执行测试，同样能实现stdout打印与测试输出分离。

补充说明 #

Zig的这种设计是有意为之：默认测试运行器使用stderr输出，是为了让用户可以将测试的正常输出（如程序的stdout）重定向到文件时，不包含测试框架的进度信息。因此，只要将自定义打印内容输出到stdout，就能避免输出混乱。

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