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 MyTest

import (
    "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 MyTest
import 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()
PASS
ok      /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 Field
FAIL
exit status 1
FAIL    _/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 . (不能漏了最後這個點，它表示執行全部的性能測試函數）

BenchmarkGetFieldValue    SetFieldValue()
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)
    }
}