8.单元测试
最后更新于：2022-04-02 04:44:16
Golang UnitTest单元测试
Golang单元测试对文件名和方法名，参数都有很严格的要求。
~~~
1、文件名必须以xx_test.go命名
2、方法必须是Test[^a-z]开头
3、方法参数必须 t *testing.T
4、使用go test执行单元测试
~~~
go test的参数解读：
go test是go语言自带的测试工具，其中包含的是两类，单元测试和性能测试
通过go help test可以看到go test的使用说明：
格式形如：
go test [-c] [-i] [build flags] [packages] [flags for test binary]
参数解读：
-c : 编译go test成为可执行的二进制文件，但是不运行测试。
-i : 安装测试包依赖的package，但是不运行测试。
关于build flags，调用go help build，这些是编译运行过程中需要使用到的参数，一般设置为空
关于packages，调用go help packages，这些是关于包的管理，一般设置为空
关于flags for test binary，调用go help testflag，这些是go test过程中经常使用到的参数
-test.v : 是否输出全部的单元测试用例（不管成功或者失败），默认没有加上，所以只输出失败的单元测试用例。
-test.run pattern: 只跑哪些单元测试用例
-test.bench patten: 只跑那些性能测试用例
-test.benchmem : 是否在性能测试的时候输出内存情况
-test.benchtime t : 性能测试运行的时间，默认是1s
-test.cpuprofile cpu.out : 是否输出cpu性能分析文件
-test.memprofile mem.out : 是否输出内存性能分析文件
-test.blockprofile block.out : 是否输出内部goroutine阻塞的性能分析文件
-test.memprofilerate n : 内存性能分析的时候有一个分配了多少的时候才打点记录的问题。这个参数就是设置打点的内存分配间隔，也就是profile中一个sample代表的内存大小。默认是设置为512 * 1024的。如果你将它设置为1，则每分配一个内存块就会在profile中有个打点，那么生成的profile的sample就会非常多。如果你设置为0，那就是不做打点了。
你可以通过设置memprofilerate=1和GOGC=off来关闭内存回收，并且对每个内存块的分配进行观察。
-test.blockprofilerate n: 基本同上，控制的是goroutine阻塞时候打点的纳秒数。默认不设置就相当于-test.blockprofilerate=1，每一纳秒都打点记录一下
-test.parallel n : 性能测试的程序并行cpu数，默认等于GOMAXPROCS。
-test.timeout t : 如果测试用例运行时间超过t，则抛出panic
-test.cpu 1,2,4 : 程序运行在哪些CPU上面，使用二进制的1所在位代表，和nginx的nginx_worker_cpu_affinity是一个道理
-test.short : 将那些运行时间较长的测试用例运行时间缩短
目录结构：
~~~
test
|
—— calc.go
|
—— calc_test.go
~~~
calc.go
~~~
package main
func add(a, b int) int {
return a + b
}
func sub(a, b int) int {
return a - b
}
~~~
calc_test.go
~~~
package main
import (
"testing"
)
func TestAdd(t *testing.T) {
r := add(2, 4)
if r != 6 {
t.Fatalf("add(2, 4) error, expect:%d, actual:%d", 6, r)
}
t.Logf("test add succ")
}
~~~
输出结果：
~~~
cd test/
ls
calc.go calc_test.go
go test
PASS
ok go_dev/test/test 0.007s
~~~
目录结构：
~~~
gotest
|
—— gotest.go
|
—— gotest_test.go
~~~
gotest.go
~~~
package gotest
import (
"errors"
)
func Division(a, b float64) (float64, error) {
if b == 0 {
return 0, errors.New("除数不能为0")
}
return a / b, nil
}
~~~
gotest_test.go
单元测试文件代码规则：
1.文件名必须是_test.go结尾的，这样在执行go test的时候才会执行到相应的代码
2.你必须import testing这个包
3.所有的测试用例函数必须是Test开头
4.测试用例会按照源代码中写的顺序依次执行
5.测试函数TestXxx()的参数是testing.T，我们可以使用该类型来记录错误或者是测试状态
6.测试格式：func TestXxx (t *testing.T),Xxx部分可以为任意的字母数字的组合，但是首字母不能是小写字母[a-z]，例如Testintdiv是错误的函数名。
7.函数中通过调用testing.T的Error, Errorf, FailNow, Fatal, FatalIf方法，说明测试不通过，调用Log方法用来记录测试的信息。
~~~
package gotest
import (
"testing"
)
func Test_Division_1(t *testing.T) {
if i, e := Division(6, 2); i != 3 || e != nil { //try a unit test on function
t.Error("除法函数测试没通过") // 如果不是如预期的那么就报错
} else {
t.Log("第一个测试通过了") //记录一些你期望记录的信息
}
}
func Test_Division_2(t *testing.T) {
t.Error("就是不通过")
}
~~~
在gotest目录下面执行 go test
输出结果：
~~~
--- FAIL: Test_Division_2 (0.00s)
gotest_test.go:16: 就是不通过
FAIL
exit status 1
FAIL gotest 0.006s
~~~
默认情况下执行go test 不会显示测试通过的信息的，我们需要带上参数go test -v，这样就会显示通过信息：
在gotest目录下面执行 go test -v
输出结果：
~~~
=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00s)
gotest_test.go:11: 第一个测试通过了
=== RUN Test_Division_2
--- FAIL: Test_Division_2 (0.00s)
gotest_test.go:16: 就是不通过
FAIL
exit status 1
FAIL gotest 0.006s
~~~
上面的输出详细的展示了这个测试的过程，我们看到测试函数1Test_Division_1测试通过，而测试函数2Test_Division_2测试失败了，最后得出结论测试不通过。接下来我们把测试函数2修改成如下代码：
~~~
func Test_Division_2(t *testing.T) {
if _, e := Division(6, 0); e == nil { //try a unit test on function
t.Error("Division did not work as expected.") // 如果不是如预期的那么就报错
} else {
t.Log("one test passed.", e) //记录一些你期望记录的信息
}
}
~~~
然后执行go test -v
输出结果：
~~~
=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00s)
gotest_test.go:11: 第一个测试通过了
=== RUN Test_Division_2
--- PASS: Test_Division_2 (0.00s)
gotest_test.go:18: one test passed. 除数不能为0
PASS
ok gotest 0.007s
~~~
单元测试通过了！
压力测试
压力测试用来检测函数(方法）的性能，和编写单元功能测试的方法类似，但需要注意以下几点：
1.压力测试用例必须遵循如下格式，其中XXX可以是任意字母数字的组合，但是首字母不能是小写字母
~~~
func BenchmarkXXX(b *testing.B) { ... }
~~~
2.go test不会默认执行压力测试的函数，如果要执行压力测试需要带上参数-test.bench，语法:-test.bench="test_name_regex",例如go test -test.bench=".*"表示测试全部的压力测试函数
3.在压力测试用例中,请记得在循环体内使用testing.B.N,以使测试可以正常的运行
4.文件名也必须以_test.go结尾
新建一个压力测试文件webbench_test.go
目录结构：
~~~
gotest
|
—— gotest.go
|
—— gotest_test.go
|
—— webbench_test.go
~~~
webbench_test.go 代码：
~~~
package gotest
import (
"testing"
)
func Benchmark_Division(b *testing.B) {
for i := 0; i < b.N; i++ { //use b.N for looping
Division(4, 5)
}
}
func Benchmark_TimeConsumingFunction(b *testing.B) {
b.StopTimer() //调用该函数停止压力测试的时间计数
//做一些初始化的工作,例如读取文件数据,数据库连接之类的,
//这样这些时间不影响我们测试函数本身的性能
b.StartTimer() //重新开始时间
for i := 0; i < b.N; i++ {
Division(4, 5)
}
}
~~~
执行命令 go test -test.bench=".*"
输出结果：
~~~
goos: darwin
goarch: amd64
pkg: gotest
Benchmark_Division-4 2000000000 0.90 ns/op
Benchmark_TimeConsumingFunction-4 2000000000 0.88 ns/op
PASS
ok gotest 3.752s
~~~
上面的结果显示我们没有执行任何TestXXX的单元测试函数，显示的结果只执行了压力测试函数。
~~~
Benchmark_Division-4 2000000000 0.90 ns/op
Benchmark_Division执行了2000000000次，每次的执行平均时间是0.90纳秒，
Benchmark_TimeConsumingFunction-4 2000000000 0.88 ns/op
Benchmark_TimeConsumingFunction执行了2000000000，每次的平均执行时间是0.88纳秒。
ok gotest 3.752s
总共的执行时间 3.752s 。
~~~
执行命令go test -test.bench=".*" -count=5 （使用-count可以指定执行多少次）
输出结果：
~~~
goos: darwin
goarch: amd64
pkg: gotest
Benchmark_Division-4 2000000000 0.90 ns/op
Benchmark_Division-4 2000000000 0.88 ns/op
Benchmark_Division-4 2000000000 0.89 ns/op
Benchmark_Division-4 2000000000 0.90 ns/op
Benchmark_Division-4 2000000000 1.00 ns/op
Benchmark_TimeConsumingFunction-4 2000000000 0.91 ns/op
Benchmark_TimeConsumingFunction-4 2000000000 0.91 ns/op
Benchmark_TimeConsumingFunction-4 2000000000 0.91 ns/op
Benchmark_TimeConsumingFunction-4 2000000000 0.90 ns/op
Benchmark_TimeConsumingFunction-4 2000000000 0.91 ns/op
PASS
ok gotest 19.144s
~~~
';