Go语言单元测试的执行
Go 语言推荐测试文件和源代码文件放在同一目录下,测试文件以 _test.go
结尾。比如,当前 package 有 calc.go
一个文件,我们想测试 calc.go
中的 Add
和 Mul
函数,那么应该新建 calc_test.go
作为测试文件。
example/
|--calc.go
|--calc_test.go
假如 calc.go
的代码如下:
1 package main
2
3 func Add(a int, b int) int {
4 return a + b
5 }
6
7 func Mul(a int, b int) int {
8 return a * b
9 }
那么 calc_test.go
中的测试用例可以这么写:
1 package main
2
3 import "testing"
4
5 func TestAdd(t *testing.T) {
6 if ans := Add(1, 2); ans != 3 {
7 t.Errorf("1 + 2 expected be 3, but %d got", ans)
8 }
9
10 if ans := Add(-10, -20); ans != -30 {
11 t.Errorf("-10 + -20 expected be -30, but %d got", ans)
12 }
13 }
- 测试用例名称一般命名为
Test
加上待测试的方法名。 - 测试用的参数有且只有一个,在这里是
t *testing.T
。
运行 go test
,该 package 下所有的测试用例都会被执行。
$ go test
ok example 0.009s
或 go test -v
, -v
参数会显示每个用例的测试结果
$ go test -v
=== RUN TestAdd
--- PASS: TestAdd (0.00s)
=== RUN TestMul
--- PASS: TestMul (0.00s)
PASS
ok example 0.007s
如果只想运行其中的一个用例,例如 TestAdd
,可以用 -run
参数指定,该参数支持通配符 *
,和部分正则表达式,例如 ^
、$
。
1 $ go test -run TestAdd -v
2 === RUN TestAdd
3 --- PASS: TestAdd (0.00s)
4 PASS
5 ok example 0.007s
遇到如下报错的解决方法
原因:
从提示:build failed可以看出是
构建失败,go test与其他的指定源码文件进行编译或运行的命令程序一样(参考:go run
和go build
),会为指定的源码文件生成一个虚拟代码包——“command-line-arguments”,对于运行这次测试的命令程序来说,测试源码文件getinfo_test.go
是属于代码包“command-line-arguments”的,可是它引用了其他包中的数据并不属于代码包“command-line-arguments”,编译不通过,错误自然发生了。
解决方法:
知道了原因之后,解决的方法就出来了,执行命令时加入这个测试文件需要引用的源码文件,在命令行后方的文件都会被加载到command-line-arguments
中进行编译,示例如下:
单元测试覆盖率
- cover:查看单元测试的覆盖率
- coverprofile:指定输出文件
示例:
生成html格式的覆盖率报告
命令:
go tool cover -html=cover.out -o coverage.html
HTML文件内容:
go test命令的使用
go test做性能测试
除了可以做功能逻辑的测试(上面讲的单元测试),go test还可以做性能测试
压测文件的规则:
- 文件名规则和单元测试一样
- 压力测试函数必须遵循如下格式,其中XXX可以是任意字母数字的组合,但是首字母不能是小写字母,注意琪参数是 testing.B,单元测试参数是 testing.T
func BenchmarkXXX(b *testing.B) { … }
- go test不会默认执行压力测试的函数,如果要执行压力测试需要带上参数-bench,语法:-bench=文件路径名,例如go test -test.bench=.
表示测试当前目录下全部的压力测试函数
- 压力测试函数在压力测试用例中,有一个属性 testing.B.N,它表示的是进行压力测试的次数。可以通过 b.N = 1234 来设置压力次数
如 webbench_test.go 压力测试函数
1 package math
2
3 import (
4 "testing"
5 )
6
7 func Benchmark_Division(b *testing.B) {
8 for i := 0; i < b.N; i++ { //use b.N for looping
9 Division(4, 5)
10 }
11 }
12
13 func Benchmark_TimeConsumingFunction(b *testing.B) {
14 b.StopTimer() //调用该函数停止压力测试的时间计数
15
16 //做一些初始化的工作,例如读取文件数据,数据库连接之类的,
17 //这样这些时间不影响我们测试函数本身的性能
18
19 b.StartTimer() //重新开始时间
20
21 b.N=1234 //自定义执行1234次
22
23 for i := 0; i < b.N; i++ {
24 Division(4, 5)
25 }
26 }
执行如下命令 go test -v ./webbench_test.go ./division.go -bench=".*" 只显示压力测试,因为两个文件有依赖所以需要放到一起编译执行
其中 -bench=".*" 表示 执行所有压力测试函数
结果如下:
$ go test -v ./webbench_test.go ./division.go -bench=".*"
goos: linux
goarch: amd64
Benchmark_Division-8 2000000000 0.74 ns/op
Benchmark_TimeConsumingFunction-8 1234 0.96 ns/op
PASS
ok command-line-arguments 1.558s
上面信息说明Benchmark_Division默认执行了2000000000次,
而Benchmark_TimeConsumingFunction通过设置 b.N=1234 执行不同次数;
每次的执行平均时间分别是0.74纳秒和0.96纳秒,总运行时间1.558秒