Golang單元測試與覆蓋率

1 概述

C/C++和Java（以及大多數的主流編程語言）都有自己成熟的單元測試框架，前者如Check，後者如JUnit，但這些編程框架本質上仍是第三方產品，爲了執行單元測試，我們不得不從頭開始搭建測試工程，並且需要依賴於第三方工具才能生成單元測試的覆蓋率。

相比之下，Go語言官方則提供了語言級的單元測試支持，即testing包，而且僅通過go工具本身就可以方便地生成覆蓋率數據，也就是說，單元測試是Go語言的自帶屬性，除了好好設計自己的單元測試用例外，開發者不需要操心工程搭建的任何細節。沒錯，Golang就是這麼任性。

2 單元測試

下面我們以《The Go Programming Language》6.5節的比特容器爲例，介紹如何通過testing包和go工具集進行單元測試。

2.1 工程目錄

不是說好的，Go語言單元測試不需要搭建測試工程麼？其實，Golang的測試工程只有一句話：對file.go新建file_test.go文件，並在其中編寫測試用例。所以，我們所謂的工程目錄其實就是：

$ go env | grep GOPATH
GOPATH="/home/pirlo/go"
$ tree /home/pirlo/go/src/github.com/pirlo-san/let-us-go
/home/pirlo/go/src/github.com/pirlo-san/let-us-go
├── bitvector
│   ├── bitvector.go
│   └── bitvector_test.go
├── LICENSE
└── README.md

/home/pirlo/go是我的GOPATH，其中的github.com/pirlo-san/let-us-go是一個git工程，bitvector則是這個工程下的一個子模塊，即比特容器模塊，bitvector.go是模塊的實現文件，bitvector_test.go則是用於測試比特容器的文件。

2.2 比特容器的實現

Golang沒有容器類型，多數容器都是通過map[type]bool實現的，但是通過map實現在某些場景下比較浪費內存，比如容器元素都是一些很小的非負整數的場景：0~31，其實，我們只需要一個uint32類型4個字節就可以了，但是如果採用map[uint32]bool實現，則對每個元素都需要一個uint32的key和bool類型的value。在C/C++語言內，可以很容易地通過位域的方式達到節省內存的目的，那麼Golang可不可以採用類似的方式實現呢？當然可以嘍。

2.2.1 定義

type IntSet struct {
    words []uint
}

const (
    wordBitCount = (32 << (^uint(0) >> 63))
)

IntSet是我們定義的比特容器類型，是一個結構體，其中唯一的成員是一個uint類型的切片，想象切片的元素被有序排列成一個“比特”數組，如果容器內存在元素N，則這個數組的第N個元素的值就爲1，否則就是0.

wordBitCount用於計算uint類型佔用的比特數，這個數字在不同的操作系統或CPU上是不同的。

2.2.2 向容器內添加一個元素

// add x into set s
func (s *IntSet) Add(x int) {
    word, index := wordIndex(x)
    for word >= len(s.words) {
        s.words = append(s.words, 0)
    }
    s.words[word] |= (1 << index)
}

func wordIndex(x int) (int, uint) {
    return x / wordBitCount, uint(x) % wordBitCount
}

先獲取這個元素在第幾個“word”，以及在這個word內的第幾個比特，如果words切片長度不夠，則一直添加到可以包含待插入的元素爲止，最後將對應元素位置的“比特位”設置爲1.

2.2.3 判斷某元素是否在容器內

// check wether x is in set s
func (s *IntSet) Has(x int) bool {
    word, index := wordIndex(x)
    if word >= len(s.words) {
        return false
    }

    return (s.words[word] & (1 << index)) != 0
}

《The Go Programming Language》內還實現了其它接口，包括String，UnionWith等，完整代碼見文末鏈接。

2.3 單元測試用例

好了，爲了測試這個比特容器模塊，我們只需要在package目錄內定義相應的test文件，並編寫用例即可。本例即爲bitvector_test.go：

package bitvector

import (
    "testing"
)

func TestAdd(t *testing.T) {
    var s IntSet
    s.Add(1)
    s.Add(2)
    s.Add(3)
    s.Add(4)

    if s.Has(1) == false || s.Has(2) == false || s.Has(3) == false || s.Has(4) == false {
        t.Error("Failed")
    }

    if s.Has(0) == true || s.Has(5) == true || s.Has(100) == true {
        t.Error("Failed")
    }
}

• 包聲明：測試文件也歸屬於bitvector包，這樣測試文件就可以隨意訪問這個包已導出和未導出的類型、函數、方法等；你可以定義成不同的包，比如package bitvector_test，這樣，bitvector包對bitvector_test包來說就是一個外部庫，test包只能訪問其中已導出的類型、函數、方法等，這個叫做外部測試;
• 導入testing包：testing包擁有執行Golang單元測試所需要的一切；
• 編寫測試函數：所有測試函數都以Test開頭，入參是testing.T類型的指針，在函數內調用被測函數，並對不符合預期的結果調用類似Error、Fatal的函數，其中前者在被調用後會打印出錯信息，並繼續執行後續用例，而後者則在打印信息後立即終止測試，一般僅在測試出現嚴重問題，無法繼續進行後續用例測試時才需要調用類似Fatal的接口。

2.4 執行單元測試

Golang執行單元測試的命令是go test，如果你在待測package所在的目錄，則直接執行go test即可：

$ pwd
/home/pirlo/go/src/github.com/pirlo-san/let-us-go/bitvector
$ go test
PASS
ok      github.com/pirlo-san/let-us-go/bitvector    0.004s

不帶任何參數的情況下，test僅輸出最終的測試結果，如果要看到測試過程，可以指定-v參數：

$ go test -v
=== RUN   TestAdd
--- PASS: TestAdd (0.00s)
PASS
ok      github.com/pirlo-san/let-us-go/bitvector    0.004s

每個用例的執行成功與否，以及執行用時都會顯示出來。

如果不在當前目錄，則需要指定待測模塊路徑：

$ pwd
/home/pirlo/go
$ go test -v github.com/pirlo-san/let-us-go/bitvector/
=== RUN   TestAdd
--- PASS: TestAdd (0.00s)
PASS
ok      github.com/pirlo-san/let-us-go/bitvector    0.004s

甚至，你還可以執行所有模塊的測試，方式是以三個點替代具體的模塊路徑：

$ go test -v ...

3 覆蓋率生成

Golang單元測試覆蓋率的生成也簡單到令人髮指。兩步：

• 執行go test時指定-coverprofile參數收集覆蓋率數據；
• 執行go tool cover生成文本、html等可視化格式的覆蓋率報告。

3.1 收集覆蓋率數據

$ go test -v -coverprofile=cover.out github.com/pirlo-san/let-us-go/bitvector/
=== RUN   TestAdd
--- PASS: TestAdd (0.00s)
PASS
coverage: 36.0% of statements
ok      github.com/pirlo-san/let-us-go/bitvector    0.009s
$ ll cover.out 
-rw-rw-r-- 1 pirlo pirlo 1330 Jan 12 23:11 cover.out

3.2 生成html格式的覆蓋率報告

$ go tool cover -html=cover.out -o coverage.html
$ ll coverage.html 
-rw-rw-r-- 1 pirlo pirlo 4504 Jan 12 23:15 coverage.html

生成的覆蓋率報告效果如下：

其中第一行左側的下拉列表列舉了所有文件的覆蓋率百分比，正文則以藍綠色字體標識已覆蓋的代碼行（本例的Add和Has都已經被測試過了），以紅色字體標識未被覆蓋的代碼行（UnionWith還沒有對應的測試用例），灰色字體則是類似類型定義、函數聲明等不需要被跟蹤的代碼行。

4 小結

Golang的單元測試和覆蓋率報告生成，過程非常簡單迅捷，而且不需要藉助任何第三方工具或庫，除了本文所述的基本測試場景外，Golang還支持Benchmark測試、內部函數/方法打樁等，有空再聊。

本文完整代碼在：這裏