Golang單元測(cè)試與覆蓋率的實(shí)例講解

1 概述

C/C++和Java（以及大多數(shù)的主流編程語(yǔ)言）都有自己成熟的單元測(cè)試框架，前者如Check，后者如JUnit，但這些編程框架本質(zhì)上仍是第三方產(chǎn)品，為了執(zhí)行單元測(cè)試，我們不得不從頭開(kāi)始搭建測(cè)試工程，并且需要依賴(lài)于第三方工具才能生成單元測(cè)試的覆蓋率。

相比之下，Go語(yǔ)言官方則提供了語(yǔ)言級(jí)的單元測(cè)試支持，即testing包，而且僅通過(guò)go工具本身就可以方便地生成覆蓋率數(shù)據(jù)，也就是說(shuō)，單元測(cè)試是Go語(yǔ)言的自帶屬性，除了好好設(shè)計(jì)自己的單元測(cè)試用例外，開(kāi)發(fā)者不需要操心工程搭建的任何細(xì)節(jié)。沒(méi)錯(cuò)，Golang就是這么任性。

2 單元測(cè)試

下面我們以《The Go Programming Language》6.5節(jié)的比特容器為例，介紹如何通過(guò)testing包和go工具集進(jìn)行單元測(cè)試。

2.1 工程目錄

不是說(shuō)好的，Go語(yǔ)言單元測(cè)試不需要搭建測(cè)試工程么？其實(shí)，Golang的測(cè)試工程只有一句話：對(duì)file.go新建file_test.go文件，并在其中編寫(xiě)測(cè)試用例。所以，我們所謂的工程目錄其實(shí)就是：

$ 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是一個(gè)git工程，bitvector則是這個(gè)工程下的一個(gè)子模塊，即比特容器模塊，bitvector.go是模塊的實(shí)現(xiàn)文件，bitvector_test.go則是用于測(cè)試比特容器的文件。

2.2 比特容器的實(shí)現(xiàn)

Golang沒(méi)有容器類(lèi)型，多數(shù)容器都是通過(guò)map[type]bool實(shí)現(xiàn)的，但是通過(guò)map實(shí)現(xiàn)在某些場(chǎng)景下比較浪費(fèi)內(nèi)存，比如容器元素都是一些很小的非負(fù)整數(shù)的場(chǎng)景：0~31，其實(shí)，我們只需要一個(gè)uint32類(lèi)型4個(gè)字節(jié)就可以了，但是如果采用map[uint32]bool實(shí)現(xiàn)，則對(duì)每個(gè)元素都需要一個(gè)uint32的key和bool類(lèi)型的value。在C/C++語(yǔ)言?xún)?nèi)，可以很容易地通過(guò)位域的方式達(dá)到節(jié)省內(nèi)存的目的，那么Golang可不可以采用類(lèi)似的方式實(shí)現(xiàn)呢？當(dāng)然可以嘍。

2.2.1 定義

type IntSet struct {
 words []uint
}

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

IntSet是我們定義的比特容器類(lèi)型，是一個(gè)結(jié)構(gòu)體，其中唯一的成員是一個(gè)uint類(lèi)型的切片，想象切片的元素被有序排列成一個(gè)“比特”數(shù)組，如果容器內(nèi)存在元素N，則這個(gè)數(shù)組的第N個(gè)元素的值就為1，否則就是0.

wordBitCount用于計(jì)算uint類(lèi)型占用的比特?cái)?shù)，這個(gè)數(shù)字在不同的操作系統(tǒng)或CPU上是不同的。

2.2.2 向容器內(nèi)添加一個(gè)元素

// 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
}

先獲取這個(gè)元素在第幾個(gè)“word”，以及在這個(gè)word內(nèi)的第幾個(gè)比特，如果words切片長(zhǎng)度不夠，則一直添加到可以包含待插入的元素為止，最后將對(duì)應(yīng)元素位置的“比特位”設(shè)置為1.

2.2.3 判斷某元素是否在容器內(nèi)

// 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》內(nèi)還實(shí)現(xiàn)了其它接口，包括String，UnionWith等，完整代碼見(jiàn)文末鏈接。

2.3 單元測(cè)試用例

好了，為了測(cè)試這個(gè)比特容器模塊，我們只需要在package目錄內(nèi)定義相應(yīng)的test文件，并編寫(xiě)用例即可。本例即為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")
 }
}

包聲明：測(cè)試文件也歸屬于bitvector包，這樣測(cè)試文件就可以隨意訪問(wèn)這個(gè)包已導(dǎo)出和未導(dǎo)出的類(lèi)型、函數(shù)、方法等；你可以定義成不同的包，比如package bitvector_test，這樣，bitvector包對(duì)bitvector_test包來(lái)說(shuō)就是一個(gè)外部庫(kù)，test包只能訪問(wèn)其中已導(dǎo)出的類(lèi)型、函數(shù)、方法等，這個(gè)叫做外部測(cè)試;

導(dǎo)入testing包：testing包擁有執(zhí)行Golang單元測(cè)試所需要的一切；

編寫(xiě)測(cè)試函數(shù)：所有測(cè)試函數(shù)都以Test開(kāi)頭，入?yún)⑹莟esting.T類(lèi)型的指針，在函數(shù)內(nèi)調(diào)用被測(cè)函數(shù)，并對(duì)不符合預(yù)期的結(jié)果調(diào)用類(lèi)似Error、Fatal的函數(shù)，其中前者在被調(diào)用后會(huì)打印出錯(cuò)信息，并繼續(xù)執(zhí)行后續(xù)用例，而后者則在打印信息后立即終止測(cè)試，一般僅在測(cè)試出現(xiàn)嚴(yán)重問(wèn)題，無(wú)法繼續(xù)進(jìn)行后續(xù)用例測(cè)試時(shí)才需要調(diào)用類(lèi)似Fatal的接口。

2.4 執(zhí)行單元測(cè)試

Golang執(zhí)行單元測(cè)試的命令是go test，如果你在待測(cè)package所在的目錄，則直接執(zhí)行g(shù)o 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

不帶任何參數(shù)的情況下，test僅輸出最終的測(cè)試結(jié)果，如果要看到測(cè)試過(guò)程，可以指定-v參數(shù)：

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

每個(gè)用例的執(zhí)行成功與否，以及執(zhí)行用時(shí)都會(huì)顯示出來(lái)。

如果不在當(dāng)前目錄，則需要指定待測(cè)模塊路徑：

$ 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

甚至，你還可以執(zhí)行所有模塊的測(cè)試，方式是以三個(gè)點(diǎn)替代具體的模塊路徑：

$ go test -v ...

3 覆蓋率生成

Golang單元測(cè)試覆蓋率的生成也簡(jiǎn)單到令人發(fā)指。兩步：

執(zhí)行g(shù)o test時(shí)指定-coverprofile參數(shù)收集覆蓋率數(shù)據(jù)；

執(zhí)行g(shù)o tool cover生成文本、html等可視化格式的覆蓋率報(bào)告。

3.1 收集覆蓋率數(shù)據(jù)

$ 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格式的覆蓋率報(bào)告

$ 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

生成的覆蓋率報(bào)告效果如下：

其中第一行左側(cè)的下拉列表列舉了所有文件的覆蓋率百分比，正文則以藍(lán)綠色字體標(biāo)識(shí)已覆蓋的代碼行（本例的Add和Has都已經(jīng)被測(cè)試過(guò)了），以紅色字體標(biāo)識(shí)未被覆蓋的代碼行（UnionWith還沒(méi)有對(duì)應(yīng)的測(cè)試用例），灰色字體則是類(lèi)似類(lèi)型定義、函數(shù)聲明等不需要被跟蹤的代碼行。

4 小結(jié)

Golang的單元測(cè)試和覆蓋率報(bào)告生成，過(guò)程非常簡(jiǎn)單迅捷，而且不需要借助任何第三方工具或庫(kù)，除了本文所述的基本測(cè)試場(chǎng)景外，Golang還支持Benchmark測(cè)試、內(nèi)部函數(shù)/方法打樁等，有空再聊。

本文完整代碼在：這里

補(bǔ)充知識(shí)：GoLang Test 顯示輸出

默認(rèn)運(yùn)行 go test 不會(huì)輸出 testing.T.Log() 的內(nèi)容。

要顯示這些內(nèi)容，需要加上開(kāi)關(guān) -v

go test -v -timeout 30s xxx/xxx/package -run ^TestXXXFunction$

在 Visual Studio Code IDE 環(huán)境中，可以設(shè)置 Workspace Settings。打開(kāi) .vscode/settings.json，添加：

"go.testFlags": ["-v"],

這樣，在 IDE 編輯器中，點(diǎn)擊函數(shù)上方的 run test，自動(dòng)運(yùn)行 go test，會(huì)被加上 -v 標(biāo)志，在 OUTPUT 窗口就可以看到 t.Logf("xxx%s","xxx") 的輸出內(nèi)容了。

未加設(shè)置前：

添加設(shè)置后：

以上這篇Golang單元測(cè)試與覆蓋率的實(shí)例講解就是小編分享給大家的全部?jī)?nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。