Go / 系统课时

用 testing 写单元测试

用 testing 写单元测试

单元测试最适合验证输入与输出明确的小函数。本篇会建立最小 Go 模块,用 _test.go、TestXxx、t.Run 和失败报告测试名称归一化函数,并用 go test 验证测试发现与执行规则。

学习目标

  • 能创建符合 Go 约定的 _test.go 文件和 TestXxx 测试函数。
  • 会用 t.Run 组织子测试,并用 t.Fatalf 输出可定位的 got/want 差异。
  • 能用 go test、-run 与 -v 选择并观察测试执行结果。

建立可测试的最小包

创建目录后初始化模块,模块名可以是本地示例用的 example.com/testing-demo。测试文件与被测文件放在同一个包时,可以直接访问包内未导出的标识符;本篇只测试导出的 NormalizeName。

bash
mkdir testing-demo
cd testing-demo
go mod init example.com/testing-demo

预期输出:

text
go: creating new go.mod: module example.com/testing-demo

新建 name.go,让函数完成两件事:去掉首尾空白,并统一转成小写。这个函数没有网络、文件或时间依赖,适合做快速单元测试。

go
package testingdemo

import "strings"

func NormalizeName(s string) string {
    return strings.ToLower(strings.TrimSpace(s))
}

预期结果:保存后执行 go test 时,Go 能编译该包;函数输入 " Alice " 时应返回 "alice"。

用 TestXxx 和 t.Run 写断言

Go 的 testing 包按命名约定发现测试:函数必须以 Test 开头,签名必须是 func TestXxx(t *testing.T)。下面把两个场景放进一个测试函数,再用 t.Run 给每个场景独立命名。

go
package testingdemo

import "testing"

func TestNormalizeName(t *testing.T) {
    t.Run("trim and lowercase", func(t *testing.T) {
        got := NormalizeName("  Alice  ")
        want := "alice"
        if got != want {
            t.Fatalf("NormalizeName() = %q, want %q", got, want)
        }
    })

    t.Run("empty after trim", func(t *testing.T) {
        got := NormalizeName("   ")
        want := ""
        if got != want {
            t.Fatalf("NormalizeName() = %q, want %q", got, want)
        }
    })
}

预期结果:将代码保存为 name_test.go 后,两个子测试都应通过;若断言失败,t.Fatalf 会立即终止当前子测试并报告实际值与期望值。

运行完整包测试:

bash
go test -v

预期输出:

text
=== RUN   TestNormalizeName
=== RUN   TestNormalizeName/trim_and_lowercase
=== RUN   TestNormalizeName/empty_after_trim
--- PASS: TestNormalizeName (<TIME>)
    --- PASS: TestNormalizeName/trim_and_lowercase (<TIME>)
    --- PASS: TestNormalizeName/empty_after_trim (<TIME>)
PASS
ok      example.com/testing-demo    <TIME>

<TIME> 由机器性能决定,实际值可能不同。子测试名称中的空格会在 go test -v 输出里显示为下划线,便于在命令行中稳定引用。

读取失败报告

故意把第一个子测试的 want 改成 "alice smith" 后再次执行 go test -v,测试会失败。失败报告最值得关注的是测试路径、断言文本和最终 FAIL 状态;行号可能因文件内容变化而不同。

bash
go test -run 'TestNormalizeName/trim_and_lowercase' -v

预期输出:

text
=== RUN   TestNormalizeName
=== RUN   TestNormalizeName/trim_and_lowercase
    name_test.go:<LINE>: NormalizeName() = "alice", want "alice smith"
--- FAIL: TestNormalizeName (<TIME>)
    --- FAIL: TestNormalizeName/trim_and_lowercase (<TIME>)
FAIL
exit status 1
FAIL    example.com/testing-demo    <TIME>

这里 -run 接收正则表达式,路径可匹配父测试和子测试。定位失败时先看 NormalizeName() = "alice", want "alice smith",它直接说明实际结果与期望值的差异。

选择合适的失败 API

testing.T 常用的失败方法有明确差别。一般断言失败且后续检查已无意义时用 t.Fatalf;如果还希望继续执行当前测试中的其他独立检查,可用 t.Errorf。辅助函数里调用 t.Helper(),可以让失败位置指向调用者而不是辅助函数内部。

不要在单元测试里依赖测试执行顺序,也不要让多个测试共享可变全局状态。保持测试独立后,go test ./... 才能稳定地作为本地检查和持续集成入口。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 testing 写单元测试

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通