深入理解Golang的单元测试和性能测试
前言
大家做开发的应该都知道,在开发程序中很重要的一点是测试,我们如何保证代码的质量,如何保证每个函数是可运行,运行结果是正确的,又如何保证写出来的代码性能是好的,我们知道单元测试的重点在于发现程序设计或实现的逻辑错误,使问题及早暴露,便于问题的定位解决,而性能测试的重点在于发现程序设计上的一些问题,让线上的程序能够在高并发的情况下还能保持稳定。本小节将带着这一连串的问题来讲解Go语言中如何来实现单元测试和性能测试。
go语言中自带有一个轻量级的测试框架testing和自带的gotest命令来实现单元测试和性能测试,testing框架和其他语言中的测试框架类似,你可以基于这个框架写针对相应函数的测试用例,也可以基于该框架写相应的压力测试用例,那么接下来让我们一一来看一下怎么写。
如何编写测试用例
由于gotest命令只能在一个相应的目录下执行所有文件,所以我们接下来新建一个项目目录gotest,这样我们所有的代码和测试代码都在这个目录下。
接下来我们在该目录下面创建两个文件:gotest.go和gotest_test.go
1、gotest.go:这个文件里面我们是创建了一个包,里面有一个函数实现了除法运算:
packagegotest import( "errors" ) funcDivision(a,bfloat64)(float64,error){ ifb==0{ return0,errors.New("除数不能为0") } returna/b,nil }
2、gotest_test.go:这是我们的单元测试文件,但是记住下面的这些原则:
- 文件名必须是_test.go结尾的,这样在执行gotest的时候才会执行到相应的代码
- 你必须importtesting这个包
- 所有的测试用例函数必须是Test开头
- 测试用例会按照源代码中写的顺序依次执行
- 测试函数TestXxx()的参数是testing.T,我们可以使用该类型来记录错误或者是测试状态
- 测试格式:funcTestXxx(t*testing.T),Xxx部分可以为任意的字母数字的组合,但是首字母不能是小写字母[a-z],例如Testintdiv是错误的函数名。
- 函数中通过调用testing.T的Error,Errorf,FailNow,Fatal,FatalIf方法,说明测试不通过,调用Log方法用来记录测试的信息。
下面是我们的测试用例的代码:
packagegotest import( "testing" ) funcTest_Division_1(t*testing.T){ ifi,e:=Division(6,2);i!=3||e!=nil{//tryaunittestonfunction t.Error("除法函数测试没通过")//如果不是如预期的那么就报错 }else{ t.Log("第一个测试通过了")//记录一些你期望记录的信息 } } funcTest_Division_2(t*testing.T){ t.Error("就是不通过") }
我们在项目目录下面执行gotest,就会显示如下信息:
---FAIL:Test_Division_2(0.00seconds) gotest_test.go:16:就是不通过 FAIL exitstatus1 FAILgotest0.013s
从这个结果显示测试没有通过,因为在第二个测试函数中我们写死了测试不通过的代码t.Error,那么我们的第一个函数执行的情况怎么样呢?默认情况下执行gotest是不会显示测试通过的信息的,我们需要带上参数gotest-v,这样就会显示如下信息:
===RUNTest_Division_1 ---PASS:Test_Division_1(0.00seconds) gotest_test.go:11:第一个测试通过了 ===RUNTest_Division_2 ---FAIL:Test_Division_2(0.00seconds) gotest_test.go:16:就是不通过 FAIL exitstatus1 FAILgotest0.012s
上面的输出详细的展示了这个测试的过程,我们看到测试函数1Test_Division_1测试通过,而测试函数2Test_Division_2测试失败了,最后得出结论测试不通过。
接下来我们把测试函数2修改成如下代码:
funcTest_Division_2(t*testing.T){ if_,e:=Division(6,0);e==nil{//tryaunittestonfunction t.Error("Divisiondidnotworkasexpected.")//如果不是如预期的那么就报错 }else{ t.Log("onetestpassed.",e)//记录一些你期望记录的信息 } }
然后我们执行gotest-v,就显示如下信息,测试通过了:
===RUNTest_Division_1 ---PASS:Test_Division_1(0.00seconds) gotest_test.go:11:第一个测试通过了 ===RUNTest_Division_2 ---PASS:Test_Division_2(0.00seconds) gotest_test.go:20:onetestpassed.除数不能为0 PASS okgotest0.013s
如何编写压力测试
压力测试用来检测函数(方法)的性能,和编写单元功能测试的方法类似,此处不再赘述,但需要注意以下几点:
- 压力测试用例必须遵循如下格式,其中XXX可以是任意字母数字的组合,但是首字母不能是小写字母
funcBenchmarkXXX(b*testing.B){...}
- gotest不会默认执行压力测试的函数,如果要执行压力测试需要带上参数-test.bench,语法:-test.bench="test_name_regex",例如gotest-test.bench=".*"表示测试全部的压力测试函数
- 在压力测试用例中,请记得在循环体内使用testing.B.N,以使测试可以正常的运行
- 文件名也必须以_test.go结尾
下面我们新建一个压力测试文件webbench_test.go,代码如下所示:
packagegotest import( "testing" ) funcBenchmark_Division(b*testing.B){ fori:=0;i我们执行命令gotest-test.bench=".*",可以看到如下结果:
PASS Benchmark_Division5000000007.76ns/op Benchmark_TimeConsumingFunction5000000007.80ns/op okgotest9.364s上面的结果显示我们没有执行任何TestXXX的单元测试函数,显示的结果只执行了压力测试函数,第一条显示了Benchmark_Division执行了500000000次,每次的执行平均时间是7.76纳秒,第二条显示了Benchmark_TimeConsumingFunction执行了500000000,每次的平均执行时间是7.80纳秒。最后一条显示总共的执行时间。
我们执行命令gotest-test.bench=".*"-count=5,可以看到如下结果:(使用-count可以指定执行多少次)
PASS Benchmark_Division-23000000004.60ns/op Benchmark_Division-23000000004.57ns/op Benchmark_Division-23000000004.63ns/op Benchmark_Division-23000000004.60ns/op Benchmark_Division-23000000004.63ns/op Benchmark_TimeConsumingFunction-23000000004.64ns/op Benchmark_TimeConsumingFunction-23000000004.61ns/op Benchmark_TimeConsumingFunction-23000000004.60ns/op Benchmark_TimeConsumingFunction-23000000004.59ns/op Benchmark_TimeConsumingFunction-23000000004.60ns/op ok_/home/diego/GoWork/src/app/testing18.546sgotest-run=文件名字-bench=bench名字-cpuprofile=生产的cprofile文件名称文件夹
例子:
testBenchMark下有个popcnt文件夹,popcnt中有文件popcunt_test.go
➜testBenchMarkls popcntpopcunt_test.go的问价内容:
ackagepopcnt import( "testing" ) constm1=0x5555555555555555 constm2=0x3333333333333333 constm4=0x0f0f0f0f0f0f0f0f consth01=0x0101010101010101 funcpopcnt(xuint64)uint64{ x-=(x>>1)&m1 x=(x&m2)+((x>>2)&m2) x=(x+(x>>4))&m4 return(x*h01)>>56 } funcBenchmarkPopcnt(b*testing.B){ fori:=0;i>1)&m1 x=(x&m2)+((x>>2)&m2) x=(x+(x>>4))&m4 _=(x*h01)>>56 } } 然后运行gotest-bench=".*"-cpuprofile=cpu.profile./popcnt
➜testBenchMarkgotest-bench=".*"-cpuprofile=cpu.profile./popcnt testing:warning:noteststorun PASS BenchmarkPopcnt-810000000002.01ns/op okapp/testBenchMark/popcnt2.219s ➜testBenchMarkll total6704 drwxr-xr-x5diegostaff1705613:57. drwxr-xr-x3diegostaff1025611:12.. -rw-r--r--1diegostaff52005613:57cpu.profile drwxr-xr-x4diegostaff1365611:47popcnt -rwxr-xr-x1diegostaff34241765613:57popcnt.test ➜testBenchMark生产cpu.profile问价和popcnt.test文件
➜testBenchMarkll total6704 drwxr-xr-x5diegostaff1705613:57. drwxr-xr-x3diegostaff1025611:12.. -rw-r--r--1diegostaff52005613:57cpu.profile drwxr-xr-x3diegostaff1025614:01popcnt -rwxr-xr-x1diegostaff34241765613:57popcnt.test ➜testBenchMarkgotoolpprofpopcnt.testcpu.profile进入交互模式➜testBenchMarkgotoolpprofpopcnt.testcpu.profile Enteringinteractivemode(type"help"forcommands) (pprof)top 1880msof1880mstotal(100%) flatflat%sum%cumcum% 1790ms95.21%95.21%1790ms95.21%app/testBenchMark/popcnt.BenchmarkPopcnt 90ms4.79%100%90ms4.79%runtime.usleep 00%100%1790ms95.21%runtime.goexit 00%100%90ms4.79%runtime.mstart 00%100%90ms4.79%runtime.mstart1 00%100%90ms4.79%runtime.sysmon 00%100%1790ms95.21%testing.(*B).launch 00%100%1790ms95.21%testing.(*B).runN (pprof)gotoolpprof--webpopcnt.testcpu.profile进入web模式
$gotoolpprof--textmybinhttp://myserver:6060:/debug/pprof/profile这有几个可用的输出类型,最有用的几个为:--text,--web和--list。运行gotoolpprof来得到最完整的列表。
下面分享一点gotest的参数解读。来源
格式形如:
gotest[-c][-i][buildflags][packages][flagsfortestbinary]
参数解读:
-c:编译gotest成为可执行的二进制文件,但是不运行测试。
-i:安装测试包依赖的package,但是不运行测试。
关于buildflags,调用gohelpbuild,这些是编译运行过程中需要使用到的参数,一般设置为空
关于packages,调用gohelppackages,这些是关于包的管理,一般设置为空
关于flagsfortestbinary,调用gohelptestflag,这些是gotest过程中经常使用到的参数
-test.v:是否输出全部的单元测试用例(不管成功或者失败),默认没有加上,所以只输出失败的单元测试用例。
-test.runpattern:只跑哪些单元测试用例
-test.benchpatten:只跑那些性能测试用例
-test.benchmem:是否在性能测试的时候输出内存情况
-test.benchtimet:性能测试运行的时间,默认是1s
-test.cpuprofilecpu.out:是否输出cpu性能分析文件
-test.memprofilemem.out:是否输出内存性能分析文件
-test.blockprofileblock.out:是否输出内部goroutine阻塞的性能分析文件
-test.memprofileraten:内存性能分析的时候有一个分配了多少的时候才打点记录的问题。这个参数就是设置打点的内存分配间隔,也就是profile中一个sample代表的内存大小。默认是设置为512*1024的。如果你将它设置为1,则每分配一个内存块就会在profile中有个打点,那么生成的profile的sample就会非常多。如果你设置为0,那就是不做打点了。
你可以通过设置memprofilerate=1和GOGC=off来关闭内存回收,并且对每个内存块的分配进行观察。
-test.blockprofileraten:基本同上,控制的是goroutine阻塞时候打点的纳秒数。默认不设置就相当于-test.blockprofilerate=1,每一纳秒都打点记录一下
-test.paralleln:性能测试的程序并行cpu数,默认等于GOMAXPROCS。
-test.timeoutt:如果测试用例运行时间超过t,则抛出panic
-test.cpu1,2,4:程序运行在哪些CPU上面,使用二进制的1所在位代表,和nginx的nginx_worker_cpu_affinity是一个道理
-test.short:将那些运行时间较长的测试用例运行时间缩短
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作能带来一定的帮助,如果有疑问大家可以留言交流,谢谢大家对毛票票的支持。