Golang单元测试及测试覆盖率

本文 go 版本 1.12.5, 在 go mod 下当前项目名称 goshop

1. 书写代码

自定义库代码 goshop/app/lib 下 utils.go

package tools

// CheckPhoneNumber 校验手机号
func CheckPhoneNumber(phone string) bool {
  // 手机号长度11位
  if StringLength(phone) != 11 {
    return false
  }
  reg := regexp.MustCompile(`^1[3,4,5,6,7,8,9]{1}[0-9]{9}$`)
  return reg.MatchString(phone)
}

// StringLength 获取字符串长度
func StringLength(str string) int {
  return strings.Count(str, "") - 1
}

测试代码 goshop/app/lib 下 utils_test.go

package tools

import (
  "testing"
)


func TestCheckPhoneNumber(t *testing.T) {
  type suite struct {
    data   string
    result bool
  }

  phoneExample := []suite{
    suite{"", false},
    suite{"12345678901", false},
    suite{"1020", false},
    ...
    suite{"19456782901", true},
  }

  for _, v := range phoneExample {
    if result := CheckPhoneNumber(v.data); result != v.result {
      t.Errorf("测试用例 %s : 测试结构 %t , 与期望不符合 %t", v.data, result, v.result)
    }
  }
}

func TestStringLength(t *testing.T) {
  type suite struct {
    data   string
    result int
  }

  strExample := []suite{
    suite{"1", 1},
    suite{"", 0},
    suite{"1678", 4},
    suite{"13456789301", 11},
    suite{"abcd", 4},
    suite{"hello world", 11},
    suite{"我在这", 3},
    suite{"你是谁?Who are you?", 16},
  }

  for _, v := range strExample {
    if result := StringLength(v.data); result != v.result {
      t.Errorf("测试用例 %s : 测试结构 %d , 与期望不符合 %d", v.data, result, v.result)
    }
  }
}

2. 查看覆盖率

go test 常用命令解释
用法 go test [build/_test flags] [packages] [build/test flags & test binary flags]
go test [file.go / mod_dir | main_test.go] / go test 文件名/包名(main_test.go)

普通展示

// 普通测试,只展示测试结果及时间
➜  go test goshop/app/lib
// ok      goshop/app/lib  0.007s

// 展示测试明细, 此时仍没有覆盖率
➜  go test goshop/app/lib -v
// === RUN   TestCheckEmail
// --- PASS: TestCheckEmail (0.00s)
// === RUN   TestStringLength
// --- PASS: TestStringLength (0.00s)
// === RUN   TestCheckPhoneNumber
// --- PASS: TestCheckPhoneNumber (0.00s)
// PASS
// ok      goshop/app/lib  (cached)

展示测试明细及覆盖率,
展示的是当前库的所有文件的覆盖率,
此时已经知道覆盖率了,
但是不知道测试到底覆盖的是哪部分代码,
哪部分没有覆盖

➜ go test goshop/app/lib -v -covermode=count 
// === RUN   TestCheckEmail
// ...
// PASS
// coverage: 19.2% of statements
// ok      goshop/app/lib  0.007s  coverage: 19.2% of statements

展示测试覆盖率,并生成覆盖统计文件到 count.out,
count.out 文件中详细展示了每个文件测试时某一行,执行的次数及其他信息(暂时只能用到次数)

1
2
3
4
5
6
➜ go test goshop/app/lib -v -coverprofile=count.out
// === RUN   TestCheckEmail
// ...
// PASS
// coverage: 19.2% of statements
// ok      goshop/app/lib  0.007s  coverage: 19.2% of statements

分析 count.out 文件生成想要的结果
-func 生成每个函数的覆盖率
-html 生成 html 文件,已图形形式展示每个函数,每一行代码的覆盖率
生成测试运行,函数覆盖率,展示每一个函数单元测试的覆盖率,100% 则测试完整,0 则没有测试

➜ go tool cover -func=count.out
// goshop/app/lib/jwt.go:31:       signHeader              0.0%
// ....
// goshop/app/lib/utils.go:11:     CheckEmail              100.0%
// goshop/app/lib/utils.go:21:     CheckPhoneNumber        100.0%
// ...
// total:                          (statements)            19.2%

`➜ go tool cover -html=count.out` 会打开默认浏览器,展示测试覆盖率的图形化,
可以切换,当前库下每个文件,看到每一行代码是否测试执行,没有执行的显示为红色, 灰色是不需要测试的, 亮绿色是测试通过的
![](go-tool-cover-html.png)