Go语言单元测试专家指南

博主： silverwq
发布时间：2022 年 11 月 29 日
1059 次浏览
暂无评论
11389字数
分类： GO语言

介绍

Go 语言的测试，主要是依赖于 go test 命令，该命令会运行一些测试函数。

Go test

在一个包目录中，以 _test.go 结尾的文件，在 go build 的时候会忽略，当执行 go test 的时候，会扫描 *_test.go 文件来寻找特殊函数，并且生成一个临时的 main 包来调用他们，然后编译和运行，并且汇报结果，最后清空临时文件。

需要注意的是，go build 和 go test 命令，在不指定包参数的情况下，是以当前所在的目录的包作为参数的，所以要测试某个包，可以进入这个包目录，然后运行 go test 命令

`_Test.go` 文件

每个 _test.go 文件必须导入 testing 包，文件中有三种特殊的函数：

功能测试函数：以 Test 开头的函数，用来检查一些程序逻辑的正确性，go test 运行的时候，会报告 pass 或者 fail
基准测试函数：以 Benchmark 开头的函数，用来测试某些操作的性能，go test 运行的时候，会报告平均运行的时间
示例函数：Example 开头的函数，用来生成文档的，方便别人使用

功能测试函数

首先，在要测试的包目录创建 _test.go 结尾的文件，然后在文件里写上以 Test 开头的函数，例如

└── word
    ├── word.go
    └── word_test.go

word.go 的内容是

package word

// LenGreaterFive 判断字符串的长度是否大于5
func LenGreaterFive(s string) bool {
    len := len(s)
   if len > 5 {
        return true
 }
   return false
}

word_test.go 的文件内容

package word

import "testing" 

func TestLenGreaterFive(t *testing.T) {
 if LenGreaterFive("abcdef") == false {
        // 使用testing包的Error 方法
      t.Error(`LenGreaterFive("abcd") == false `)
   }
}

只有在 go test 运行没有问题后，才可以提交修改，如果修改之后也要记得重新运行 go test，如果输出错误会如下所示

# go test                                                                           22-11-29 - 17:24:17
PASS
ok      gotest/word     0.002s

如果想要输出测试用例的名称和时长，可以加上 -v 参数

# go test -v                                                                   :( 1 22-11-29 - 17:20:37
=== RUN   TestLenGreaterFive
--- PASS: TestLenGreaterFive (0.00s)
PASS
ok      gotest/word     0.002s

测试包里经常有个很多测试用例，有时候想要只运行某个用例，可以加入 -run 参数，下例中只运行名称中包含 Five 的测试用例

# go test -v -run="Five"                                                            22-11-29 - 17:23:55
=== RUN   TestLenGreaterFive
--- PASS: TestLenGreaterFive (0.00s)
PASS
ok      gotest/word     0.002s

有时候想要一次性测试很多情况，可以遍历切片

package word

import "testing"

func TestLenGreaterFive(t *testing.T) {
   var tests = []struct {
      input string
    }{
      {"123456"},
       {"abc"},
      {"abcd"},
     {"abcdef"},
   }
   for _, val := range tests {
     if LenGreaterFive(val.input) == false {
         // Errorf 带有格式化的输出
          t.Errorf("LenGreaterFive(%q) == false ", val.input)
       }
   }

}

调用 t.Errorf 输出失败的测试用例不会导致程序宕机终止运行，所以一次性可以输出多个错误信息。

如果我们需要终止一个测试用例，可以使用 t.Fatal或者t.Fatalf 来终止测试。需要注意的是，这两个函数的调用必须和 Test 函数在同一个协程中，而不是在 Test 里创建一个新的协程，然后把它们放在新的协程中。

入门

Go 语言推荐测试文件和源代码文件放在一块，测试文件以 _test.go 结尾。比如，当前 package 有 calc.go 一个文件，我们想测试 calc.go 中的 Add 和 Mul 函数，那么应该新建 calc_test.go 作为测试文件

goTest/  
   |--calc.go  
   |--calc_test.go

假如 calc.go 的代码如下：

package goTest

func Add(a int, b int) int {
    return a + b
}

func Mul(a int, b int) int {
   return a * b
}

那么 calc_test. Go 中的测试用例可以这么写：

package goTest

import "testing"

func TestAdd(t *testing.T) {
  if ans := Add(1, 2); ans != 3 {
     t.Errorf("1 + 2 expected be 3, but %d got", ans)
  }

   if ans := Add(-10, -20); ans != -30 {
       t.Errorf("-10 + -20 expected be -30, but %d got", ans)
    }
}

测试用例名称一般命名为 Test 加上待测试的方法名
测试用的参数有且只有一个，在这里是 t *testing.T。
基准测试 (benchmark) 的参数是 *testing.B，TestMain 的参数是 *testing.M 类型。

运行 go test，该 package 下所有的测试用例都会被执行。

PS D:\project\go\module\helloWorld> cd .\goTest\
PS D:\project\go\module\helloWorld\goTest> go test
PASS
ok      helloWorld/goTest       0.041s

或 go test -v，-v 参数会显示每个用例的测试结果，另外 -cover 参数可以查看覆盖率。

$ go test -v
=== RUN   TestAdd
--- PASS: TestAdd (0.00s)
=== RUN   TestMul
--- PASS: TestMul (0.00s)
PASS
ok      example 0.007s

如果只想运行其中的一个用例，例如 TestAdd，可以用 -run 参数指定，该参数支持通配符 *，和部分正则表达式，例如 ^、$。

$ go test -run TestAdd -v  
=== RUN   TestAdd  
--- PASS: TestAdd (0.00s)  
PASS  
ok      example 0.007s

子测试 (Subtests)

子测试是 Go 语言内置支持的，可以在某个测试用例中，根据测试场景使用 t.Run 创建不同的子测试用例：

func TestMul(t *testing.T) {  
   t.Run("pos", func(t *testing.T) {  
       if Mul(2, 3) != 6 {  
           t.Fatal("fail")  
     }  

   })  
    t.Run("neg", func(t *testing.T) {  
       if Mul(2, -3) != -6 {  
         t.Fatal("fail")  
     }  
 })  
}

之前的例子测试失败时使用 t.Error/t.Errorf，这个例子中使用 t.Fatal/t.Fatalf，区别在于前者遇错不停，还会继续执行其他的测试用例，后者遇错即停。

运行某个测试用例的子测试：

$ go test -run TestMul/pos -v  
=== RUN   TestMul  
=== RUN   TestMul/pos  
--- PASS: TestMul (0.00s)  
    --- PASS: TestMul/pos (0.00s)  
PASS  
ok      example 0.008s

对于多个子测试的场景，更推荐如下的写法 (table-driven tests)：

//  calc_test.go
func TestMul(t *testing.T) {
  cases := []struct {
     Name           string
       A, B, Expected int
  }{
      {"pos", 2, 3, 6},
     {"neg", 2, -3, -6},
       {"zero", 2, 0, 0},
    }

   for _, c := range cases {
       t.Run(c.Name, func(t *testing.T) {
          if ans := Mul(c.A, c.B); ans != c.Expected {
                t.Fatalf("%d * %d expected %d, but %d got",
                   c.A, c.B, c.Expected, ans)
          }
       })
  }
}

所有用例的数据组织在切片 cases 中，看起来就像一张表，借助循环创建子测试。这样写的好处有：

新增用例非常简单，只需给 cases 新增一条测试数据即可。
测试代码可读性好，直观地能够看到每个子测试的参数和期待的返回值。
用例失败时，报错信息的格式比较统一，测试报告易于阅读。

如果数据量较大，或是一些二进制数据，推荐使用相对路径从文件中读取。

帮助函数

对一些重复的逻辑，抽取出来作为公共的帮助函数 (helpers)，可以增加测试代码的可读性和可维护性。借助帮助函数，可以让测试用例的主逻辑看起来更清晰。

例如，我们可以将创建子测试的逻辑抽取出来：

package goTest

import "testing"

type calcCase struct{ A, B, Expected int }

func createMulTestCase(t *testing.T, c *calcCase) {
   // t.Helper()
   if ans := Mul(c.A, c.B); ans != c.Expected {
        t.Fatalf("%d * %d expected %d, but %d got",
           c.A, c.B, c.Expected, ans)
  }

}

func TestMul(t *testing.T) {
  createMulTestCase(t, &calcCase{2, 3, 6})
    createMulTestCase(t, &calcCase{2, -3, -6})
  createMulTestCase(t, &calcCase{2, 0, 1}) // wrong case
}

在这里，我们故意创建了一个错误的测试用例，运行 go test，用例失败，会报告错误发生的文件和行号信息：

=== RUN   TestMul
    calc_test.go:10: 2 * 0 expected 1, but 0 got
--- FAIL: TestMul (0.00s)

FAIL

可以看到，错误发生在第 11 行，也就是帮助函数 createMulTestCase 内部。18, 19, 20 行都调用了该方法，我们第一时间并不能够确定是哪一行发生了错误。有些帮助函数还可能在不同的函数中被调用，报错信息都在同一处，不方便问题定位。因此，Go 语言在 1.9 版本中引入了 t.Helper()，用于标注该函数是帮助函数，报错时将输出帮助函数调用者的信息，而不是帮助函数的内部信息。

修改 createMulTestCase，调用 t.Helper()

func createMulTestCase(t *testing.T, c *calcCase) {  
   t.Helper()  
   if ans := Mul(c.A, c.B); ans != c.Expected {  
      t.Fatalf("%d * %d expected %d, but %d got",  
         c.A, c.B, c.Expected, ans)  
   }  

}

运行 go test，报错信息如下，可以非常清晰地知道，错误发生在第 19 行。

=== RUN   TestMul
    calc_test.go:19: 2 * 0 expected 1, but 0 got
--- FAIL: TestMul (0.00s)

FAIL

关于 helper 函数的 2 个建议：

不要返回错误，帮助函数内部直接使用 t.Error 或 t.Fatal 即可，在用例主逻辑中不会因为太多的错误处理代码，影响可读性。
调用 t.Helper() 让报错信息更准确，有助于定位。

Setup 和 teardown

如果在同一个测试文件中，每一个测试用例运行前后的逻辑是相同的，一般会写在 setup 和 teardown 函数中。例如执行前需要实例化待测试的对象，如果这个对象比较复杂，很适合将这一部分逻辑提取出来；执行后，可能会做一些资源回收类的工作，例如关闭网络连接，释放文件等。标准库 testing 提供了这样的机制：

package goTest  

import (  
   "fmt"  
   "os"   "testing")  

func setup() {  
   fmt.Println("Before all tests")  
}  

func teardown() {  
   fmt.Println("After all tests")  
}  

func Test1(t *testing.T) {  
   fmt.Println("I'm test1")  
}  

func Test2(t *testing.T) {  
   fmt.Println("I'm test2")  
}  

func TestMain(m *testing.M) {  
   setup()  
   code := m.Run()  
   teardown()  
   os.Exit(code)  
}

在这个测试文件中，包含有 2 个测试用例，Test1 和 Test2。
如果测试文件中包含函数 TestMain，那么生成的测试将调用 TestMain(m)，而不是直接运行测试。
调用 m.Run() 触发所有测试用例的执行，并使用 os.Exit() 处理返回的状态码，如果不为0，说明有用例失败。
因此可以在调用 m.Run() 前后做一些额外的准备 (setup) 和回收 (teardown) 工作。

执行 go test，将会输出

Before all tests
I'm test1
I'm test2
PASS
After all tests
ok      helloWorld/goTest       0.040s

网络测试 (Network)

TCP/HTTP

假设需要测试某个 API 接口的 handler 能够正常工作，例如 helloHandler

func helloHandler(w http.ResponseWriter, r *http.Request) {  
    w.Write([]byte("hello world"))  
}

那我们可以创建真实的网络连接进行测试：

// test code  
import (  
  "io/ioutil"  
 "net"  
   "net/http"  
  "testing"  
)  

func handleError(t *testing.T, err error) {  
 t.Helper()  
    if err != nil {  
       t.Fatal("failed", err)  
  }  
}  

func TestConn(t *testing.T) {  
 ln, err := net.Listen("tcp", "127.0.0.1:0")  
   handleError(t, err)  
   defer ln.Close()  

    http.HandleFunc("/hello", helloHandler)  
 go http.Serve(ln, nil)  

  resp, err := http.Get("http://" + ln.Addr().String() + "/hello")  
  handleError(t, err)  

 defer resp.Body.Close()  
   body, err := ioutil.ReadAll(resp.Body)  
    handleError(t, err)  

 if string(body) != "hello world" {  
      t.Fatal("expected hello world, but got", string(body))  
  }  
}

net.Listen("tcp", "127.0.0.1:0") ：监听一个未被占用的端口，并返回 Listener。
调用 http.Serve(ln, nil) 启动 http 服务。
使用 http.Get 发起一个 Get 请求，检查返回值是否正确。
尽量不对 http 和 net 库使用 mock，这样可以覆盖较为真实的场景。

Httptest

针对 http 开发的场景，使用标准库 net/http/httptest 进行测试更为高效。

上述的测试用例改写如下：

// test code  
import (  
   "io/ioutil"  
 "net/http"  
  "net/http/httptest"  
 "testing"  
)  

func TestConn(t *testing.T) {  
   req := httptest.NewRequest("GET", "http://example.com/foo", nil)  
  w := httptest.NewRecorder()  
   helloHandler(w, req)  
  bytes, _ := ioutil.ReadAll(w.Result().Body)  

 if string(bytes) != "hello world" {  
     t.Fatal("expected hello world, but got", string(bytes))  
 }  
}

使用 httptest 模拟请求对象 (req) 和响应对象 (w)，达到了相同的目的。

Benchmark 基准测试

基准测试用例的定义如下：

func BenchmarkName(b *testing.B){  
    // ...  
}

函数名必须以 Benchmark 开头，后面一般跟待测试的函数名
参数为 b *testing.B。
执行基准测试时，需要添加 -bench 参数。

例如：

func BenchmarkHello(b *testing.B) {  
    for i := 0; i < b.N; i++ {  
        fmt.Sprintf("hello")  
    }  
}

$ go test -benchmem -bench .  
...  
BenchmarkHello-16   15991854   71.6 ns/op   5 B/op   1 allocs/op  
...

基准测试报告每一列值对应的含义如下：

type BenchmarkResult struct {  
    N         int           // 迭代次数  
    T         time.Duration // 基准测试花费的时间  
    Bytes     int64         // 一次迭代处理的字节数  
    MemAllocs uint64        // 总的分配内存的次数  
    MemBytes  uint64        // 总的分配内存的字节数  
}

如果在运行前基准测试需要一些耗时的配置，则可以使用 b.ResetTimer() 先重置定时器，例如：

func BenchmarkHello(b *testing.B) {  
    ... // 耗时操作  
    b.ResetTimer()  
    for i := 0; i < b.N; i++ {  
        fmt.Sprintf("hello")  
    }  
}

使用 RunParallel 测试并发性能

func BenchmarkParallel(b *testing.B) {  
  templ := template.Must(template.New("test").Parse("Hello, {{.}}!"))  
   b.RunParallel(func(pb *testing.PB) {  
      var buf bytes.Buffer  
      for pb.Next() {  
           // 所有 goroutine 一起，循环一共执行 b.N 次  
           buf.Reset()  
           templ.Execute(&buf, "World")  
        }  
 })  
}

$ go test -benchmem -bench .  
...  
BenchmarkParallel-16   3325430     375 ns/op   272 B/op   8 allocs/op

go test 命令

# 会每一个目录去test
go test ./...
# 一般要加上这个条件，竞态测试
go test -race

最后修改：2023 年 12 月 30 日

如果觉得我的文章对你有用，请随意赞赏

发表评论取消回复
使用cookie技术保留您的个人信息以便您下次快速评论，继续评论表示您已同意该条款

评论 *

私密评论

名称 *

🎲

邮箱 *

地址

介绍