Golang測試包小結

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

Golang測試包

golang內建了測試包（testing），直接可以進行單元測試、效能分析、輸出結果驗證等。簡單看著官方文檔試了試，總結一下：

目錄結構和命令

使用golang的測試包，需要遵循簡單的目錄結構

測試代碼放在待測試代碼的目錄下（一個包內），以_test.go結尾，例如如下目錄結構，MyTest目錄下有待測試的代碼檔案MyTest.go和測試代碼MyTest_test.go

.|-- bin|   `-- main|-- pkg|   `-- darwin_amd64|       `-- MyTest.a`-- src    |-- MyTest    |   |-- MyTest.go    |   `-- MyTest_test.go    `-- main        `-- main.go

直接在MyTest目錄下執行go test命令即可，go test包含很多選項，可以參考Golang手冊相關部分

基本的測試函數

待測試的MyTest.go源碼如下：

package MyTestimport (    "fmt")type MyStruct struct {    name string}func GetFieldValue(x *MyStruct) string {    value := x.name    return value}func SetFieldValue(x *MyStruct, value string) {    fmt.Println("SetFieldValue()")    x.name = value}

對於MyTest_test.go，首先自然是要匯入golang的測試包：

package MyTestimport testing

基本的測試函數以Test開頭，後面接的字串，第一個字元必須是數字或者大寫，例如：

func TestMytest(t *testing.T) {    var st MyStruct    SetFieldValue(&st, "hello")    val := GetFieldValue(&st)    if val != "hello" {        t.Error("Set Field")    }}

T是testing包裡定義的一個結構體，其包含了名為common的介面，提供了很多格式化輸出的功能，golang提供了自動檢查與調用測試函數的機制，測試函數的執行邏輯則需要編寫者自行完成。

執行go test 結果為：

Call SetFieldValue()PASSok  /go/src/MyTest 0.004s

如果寫成Testmytest，運行時會直接忽略掉該函數。得到的結果仍然為Pass，但是不會列印“Call SetFieldValue()”，也就是說測試函數實際沒有執行。
修改一下判斷條件：

func TestMytest(t *testing.T) {    var st MyStruct    SetFieldValue(&st, "hello")    val := GetFieldValue(&st)    if val != "world" {        t.Error("Set Field")    }}

這個測試案例不會通過, 而Error函數的入參就是測試不通過時列印的資訊：

SetFieldValue()--- FAIL: TestMytest (0.00s)MyTest_test.go:15: Set FieldFAILexit status 1FAIL_/Users/ronghuihe/Documents/code/golang/my/go/src/MyTest 0.004s

這並不會中斷測試程式，這個函數後面的部分仍然會執行，其他的測試函數也會執行。

效能分析函數

testing包還內建了效能分析功能，可評估代碼執行效能。效能分析函數也可以放到前面的xxx_test.go檔案內，命名以Benchmark開頭，如：

func BenchmarkGetFieldValue(b *testing.B) {    var st MyStruct    SetFieldValue(&st, "hello")    for i := 0; i < b.N; i++ {        GetFieldValue(&st)    }}

其中b.N的值在執行過程中會自動調整，使得迴圈可以執行足夠多次，以便得到較為準確的單次結果：
效能分析加-bench參數執行，即go test -bench . (不能漏了最後這個點，它表示執行所有的效能測試函數）

BenchmarkGetFieldValueSetFieldValue()SetFieldValue()SetFieldValue()SetFieldValue()SetFieldValue()SetFieldValue()2000000000         0.55 ns/op

每次迴圈大約需要0.55ns。這裡SetFieldValue()列印了多次，是因為BenchmarkGetFieldValue被調用了多次。
分析testing包的源碼benchmark.go裡的launch函數和runN函數，可以看到golang會自行調節效能分析函數的調用次數。每次執行runN都會執行一次效能測試函數，而後根據已耗用時間，會確定後續的內部迴圈執行次數b.N，直到總的已耗用時間達到go test -benchtime指定的時間（如果沒指定預設為1s）

注意統計時間時，執行的是使用者編寫的效能分析函數，如上例中的BenchmarkGetFieldValue，而最後輸出的結果，表達的是for迴圈裡函數的效能，因此for迴圈之前的代碼執行時間很長的話，可能導致統計誤差比較大，如果需要剔除for之前代碼的影響，可以在for迴圈之前調用ResetTimer()介面重設本次統計的時間值：

func BenchmarkGetFieldValue(b *testing.B) {    var st MyStruct    SetFieldValue(&st, "hello")    b.ResetTimer()    for i := 0; i < b.N; i++ {        GetFieldValue(&st)    }}