濮阳杆衣贸易有限公司

主頁 > 知識庫 > Golang單元測試與覆蓋率的實例講解

Golang單元測試與覆蓋率的實例講解

熱門標(biāo)簽:谷歌美發(fā)店地圖標(biāo)注 400開頭電話怎樣申請 江蘇呼叫中心外呼系統(tǒng)有效果嗎 地圖區(qū)域圖標(biāo)注后導(dǎo)出 貴州電話智能外呼系統(tǒng) 官渡電銷外呼管理系統(tǒng)怎么收費 杭州人工智能電銷機器人費用 利用地圖標(biāo)注位置 赤峰電銷

1 概述

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

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

2 單元測試

下面我們以《The Go Programming Language》6.5節(jié)的比特容器為例,介紹如何通過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是模塊的實現(xiàn)文件,bitvector_test.go則是用于測試比特容器的文件。

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

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

2.2.1 定義

type IntSet struct {
 words []uint
}

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

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

wordBitCount用于計算uint類型占用的比特數(shù),這個數(shù)字在不同的操作系統(tǒng)或CPU上是不同的。

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

// 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內(nèi)的第幾個比特,如果words切片長度不夠,則一直添加到可以包含待插入的元素為止,最后將對應(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)還實現(xiàn)了其它接口,包括String,UnionWith等,完整代碼見文末鏈接。

2.3 單元測試用例

好了,為了測試這個比特容器模塊,我們只需要在package目錄內(nèi)定義相應(yīng)的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包,這樣測試文件就可以隨意訪問這個包已導(dǎo)出和未導(dǎo)出的類型、函數(shù)、方法等;你可以定義成不同的包,比如package bitvector_test,這樣,bitvector包對bitvector_test包來說就是一個外部庫,test包只能訪問其中已導(dǎo)出的類型、函數(shù)、方法等,這個叫做外部測試;

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

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

2.4 執(zhí)行單元測試

Golang執(zhí)行單元測試的命令是go test,如果你在待測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僅輸出最終的測試結(jié)果,如果要看到測試過程,可以指定-v參數(shù):

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

每個用例的執(zhí)行成功與否,以及執(zhí)行用時都會顯示出來。

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

$ 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í)行所有模塊的測試,方式是以三個點替代具體的模塊路徑:

$ go test -v ...

3 覆蓋率生成

Golang單元測試覆蓋率的生成也簡單到令人發(fā)指。兩步:

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

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

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格式的覆蓋率報告

$ 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

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

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

4 小結(jié)

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

本文完整代碼在:這里

補充知識:GoLang Test 顯示輸出

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

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

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

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

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

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

未加設(shè)置前:

添加設(shè)置后:

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

您可能感興趣的文章:
  • logrus hook輸出日志到本地磁盤的操作
  • go日志系統(tǒng)logrus顯示文件和行號的操作
  • logrus日志自定義格式操作

標(biāo)簽:武漢 泰安 宜春 黔西 松原 河池 保定 鷹潭

巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《Golang單元測試與覆蓋率的實例講解》,本文關(guān)鍵詞  Golang,單元,測試,與,覆蓋率,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請?zhí)峁┫嚓P(guān)信息告之我們,我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無關(guān)。
  • 相關(guān)文章
  • 下面列出與本文章《Golang單元測試與覆蓋率的實例講解》相關(guān)的同類信息!
  • 本頁收集關(guān)于Golang單元測試與覆蓋率的實例講解的相關(guān)信息資訊供網(wǎng)民參考!
  • 推薦文章
    大冶市| 大庆市| 常山县| 舞阳县| 永川市| 清苑县| 汶上县| 元谋县| 开封县| 正安县| 定襄县| 达拉特旗| 中山市| 专栏| 浦江县| 景洪市| 连平县| 佛冈县| 安吉县| 商河县| 和林格尔县| 宜城市| 宣恩县| 穆棱市| 庆城县| 泰顺县| 平山县| 仲巴县| 衢州市| 安化县| 通山县| 德州市| 永和县| 旬阳县| 简阳市| 吉安县| 松阳县| 唐山市| 台南市| 建阳市| 南投县|