1.9 Go 单元测试和性能测试

测试对于互联网应用软件开发来说非常重要，它对软件可靠性保证具有重要意义，通过测试能够尽可能发现并改正软件中的错误，提高软件质量。

这里我们主要讲解Go语言如何实现单元测试和性能测试。

go语言中自带有一个轻量级的测试框架testing和自带的go test命令来实现单元测试和性能测试，testing框架和其他语言中的测试框架类似，你可以基于这个框架写针对相应函数的测试用例，也可以基于该框架写相应的压力测试用例，那么接下来让我们一一来看一下怎么写。

单元测试

创建目录test，在目录下创建add.go、add_test.go两个文件，add_test.go为单元测试文件。

add_test.go

  1. package test
  3. import "testing"
  5. func TestAdd(t *testing.T) {
  6.    sum := Add(1, 2)
  7.    if sum == 3 {
  8.       t.Log("the result is ok")
  9.    } else {
  10.       t.Fatal("the result is wrong")
  11.    }
  12. }
  13. func TestAdd1(t *testing.T) {
  14.     t.Error("the result is error")
  15. }

add.go

  1. package test
  3. func Add(a, b int) int {
  4.    return a + b
  5. }

然后在项目目录下运行go test -v就可以看到测试结果了

  1. === RUN   TestAdd
  2. --- PASS: TestAdd (0.00s)
  3.     add_test.go:8: the result is ok
  4. === RUN   TestAdd1
  5. --- FAIL: TestAdd1 (0.00s)
  6.     add_test.go:14: the result is error
  7. FAIL
  8. exit status 1
  9. FAIL    _/D_/gopath/src/ados/test       0.419s

如果看到PASS字样证明测试通过，FAIL字样表示测试失败。

使用testing库的测试框架需要遵循以下几个规则如下：

  • 文件名必须是_test.go结尾的，这样在执行go test的时候才会执行到相应的代码
  • 你必须import testing这个包
  • 所有的测试用例函数必须是Test开头
  • 测试用例会按照源代码中写的顺序依次执行
  • 测试函数TestXxx()的参数是testing.T，我们可以使用该类型来记录错误或者是测试状态
  • 测试格式：func TestXxx (t *testing.T),Xxx部分可以为任意的字母数字的组合，但是首字母不能是小写字母[a-z]，例如Testintdiv是错误的函数名。
  • 函数中通过调用testing.T的Error, Errorf, FailNow, Fatal, FatalIf方法，说明测试不通过，调用Log方法用来记录测试的信息。

性能测试或压力测试

压力测试用来检测函数(方法）的性能，和编写单元功能测试的方法类似,此处不再赘述，但需要注意以下几点：

  • 压力测试用例必须遵循如下格式，其中XXX可以是任意字母数字的组合，但是首字母不能是小写字母

    1. func BenchmarkXXX(b *testing.B) { ... }

  • go test不会默认执行压力测试的函数，如果要执行压力测试需要带上参数-test.bench，语法:-test.bench="test_name_regex",例如go test -test.bench=".*"表示测试全部的压力测试函数

  • 在压力测试用例中,请记得在循环体内使用testing.B.N,以使测试可以正常的运行
  • 文件名也必须以_test.go结尾

在test目录下创建 reflect_test.go

  1. package test
  3. import (
  4.    "reflect"
  5.    "testing"
  6. )
  8. type Student struct {
  9.    Name  string
  10.    Age   int
  11.    Class string
  12.    Score int
  13. }
  15. func BenchmarkReflect_New(b *testing.B) {
  16.    var s *Student
  17.    sv := reflect.TypeOf(Student{})
  18.    b.ResetTimer()
  19.    for i := 0; i < b.N; i++ {
  20.       sn := reflect.New(sv)
  21.       s, _ = sn.Interface().(*Student)
  22.    }
  23.    _ = s
  24. }
  25. func BenchmarkDirect_New(b *testing.B) {
  26.    var s *Student
  27.    b.ResetTimer()
  28.    for i := 0; i < b.N; i++ {
  29.       s = new(Student)
  30.    }
  31.    _ = s
  32. }
  33. func BenchmarkReflect_Set(b *testing.B) {
  34.    var s *Student
  35.    sv := reflect.TypeOf(Student{})
  36.    b.ResetTimer()
  37.    for i := 0; i < b.N; i++ {
  38.       sn := reflect.New(sv)
  39.       s = sn.Interface().(*Student)
  40.       s.Name = "Jerry"
  41.       s.Age = 18
  42.       s.Class = "20005"
  43.       s.Score = 100
  44.    }
  45. }
  46. func BenchmarkReflect_SetFieldByName(b *testing.B) {
  47.    sv := reflect.TypeOf(Student{})
  48.    b.ResetTimer()
  49.    for i := 0; i < b.N; i++ {
  50.       sn := reflect.New(sv).Elem()
  51.       sn.FieldByName("Name").SetString("Jerry")
  52.       sn.FieldByName("Age").SetInt(18)
  53.       sn.FieldByName("Class").SetString("20005")
  54.       sn.FieldByName("Score").SetInt(100)
  55.    }
  56. }
  57. func BenchmarkReflect_SetFieldByIndex(b *testing.B) {
  58.    sv := reflect.TypeOf(Student{})
  59.    b.ResetTimer()
  60.    for i := 0; i < b.N; i++ {
  61.       sn := reflect.New(sv).Elem()
  62.       sn.Field(0).SetString("Jerry")
  63.       sn.Field(1).SetInt(18)
  64.       sn.Field(2).SetString("20005")
  65.       sn.Field(3).SetInt(100)
  66.    }
  67. }
  68. func BenchmarkDirect_Set(b *testing.B) {
  69.    var s *Student
  70.    b.ResetTimer()
  71.    for i := 0; i < b.N; i++ {
  72.       s = new(Student)
  73.       s.Name = "Jerry"
  74.       s.Age = 18
  75.       s.Class = "20005"
  76.       s.Score = 100
  77.    }
  78. }

在test目录下，执行：

go test reflect_test.go -test.bench=”.*”

结果如下

  1. goos: windows
  2. goarch: amd64
  3. BenchmarkReflect_New-4                  20000000                84.9 ns/op
  4. BenchmarkDirect_New-4                   30000000                50.6 ns/op
  5. BenchmarkReflect_Set-4                  20000000                89.9 ns/op
  6. BenchmarkReflect_SetFieldByName-4        3000000               552 ns/op
  7. BenchmarkReflect_SetFieldByIndex-4      10000000               132 ns/op
  8. BenchmarkDirect_Set-4                   30000000                53.0 ns/op
  9. PASS
  10. ok      command-line-arguments  10.982s

上面的结果显示我们没有执行任何TestXXX的单元测试函数，显示的结果只执行了压力测试函数，以第三行为例

BenchmarkReflect_New 函数执行了20000000次，每次的执行平均时间是84.9纳秒。最后一行 command-line-arguments 10.982s，代表总的执行时间为 10.982s。

如果只想对某个函数测试，以BenchmarkReflect_New 为例，执行命令

go test reflect_test.go -test.bench=”BenchmarkReflect_New”

结果为：

  1. goos: windows
  2. goarch: amd64
  3. BenchmarkReflect_New-4          20000000                84.9 ns/op
  4. PASS
  5. ok      command-line-arguments  2.490s

如果测试整个目录下的所有测试执行:

go test -test.bench=”.*”

如果想显示内存分配的次数和大小添加 -benchmem

go test reflect_test.go -benchmem -test.bench=”.*”

  1. goos: windows
  2. goarch: amd64
  3. BenchmarkReflect_New-4                  20000000   88.3 ns/op  48 B/op     1 allocs/op
  4. BenchmarkDirect_New-4                   30000000   53.8 ns/op  48 B/op     1 allocs/op
  5. BenchmarkReflect_Set-4                  20000000   90.9 ns/op  48 B/op     1 allocs/op
  6. BenchmarkReflect_SetFieldByName-4        3000000   564 ns/op   80 B/op     5 allocs/op
  7. BenchmarkReflect_SetFieldByIndex-4      10000000   135 ns/op   48 B/op     1 allocs/op
  8. BenchmarkDirect_Set-4                   30000000   52.4 ns/op  48 B/op     1 allocs/op
  9. PASS
  10. ok      command-line-arguments  12.955s

后两列代表分配的内存大小和次数（48 B/op 1 allocs/op）

推荐gotests

它是编写Go测试的一个Golang命令行工具，可以根据目标源文件的函数和方法签名生成表驱动的测试。将自动导入测试文件中的任何新依赖项。

参考：

https://studygolang.com/static/pkgdoc/pkg/testing.htm

https://www.cnblogs.com/yjf512/archive/2013/01/22/2870927.html

links