Golang單元測試怎么寫？Golang單元測試最佳實踐

golang單元測試是用代碼驗證代碼是否按預(yù)期工作，以發(fā)現(xiàn)bug、提高質(zhì)量并支持重構(gòu)。其核心解決方案依賴標(biāo)準(zhǔn)庫testing，流程包括：1.創(chuàng)建以_test.go結(jié)尾的測試文件；2.編寫以test開頭、含*testing.t參數(shù)的測試函數(shù)；3.使用t.errorf等方法進(jìn)行斷言；4.運行g(shù)o test命令執(zhí)行測試。為提升可維護(hù)性，應(yīng)采用清晰命名、覆蓋邊界條件、減少重復(fù)代碼、使用表驅(qū)動測試。對于外部依賴，可通過gomock框架定義接口、生成mock對象、設(shè)置預(yù)期行為并注入測試代碼中。并發(fā)測試可用sync.waitgroup、chan及t.parallel()實現(xiàn)并行控制。benchmark測試以benchmark開頭，用*testing.b參數(shù)評估性能，通過go test -bench=.運行。代碼覆蓋率工具go test -coverprofile及go tool cover可分析測試覆蓋情況，但覆蓋率僅作參考指標(biāo)。

golang單元測試，簡單來說，就是用代碼來驗證你的代碼是否按照預(yù)期工作。它能幫你盡早發(fā)現(xiàn)bug，提高代碼質(zhì)量，并讓你更有信心進(jìn)行重構(gòu)。

解決方案

Golang的單元測試非常方便，標(biāo)準(zhǔn)庫testing已經(jīng)提供了所有你需要的基礎(chǔ)設(shè)施。一個基本的測試流程如下：

1. 創(chuàng)建測試文件： 對于你的my_module.go文件，創(chuàng)建一個對應(yīng)的my_module_test.go文件。
2. 編寫測試函數(shù)： 測試函數(shù)必須以Test開頭，并且接收一個*testing.T類型的參數(shù)。
3. 使用斷言： 使用t.Errorf、t.Fatalf等方法來報告測試失敗。
4. 運行測試： 使用go test命令運行測試。

下面是一個簡單的例子：

立即學(xué)習(xí)“go語言免費學(xué)習(xí)筆記（深入）”；

// my_module.go package mymodule  func Add(a, b int) int {     return a + b }  // my_module_test.go package mymodule  import "testing"  func TestAdd(t *testing.T) {     result := Add(2, 3)     if result != 5 {         t.Errorf("Add(2, 3) = %d; want 5", result)     } }

運行 go test，如果一切正常，你會看到 “PASS”。

如何編寫可維護(hù)的Golang單元測試？

編寫可維護(hù)的單元測試，意味著你的測試不僅要能發(fā)現(xiàn)bug，還要易于理解、修改和擴展。可以試試以下幾個技巧：

• 清晰的命名： 測試函數(shù)的名字應(yīng)該清晰地描述它測試的內(nèi)容。例如，TestAdd_PositiveNumbers 比 TestAdd 更好。
• 測試邊界條件： 不要只測試正常情況，還要測試邊界條件、錯誤情況和異常輸入。
• 避免重復(fù)代碼： 使用 helper 函數(shù)來減少測試代碼中的重復(fù)。
• 使用表驅(qū)動測試： 對于類似的測試用例，可以使用表驅(qū)動測試來提高代碼的可讀性和可維護(hù)性。

下面是一個表驅(qū)動測試的例子：

func TestAdd(t *testing.T) {     testCases := []struct {         a, b     int         expected int     }{         {2, 3, 5},         {-1, 1, 0},         {0, 0, 0},         {10, -5, 5},     }      for _, tc := range testCases {         result := Add(tc.a, tc.b)         if result != tc.expected {             t.Errorf("Add(%d, %d) = %d; want %d", tc.a, tc.b, result, tc.expected)         }     } }

如何Mock外部依賴進(jìn)行單元測試？

在單元測試中，我們希望隔離被測試的代碼，避免受到外部依賴的影響。這時，就需要使用 Mock。Golang有很多Mock框架，例如gomock。

使用 gomock 的基本步驟：

1. 定義接口： 定義一個接口，描述外部依賴的行為。
2. 生成 Mock 對象： 使用 gomock 生成接口的 Mock 對象。
3. 設(shè)置 Mock 對象的預(yù)期行為： 使用 EXPECT() 方法設(shè)置 Mock 對象的預(yù)期行為和返回值。
4. 在測試中使用 Mock 對象： 將 Mock 對象注入到被測試的代碼中。

例如，假設(shè)你的代碼依賴于一個數(shù)據(jù)庫連接：

// db.go package db  type Database interface {     Get(key string) (string, error) }  // my_module.go package mymodule  import "db"  type MyService struct {     db db.Database }  func (s *MyService) GetData(key string) (string, error) {     return s.db.Get(key) }

你可以這樣 Mock 數(shù)據(jù)庫連接：

// my_module_test.go package mymodule  import (     "testing"     "db"     "github.com/golang/mock/gomock" )  //go:generate mockgen -destination=mock_db.go -package=mymodule db Database  func TestGetData(t *testing.T) {     ctrl := gomock.NewController(t)     defer ctrl.Finish()      mockDB := NewMockDatabase(ctrl)     mockDB.EXPECT().Get("mykey").Return("myvalue", nil)      service := &MyService{db: mockDB}     result, err := service.GetData("mykey")      if err != nil {         t.Fatalf("unexpected error: %v", err)     }      if result != "myvalue" {         t.Errorf("GetData() = %v, want myvalue", result)     } }

首先，需要安裝 gomock: go install github.com/golang/mock/mockgen@v1.6.0。 然后，使用 go generate 命令生成 Mock 對象：go generate。

如何測試并發(fā)代碼？

測試并發(fā)代碼是一項挑戰(zhàn)，因為它涉及到不確定性和競態(tài)條件。Golang提供了一些工具來幫助你測試并發(fā)代碼：

• sync.WaitGroup： 用于等待一組 Goroutine 完成。
• chan： 用于 Goroutine 之間的通信。
• testing.T.Parallel()： 允許并行運行測試用例。

一個簡單的例子：

func TestParallel(t *testing.T) {     testCases := []int{1, 2, 3, 4, 5}      for _, tc := range testCases {         tc := tc // Capture range variable         t.Run(fmt.Sprintf("TestCase-%d", tc), func(t *testing.T) {             t.Parallel() // Mark this test case as parallel              // Simulate some work             time.Sleep(time.Duration(tc) * time.Millisecond)             fmt.Printf("Running test case: %dn", tc)              // Add your assertions here         })     } }

注意，t.Parallel() 必須在每個并行運行的測試用例中調(diào)用。 另外，要小心共享變量，使用互斥鎖或其他同步機制來避免競態(tài)條件。

如何進(jìn)行Benchmark測試？

Benchmark測試用于評估代碼的性能。Golang的testing包也提供了Benchmark測試的支持。

Benchmark測試函數(shù)必須以Benchmark開頭，并且接收一個*testing.B類型的參數(shù)。

func BenchmarkAdd(b *testing.B) {     for i := 0; i < b.N; i++ {         Add(2, 3)     } }

運行Benchmark測試：go test -bench=.。 -bench=. 表示運行所有Benchmark測試。

Benchmark測試會運行多次，并報告每次操作的平均時間。

如何使用代碼覆蓋率工具？

代碼覆蓋率工具可以幫助你了解你的測試覆蓋了多少代碼。Golang提供了一個內(nèi)置的代碼覆蓋率工具。

運行代碼覆蓋率：go test -coverprofile=coverage.out。

然后，可以使用go tool cover命令來分析覆蓋率結(jié)果：

• go tool cover -html=coverage.out：生成一個HTML報告，顯示哪些代碼被覆蓋了，哪些代碼沒有被覆蓋。
• go tool cover -func=coverage.out：顯示每個函數(shù)的覆蓋率。

代碼覆蓋率只是一個指標(biāo)，不能完全保證代碼的質(zhì)量。但是，它可以幫助你發(fā)現(xiàn)測試的盲點，并提高代碼的可靠性。