golang 单元测试框架实践

简介: 日常开发中, 测试是不能缺少的,每次手动测试非常费时费力,通过单元测试可以达到一次实现多次利用;单元测试主要是通过模拟业务中的参数,调用我们的函数,然后获取执行结果,再判断结果是否符合规则;同时还可以对某一个方法进行性能分析在Go 标准库中有一个叫做 `testing` 的测试框架, 可以用于单元测试和性能测试. 它是和命令 `go test` 集成使用的,测试文件是以后缀 `_test.go` 命名的, 通常和被测试的文件放在同一个包中.

一、简介

日常开发中, 测试是不能缺少的,每次手动测试非常费时费力,通过单元测试可以达到一次实现多次利用;

单元测试主要是通过模拟业务中的参数,调用我们的函数,然后获取执行结果,再判断结果是否符合规则;同时还可以对某一个方法进行性能分析

在Go 标准库中有一个叫做 testing 的测试框架, 可以用于单元测试和性能测试. 它是和命令 go test 集成使用的,测试文件是以后缀 _test.go 命名的, 通常和被测试的文件放在同一个包中.

规则:

  • 单元测试代码的go文件必须以_test.go结尾,Go语言测试工具只认符合这个规则的文件
  • 单元测试的函数名必须以Test开头,是可导出公开的函数。备注:函数名最好是Test+要测试的方法函数名
  • 测试函数的签名必须接收一个指向testing.T类型的指针作为参数,并且该测试函数不能返回任何值

二、实验环境

单元测试我们大部分情况下无需增加或修改业务代码,只需增加单元测试代码即可,在这个实验过程中,我们简单编写一个简单的业务代码,用来模拟项目中的业务代码;然后再添加单元测试代码进行测试。

2.1 编写被测试的代码

我们找一个空文件夹,新建一个main.go文件,在文件中将一下代码复制进去并保存

package main

func Sum(count int) int {
    count--
    return count
}

2.2 编写单元测试代码

接着我们继续在当前文件夹下新建单元测试代码,按照简介中的规则,我们需要新建一个名为main_test.go的文件,然后在文件中编写测试代码,示例代码如下

package main

import (
    "testing"
)

//单元测试
func TestSum(t *testing.T) {
    //准备参数
    param := 10
    //执行函数
    ret := Sum(param)
    //判断结果是否符合预期
    if ret != 9 {
        t.Error("Sum result failed")
    }
}

//性能测试
func BenchmarkSum(b *testing.B) {
    //准备参数
    param := 10
    //执行函数
    for i := 0; i < b.N; i++ {
        Sum(param)
    }
}

三、单元测试使用

3.1 普通测试

普通测试主要是验证返回的结果是否符合预期,执行的命令如下所示

go test -v  main_test.go  main.go

命令执行后,返回的结果如下所示
image

从上图中可以看到,单元测试提示测试通过,说明我们程序符合预期

3.2 性能测试

性能测试主要是通过多次调用程序,总耗时来分析程序的性能,类似于AB压力测试,执行命令如下所示

go test -v -bench="BenchmarkSum$"  --run=none main_test.go  main.go

命令中的-bench="BenchmarkSum$"参数代表要窒息哪一个方法,执行结果如下所示
image

在上图中可以看到程序被调用了1000000000次,平均耗时0.254ns

3.3 性能分析

性能分析主要是查看方法中具体的瓶颈,比如A方法调用了C、B、D多个方法,具体耗时在什么位置,我们可以在上一条性能测试的命令中加入-cpuprofile cpu.out参数(文章附录有多种分析指标类型)加入到性能测试中的具体信息保存

go test -v -bench="BenchmarkSum$"  --run=none  -cpuprofile cpu.out  main_test.go  main.go

image
通过go 自带工具分析保存的文件

go tool pprof cpu.out

命令执行之后返回信息如下图所示
image

通过第三方工具视图分析

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

命令执行之后,会返回一个localhost域名加随机端口的网址,打开网址之后,能看到如下信息,因为我测试的方法比较简单

image

四、附录

各参数含义翻译

-blockprofile block.out

将goroutine阻塞配置文件写入指定文件
当所有测试完成时。
按照-c的方式编写测试二进制文件。

-blockprofilerate n


控制细节提供的goroutine阻塞配置文件
调用运行时。SetBlockProfileRate与n。
参见" go doc run . setblockprofilerate "
剖析器的目标是平均每个阻塞事件采样一次
n纳秒的程序花费被阻塞。默认情况下,
如果以及。块配置文件没有设置这个标志,所有的阻塞事件
,相当于-test.blockprofilerate=1。

-coverprofile cover.out


在所有测试通过后,向文件写入覆盖率配置文件。
设置覆盖。

-cpuprofile cpu.out


退出前将CPU配置文件写入指定文件。
按照-c的方式编写测试二进制文件。

-memprofile mem.out


通过所有测试后,将分配配置文件写入该文件。
按照-c的方式编写测试二进制文件。

-memprofilerate n


启用更精确(和昂贵)的内存分配配置文件
设置runtime.MemProfileRate。参见" go doc run . memprofilerate "。
要配置所有内存分配,使用-test.memprofilerate=1。

-mutexprofile mutex.out


将互斥锁争用配置文件写入指定文件
当所有测试完成时。
按照-c的方式编写测试二进制文件。

-mutexprofilefraction n


样本1在n堆栈的踪迹goroutines持有a
争用互斥锁。


作者:汤青松

日期:2020-08-11

相关实践学习
通过性能测试PTS对云服务器ECS进行规格选择与性能压测
本文为您介绍如何利用性能测试PTS对云服务器ECS进行规格选择与性能压测。
目录
相关文章
|
17天前
|
数据采集 存储 Go
Golang爬虫代理接入的技术与实践
Golang爬虫代理接入的技术与实践
|
18天前
|
SQL 关系型数据库 MySQL
探索Gorm - Golang流行的数据库ORM框架
探索Gorm - Golang流行的数据库ORM框架
|
2天前
|
Go
golang学习3,golang 项目中配置gin的web框架
golang学习3,golang 项目中配置gin的web框架
|
5天前
|
测试技术
测试基础 Junit单元测试框架
测试基础 Junit单元测试框架
11 2
测试基础 Junit单元测试框架
|
6天前
|
Java 测试技术 Maven
5个编写技巧,有效提高单元测试实践
本文作者详细讲解了关于单元测试的相关知识,做好单元测试能有效地保障代码质量,本文将手把手教你学会应用单元测试并附有案例、测试插件。
|
6天前
|
Java 测试技术 开发者
卓越工程之单元测试在行权鉴权中的实践
这篇文章着重在“实践”上,是对Java编程技巧之单元测试用例编写流程这篇文章的实际应用,并没有高深的理论和技术。
48 10
|
7天前
|
分布式计算 Java Go
Golang深入浅出之-Go语言中的分布式计算框架Apache Beam
【5月更文挑战第6天】Apache Beam是一个统一的编程模型,适用于批处理和流处理,主要支持Java和Python,但也提供实验性的Go SDK。Go SDK的基本概念包括`PTransform`、`PCollection`和`Pipeline`。在使用中,需注意类型转换、窗口和触发器配置、资源管理和错误处理。尽管Go SDK文档有限,生态系统尚不成熟,且性能可能不高,但它仍为分布式计算提供了可移植的解决方案。通过理解和掌握Beam模型,开发者能编写高效的数据处理程序。
135 1
|
9天前
|
消息中间件 Go API
Golang深入浅出之-Go语言中的微服务架构设计与实践
【5月更文挑战第4天】本文探讨了Go语言在微服务架构中的应用,强调了单一职责、标准化API、服务自治和容错设计等原则。同时,指出了过度拆分、服务通信复杂性、数据一致性和部署复杂性等常见问题,并提出了DDD拆分、使用成熟框架、事件驱动和配置管理与CI/CD的解决方案。文中还提供了使用Gin构建HTTP服务和gRPC进行服务间通信的示例。
24 0
|
13天前
|
安全 测试技术 Go
Golang深入浅出之-Go语言单元测试与基准测试:testing包详解
【4月更文挑战第27天】Go语言的`testing`包是单元测试和基准测试的核心,简化了测试流程并鼓励编写高质量测试代码。本文介绍了测试文件命名规范、常用断言方法,以及如何进行基准测试。同时,讨论了测试中常见的问题,如状态干扰、并发同步、依赖外部服务和测试覆盖率低,并提出了相应的避免策略,包括使用`t.Cleanup`、`t.Parallel()`、模拟对象和检查覆盖率。良好的测试实践能提升代码质量和项目稳定性。
17 1
|
14天前
|
Java 测试技术 Shell
单元测试3.0实践之Golang质量生态建设
研发是否必须写单测?文章提到,单元测试对于确保代码质量、提高软件可靠性至关重要。在顶级互联网公司中,单元测试被认为是必要的,因为它能快速执行、降低维护成本,并能发现代码中的问题。文章还讨论了Go语言中单元测试的优化,如支持不同版本的Go、提高测试覆盖率、处理并发问题等。此外,文章介绍了一个用于Go语言单元测试的插件,该插件可以集成到持续集成流程中,提供详细的测试报告和覆盖率信息。通过这个插件,团队可以方便地管理和执行单元测试,提升开发效率和代码质量。