独孤九剑 Dit (0x04) - 测试篇
《南皮县志·风土志下·歌谣》：“兵马不动，粮草先行”。作战时兵马还没出动，军用粮草的运输要先行一步。在开发新功能之前，先编写测试代码，然后只编写使测试通过的功能代码，这种以测试驱动开发的开发模式是我非常推荐的。
对 Dit 的贡献要求需要通过单元测试，编写 Dit 的任意模块，都需要一并编写测试用例。本文先简述一下 Go 对测试的支持，后续会陆续提供 Dit 的测试方案和测试报告。
Go 对测试的支持
Go 自带的测试框架 testing 支持单元测试和性能测试。Go 规定测试文件以 _test.go 为后缀，使用命令 go test 命令自动运行测试用例。
单元测试
以 Test 开头的方法为一个测试用例，并拥有一个参数 *testing.T, 写法如下：
func TestXxx(*testing.T)
Xxx 部分为任意的字母数字组合，首字母不能是小写字母。*testing.T 可记录错误或者标记错误状态。可通过 Short 判断略过一部分测试，加快测试时间。如下：
func TestTimeConsuming(t *testing.T) {
if testing.Short() {
t.Skip("skipping test in short mode.")
}
...
}
性能测试
性能测试用例以 Benchmark 开始，参数为 *testing.B, 写法如下：
func BenchmarkXxx(*testing.B)
使用 go test 运行性能测试用例时，需要加上参数 -bench。
在编写性能测试用例时,需牢记在循环体内使用 testing.B.N , 以使测试可以正常的运行:
func BenchmarkHello(b *testing.B) {
for i := 0; i < b.N; i++ {
fmt.Sprintf("hello")
}
}
对耗时的初始化操作，可在测试用例内部重置计时器 ResetTimer，确保引入不必要的误差:
func BenchmarkBigLen(b *testing.B) {
big := NewBig()
b.ResetTimer()
for i := 0; i < b.N; i++ {
big.Len()
}
}
使用 RunParallel 测试并行模块, 运行时需要加上参数 -cpu:
func BenchmarkTemplateParallel(b *testing.B) {
templ := template.Must(template.New("test").Parse("Hello, \{\{.}}!"))
b.RunParallel(func(pb *testing.PB) {
var buf bytes.Buffer
for pb.Next() {
buf.Reset()
templ.Execute(&buf, "World")
}
})
}
标准输出测试
testing 包提供对标准终端输出的测试, 测试用例以 Example 开始，结果使用注释的方式，写在 Output: 之后：
func ExampleHello() {
fmt.Println("hello")
// Output: hello
}
Example 用例的命名规则:
func Example() { ... }
func ExampleF() { ... } // F - function
func ExampleT() { ... } // T - type
func ExampleT_M() { ... } // T_M - method M on type T
// 多个 example 可用后缀区分，The suffix must start with a lower-case letter.
func Example_suffix() { ... }
func ExampleF_suffix() { ... }
func ExampleT_suffix() { ... }
func ExampleT_M_suffix() { ... }
Main 测试
当需要批量 setup 或 teardown 测试环境时，可使用：
func TestMain(m *testing.M)
TestMain 简单实现如下：
func TestMain(m *testing.M) {
flag.Parse()
os.Exit(m.Run())
}
Demo
写一个简单的示例，来 Demo 一下 testing 测试框架的用法。
// div.go
package test
import (
"errors"
)
func div(a, b int) (int, error) {
if b == 0 {
return 0, errors.New("b must NOT be 0")
}
return a / b, nil
}
// div_test.go
package test
import (
"errors"
"flag"
"fmt"
"os"
"testing"
"time"
)
func TestDivNormal(t *testing.T) {
ret, err := div(6, 2)
if err != nil || ret != 3 {
t.Error("6/2=3")
}
}
func TestDivZero(t *testing.T) {
_, err := div(6, 0)
if err.Error() != errors.New("b must NOT be 0").Error() {
t.Error("zero div error")
}
}
func BenchmarkDiv(b *testing.B) {
b.Log("run times:", b.N)
for i := 0; i < b.N; i++ {
div(6, 2)
}
}
func BenchmarkDiv_Sleep(b *testing.B) {
b.Log("run times:", b.N)
time.Sleep(3000) // 模拟费时操作
b.ResetTimer()
for i := 0; i < b.N; i++ {
div(6, 2)
}
}
func ExampleOutput() {
ret, _ := div(6, 2)
fmt.Println("6 / 2 =", ret)
// Output:
// 6 / 2 = 3
}
func TestMain(m *testing.M) {
flag.Parse()
fmt.Println("Setup ... Done")
ret := m.Run()
fmt.Println("Teardown ... Done")
os.Exit(ret)
}
运行 go test -v, 结果如下：
localhost:test zdd$ go test -v
Setup ... Done
=== RUN TestDivNormal
--- PASS: TestDivNormal (0.00s)
=== RUN TestDivZero
--- PASS: TestDivZero (0.00s)
=== RUN: ExampleOutput
--- PASS: ExampleOutput (0.00s)
PASS
Teardown ... Done
ok github.com/zddhub/hellogo/test 0.005s
默认不执行性能测试用例，使用 go test -v -bench . 执行:
localhost:test zdd$ go test -v -bench .
Setup ... Done
=== RUN TestDivNormal
--- PASS: TestDivNormal (0.00s)
=== RUN TestDivZero
--- PASS: TestDivZero (0.00s)
=== RUN: ExampleOutput
--- PASS: ExampleOutput (0.00s)
PASS
BenchmarkDiv 100000000 16.2 ns/op
--- BENCH: BenchmarkDiv
div_test.go:27: run times: 1
div_test.go:27: run times: 100
div_test.go:27: run times: 10000
div_test.go:27: run times: 1000000
div_test.go:27: run times: 100000000
BenchmarkDiv_Sleep 100000000 16.4 ns/op
--- BENCH: BenchmarkDiv_Sleep
div_test.go:34: run times: 1
div_test.go:34: run times: 100
div_test.go:34: run times: 10000
div_test.go:34: run times: 1000000
div_test.go:34: run times: 100000000
Teardown ... Done
ok github.com/zddhub/hellogo/test 3.305s
如果你喜欢这篇文章，欢迎赞赏作者以示鼓励
