Go 的测试框架

Go 语言中自带了测试框架,在不引入外部包的情况下,也可以编写完整的测试。这篇文章来看一下Go 提供原生测试能力,及其不足之处,以及补充这些不足的方法。

1. 基本测试框架

在 Go 语言中,所有的测试都需要以 _test.go 结尾,这样go build 不会去编译 _test.go 结尾的文件,而 go test 会去编译 _test.go 结尾的文件。

在编写测试的时候,我们都会用到 testing 这个包,在这个包中,常用的类型有下面这些:

  • testing.T
  • testing.B
  • testing.M

testing.TB 和 testing.PB 平时用的不多,在这里就不展开说,感兴趣的可以自行去搜索。上面的三类代表了三种不同的测试,分别是单元测试、基准测试和 TestMain 测试,对于不同的测试,在测试方法的入参中,必须带上这个类型。

有一类测试例外,那就是 Example 测试,这个测试主要用来在文档中输出一些测试案例,Example 测试必须以 Example 开头,方法不需要任何参数,同时要指明这个实例的输出,像下面这样:

1
2
3
4
5
func ExampleTest() {
fmt.Println("run example test")
// Output:
// run example test
}

所有的测试都可以通过 go test 来发起,例如,在当前包下发起测试 go test -v ./ ,-v 参数表示打印测试的过程,会把测试过程中的标准输出都打印出来。

2. 单元测试

单元测试的编写需要按照一定的规则来,所有的单元测试都需要以 Test 开头,后面加上测试的方法名称,就像下面这样:

1
2
3
4
5
6
7
8
import (
"fmt"
"testing"
)

func TestDemo(t *testing.T) {
fmt.Println(" run test demo")
}

这就是一个最简单的单元测试,在实际使用中,一组测试可能会有多个单元测试,而且要同时运行,这时我们就需要一个方法将这些测试串联起来,那就需要用到 TestMain 了,这个方法名称和签名是统一的,只能是下面的写法:

1
2
3
4
5
func TestMain(m *testing.M)  {
fmt.Println("begin test")
m.Run()
fmt.Println("end test")
}

TestMain(m *testing.M) 在一个包下只能有一个,测试执行的时候,会先执行这个方法,然后再去执行这个包下的所有 Test 测试和 Example 测试,基准测试则不会执行。

而且这个方法可以用来初始化和回收资源,有些测试在运行之前需要初始化一些配置,连接数据库、释放数据库连接等操作,就可以在这个测试中完成。

写完上面的测试之后,就可以运行测试了,这样会从 TestMain 开始,运行所有的 Test 和 Example 测试:

1
$ go test -v ./

但有时候我们也会关心单元测试的覆盖率,只要加上一个参数就可以看到测试的覆盖率:

1
$ go test -cover -v ./

3. 基准测试

基准测试通常用来测试某个程序的性能,基准测试必须要用 Benchmark 开头,同时方法的入参必须是 testing.B,就像下面这样:

1
2
3
func BenchmarkDemo(b *testing.B) {
fmt.Println("run benchmark demo")
}

为了更好的说明基准测试的功能,我用之前测试字符串拼接的基准测试的例子来说明:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
func BenchmarkPlus(b *testing.B) {
str := "this is just a string"

for i := 0; i < b.N; i++ {
stringPlus(str)
}
}

func stringPlus(str string) string {
s := ""
for i := 0; i < 10000; i++ {
s += str
}
return s
}

其中 b.N 不是一个固定的值,这个值的大小由框架自己来决定,上面这侧测试的内容是对于一个要拼接一万次字符传的函数进行性能测试,至于这个测试运行多少次,由框架自己决定。

运行基准测试的命令如下:

1
$ go test -bench=. -benchmem .

输出结果如下:

1
2
3
4
5
6
goos: darwin
goarch: amd64
pkg: zxin.com/zx-demo/string_benchmark
**BenchmarkPlus-12 12 96586447 ns/op 1086401355 B/op 10057 allocs/op**
PASS
ok zxin.com/zx-demo/string_benchmark 6.186s

加粗的那行是基准测试的输出,每列信息的具体含义如下:

  • 第一列表示基准测试的方法名称和所用的 GOMAXPROCS 的值
  • 第二列表示这次测试循环的次数
  • 第三列表示平均每次测试所用的时间,单位为纳秒
  • 第四列表示平均每次运行所分配的内存
  • 第五列表示每次运行所分配内存的次数

4. 测试加强

但原生的测试包不够完美,比如在单元测试中,就缺少断言机制,使得在判断测试结果的时候,非常不方便,有一个外部的包可以帮助完善测试的功能。

安装也很方便:

1
$ go get github.com/stretchr/testify

这个包从三个方面扩展了 Go 原生测试框架的能力:

  • 断言

原生测试框架里面缺失断言功能,在很多场景下都不方便,testify 提供的断言功能开箱即用,与原生测试框架完美契合:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
func TestAssert(t *testing.T) {
assert := assert.New(t)

assert.Equal(123, 123, "they should be equal")

assert.NotEqual(123, 456, "they should not be equal")

o := make(map[string]string)
o["ray"] = "jun"

if assert.NotNil(o) {
assert.Equal("jun", o["ray"])
} else {
assert.Nil(o)
}
}

  • Mock 能力

testify 提供了Mock 的能力,可以很好的模拟测试需要的数据,对于一些需要复杂数据的测试很有帮助:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
type MyMockedObject struct{
mock.Mock
}

func (m *MyMockedObject) DoSomething(number int) (bool, error) {
args := m.Called(number)
return args.Bool(0), args.Error(1)

}

func TestSomething(t *testing.T) {
testObj := new(MyMockedObject)

testObj.On("DoSomething", 123).Return(true, nil)

testMockObj(testObj)

testObj.AssertExpectations(t)
}

func testMockObj(mcObj *MyMockedObject) {
fmt.Println(mcObj.DoSomething(123))
}

  • 构建更完善的测试

即使有了 TestMain 来初始化配置,但也还是不够灵活,比如在一个包下,我需要包含多组测试,而且每组测试的初始化都不一样,而 testify 提供的 suite 包提供了更加面向对象的测试方式,并且也提供了 setup/teardown 等方法来初始化和回收资源,可以直接使用 go test 进行测试,不会对现有的测试框架有侵入性修改:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
type ExampleTestSuite struct {
suite.Suite
VariableThatShouldStartAtFive int
}

func (suite *ExampleTestSuite) SetupTest() {
fmt.Println("run setup method")
suite.VariableThatShouldStartAtFive = 5
}

func (suite *ExampleTestSuite) TearDownTest() {
fmt.Println("run tear down method")
suite.VariableThatShouldStartAtFive = 0

}

func (suite *ExampleTestSuite) TestExample() {
assert.Equal(suite.T(), 5, suite.VariableThatShouldStartAtFive)
}

func TestExampleTestSuite(t *testing.T) {
suite.Run(t, new(ExampleTestSuite))
}

5. 小结

虽然 Go 原生测试框架已经支持编写很复杂的测试,但很多场景下还不是很方便,这时候就有必要引入新的测试加强包 testify,这个包基本做到了开箱即用,而且不会破坏现有的测试流程。

文 / Rayjun

© 2020 Rayjun    PowerBy Hexo    京ICP备16051220号-1