快捷導(dǎo)航

golang使用go test輸出單元測(cè)試覆蓋率的方式

更新時(shí)間：2024年02月28日 10:07:25 作者：xiaoliizi

單元測(cè)試覆蓋率是衡量代碼質(zhì)量的一個(gè)重要指標(biāo),重要的代碼文件覆蓋率應(yīng)該至少達(dá)到80%以上,Java 可以通過(guò)JaCoCo 統(tǒng)計(jì)覆蓋率,那么go 項(xiàng)目如何進(jìn)行代碼覆蓋率測(cè)試呢,本文將給大家詳細(xì)的介紹一下golang使用go test輸出單元測(cè)試覆蓋率的方式,需要的朋友可以參考下

一、背景

單元測(cè)試覆蓋率是衡量代碼質(zhì)量的一個(gè)重要指標(biāo)，重要的代碼文件覆蓋率應(yīng)該至少達(dá)到80%以上。Java 可以通過(guò)JaCoCo 統(tǒng)計(jì)覆蓋率，那么go 項(xiàng)目如何進(jìn)行代碼覆蓋率測(cè)試呢？

二、統(tǒng)計(jì)方式

1、生成覆蓋率報(bào)告（go test 指令）

我們知道直接執(zhí)行測(cè)試代碼的指令： go test 指定文件名稱 -run “測(cè)試方法”。

項(xiàng)目工程是如下架構(gòu)的，可以通過(guò)這種方式生成覆蓋率報(bào)告：

在這里插入圖片描述

go test -mod=vendor -covermode=count -coverprofile=coverprofile.cov -run="^Test" -coverpkg=$(go list -mod=vendor ./... | grep -v "/test" | tr '\n' ',') ./...

或 非 vendor 模式：
go test -covermode=count -coverprofile=coverprofile.cov -run="^Test" -coverpkg=$(go list ./... | grep -v "/test" | tr '\n' ',') ./...

生成結(jié)果：coverprofile.cov

指令簡(jiǎn)單說(shuō)明：

mod=vendor: 加載依賴的方式：從本地vendor 目錄加載。適用于服務(wù)器不能從外網(wǎng)下載依賴的情況

covermode: count: 統(tǒng)計(jì)代碼訪問(wèn)次數(shù)；set: 統(tǒng)計(jì)代碼是否被訪問(wèn); atomic: 一般在并發(fā)工程中使用（？）

run: 正則方式指定需要運(yùn)行的測(cè)試方法

coverpkg: 指定業(yè)務(wù)代碼路徑，多個(gè)用逗號(hào)隔開(kāi)，詳細(xì)說(shuō)明在后面

./…：遍歷當(dāng)前目錄下測(cè)試文件，包括子目錄

關(guān)于為什么要使用coverpkg:

主要是因?yàn)槲覀兊捻?xiàng)目結(jié)構(gòu)中，測(cè)試代碼和業(yè)務(wù)代碼是分開(kāi)的，而不是放到同一個(gè)目錄中。因此如果只指定測(cè)試方法，就無(wú)法識(shí)別到業(yè)務(wù)代碼，來(lái)計(jì)算覆蓋率了。

因此我們既需要指定測(cè)試代碼路徑（當(dāng)然這里聲明為 ./… 就可以了，只有_test 結(jié)尾的方法會(huì)自動(dòng)作為測(cè)試方法），也需要指定業(yè)務(wù)代碼路徑（通過(guò)grep -v 和 tr 指令，最終將業(yè)務(wù)代碼輸出成 git/controller,git/database 的格式）