【Go 快速入门】Go Test 工具 | 单元测试 | 基准测试

于 2024-09-01 21:01:07 发布
阅读量792 收藏 13
点赞数 6
分类专栏： Go 文章标签： golang 单元测试 基准测试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_52678569/article/details/141786689
版权

文章目录

本节项目地址：07-UnitTestBenchmarkTest

go test工具

Go语言中的测试依赖go test，该命令是一个按照一定约定和组织的测试代码的驱动程序。在包目录内，所有以_test.go为后缀名的源代码文件都是go test测试的一部分，不会被go build编译到最终的可执行文件中。

在*_test.go文件中有三种类型的函数，单元测试函数、基准测试函数和示例函数。

类型格式作用
测试函数函数名前缀为Test测试程序的一些逻辑行为是否正确
基准函数函数名前缀为Benchmark测试函数的性能
示例函数函数名前缀为Example为文档提供示例文档

go test命令会遍历所有的*_test.go文件中符合上述命名规则的函数，然后生成一个临时的main包用于调用相应的测试函数，然后构建并运行、报告测试结果，最后清理测试中生成的临时文件。

单元测试

  • 固定语法

func TestFuncName(t *testing.T) {}

  1. 单元测试的测试函数都以 Test 开头，可选的后缀名以大写字母开头
  2. 参数 t 是 *testing.T 类型，用于报告测试失败和附加的日志信息

下述创建了一个测试函数：

// TestStringSplit 测试 string 的 split 函数
func TestStringSplit(t *testing.T) {
	// 定义一个测试用例类型
	type test struct {
		input string
		sep   string
		want  []string
	}
	// 定义一个存储测试用例的切片
	tests := []test{
		{input: "a:b:c", sep: ":", want: []string{"a", "b", "c"}},
		{input: "a:b:c", sep: ",", want: []string{"a:b:c"}},
		{input: "abcd", sep: "bc", want: []string{"a", "d"}},
		{input: "沙河有沙又有河", sep: "沙", want: []string{"", "河有", "又有河"}},
	}
	// 遍历切片，逐一执行测试用例
	for _, tc := range tests {
		got := strings.Split(tc.input, tc.sep)
		if !reflect.DeepEqual(got, tc.want) {
			t.Errorf("expected:%#v, got:%#v", tc.want, got)
		}
	}
}
  • go test -v：执行测试，并打印出测试函数名和运行时间
go test -v 
=== RUN   TestStringSplit
--- PASS: TestStringSplit (0.00s)
PASS
ok      07-UnitTestBenchmarkTest/UnitTest       0.662s

子测试

如果测试用例比较多的时候，我们是没办法一眼看出来具体是哪个测试用例失败了。可以按照如下方式使用t.Run执行子测试就能够看到更清晰的输出内容了。

// TestStringSplit1 测试 string 的 split 函数，子测试
func TestStringSplit1(t *testing.T) {
	// 定义一个测试用例类型
	type test struct {
		input string
		sep   string
		want  []string
	}
	// 测试用例使用map存储
	tests := map[string]test{
		"simple":      {input: "a:b:c", sep: ":", want: []string{"a", "b", "c"}},
		"wrong sep":   {input: "a:b:c", sep: ",", want: []string{"a:b:c"}},
		"more sep":    {input: "abcd", sep: "bc", want: []string{"a", "d"}},
		"leading sep": {input: "沙河有沙又有河", sep: "沙", want: []string{"河有", "又有河"}},
	}
	for name, tc := range tests {
		// 使用t.Run()执行子测试
		t.Run(name, func(t *testing.T) {
			got := strings.Split(tc.input, tc.sep)
			if !reflect.DeepEqual(got, tc.want) {
				t.Errorf("expected:%#v, got:%#v", tc.want, got)
			}
		})
	}
}

go test -v 
=== RUN   TestStringSplit
--- PASS: TestStringSplit (0.00s)
=== RUN   TestStringSplit1
=== RUN   TestStringSplit1/wrong_sep
=== RUN   TestStringSplit1/more_sep
=== RUN   TestStringSplit1/leading_sep
    string_test.go:53: expected:[]string{"河有", "又有河"}, got:[]string{"", "河有", "又有河"}
=== RUN   TestStringSplit1/simple
--- FAIL: TestStringSplit1 (0.00s)
    --- PASS: TestStringSplit1/wrong_sep (0.00s)
    --- PASS: TestStringSplit1/more_sep (0.00s)
    --- FAIL: TestStringSplit1/leading_sep (0.00s)
    --- PASS: TestStringSplit1/simple (0.00s)
FAIL
exit status 1
FAIL    07-UnitTestBenchmarkTest/UnitTest       0.629s

如果指向执行指定的测试函数，可以通过 -run 参数指定，它对应一个正则表达式，只有函数名匹配的上的测试函数才会被 go test 命令执行。

go test -v -run=Split/simple
=== RUN   TestStringSplit
--- PASS: TestStringSplit (0.00s)
=== RUN   TestStringSplit1
=== RUN   TestStringSplit1/simple
--- PASS: TestStringSplit1 (0.00s)
    --- PASS: TestStringSplit1/simple (0.00s)
PASS
ok      07-UnitTestBenchmarkTest/UnitTest       0.046s

测试覆盖率

测试覆盖率是你的代码被测试套件覆盖的百分比。通常我们使用的都是语句的覆盖率，也就是在测试中至少被运行一次的代码占总代码的比例。

Go提供内置功能来检查你的代码覆盖率。我们可以使用go test -cover来查看测试覆盖率。Go还提供了一个额外的-coverprofile参数，用来将覆盖率相关的记录信息输出到一个文件。

使用：go test -cover -coverprofile="a.out"，将会生成 a.out 文件。然后可以执行go tool cover -html="a.out"，使用cover工具来处理生成的记录信息，该命令会打开本地的浏览器窗口生成一个HTML报告。

基准测试

  • 固定语法

func BenchmarkFuncName(b *testing.B) {}

  1. 基准测试的测试函数都以 Benchmark 开头
  2. 参数 b 是 *testing.B 类型
  3. 基准测试必须包含for循环，循环次数是 b.N 次（b.N的值是系统根据实际情况调整，保证测试稳定性）

下述创建了一个测试函数：

func split(s, sep string) (result []string) {
	result = make([]string, 0, strings.Count(s, sep)+1)
	i := strings.Index(s, sep)
	for i > -1 {
		result = append(result, s[:i])
		s = s[i+len(sep):]
		i = strings.Index(s, sep)
	}
	result = append(result, s)
	return
}

// BenchmarkSplit 测试自定义的 split 函数
func BenchmarkSplit(b *testing.B) {
	for i := 0; i < b.N; i++ {
		split("沙河有沙又有河", "沙")
	}
}

使用 go test -v -bench=Split 命令执行基准测试，基础测试默认不会执行，必须携带 -bench 参数。

go test -v -bench=Split
goos: windows
goarch: amd64
pkg: 07-UnitTestBenchmarkTest/BenchmarkTest
cpu: 13th Gen Intel(R) Core(TM) i9-13900HX
BenchmarkSplit
BenchmarkSplit-32       26486323                47.05 ns/op
PASS
ok      07-UnitTestBenchmarkTest/BenchmarkTest  1.897s

其中 BenchmarkSplit-32 表示对 Split 函数进行基准测试，数字 32 表示 GOMAXPROCS 的值，26486323 和 47.05 ns/op 表示每次调用 Split 函数耗时 47.05ns，这个结果是 26486323 次调用的平均值。

还可以为基准测试添加 -benchmem 参数，来获得内存分配的统计数据。如下所示，48 B/op 表示每次操作内存分配了48字节，1 allocs/op 表示每次操作进行了1次内存分配。

go test -v -bench=Split -benchmem
goos: windows
goarch: amd64
pkg: 07-UnitTestBenchmarkTest/BenchmarkTest
cpu: 13th Gen Intel(R) Core(TM) i9-13900HX
BenchmarkSplit
BenchmarkSplit-32       26387544                45.29 ns/op           48 B/op          1 allocs/op
PASS
ok      07-UnitTestBenchmarkTest/BenchmarkTest  1.295s

性能比较函数

性能比较函数通常是一个带有参数的函数，被多个不同的 Benchmark 函数传入不同的值来调用。

func fib(n int) int {
	if n < 2 {
		return n
	}
	return fib(n-1) + fib(n-2)
}

func benchmarkFib(b *testing.B, n int) {
	for i := 0; i < b.N; i++ {
		fib(n)
	}
}

func BenchmarkFib1(b *testing.B)  { benchmarkFib(b, 1) }
func BenchmarkFib2(b *testing.B)  { benchmarkFib(b, 2) }
func BenchmarkFib3(b *testing.B)  { benchmarkFib(b, 3) }
func BenchmarkFib10(b *testing.B) { benchmarkFib(b, 10) }
func BenchmarkFib20(b *testing.B) { benchmarkFib(b, 20) }
func BenchmarkFib40(b *testing.B) { benchmarkFib(b, 40) }

上述编写了一个斐波那契数列计算函数，并在不同大小的n值的情况下进行基准测试。

go test -v -bench=Fib          
goos: windows
goarch: amd64
pkg: 07-UnitTestBenchmarkTest/BenchmarkTest
cpu: 13th Gen Intel(R) Core(TM) i9-13900HX
BenchmarkFib1
BenchmarkFib1-32        1000000000               0.5479 ns/op
BenchmarkFib2
BenchmarkFib2-32        736555106                1.600 ns/op
BenchmarkFib3
BenchmarkFib3-32        459925009                2.590 ns/op
BenchmarkFib10
BenchmarkFib10-32        7295648               164.5 ns/op
BenchmarkFib20
BenchmarkFib20-32          59763             20160 ns/op
BenchmarkFib40
BenchmarkFib40-32              4         306910725 ns/op
PASS
ok      07-UnitTestBenchmarkTest/BenchmarkTest  8.692s

默认情况下，每个基准测试至少运行1秒，可以通过参数 -benchtime 设置基准测试时间。此外还有 -cpu 参数设置运行基准测试的并发数，-count 参数设置运行测试的总次数。

go test -v -bench="." -benchtime=2s 
goos: windows
goarch: amd64
pkg: 07-UnitTestBenchmarkTest/BenchmarkTest
cpu: 13th Gen Intel(R) Core(TM) i9-13900HX
BenchmarkSplit
BenchmarkSplit-32       48237133                44.58 ns/op
BenchmarkFib1
BenchmarkFib1-32        1000000000               0.5392 ns/op
BenchmarkFib2
BenchmarkFib2-32        1000000000               1.575 ns/op
BenchmarkFib3
BenchmarkFib3-32        931792406                2.590 ns/op
BenchmarkFib10
BenchmarkFib10-32       14704368               163.8 ns/op
BenchmarkFib20
BenchmarkFib20-32         119018             20080 ns/op
BenchmarkFib40
BenchmarkFib40-32              7         303590871 ns/op
PASS
ok      07-UnitTestBenchmarkTest/BenchmarkTest  14.857s

重置时间

b.ResetTimer 之前的处理不会放到执行时间里，也不会输出到报告中，所以可以在之前做一些不计划作为测试报告的操作。b.ReportAllocs() 记录内存分配数据。

func BenchmarkResetTimer(b *testing.B) {
	time.Sleep(3 * time.Second)
	b.ResetTimer()
	b.ReportAllocs()
	for i := 0; i < b.N; i++ {
		split("abc.poe.org.com", ".")
	}
}

go test -bench="Timer"
goos: windows
goarch: amd64
pkg: 07-UnitTestBenchmarkTest/BenchmarkTest
cpu: 13th Gen Intel(R) Core(TM) i9-13900HX
BenchmarkResetTimer-32          32262052                34.99 ns/op           64 B/op          1 allocs/op
PASS
ok      07-UnitTestBenchmarkTest/BenchmarkTest  16.843s

并行测试

func (b *B) RunParallel(body func(*PB)) 会以并行的方式执行给定的基准测试。

RunParallel 会创建出多个 goroutine，并将 b.N 分配给这些 goroutine 执行， 其中 goroutine 数量的默认值为GOMAXPROCS。用户如果想要增加非 CPU 受限（non-CPU-bound）基准测试的并行性， 那么可以在 RunParallel 之前调用 SetParallelism 。RunParallel 通常会与 -cpu 标志一同使用。

func BenchmarkSplitParallel(b *testing.B) {
	// b.SetParallelism(1) // 设置使用的cpu数
	b.RunParallel(func(pb *testing.PB) {
		for pb.Next() {
			split("cn.com.org", ".")
		}
	})
}

go test -bench="Parallel" -cpu=4
goos: windows
goarch: amd64
pkg: 07-UnitTestBenchmarkTest/BenchmarkTest
cpu: 13th Gen Intel(R) Core(TM) i9-13900HX
BenchmarkSplitParallel-4        95221719                14.72 ns/op
PASS
ok      07-UnitTestBenchmarkTest/BenchmarkTest  2.329s

参考：https://www.liwenzhou.com/posts/Go/unit-test/

ღCauchyོꦿ࿐
关注
  • 6
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Go语言编程从入门到精通（单元测试、检查覆盖率、基准测试）
phpygo的博客
01-14 246
Go（或Golang）是Google在2007年开发的一种开源编程语言，出自RobertGriesemer、RobPike和KenThompson之手。2009年11月10日，GoogleOpenSourceBlog向全球发布了这款语言：公告指出Go的主要目标是“兼具Python等动态语句的开发速度和C或C＋＋等编译型语言的性能与安全性”。 单元测试testing，测试函数、表格驱动测试、检查代码覆盖率、基准测试性能 单元测试 在Go语言中，单元测试使用gotest命令。 在包目录中，以_test.
Go单元测试从入门到放弃—0.单元测试基础
kevin_tech的博客，微信搜「网管叨bi叨」
03-21 714
这是Go单测从入门到放弃系列教程的第0篇，主要讲解在Go语言中如何做单元测试以及介绍了表格驱动测试、回归测试，并且介绍了常用的断言工具。Go语言测试go test工具Go语言中的测试依赖go test命令。编写测试代码和编写普通的Go代码过程是类似的，并不需要学习新的语法、规则或工具。go test命令是一个按照一定约定和组织的测试代码的驱动程序。在包目录内，所有以_te...
Go Test测试教程
止语的博客
03-13 3218
go中测试既有类似有pytest中的功能测试，也有benchMark的基准测试，以及单元测试（Unit TestsUT）.这里从单元测试UT引入本篇的话题，单元测试的重要性不言而喻，尤其在大型项目中跨团队合作时，无法mr合格的代码，很容易影响整个团队的交付进度和质量。或者会说直接debug，但是当你的代码是几千行的时候，这个时候debug似乎也比较累，那单元测试就能覆盖上述情况。如何写好单元测试呢？测试用例编写是基础。比如如何编写单个测试函数和单个测试方法，如何做基准测试，如何Mock。
Go 单元测试完全指南（一）- 基本测试流程
rubys007的博客
05-10 3848
而 E2E 测试和集成测试，往往需要启动整个项目，然后需要真实用户进行手动操作，这样的测试成本高，速度慢，所以我们往往不会频繁地运行这样的测试。只有在项目的最后阶段，我们才会运行这样的测试。这不难理解，单元测试往往用来验证代码的最小单元，比如一个函数、一个方法，这样的测试我们一个命令就能跑完整个项目的单元测试，而且速度还很快，所以单元测试是我们最常用的测试方式。很遗憾的是，Go 的测试框架并没有直接提供这样的功能，但是我们可以通过 Go 的特性来实现这样的功能。我们可以看到，两个测试失败输出的报错行都是。
golang入门笔记——测试
qq_43716830的博客
02-23 1395
1.所有测试文件以_test.go结尾3.初始化逻辑放到TestMain中。
【Go入门·预备知识】1.1 Go开发工具——《跟老吕学Go语言》
Python老吕的博客
06-18 634
Go语言的开发工具种类繁多，每种工具都有其独特的特点和优势。开发者可以根据自己的需求和偏好选择合适的工具进行Go语言的开发工作。通过使用这些工具，可以大大提高开发效率和质量，提升项目的稳定性和可维护性。👨‍💻博主Python老吕评论，您的举手之劳将对我提供了无限的写作动力！🤞') # 每日一码，用Python跟世界说Hello,World!🔥《Python全栈工程师》《跟老吕学MySQL》《Python游戏开发实战讲解》🌞《Python全栈工程师·附录资料》《Pillow库·附录资料》
Go-单元测试详解与代码
关注网络安全、云原生安全
07-17 2678
_test.go结尾 文件包含TestXxx函数 形参必须为*test.T go test go test -v go test 测试文件 被测试文件 go test -v -test.run 测试函数 参考 Go标准库-testing
如何做好单元测试？Golang Mock”三剑客“ gomock、monkey、sqlmock
文振熙 -- 云计算技术博客站
07-17 3343
单元测试一直是一个研发过程中老生常谈的话题，能够把单元测试做的比较好的公司也寥寥可数。最近同事开玩笑说最不喜欢的两件事情”接手的代码没有单测和别人让我写单测“，也能看得出大家对单测是又爱又恨。但真实情况是单测确实能够提高质量，一般公司架构团队或TL会要求业务研发有单测指标，但很容易因为”成本“问题最终以失败收尾，那怎么能够降低单测成本又能享受到单测带来和好处就是本文的”目的“了。代码可测性低成本mock逻辑断言工具httpsmonkey原理解读httpshttps。...
Go单元测试入门
恁村扛把子的博客
09-09 170
因此，Go 语言在 1.9 版本中引入了 t.Helper()，用于标注该函数是帮助函数，报错时将输出帮助函数调用者的信息，而不是帮助函数的内部信息。不要返回错误， 帮助函数内部直接使用 t.Error 或 t.Fatal 即可，在用例主逻辑中不会因为太多的错误处理代码，影响可读性。如果只想运行其中的一个用例，例如 TestAdd，可以用 -run 参数指定，该参数支持通配符 *，和部分正则表达式，例如 ^、$。运行 go test，报错信息如下，可以非常清晰地知道，错误发生在第 20 行。
Go-Golang单元测试快速入门
08-14
本教程将带你快速入门Go语言的单元测试，了解如何利用内置的`testing`包编写和运行测试用例。 Go语言的单元测试基于其标准库中的`testing`包，该包提供了编写、组织和执行测试的基本框架。下面我们将深入探讨`...
Go快速入门强化
06-16
- `go test`：内置的测试框架，支持单元测试和基准测试。 - `go mod`：模块化管理工具，用于解决依赖管理和版本控制。 - `go fmt`：自动格式化代码，保证代码风格的一致性。 4. **Go语言的性能优化** - 内存...
20-Go语言快速入门.zip
09-20
8. **Go的测试**：Go语言提供了内置的测试框架，通过`testing`包来编写单元测试和基准测试。学习如何编写测试用例和断言，以及如何运行和分析测试结果。 9. **Go的类型系统**：Go有丰富的类型系统，包括基本类型、...
如何完美实现 Go 服务的平滑升级
禅与代码的艺术
08-27 1491
首先通过一个具体的实验，演示了 Go 服务升级是如何引起的请求 502,从而引起平滑升级的必要性。其次，介绍了 Go 语言原生的信号处理框架，为后续讲解平滑升级打下基础。最后，讲解了如何实现 Go 服务的平滑退出以及开源框架 gracehttp。
golang 于 goland 无法运行
m0_63416413的博客
08-27 649
goland中直接删除配置( Edit Configurations )，或者把运行模式从 File 改为 Package 即可解决。命令行 go build -o main.go 等等。command-line-arguements 等等。直接goland运行。
Go语言的编程规则和秘籍
最新发布
一个被知识诅咒的人
09-01 442
本文介绍了Go语言的两条关键编程规则及其相关操作。首先，Go语言要求所有导入的包必须在代码中实际使用，未使用的包会导致编译错误。通过在包名前添加下划线，可以避免此限制但不建议这样做。其次，Go对大括号的使用有严格要求，大括号必须与函数声明在同一行，否则会引发编译错误。此外，本文还介绍了如何下载和管理外部Go包，使用`go get`命令可以轻松获取并编译外部包，并展示了删除中间文件和包的方法。了解并遵循这些规则有助于编写更高质量的Go代码。
Go 语言版本管理——Goenv
trinityleo5的博客
08-31 311
Go 语言版本管理——Goenv
go+gin+vue入门
yeanhoo的博客
08-23 1085
src目录下创建views目录，目录下新建vue组件，Login.vue。5、按照项目框架搭建目录、文件、代码：如router、model…7、按照项目框架搭建目录、文件、代码：如router、views…初始化数据库：创建model目录，目录下创建init.go文件。初始化路由：创建router目录，目录下创建app.go文件。src目录下创建router目录，目录下创建index.ts。6、运行测试，go run main.go。1、安装node.js、WebStorm。1、安装go、goland。
Go 中间件学习
程序媛平平无奇的一天
08-28 757
/ 在处理请求之前执行的操作// 继续处理请求c.Next()// 在处理请求之后执行的操作在这个例子中，中间件函数返回一个，它包含了在请求处理前后执行的代码。通过自定义中间件，你可以在 Gin 应用中轻松实现如日志记录、身份验证等通用功能。自定义中间件可以应用于整个路由组或单个路由，且中间件可以在请求处理的不同阶段执行逻辑，使你的应用程序更加灵活和易于维护。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ღCauchyོꦿ࿐

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值