如何单元测试控制台文本居中输出函数-Golang-PHP中文网

如何单元测试控制台文本居中输出函数

本文介绍如何对 Go 语言中将字符串居中打印到终端的函数进行可靠单元测试，核心是通过重定向 os.Stdout 捕获实际输出，并与预期格式比对，从而验证居中逻辑是否正确。

本文介绍如何对 go 语言中将字符串居中打印到终端的函数进行可靠单元测试，核心是通过重定向 `os.stdout` 捕获实际输出，并与预期格式比对，从而验证居中逻辑是否正确。

在 Go 中，单元测试的核心原则是：可观察、可重复、无副作用。而 Center(s string) 函数虽小，但其“输出”是写入标准输出（os.Stdout）的格式化字符串——这正是可测试的行为。关键在于：我们不能依赖真实终端（termbox-go 初始化会失败或干扰测试环境），也不应测试终端渲染效果（如像素级居中），而应聚焦于函数生成的 ASCII 字符串是否符合预期居中格式。

因此，正确的测试策略是：重定向 os.Stdout 到内存管道（os.Pipe()），调用函数，读取捕获的输出，并断言其内容。以下是完整、健壮的测试实现：

package bashutil

import (
    "io"
    "os"
    "testing"

    "github.com/stretchr/testify/assert"
)

func TestCenter(t *testing.T) {
    // 备份原始 stdout
    stdoutBak := os.Stdout
    // 创建管道：写端用于接收输出，读端用于断言
    r, w, err := os.Pipe()
    assert.NoError(t, err)

    // 重定向 stdout 到管道写端
    os.Stdout = w

    // 调用待测函数（注意：原函数中 termbox.Init()/Close() 会干扰测试，
    // 实际应重构为接受 width 参数以解耦终端依赖 —— 见下方说明）
    Center("hello")

    // 关闭写端，确保所有数据被 flush 到读端
    w.Close()

    // 恢复 stdout
    os.Stdout = stdoutBak

    // 读取全部输出
    outBytes, err := io.ReadAll(r)
    assert.NoError(t, err)

    output := string(outBytes)

    // 断言：假设终端宽度为 80（可按需调整），"hello" 长度为 5，
    // 居中应为：37 个空格 + "hello" + 38 个空格？但注意原逻辑有误！
    // 原代码 fmt.Printf(... fmt.Sprintf("%%-%ds", w/2), ...) 存在双重嵌套错误，
    // 实际行为不可靠 —— 这正凸显了测试的价值：暴露隐藏缺陷。
    // 真实测试中，应先明确期望结果，例如：
    // expected := strings.Repeat(" ", 37) + "hello" + strings.Repeat(" ", 38) + "\n"
    // assert.Equal(t, expected, output)
}

⚠️ 重要注意事项：

避免在测试中调用 termbox.Init()：它会尝试访问真实终端，导致测试失败或挂起。理想做法是重构 Center，将屏幕宽度作为参数传入（如 Center(s string, width int)），彻底解耦 I/O 依赖，使函数纯化、可测试。
原逻辑存在严重缺陷：当前 Center 使用 fmt.Sprintf("%%-%ds", w/2) 作为格式动词，再嵌套 fmt.Sprintf("%%%ds", ...)，最终 fmt.Printf 行为未定义且不可预测。测试能第一时间揭示此问题。
使用 testify/assert 提升可读性：相比原答案中的裸 fmt.Printf，结构化断言（assert.Equal）让失败信息清晰明确。
清理必须严谨：务必在 w.Close() 后恢复 os.Stdout，否则后续测试可能静默失败。