深入理解Golang的單元測(cè)試和性能測(cè)試

更新時(shí)間：2017年08月14日 09:28:26 作者：shenlanzifa

Go語(yǔ)言提供了強(qiáng)大的測(cè)試工具，下面這篇文章主要給大家介紹了關(guān)于Golang單元測(cè)試和性能測(cè)試的相關(guān)資料，文中通過(guò)示例代碼給大家詳細(xì)介紹了單元測(cè)試和性能測(cè)試的相關(guān)內(nèi)容，需要的朋友可以參考借鑒，下面來(lái)一起看看吧。

前言

大家做開發(fā)的應(yīng)該都知道，在開發(fā)程序中很重要的一點(diǎn)是測(cè)試，我們?nèi)绾伪ＷC代碼的質(zhì)量，如何保證每個(gè)函數(shù)是可運(yùn)行，運(yùn)行結(jié)果是正確的，又如何保證寫出來(lái)的代碼性能是好的，我們知道單元測(cè)試的重點(diǎn)在于發(fā)現(xiàn)程序設(shè)計(jì)或?qū)崿F(xiàn)的邏輯錯(cuò)誤，使問(wèn)題及早暴露，便于問(wèn)題的定位解決，而性能測(cè)試的重點(diǎn)在于發(fā)現(xiàn)程序設(shè)計(jì)上的一些問(wèn)題，讓線上的程序能夠在高并發(fā)的情況下還能保持穩(wěn)定。本小節(jié)將帶著這一連串的問(wèn)題來(lái)講解Go語(yǔ)言中如何來(lái)實(shí)現(xiàn)單元測(cè)試和性能測(cè)試。

go語(yǔ)言中自帶有一個(gè)輕量級(jí)的測(cè)試框架testing和自帶的go test命令來(lái)實(shí)現(xiàn)單元測(cè)試和性能測(cè)試，testing框架和其他語(yǔ)言中的測(cè)試框架類似，你可以基于這個(gè)框架寫針對(duì)相應(yīng)函數(shù)的測(cè)試用例，也可以基于該框架寫相應(yīng)的壓力測(cè)試用例，那么接下來(lái)讓我們一一來(lái)看一下怎么寫。

如何編寫測(cè)試用例

由于go test命令只能在一個(gè)相應(yīng)的目錄下執(zhí)行所有文件，所以我們接下來(lái)新建一個(gè)項(xiàng)目目錄gotest,這樣我們所有的代碼和測(cè)試代碼都在這個(gè)目錄下。

接下來(lái)我們?cè)谠撃夸浵旅鎰?chuàng)建兩個(gè)文件：gotest.go和gotest_test.go

1、gotest.go:這個(gè)文件里面我們是創(chuàng)建了一個(gè)包，里面有一個(gè)函數(shù)實(shí)現(xiàn)了除法運(yùn)算:

package gotest

import (
 "errors"
)

func Division(a, b float64) (float64, error) {
 if b == 0 {
 return 0, errors.New("除數(shù)不能為0")
 }

 return a / b, nil
}

2、gotest_test.go:這是我們的單元測(cè)試文件，但是記住下面的這些原則：

文件名必須是_test.go結(jié)尾的，這樣在執(zhí)行g(shù)o test的時(shí)候才會(huì)執(zhí)行到相應(yīng)的代碼
你必須import testing這個(gè)包
所有的測(cè)試用例函數(shù)必須是Test開頭
測(cè)試用例會(huì)按照源代碼中寫的順序依次執(zhí)行
測(cè)試函數(shù)TestXxx()的參數(shù)是testing.T，我們可以使用該類型來(lái)記錄錯(cuò)誤或者是測(cè)試狀態(tài)
測(cè)試格式：func TestXxx (t *testing.T),Xxx部分可以為任意的字母數(shù)字的組合，但是首字母不能是小寫字母[a-z]，例如Testintdiv是錯(cuò)誤的函數(shù)名。
函數(shù)中通過(guò)調(diào)用testing.T的Error, Errorf, FailNow, Fatal, FatalIf方法，說(shuō)明測(cè)試不通過(guò)，調(diào)用Log方法用來(lái)記錄測(cè)試的信息。

下面是我們的測(cè)試用例的代碼：

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("除法函數(shù)測(cè)試沒(méi)通過(guò)") // 如果不是如預(yù)期的那么就報(bào)錯(cuò)
 } else {
 t.Log("第一個(gè)測(cè)試通過(guò)了") //記錄一些你期望記錄的信息
 }
}

func Test_Division_2(t *testing.T) {
 t.Error("就是不通過(guò)")
}

我們?cè)陧?xiàng)目目錄下面執(zhí)行g(shù)o test,就會(huì)顯示如下信息：

--- FAIL: Test_Division_2 (0.00 seconds)
 gotest_test.go:16: 就是不通過(guò)
FAIL
exit status 1
FAIL gotest 0.013s

從這個(gè)結(jié)果顯示測(cè)試沒(méi)有通過(guò)，因?yàn)樵诘诙€(gè)測(cè)試函數(shù)中我們寫死了測(cè)試不通過(guò)的代碼t.Error，那么我們的第一個(gè)函數(shù)執(zhí)行的情況怎么樣呢？默認(rèn)情況下執(zhí)行go test是不會(huì)顯示測(cè)試通過(guò)的信息的，我們需要帶上參數(shù)go test -v，這樣就會(huì)顯示如下信息：

=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00 seconds)
 gotest_test.go:11: 第一個(gè)測(cè)試通過(guò)了
=== RUN Test_Division_2
--- FAIL: Test_Division_2 (0.00 seconds)
 gotest_test.go:16: 就是不通過(guò)
FAIL
exit status 1
FAIL gotest 0.012s

上面的輸出詳細(xì)的展示了這個(gè)測(cè)試的過(guò)程，我們看到測(cè)試函數(shù)1Test_Division_1測(cè)試通過(guò)，而測(cè)試函數(shù)2Test_Division_2測(cè)試失敗了，最后得出結(jié)論測(cè)試不通過(guò)。

接下來(lái)我們把測(cè)試函數(shù)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.") // 如果不是如預(yù)期的那么就報(bào)錯(cuò)
 } else {
 t.Log("one test passed.", e) //記錄一些你期望記錄的信息
 }
}

然后我們執(zhí)行go test -v，就顯示如下信息，測(cè)試通過(guò)了：

=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00 seconds)
 gotest_test.go:11: 第一個(gè)測(cè)試通過(guò)了
=== RUN Test_Division_2
--- PASS: Test_Division_2 (0.00 seconds)
 gotest_test.go:20: one test passed. 除數(shù)不能為0
PASS
ok gotest 0.013s

如何編寫壓力測(cè)試

壓力測(cè)試用來(lái)檢測(cè)函數(shù)(方法）的性能，和編寫單元功能測(cè)試的方法類似,此處不再贅述，但需要注意以下幾點(diǎn)：

壓力測(cè)試用例必須遵循如下格式，其中XXX可以是任意字母數(shù)字的組合，但是首字母不能是小寫字母
```
func BenchmarkXXX(b *testing.B) { ... }
```
go test不會(huì)默認(rèn)執(zhí)行壓力測(cè)試的函數(shù)，如果要執(zhí)行壓力測(cè)試需要帶上參數(shù)-test.bench，語(yǔ)法: -test.bench="test_name_regex",例如go test -test.bench=".*"表示測(cè)試全部的壓力測(cè)試函數(shù)
在壓力測(cè)試用例中,請(qǐng)記得在循環(huán)體內(nèi)使用testing.B.N,以使測(cè)試可以正常的運(yùn)行
文件名也必須以_test.go結(jié)尾

下面我們新建一個(gè)壓力測(cè)試文件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() //調(diào)用該函數(shù)停止壓力測(cè)試的時(shí)間計(jì)數(shù)

 //做一些初始化的工作,例如讀取文件數(shù)據(jù),數(shù)據(jù)庫(kù)連接之類的,
 //這樣這些時(shí)間不影響我們測(cè)試函數(shù)本身的性能

 b.StartTimer() //重新開始時(shí)間
 for i := 0; i < b.N; i++ {
 Division(4, 5)
 }
}

我們執(zhí)行命令go test -test.bench=".*" ，可以看到如下結(jié)果：

PASS
Benchmark_Division 500000000  7.76 ns/op
Benchmark_TimeConsumingFunction 500000000  7.80 ns/op
ok gotest 9.364s

上面的結(jié)果顯示我們沒(méi)有執(zhí)行任何TestXXX的單元測(cè)試函數(shù)，顯示的結(jié)果只執(zhí)行了壓力測(cè)試函數(shù)，第一條顯示了Benchmark_Division執(zhí)行了500000000次，每次的執(zhí)行平均時(shí)間是7.76納秒，第二條顯示了Benchmark_TimeConsumingFunction執(zhí)行了500000000，每次的平均執(zhí)行時(shí)間是7.80納秒。最后一條顯示總共的執(zhí)行時(shí)間。

我們執(zhí)行命令go test -test.bench=".*" -count=5，可以看到如下結(jié)果：（使用-count可以指定執(zhí)行多少次）

PASS
Benchmark_Division-2   300000000  4.60 ns/op
Benchmark_Division-2   300000000  4.57 ns/op
Benchmark_Division-2   300000000  4.63 ns/op
Benchmark_Division-2   300000000  4.60 ns/op
Benchmark_Division-2   300000000  4.63 ns/op
Benchmark_TimeConsumingFunction-2 300000000  4.64 ns/op
Benchmark_TimeConsumingFunction-2 300000000  4.61 ns/op
Benchmark_TimeConsumingFunction-2 300000000  4.60 ns/op
Benchmark_TimeConsumingFunction-2 300000000  4.59 ns/op
Benchmark_TimeConsumingFunction-2 300000000  4.60 ns/op
ok _/home/diego/GoWork/src/app/testing 18.546s

go test -run=文件名字 -bench=bench名字 -cpuprofile=生產(chǎn)的cprofile文件名稱文件夾

例子：

testBenchMark下有個(gè)popcnt文件夾，popcnt中有文件popcunt_test.go

➜ testBenchMark ls
popcnt

popcunt_test.go的問(wèn)價(jià)內(nèi)容：

ackage popcnt

import (
 "testing"
)

const m1 = 0x5555555555555555
const m2 = 0x3333333333333333
const m4 = 0x0f0f0f0f0f0f0f0f
const h01 = 0x0101010101010101

func popcnt(x uint64) uint64 {
 x -= (x >> 1) & m1
 x = (x & m2) + ((x >> 2) & m2)
 x = (x + (x >> 4)) & m4
 return (x * h01) >> 56
}

func BenchmarkPopcnt(b *testing.B) {
 for i := 0; i < b.N; i++ {
  x := i
  x -= (x >> 1) & m1
  x = (x & m2) + ((x >> 2) & m2)
  x = (x + (x >> 4)) & m4
  _ = (x * h01) >> 56
 }
}

然后運(yùn)行go test -bench=".*" -cpuprofile=cpu.profile ./popcnt

➜ testBenchMark go test -bench=".*" -cpuprofile=cpu.profile ./popcnt
testing: warning: no tests to run
PASS
BenchmarkPopcnt-8 1000000000    2.01 ns/op
ok  app/testBenchMark/popcnt 2.219s
➜ testBenchMark ll
total 6704
drwxr-xr-x 5 diego staff  170 5 6 13:57 .
drwxr-xr-x 3 diego staff  102 5 6 11:12 ..
-rw-r--r-- 1 diego staff  5200 5 6 13:57 cpu.profile
drwxr-xr-x 4 diego staff  136 5 6 11:47 popcnt
-rwxr-xr-x 1 diego staff 3424176 5 6 13:57 popcnt.test
➜ testBenchMark

生產(chǎn) cpu.profile問(wèn)價(jià)和popcnt.test 文件

➜ testBenchMark ll
total 6704
drwxr-xr-x 5 diego staff  170 5 6 13:57 .
drwxr-xr-x 3 diego staff  102 5 6 11:12 ..
-rw-r--r-- 1 diego staff  5200 5 6 13:57 cpu.profile
drwxr-xr-x 3 diego staff  102 5 6 14:01 popcnt
-rwxr-xr-x 1 diego staff 3424176 5 6 13:57 popcnt.test
➜ testBenchMark

go tool pprof popcnt.test cpu.profile 進(jìn)入交互模式

➜ testBenchMark go tool pprof popcnt.test cpu.profile
Entering interactive mode (type "help" for commands)
(pprof) top
1880ms of 1880ms total ( 100%)
  flat flat% sum%  cum cum%
 1790ms 95.21% 95.21%  1790ms 95.21% app/testBenchMark/popcnt.BenchmarkPopcnt
  90ms 4.79% 100%  90ms 4.79% runtime.usleep
   0  0% 100%  1790ms 95.21% runtime.goexit
   0  0% 100%  90ms 4.79% runtime.mstart
   0  0% 100%  90ms 4.79% runtime.mstart1
   0  0% 100%  90ms 4.79% runtime.sysmon
   0  0% 100%  1790ms 95.21% testing.(*B).launch
   0  0% 100%  1790ms 95.21% testing.(*B).runN
(pprof)

go tool pprof --web popcnt.test cpu.profile 進(jìn)入web模式

$ go tool pprof --text mybin http://myserver:6060:/debug/pprof/profile

這有幾個(gè)可用的輸出類型，最有用的幾個(gè)為： --text，--web 和 --list 。運(yùn)行 go tool pprof 來(lái)得到最完整的列表。

下面分享一點(diǎn)go test的參數(shù)解讀。來(lái)源

格式形如：

go test [-c] [-i] [build flags] [packages] [flags for test binary]

參數(shù)解讀：

-c : 編譯go test成為可執(zhí)行的二進(jìn)制文件，但是不運(yùn)行測(cè)試。

-i : 安裝測(cè)試包依賴的package，但是不運(yùn)行測(cè)試。

關(guān)于build flags，調(diào)用go help build，這些是編譯運(yùn)行過(guò)程中需要使用到的參數(shù)，一般設(shè)置為空

關(guān)于packages，調(diào)用go help packages，這些是關(guān)于包的管理，一般設(shè)置為空

關(guān)于flags for test binary，調(diào)用go help testflag，這些是go test過(guò)程中經(jīng)常使用到的參數(shù)

-test.v : 是否輸出全部的單元測(cè)試用例（不管成功或者失?。?，默認(rèn)沒(méi)有加上，所以只輸出失敗的單元測(cè)試用例。

-test.run pattern: 只跑哪些單元測(cè)試用例

-test.bench patten: 只跑那些性能測(cè)試用例

-test.benchmem : 是否在性能測(cè)試的時(shí)候輸出內(nèi)存情況

-test.benchtime t : 性能測(cè)試運(yùn)行的時(shí)間，默認(rèn)是1s

-test.cpuprofile cpu.out : 是否輸出cpu性能分析文件

-test.memprofile mem.out : 是否輸出內(nèi)存性能分析文件

-test.blockprofile block.out : 是否輸出內(nèi)部goroutine阻塞的性能分析文件

-test.memprofilerate n : 內(nèi)存性能分析的時(shí)候有一個(gè)分配了多少的時(shí)候才打點(diǎn)記錄的問(wèn)題。這個(gè)參數(shù)就是設(shè)置打點(diǎn)的內(nèi)存分配間隔，也就是profile中一個(gè)sample代表的內(nèi)存大小。默認(rèn)是設(shè)置為512 * 1024的。如果你將它設(shè)置為1，則每分配一個(gè)內(nèi)存塊就會(huì)在profile中有個(gè)打點(diǎn)，那么生成的profile的sample就會(huì)非常多。如果你設(shè)置為0，那就是不做打點(diǎn)了。

你可以通過(guò)設(shè)置memprofilerate=1和GOGC=off來(lái)關(guān)閉內(nèi)存回收，并且對(duì)每個(gè)內(nèi)存塊的分配進(jìn)行觀察。

-test.blockprofilerate n: 基本同上，控制的是goroutine阻塞時(shí)候打點(diǎn)的納秒數(shù)。默認(rèn)不設(shè)置就相當(dāng)于-test.blockprofilerate=1，每一納秒都打點(diǎn)記錄一下

-test.parallel n : 性能測(cè)試的程序并行cpu數(shù)，默認(rèn)等于GOMAXPROCS。

-test.timeout t : 如果測(cè)試用例運(yùn)行時(shí)間超過(guò)t，則拋出panic

-test.cpu 1,2,4 : 程序運(yùn)行在哪些CPU上面，使用二進(jìn)制的1所在位代表，和nginx的nginx_worker_cpu_affinity是一個(gè)道理

-test.short : 將那些運(yùn)行時(shí)間較長(zhǎng)的測(cè)試用例運(yùn)行時(shí)間縮短

總結(jié)

以上就是這篇文章的全部?jī)?nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作能帶來(lái)一定的幫助，如果有疑問(wèn)大家可以留言交流，謝謝大家對(duì)腳本之家的支持。

您可能感興趣的文章: