欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

使用Go进行单元测试的实现

程序员文章站 2022-11-16 09:32:32
简介 日常开发中, 测试是不能缺少的. go 标准库中有一个叫做 testing 的测试框架, 可以用于单元测试和性能测试. 它是和命令 go test 集成使用的....

简介

日常开发中, 测试是不能缺少的.

go 标准库中有一个叫做 testing 的测试框架, 可以用于单元测试和性能测试.

它是和命令 go test 集成使用的.

测试文件是以后缀 _test.go 命名的, 通常和被测试的文件放在同一个包中.

单元测试

单元测试的格式形如:

func testabs(t *testing.t) {
 got := abs(-1)
 if got != 1 {
  t.errorf("abs(-1) = %d; want 1", got)
 }
}

在 util 目录下创建一个文件 util_test.go, 添加一个单元测试:

package util

import "testing"

// 普通的测试
func testgenshortid(t *testing.t) {
 shortid, err := genshortid()
 if shortid == "" || err != nil {
 t.error("genshortid failed")
 }
}

然后, 在根目录下运行 go test -v ./util/, 测试结果如下:

root@592402321ce7:/workspace# go test -v ./util/
=== run  testgenshortid
--- pass: testgenshortid (0.00s)
pass
ok   tzh.com/web/util    0.006s

性能测试

性能测试的结果形如:

func benchmarkhello(b *testing.b) {
 for i := 0; i < b.n; i++ {
  fmt.sprintf("hello")
 }
}

在 util_test.go 添加性能测试:

// 性能测试
func benchmarkgenshortid(b *testing.b) {
 for i := 0; i < b.n; i++ {
 genshortid()
 }
}

运行结果如下(使用 --run=none 避免运行普通的测试函数, 因为一般不可能有函数名匹配 none):

root@592402321ce7:/workspace# go test -v -bench="benchmarkgenshortid$" --run=none ./util/
goos: linux
goarch: amd64
pkg: tzh.com/web/util
benchmarkgenshortid-2       507237       2352 ns/op
pass
ok   tzh.com/web/util    1.229s

这说明, 平均每次运行 genshortid() 需要 2352 纳秒.

性能分析

运行测试的时候, 可以指定一些参数, 生成性能文件 profile.

-blockprofile block.out
  write a goroutine blocking profile to the specified file
  when all tests are complete.
  writes test binary as -c would.

-blockprofilerate n
  control the detail provided in goroutine blocking profiles by
  calling runtime.setblockprofilerate with n.
  see 'go doc runtime.setblockprofilerate'.
  the profiler aims to sample, on average, one blocking event every
  n nanoseconds the program spends blocked. by default,
  if -test.blockprofile is set without this flag, all blocking events
  are recorded, equivalent to -test.blockprofilerate=1.

-coverprofile cover.out
  write a coverage profile to the file after all tests have passed.
  sets -cover.

-cpuprofile cpu.out
  write a cpu profile to the specified file before exiting.
  writes test binary as -c would.

-memprofile mem.out
  write an allocation profile to the file after all tests have passed.
  writes test binary as -c would.

-memprofilerate n
  enable more precise (and expensive) memory allocation profiles by
  setting runtime.memprofilerate. see 'go doc runtime.memprofilerate'.
  to profile all memory allocations, use -test.memprofilerate=1.

-mutexprofile mutex.out
  write a mutex contention profile to the specified file
  when all tests are complete.
  writes test binary as -c would.

-mutexprofilefraction n
  sample 1 in n stack traces of goroutines holding a
  contended mutex.

使用下面的命令, 生成 cpu 的 profile:

go test -v -bench="benchmarkgenshortid$" --run=none -cpuprofile cpu.out ./util/

当前目录下, 应该会生成 cpu.out 文件和 util.test 文件.

使用下面的命令, 观察耗时操作:

# 进入交互模式
go tool pprof cpu.out
top

安装 graphviz 后可以生成可视化的分析图.

apt install graphviz
go tool pprof -http=":" cpu.out

测试覆盖率

root@592402321ce7:/workspace# go test -v -coverprofile=cover.out ./util/
=== run  testgenshortid
--- pass: testgenshortid (0.00s)
pass
coverage: 9.1% of statements
ok   tzh.com/web/util    0.005s coverage: 9.1% of statements

root@592402321ce7:/workspace# go tool cover -func=cover.out
tzh.com/web/util/util.go:12:  genshortid   100.0%
tzh.com/web/util/util.go:17:  getreqid    0.0%
tzh.com/web/util/util.go:22:  timetostr    0.0%
tzh.com/web/util/util.go:30:  gettag     0.0%
total:             (statements)  9.1%

使用 -coverprofile=cover.out 选项可以统计测试覆盖率.使用 go tool cover -func=cover.out 可以查看更加详细的测试覆盖率结果,
统计每个函数的测试覆盖率.

总结

测试是开发中非常重要的一个环节, 用于保证软件质量, 切不可偷懒.

当前部分的代码

作为版本

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。