深入理解Golang的單元測試和性能測試

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

Go語言提供了強大的測試工具，下面這篇文章主要給大家介紹了關于Golang單元測試和性能測試的相關資料，文中通過示例代碼給大家詳細介紹了單元測試和性能測試的相關內容，需要的朋友可以參考借鑒，下面來一起看看吧。

前言

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

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

如何編寫測試用例

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

接下來我們在該目錄下面創(chuàng)建兩個文件：gotest.go和gotest_test.go

1、gotest.go:這個文件里面我們是創(chuàng)建了一個包，里面有一個函數(shù)實現(xià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:這是我們的單元測試文件，但是記住下面的這些原則：

文件名必須是_test.go結尾的，這樣在執(zhí)行go test的時候才會執(zhí)行到相應的代碼
你必須import testing這個包
所有的測試用例函數(shù)必須是Test開頭
測試用例會按照源代碼中寫的順序依次執(zhí)行
測試函數(shù)TestXxx()的參數(shù)是testing.T，我們可以使用該類型來記錄錯誤或者是測試狀態(tài)
測試格式：func TestXxx (t *testing.T),Xxx部分可以為任意的字母數(shù)字的組合，但是首字母不能是小寫字母[a-z]，例如Testintdiv是錯誤的函數(shù)名。
函數(shù)中通過調用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("除法函數(shù)測試沒通過") // 如果不是如預期的那么就報錯
 } else {
 t.Log("第一個測試通過了") //記錄一些你期望記錄的信息
 }
}

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

我們在項目目錄下面執(zhí)行go test,就會顯示如下信息：

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

從這個結果顯示測試沒有通過，因為在第二個測試函數(shù)中我們寫死了測試不通過的代碼t.Error，那么我們的第一個函數(shù)執(zhí)行的情況怎么樣呢？默認情況下執(zhí)行go test是不會顯示測試通過的信息的，我們需要帶上參數(shù)go test -v，這樣就會顯示如下信息：

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

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

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

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

=== RUN Test_Division_1
--- PASS: Test_Division_1 (0.00 seconds)
 gotest_test.go:11: 第一個測試通過了
=== 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

如何編寫壓力測試

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

壓力測試用例必須遵循如下格式，其中XXX可以是任意字母數(shù)字的組合，但是首字母不能是小寫字母
```
func BenchmarkXXX(b *testing.B) { ... }
```
go test不會默認執(zhí)行壓力測試的函數(shù)，如果要執(zhí)行壓力測試需要帶上參數(shù)-test.bench，語法: -test.bench="test_name_regex",例如go test -test.bench=".*"表示測試全部的壓力測試函數(shù)
在壓力測試用例中,請記得在循環(huán)體內使用testing.B.N,以使測試可以正常的運行
文件名也必須以_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() //調用該函數(shù)停止壓力測試的時間計數(shù)

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

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

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

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

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

我們執(zhí)行命令go test -test.bench=".*" -count=5，可以看到如下結果：（使用-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=生產的cprofile文件名稱文件夾

例子：

testBenchMark下有個popcnt文件夾，popcnt中有文件popcunt_test.go

➜ testBenchMark ls
popcnt

popcunt_test.go的問價內容：

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
 }
}

然后運行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

生產 cpu.profile問價和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 進入交互模式

➜ 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 進入web模式

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

這有幾個可用的輸出類型，最有用的幾個為： --text，--web 和 --list 。運行 go tool pprof 來得到最完整的列表。

下面分享一點go test的參數(shù)解讀。來源

格式形如：

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

參數(shù)解讀：

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

-i : 安裝測試包依賴的package，但是不運行測試。

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

關于packages，調用go help packages，這些是關于包的管理，一般設置為空

關于flags for test binary，調用go help testflag，這些是go test過程中經常使用到的參數(shù)

-test.v : 是否輸出全部的單元測試用例（不管成功或者失?。J沒有加上，所以只輸出失敗的單元測試用例。

-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 : 內存性能分析的時候有一個分配了多少的時候才打點記錄的問題。這個參數(shù)就是設置打點的內存分配間隔，也就是profile中一個sample代表的內存大小。默認是設置為512 * 1024的。如果你將它設置為1，則每分配一個內存塊就會在profile中有個打點，那么生成的profile的sample就會非常多。如果你設置為0，那就是不做打點了。

你可以通過設置memprofilerate=1和GOGC=off來關閉內存回收，并且對每個內存塊的分配進行觀察。

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

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

-test.timeout t : 如果測試用例運行時間超過t，則拋出panic

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

-test.short : 將那些運行時間較長的測試用例運行時間縮短

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作能帶來一定的幫助，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

您可能感興趣的文章:

Go 協(xié)程超時控制的實現(xiàn)
本文主要介紹了Go 協(xié)程超時控制的實現(xiàn)，文中通過示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-08-08
深入解析快速排序算法的原理及其Go語言版實現(xiàn)
這篇文章主要介紹了快速排序算法的原理及其Go語言版實現(xiàn),文中對于快速算法的過程和效率有較為詳細的說明,需要的朋友可以參考下
2016-04-04
go env環(huán)境變量配置的使用
在安裝和使用Go時,必須要正確地配置環(huán)境變量,本文主要介紹了go env環(huán)境變量配置的使用,具有一定的參考價值,感興趣的可以了解一下
2023-11-11
Go語言Select chan用法小結
select語句是Go語言中用于處理多個通道操作的關鍵字,它允許你在多個通道上進行非阻塞的選擇操作,本文就詳細介紹一下如何使用,感興趣的可以了解一下
2023-09-09
Golang如何調用Python代碼詳解
這篇文章主要給大家介紹了關于Golang如何調用Python代碼的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2018-10-10
golang連接redis庫及基本操作示例過程
這篇文章主要介紹了golang連接redis庫及基本操作示例過程，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步早日升職加薪
2022-04-04
go語言中[]*int和*[]int的具體使用
本文主要介紹了go語言中[]*int和*[]int的具體使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
2023-04-04
淺析GO語言的垃圾回收機制
今天我們來聊聊golang是如何進行垃圾回收的，我們知道，目前各語言進行垃圾回收的方法有很多，如引用計數(shù)、標記清除、分代回收、三色標記等，各種方式都有其特點，文中介紹的非常詳細，感興趣的小伙伴跟著小編一起學習吧
2023-07-07
golang實現(xiàn)并發(fā)數(shù)控制的方法
下面小編就為大家分享一篇golang實現(xiàn)并發(fā)數(shù)控制的方法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2017-12-12
詳解Golang互斥鎖內部實現(xiàn)
本篇文章主要介紹了詳解Golang互斥鎖內部實現(xiàn)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2017-06-06