目录
介绍&测试范围
go test测试是go自带的测试工具,主要包括单元测试和性能测试两大类。
包括了工程目录下所有以_test.go为后缀名的源代码文件,这些文件在编译时不会被编译到最终的可执行文件中。
测试函数
命名
一般是以Test开头再加自定义函数名
正常:TestAnd
错误:Testand
参数
测试函数参数只有一个,普通的单元测试均为*testing.T,参数如果不对则会提示:Wrong test signature
可允许的参数类型如:
*testing.T:普通单元测试
*testing.B:benchmark基准测试,一般用于测试性能
*testing.M:测试主函数,在运行指定测试函数之前首先运行测试文件中的func TestMain(m *testing.M),TestMain运行在主goroutine中。
如待测函数为Add:
Go
func Add(a int, b int) int {
return a + b
}
则
Go
func TestAdd(t *testing.T) {
if result := Add(1, 2); result != 3 {
t.Errorf("1 + 2 = 3, not %d", result)
}
if result := Add(-1, -2); result != -3 {
t.Errorf("-1 + -2 = -3, not %d", result)
}
}
执行机制
go test过程首先扫描*_test.go的文件,会生成一个临时的main包用于调用相应的测试函数,然后构建、运行、产生测试结果,最后清理测试中生成的临时文件。
常用执行模式
1、仅运行一个测试函数
Go
go test -run TestAdd
2、运行一个包下所有的测试函数
根目录下运行指定包
Go
go test awesomeProject/testt
或进入指定包下再执行
Go
go test -v
其中 -v用于显示具体用例测试结果,不是必须的
注意,当有两个测试函数 TestAdd、TestAdd0时,执行go test -run TestAdd会将这两个都进行测试。
测试打印
测试函数与其它go函数一样都是函数,可使用fmt、log等进行打印,但参数t自带了常用的打印方法:
Go
// 打印日志
t.Log()
t.Logf()
// 打印错误,遇到错误终止执行
t.Fatal()
t.Fatalf()
// 打印错误,遇到错误继续执行
t.Error()
t.Errorf()
子测试
子测试是指在测试场景下允许使用t.Run来创建不同的子测试用例。
举例如下:
Go
func TestAdd(t *testing.T) {
testsAdd := []struct {
a, b int
want int
}{
{0, 1, 1},
{1, 2, 3},
{2, 2, 4},
{0, -1, -1},
{-3, 4, 1},
{-3, 1, -2},
{-1, -1, -2},
{-1, -2, -3},
}
for _, tt := range testsAdd {
t.Run("", func(t *testing.T) {
if got := Add(tt.a, tt.b); got != tt.want {
t.Errorf("Add(%d,%d) = %d, want %d", tt.a, tt.b, got, tt.want)
}
})
}
}
这种写法直观、清晰,新增用例方便、格式统一。用例正常时结果如下:
Go
PASS
ok awesomeProject/testt 0.754s
若将第一个用例写错模拟Add函数问题,结果如下:
Go
--- FAIL: TestAdd (0.00s)
--- FAIL: TestAdd/#00 (0.00s)
f_test.go:35: Add(0,1) = 1, want 2
FAIL
exit status 1
FAIL awesomeProject/testt 0.669s
帮助函数Helper()
改造上述测试函数,设定写法如下:
Go
func TestAddWithHelper(t *testing.T) {
type model struct {
a, b int
want int
}
execRun := func(t *testing.T, tt model) {
// t.Helper()
if got := Add(tt.a, tt.b); got != tt.want {
t.Errorf("Add(%d,%d) = %d, want %d", tt.a, tt.b, got, tt.want) // 52行
}
}
execRun(t, model{a: 0, b: 1, want: 0}) // 56行 设定错误,模拟测试不通过
execRun(t, model{a: 1, b: 2, want: 3})
}
多个自定义execRun在执行时都有出问题的可能,对于上述代码,当不加t.Helper()时提示如下:
Go
--- FAIL: TestAddWithHelper (0.00s)
f_test.go:52: Add(0,1) = 1, want 0
FAIL
FAIL awesomeProject/testt 0.707s
FAIL
可以看到是t.Errorf这一行,不是特别直观,下面加上t.Helper(),结果如下:
Go
--- FAIL: TestAddWithHelper (0.00s)
f_test.go:56: Add(0,1) = 1, want 0
FAIL
FAIL awesomeProject/testt 0.743s
FAIL
可以看到直接提示是56行的问题。
测试覆盖率
Go
go test awesomeProject/testt -run TestAdd0 -cover
其中-cover测试表示本次测试启用覆盖率检测。
覆盖率的含义是,代码被测试套件覆盖的百分比,即测试中至少被运行一次的代码占总代码的比例。
将覆盖率结果生成报告:
Go
go test awesomeProject/testt -run TestAdd0 -cover -coverprofile=a
如上,-coverprofile=a 参数会将覆盖率信息输出到文件a中,接着使用go tool调用本地浏览器来生成一个html格式的报告:
Go
go tool cover -html=a
效果如下
加函数测试了,减函数未测试。