go语言快速入门：测试覆盖率(18)

上篇文章讨论了如何使用testing标准包进行自动化测试，在这篇文章中将进一步细化测试覆盖率的可视化确认。

测试覆盖率

代码测试的覆盖率分很多种，语句覆盖/条件覆盖等等，而在go中，测试覆盖率是这样定义的：Test coverage is a term that describes how much of a package’s code is exercised by running the package’s tests. 可以看出，go语言中的理解是：测试覆盖率是通过执行某包的测试用例来确认代码被执行的程度的术语。

项目	URL
Cover	https://blog.golang.org/cover

统计模式

在go语言的测试覆盖率统计时，go test通过参数covermode的设定可以对覆盖率统计模式作如下三种设定。

模式	解释
set	缺省模式, 只记录语句是否被执行过
count	记录语句被执行的次数
atomic	记录语句被执行的次数，并保证在并发执行时的正确性

测试对象

项目	详细	说明
文件名	basicfunc.go	测试对象文件
package名	basicfunc	测试对象Package
测试对象函数	GetGrade	输入分数返回A-D的等级
测试对象函数	Add	输入两个数字，返回其相加之和

示例代码

[root@liumiaocn test]# cat basicfunc.go
package basicfunc

func GetGrade(score int) string {
        switch {
        case score < 60:
                return "D"
        case score <= 70:
                return "C"
        case score <= 80:
                return "B"
        case score <= 90:
                return "A"
        default:
                return "Undefined"
        }
}

func Add(num1 int, num2 int) int {
        return num1 + num2
}
[root@liumiaocn test]#

功能测试用例

[root@liumiaocn test]# cat func_test.go
package basicfunc

import "testing"

func TestBasic(test *testing.T) {
        grade := GetGrade(40)
        if grade != "D" {
                test.Error("Test Case failed.")
        }

}

func TestAddfunc(test *testing.T) {
        sum := Add(1, 1)
        if sum == 2 {
                test.Log("Passed: 1 + 1 == 2 ")
        } else {
                test.Log("Failed: 1 + 1 == 2 ")
        }
}
[root@liumiaocn test]#

覆盖率确认

注意事项

当go test命令无法正常运行时，学习时请将测试对象package放到GOROOT下，比如

[root@liumiaocn test]# echo $GOROOT
/usr/local/go
[root@liumiaocn test]# pwd
/usr/local/go/src/goprj/test
[root@liumiaocn test]#

确认覆盖率

[root@liumiaocn test]# go test -cover
PASS
coverage: 42.9% of statements
ok      goprj/test      0.007s
[root@liumiaocn test]#

HTML方式

可以看到我们现在得到了一个42.9%的覆盖率，这说明42.9%的代码在测试用例执行中被至少执行过一次。但是想确认那些语句没有被执行的时候，上述方法就无法使用了。接下来我们将继续使用go test命令生成html文件用以显示测试覆盖率情况。

生成HTML前的准备

哪个文件的哪行代码被执行了的中间信息如果没有的话，无论什么工具也会无能为力。所以第一步就是要生成这些中间的信息。

[root@liumiaocn test]# pwd
/usr/local/go/src/goprj/test
[root@liumiaocn test]# go test -coverprofile=covprofile
PASS
coverage: 42.9% of statements
ok      goprj/test      0.007s
[root@liumiaocn test]# cat covprofile
mode: set
goprj/test/basicfunc.go:3.33,4.16 1 1
goprj/test/basicfunc.go:5.9,6.27 1 1
goprj/test/basicfunc.go:7.9,8.27 1 0
goprj/test/basicfunc.go:9.9,10.27 1 0
goprj/test/basicfunc.go:11.9,12.27 1 0
goprj/test/basicfunc.go:13.9,14.35 1 0
goprj/test/basicfunc.go:18.34,20.2 1 1
[root@liumiaocn test]#

可以看到生成的中间文件covprofile中覆盖率统计模式为set，同时还有很多统计信息。

生成HTML文件

[root@liumiaocn test]# go tool cover -html=covprofile -o coverage.html
[root@liumiaocn test]#

生成的HTML文件内容

[root@liumiaocn test]# cat coverage.html



        
                
                
        
        
                

                        

                                

                                goprj/test/basicfunc.go (42.9%)

                                
                        
                        

                                not tracked

                                not covered
                                covered

                        
                
                


                
package basicfunc

func GetGrade(score int) string {
        switch {
        case score < 60:
                return "D"
        case score <= 70:
                return "C"
        case score <= 80:
                return "B"
        case score <= 90:
                return "A"
        default:
                return "Undefined"
        }
}

func Add(num1 int, num2 int) int {
        return num1 + num2
}


                
        
        

[root@liumiaocn test]#

结果确认

将生成的HTML用浏览器打开，可以很清楚地看到测试用例覆盖的代码和未曾覆盖到的代码，一目了然。

参考文献

项目	URL
Cover	https://blog.golang.org/cover