Go 怎么寫測試用例

2022-05-13 17:03 更新

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

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

如何編寫測試用例

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

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

  1. gotest.go:這個文件里面我們是創(chuàng)建了一個包,里面有一個函數(shù)實現(xiàn)了除法運算:
  2. package gotest
    
    import (
        "errors"
    )
    
    func Division(a, b float64) (float64, error) {
        if b == 0 {
            return 0, errors.New("除數(shù)不能為0")
        }
    
        return a / b, nil
    }
  3. gotest_test.go:這是我們的單元測試文件,但是記住下面的這些原則:

    • 文件名必須是_test.go結(jié)尾的,這樣在執(zhí)行go test的時候才會執(zhí)行到相應(yīng)的代碼
    • 你必須import testing這個包
    • 所有的測試用例函數(shù)必須是Test開頭
    • 測試用例會按照源代碼中寫的順序依次執(zhí)行
    • 測試函數(shù)TestXxx()的參數(shù)是testing.T,我們可以使用該類型來記錄錯誤或者是測試狀態(tài)
    • 測試格式:func TestXxx (t *testing.T),Xxx部分可以為任意的字母數(shù)字的組合,但是首字母不能是小寫字母[a-z],例如Testintdiv是錯誤的函數(shù)名。
    • 函數(shù)中通過調(diào)用testing.TErrorErrorfFailNowFatalFatalIf方法,說明測試不通過,調(diào)用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ù)測試沒通過") // 如果不是如預(yù)期的那么就報錯
    } 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
從這個結(jié)果顯示測試沒有通過,因為在第二個測試函數(shù)中我們寫死了測試不通過的代碼`t.Error`,那么我們的第一個函數(shù)執(zhí)行的情況怎么樣呢?默認(rèn)情況下執(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
上面的輸出詳細(xì)的展示了這個測試的過程,我們看到測試函數(shù)1`Test_Division_1`測試通過,而測試函數(shù)2`Test_Division_2`測試失敗了,最后得出結(jié)論測試不通過。接下來我們把測試函數(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ù)期的那么就報錯
    } 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不會默認(rèn)執(zhí)行壓力測試的函數(shù),如果要執(zhí)行壓力測試需要帶上參數(shù)-test.bench,語法:-test.bench="test_name_regex",例如go test -test.bench=".*"表示測試全部的壓力測試函數(shù)

  • 在壓力測試用例中,請記得在循環(huán)體內(nèi)使用testing.B.N,以使測試可以正常的運行
  • 文件名也必須以_test.go結(jié)尾

下面我們新建一個壓力測試文件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ù)停止壓力測試的時間計數(shù)

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

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

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

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

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

小結(jié)

通過上面對單元測試和壓力測試的學(xué)習(xí),我們可以看到testing包很輕量,編寫單元測試和壓力測試用例非常簡單,配合內(nèi)置的go test命令就可以非常方便的進(jìn)行測試,這樣在我們每次修改完代碼,執(zhí)行一下go test就可以簡單的完成回歸測試了。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號