Go自带了测试框架和工具,在testing包中,以便完成单元测试(T类型)和性能测试(B类型)。
一般测试代码放在*_test.go文件中,与被测代码放于同一个包中。
测试函数名称格式是:Test[^a-z],即以Test开头,跟上非小写字母开头的字符串。每个测试函数都接受一个*testing.T类型参数,用于输出信息或中断测试。
测试方法有:
测试代码:
// filename: add_test.go
package test
import (
"testing"
func Add(a, b int) int {
return a + b
func TestAdd1(t *testing.T) {
if Add(2, 3) != 5 {
t.Error("result is wrong!")
} else {
t.Log("result is right")
func TestAdd2(t *testing.T) {
if Add(2, 3) != 6 {
t.Fatal("result is wrong!")
} else {
t.Log("result is right")
运行以下命令,自动搜集所有的测试文件(*_test.go),提取全部测试函数。
$ go test
--- FAIL: TestAdd2 (0.00s)
add_test.go:20: result is wrong!
exit status 1
FAIL _/Users/golang_learning/testTB 0.006s
输出结果包括:出错的测试函数名称,执行时长和错误信息。
go test还有以下参数:
-v:显示所有测试函数运行细节
$ go test -v
=== RUN TestAdd1
--- PASS: TestAdd1 (0.00s)
add_test.go:14: result is right
=== RUN TestAdd2
--- FAIL: TestAdd2 (0.00s)
add_test.go:20: result is wrong!
exit status 1
FAIL _/Users/golang_learning/testTB 0.007s
-run regex:指定要执行的测试函数
$ go test -run TestAdd2
--- FAIL: TestAdd2 (0.00s)
add_test.go:20: result is wrong!
exit status 1
FAIL _/Users/golang_learning/testTB 0.006s
性能测试函数以Benchmark 开头,参数类型是 *testing.B,可与Test函数放在同个文件中。默认情况下,go test不执行Benchmark测试,必须用“-bench <pattern>”指定性能测试函数。
测试代码:
// filename: add_test.go
package test
import (
"testing"
func Add(a, b int) int {
return a + b
func Benchmark(b *testing.B) {
for i := 0; i < b.N; i++ { // b.N,测试循环次数
Add(4, 5)
执行命令测试:
$ go test -bench=.
goos: darwin
goarch: amd64
Benchmark-4 2000000000 0.35 ns/op
ok _/Users/golang_learning/testTB 0.753s
B类型也有以下参数:
benchmem:输出内存分配统计
benchtime:指定测试时间
cpu:指定GOMAXPROCS
timeout:超市限制
$ go test -v -bench=. -cpu=8 -benchtime="3s" -timeout="5s" -benchmem
goos: darwin
goarch: amd64
Benchmark-8 5000000000 0.34 ns/op 0 B/op 0 allocs/op
ok _/Users/golang_learning/testTB 1.766s
Benchmark-8:-cpu参数指定,-8表示8个CPU线程执行
5000000000:表示总共执行了5000000000次
0.34 ns/op:表示每次执行耗时0.34纳秒
0 B/op:表示每次执行分配的内存(字节)
0 allocs/op:表示每次执行分配了多少次对象
pprof
go tools继承了pprof,以便进行性能测试并找出瓶颈。
测试数据文件生成有两种方法:命令行和代码
1、命令行生成测试数据文件
$ go test -bench=. -cpuprofile cpu.out
goos: darwin
goarch: amd64
Benchmark-4 2000000000 0.35 ns/op
ok _/Users/golang_learning/testTB 0.911s
输出:(上一条命令生成cpu.out和testTB.test)
add_test.go cpu.out testTB.test
用命令行分析
$ go tool pprof -text mem.out
Main binary filename not available.
Type: inuse_space
Time: May 22, 2018 at 3:36pm (CST)
Showing nodes accounting for 1.16MB, 100% of 1.16MB total
flat flat% sum% cum cum%
1.16MB 100% 100% 1.16MB 100% runtime/pprof.StartCPUProfile
0 0% 100% 1.16MB 100% main.main
0 0% 100% 1.16MB 100% runtime.main
pprof交互模式分析
$ go tool pprof testTB.test cpu.out
File: testTB.test
Type: cpu
Time: May 22, 2018 at 3:08pm (CST)
Duration: 906.10ms, Total samples = 670ms (73.94%)
Entering interactive mode (type "help" for commands, "o" for options)
(pprof) top
Showing nodes accounting for 670ms, 100% of 670ms total
flat flat% sum% cum cum%
670ms 100% 100% 670ms 100% _/Users/golang_learning/testTB.Benchmark
0 0% 100% 670ms 100% testing.(*B).launch
0 0% 100% 670ms 100% testing.(*B).runN
(pprof) quit
以上性能指标含义:
函数本地采样数量(不包含其调用的其他函数)
函数本地采样数量所占百分比
前几个函数(包括当前函数)本地采样总和所占百分比
函数(包括其调用的函数)采样总数量
函数采样总数量所占百分比
pprof交互模式命令:
top、top10: 显示前几条信息;
web:以svg文件展示。
pdf或者svg分析
$ go tool pprof -svg cpu.out > cpu.svg
$ go tool pprof -pdf cpu.out > cpu.pdf
$ ls(以上命令生成cpu.pdf和cpu.svg文件)
add_test.go cpu.out cpu.pdf cpu.svg testTB.test
打开cpu.pdf或者cpu.svg文件:
$ go tool pprof http://localhost:port/debug/pprof/profile
就会进入30秒的profile收集时间,在这段事件内向服务器连续发送多次请求,尽量让cpu占用性能产生数据。
$ go tool pprof http://localhost:8080/debug/pprof/profile
Fetching profile over HTTP from http://localhost:8080/debug/pprof/profile
// 这里会阻塞30s收集profile,在这段时间应多发请求
Saved profile in /Users/pprof/pprof.samples.cpu.002.pb.gz
Type: cpu
Time: May 22, 2018 at 7:16pm (CST)
Duration: 30s, Total samples = 330ms ( 1.10%)
Entering interactive mode (type "help" for commands, "o" for options)
(pprof) top10
输出:(前10条信息)
Showing nodes accounting for 330ms, 100% of 330ms total
Showing top 10 nodes out of 39
flat flat% sum% cum cum%
100ms 30.30% 30.30% 100ms 30.30% runtime.mach_semaphore_signal
60ms 18.18% 48.48% 60ms 18.18% runtime.mach_semaphore_timedwait
60ms 18.18% 66.67% 60ms 18.18% runtime.mach_semaphore_wait
... ...
(pprof) web
// 在浏览器中以svg文件的方式展示cpu占用图
启动服务器,访问链接http://localhost:port/debug/pprof/heap,就会自动下载heap文件,调用以下命令,进入pprof交互模式:
$ go tool pprof heap
Main binary filename not available.
Type: inuse_space
Time: May 24, 2018 at 11:30pm (CST)
Entering interactive mode (type "help" for commands, "o" for options)
(pprof) top5
Showing nodes accounting for 62.02MB, 98.20% of 63.16MB total
Showing top 5 nodes out of 26
flat flat% sum% cum cum%
21.67MB 34.31% 34.31% 21.67MB 34.31% bytes.makeSlice
20.50MB 32.46% 66.77% 20.50MB 32.46% reflect.unsafe_New
15MB 23.75% 90.52% 15MB 23.75% github.com/golang/protobuf/proto.(*word32Slice).Append
2.85MB 4.51% 95.03% 2.85MB 4.51% github.com/golang/protobuf/proto.(*structPointerSlice).Append
2MB 3.17% 98.20% 2MB 3.17% github.com/golang/protobuf/proto.word32_Set
(pprof) web