在计算机编程中,单元测试Unit Testing
又称为模块测试,是针对程序模块来进行正确性检验的测试工作。
在Go语言中有几种方法可以用于单元测试,基础测试basic test
是指只使用一组参数和结果来测试一段代码;表组测试table test
是指使用多组参数和结果测试一段代码。此外,还可以使用一些方法来模仿mock
测试代码需要使用到的外部资源,例如数据库或者网络服务器。
单元测试
testing
是Go语言的一个包,它将提供自动化测试的功能,通过go test
命令能够自动执行如下形式的函数:
func TestXxx(*testing.T)
其中Xxx
可以是任何字母、数字、字符串,但是第一个字母一定不能是小写字母。在这些函数中,使用Error
,Fail
或相关方法来返回失败信号。
要编写一个新的测试模块,需要创建一个名称以_test.go
为结尾的文件,该文件包含TestXxx
函数,最后将该文件放在与被测试的包相同的包目录中。
第一个单元测试
我们来看一个简单的例子:
package main
import "fmt"
func main() {
fmt.Println(Age(-7))
}
func Age(n int) int {
if n > 0 {
return n
}
n = 0
return n
}
我们在来写一下测试文件,注意名称的定义,一定要记得在文件名称后面加_test.go
:
package main
import "testing"
func TestFib(t *testing.T) {
var (
input = -100
expected = 0
)
actual := Age(input)
if actual != expected {
t.Errorf("Fib(%d) = %d, expected is %d.", input, actual, expected)
}
}
当我们运行之后得到的结果为ok
时,那就表明我们的测试是成功的,函数也是没有问题的。
这就是基础测试,我们接下来再看一下表组测试,它是可以提供多组数据的测试方式。
表组测试
我们通过一个判断一个数字是否为素数的例子来看一下表组测试:
package main
import "fmt"
func main() {
fmt.Println(isPrime(25))
}
func isPrime(value int) bool {
if value <= 3 {
return value >= 2
}
if value%2 == 0 || value%3 == 0 {
return false
}
for i := 5; i <= value; i += 6 {
if value%i == 0 || value%(i+2) == 0 {
return false
}
}
return true
}
基于以上的程序,我们的测试文件可以这样来写:
package main
import "testing"
func TestPrime(t *testing.T) {
var primeTests = []struct {
input int
expected bool
}{
{1, false},
{2, true},
{3, true},
{4, false},
{5, true},
{6, false},
{7, false},
}
for _, tt := range primeTests {
actual := isPrime(tt.input)
if actual != tt.expected {
t.Errorf("%d %v %v", tt.input, actual, tt.expected)
}
}
}
在每一次的测试当中,测试函数执行结束返回,或者测试函数调用FailNow
,Fatal
,Fatalf
,SkipNow
,Skip
和Skipf
中的任意一个时,这次测试即宣告结束。
Fail
记录失败信息,然后继续执行后续用例。
FailNow
记录失败信息,所有测试中断。
SkipNow
不会记录失败的用例信息,然后终止测试。
Skip
记录失败信息,中断后续测试。
Skipf
相比前者多了一个格式化输出。
模拟测试
针对模拟网络访问,标准库提供了一个httptest
包,可以模拟HTTP
的网络调用,下面我们还是通过例子来看一下:
import (
"encoding/json"
"net/http"
)
func Routes() {
http.HandleFunc("/sendjson", SendJSON)
}
func SendJSON(rw http.ResponseWriter, r *http.Request) {
u := struct {
Name string
}{
Name: "Alice",
}
rw.Header().Set("Content-Type", "application/json")
rw.WriteHeader(http.StatusOK)
json.NewEncoder(rw).Encode(u)
}
现在我们对这API
服务进行测试:
func init() {
request.Routes()
}
func TestSendJSON(t *testing.T) {
req, err := http.NewRequest(http.MethodGet, "/sendjson", nil)
if err != nil {
t.Fatal("Creating request failed.")
}
rw := httptest.NewRecorder()
http.DefaultServeMux.ServeHTTP(rw, req)
log.Println("code: ", rw.Code)
log.Println("body: ", rw.Body.String())
}
测试覆盖率
尽可能模拟更多的场景来测试代码的不同情况,但是有时候的确也有忘记测试的代码,这时候就需要涉及到测试覆盖率的概念来进行参考了。
我们在对测试覆盖率进行测试的时候,需要在执行go test
的时候多添加一个参数-coverprofile
,完整的命令就是:
go test -v -coverprofile=c.out
-coverprofile
是指定生成的覆盖率文件,在我们的例子中是c.out
。
$ go test -v -coverprofile=c.out
=== RUN TestPrime
--- PASS: TestPrime (0.00s)
PASS
coverage: 66.7% of statements
ok _/home/hdc/goProgramming/testing1 0.001s
我们可以看到覆盖率为66.7%
。说明并没有完全覆盖,那么我们该如何查看还有哪些代码没有被测试到呢?这时就需要使用测试覆盖率文件c.out
了。生成报告使用的工具是:
go tool cover -html=c.out -o=tag.html
这样就可以生成一个名字为tag.html
的HTML
格式的测试覆盖率报告了。但一定要注意文件存放的路径,因为路径如果不满足条件的话是无法生成的。