Go单元测试基础

1.go test工具

Go语言中的测试依赖go test命令。编写测试代码和编写普通的Go代码过程是类似的，并不需要学习新的语法、规则或工具。

go test命令是一个按照一定约定和组织的测试代码的驱动程序。在包目录内，所有以_test.go为后缀名的源代码文件都是go test测试的一部分，不会被go build编译到最终的可执行文件中。

在*_test.go文件中有三种类型的函数，单元测试函数、基准测试函数和示例函数。

go test命令会遍历所有的*_test.go文件中符合上述命名规则的函数，然后生成一个临时的main包用于调用相应的测试函数，然后构建并运行、报告测试结果，最后清理测试中生成的临时文件。

---

2.单元测试函数

每个测试函数必须导入testing包，测试函数的基本格式（签名）如下：

func TestName(t *testing.T){// ...
}

测试函数的名字必须以Test开头，可选的后缀名必须以大写字母开头，举几个例子：

func TestAdd(t *testing.T){ ... }
func TestSum(t *testing.T){ ... }
func TestLog(t *testing.T){ ... }

其中参数t用于报告测试失败和附加的日志信息。 testing.T的拥有的方法如下：

func (c *T) Cleanup(func())
func (c *T) Error(args ...interface{})
func (c *T) Errorf(format string, args ...interface{})
func (c *T) Fail()
func (c *T) FailNow()
func (c *T) Failed() bool
func (c *T) Fatal(args ...interface{})
func (c *T) Fatalf(format string, args ...interface{})
func (c *T) Helper()
func (c *T) Log(args ...interface{})
func (c *T) Logf(format string, args ...interface{})
func (c *T) Name() string
func (c *T) Skip(args ...interface{})
func (c *T) SkipNow()
func (c *T) Skipf(format string, args ...interface{})
func (c *T) Skipped() bool
func (c *T) TempDir() string

实例：

package mainfunc sum(x, y int) int {return x + y
}

在当前目录下，我们创建一个danyuan_test.go的测试文件，并定义一个测试函数如下：

package mainimport ("reflect""testing"
)func TestDanyuan(t *testing.T) {sum := Sum(10, 20)                 // 程序输出的结果want := 30                         // 期望的结果if !reflect.DeepEqual(want, sum) { // 因为slice不能比较直接，借助反射包中的方法比较t.Errorf("expected:%v,got:%v", want, sum) // 测试失败输出错误提示}
}

在当前路径下执行go test命令，可以看到输出结果如下：

---

3.go test -v/go test -run

一个测试用例有点单薄，我们再编写一个测试：

func TestDanyuanTwo(t *testing.T) {sum := Sum(-20, -30)want := -50if !reflect.DeepEqual(want, sum) { // 因为slice不能比较直接，借助反射包中的方法比较t.Errorf("expected:%v,got:%v", want, sum) // 测试失败输出错误提示}
}

现在我们有多个测试用例了，为了能更好的在输出结果中看到每个测试用例的执行
情况，我们可以为go test命令添加-v参数，让它输出完整的测试结果

都通过了：

假设有不通过的，会提示我们：

在执行go test命令的时候可以添加-run参数，它对应一个正则表达式，只有函数名匹配上的测试函数才会被go test命令执行

例如通过给go test添加-run=Two参数来告诉它本次测试只运行第二个这个测试用例：

---

4.跳过某些测试用例

为了节省时间支持在单元测试时跳过某些耗时的测试用例

func TestTimeConsuming(t *testing.T) {if testing.Short() {t.Skip("short模式下会跳过该测试用例")}...
}

当执行go test -short时就不会执行上面的TestTimeConsuming测试用例

---

5.子测试

通常单元测试中需要多组测试数据保证测试的效果

Go1.7+中新增了子测试，支持在测试函数中使用t.Run执行一组测试用例，这样就不需要为不同的测试数据定义多个测试函数了，例如：

func TestDanyuan(t *testing.T) {t.Run("case1", func(t *testing.T) {sum := Sum(-20, -30)want := -50if !reflect.DeepEqual(want, sum) { // 因为slice不能比较直接，借助反射包中的方法比较t.Errorf("expected:%v,got:%v", want, sum) // 测试失败输出错误提示}})t.Run("case2", func(t *testing.T) {sum := Sum(20, 30)want := 50if !reflect.DeepEqual(want, sum) { // 因为slice不能比较直接，借助反射包中的方法比较t.Errorf("expected:%v,got:%v", want, sum) // 测试失败输出错误提示}})t.Run("case3", func(t *testing.T) {sum := Sum(-20, 30)want := 10if !reflect.DeepEqual(want, sum) { // 因为slice不能比较直接，借助反射包中的方法比较t.Errorf("expected:%v,got:%v", want, sum) // 测试失败输出错误提示}})
}

---

6.表格驱动测试

表格驱动测试不是工具、包或其他任何东西，它只是编写更清晰测试的一种方式和视角。

编写好的测试并非易事，但在许多情况下，表格驱动测试可以涵盖很多方面：表格里的每一个条目都是一个完整的测试用例，包含输入和预期结果，有时还包含测试名称等附加信息，以使测试输出易于阅读。

使用表格驱动测试能够很方便的维护多个测试用例，避免在编写单元测试时频繁的复制粘贴。

表格驱动测试的步骤通常是定义一个测试用例表格，然后遍历表格，并使用t.Run对每个条目执行必要的测试。

例如我们针对上面的程序进行表格驱动测试：

package mainimport ("reflect""strconv""testing"
)/*
表格驱动测试
*/
func TestDanyuan(t *testing.T) {var danyuantests = []struct {in   intout  intwant int}{{10, 20, 30},{-30, 40, 10},{-55, -55, -110},{13131313, 14141414, 27272727},}// 遍历测试用例for _, tt := range danyuantests {t.Run(strconv.Itoa(tt.in), func(t *testing.T) { // 使用t.Run()执行子测试sum := Sum(tt.in, tt.out)if !reflect.DeepEqual(sum, tt.want) {t.Errorf("expected:%#v, got:%#v", tt.want, sum)}})}
}

在终端执行go test -v，会得到如下测试输出结果：

> go test -v
=== RUN   TestDanyuan
=== RUN   TestDanyuan/10
=== RUN   TestDanyuan/-30
=== RUN   TestDanyuan/-55
=== RUN   TestDanyuan/13131313
--- PASS: TestDanyuan (0.00s)--- PASS: TestDanyuan/10 (0.00s)--- PASS: TestDanyuan/-30 (0.00s)--- PASS: TestDanyuan/-55 (0.00s)--- PASS: TestDanyuan/13131313 (0.00s)
PASS
ok      Go-Page 0.042s

---

7.并行测试

想要在单元测试过程中使用并行测试，可以像下面的代码示例中那样通过添加t.Parallel()来实现

package mainimport ("reflect""strconv""testing"
)/*
表格驱动测试
*/
func TestDanyuan(t *testing.T) {var danyuantests = []struct {in   intout  intwant int}{{10, 20, 30},{-30, 40, 10},{-55, -55, -110},{13131313, 14141414, 27272727},}// 遍历测试用例for _, tt := range danyuantests {t.Run(strconv.Itoa(tt.in), func(t *testing.T) { // 使用t.Run()执行子测试t.Parallel() // 将每个测试用例标记为能够彼此并行运行sum := Sum(tt.in, tt.out)if !reflect.DeepEqual(sum, tt.want) {t.Errorf("expected:%#v, got:%#v", tt.want, sum)}})}
}

---

8.使用工具生成测试代码

社区里有很多自动生成表格驱动测试函数的工具，比如gotests等，很多编辑器如Goland也支持快速生成测试文件。这里简单演示一下gotests的使用

安装

go get -u github.com/cweill/gotests/...

执行（待测试的文件为mul.go）

gotests -all -w mul.go

---

9.测试覆盖率

测试覆盖率是指代码被测试套件覆盖的百分比。通常我们使用的都是语句的覆盖率，也就是在测试中至少被运行一次的代码占总代码的比例。在公司内部一般会要求测试覆盖率达到80%左右

Go提供内置功能来检查你的代码覆盖率，即使用go test -cover来查看测试覆盖率

此处可以看到覆盖率是50%，原因是有一个函数我们没有对它添加单元测试

版权声明：本文教程基于李文周的Go语言博客