神刀安全网

『Go 语言学习专栏』– 第十一期

『Go 语言学习专栏』-- 第十一期

12.png

『Go 语言学习专栏』-- 第十一期

golang-11.png

大家好,我叫谢伟,是一名程序员。

最近更新不是很频繁,主要是我手头有好些事需要解决,比如更换环境,比如出去见识人,以便更好的认识自己,知道自己的短板在哪。

很早之前我就意识到:每隔半年需要出去走走,哪怕不是真的更换工作,你也应该出去走走,去市场检验一下自己是否在对应的岗位有竞争力,你的市场价位是多少。

好,本节的主题是:单元测试。

测试其实分很多种,就我在企业中的认识,一般称为测试工程师,从事的应该是所谓的集成测试(或者说是 AC测试(Acceptance Criteria,验收准则))。这一类的测试是从用户层面进行的测试。

比如你需要测试一个 PaaS 安装部署的功能。集成测试会怎么做?即完全按照用户的角度进行操作,比如部署之前的参数设置,参数设置完进行执行命令,部署完成查询一些参数等。

那AC 测试如何完全枚举这些用户行为呢?有各种各样的框架,比如MFQ ,这套框架本质是对金字塔原理的诠释,即:完全穷尽、相互独立。

还有一类测试称为FT(Functional Test) 即功能测试。我讲其中的一种吧。比如微服务领域,大多数服务其实是RESTful API 的形式。如何进行功能测试?大多数使用的是契约测试,即也是使用框架,对生产者和消费者独立测试,消费者和生产者相互独立,相互解耦,调用API,和预期的结果对比。

今天我们的主题是:单元测试(UT)

即完成的是对函数级的测试,测试是保证代码质量重要的一环。大厂一般合入代码都有一套流水线,什么意思呢。即你提交代码,自动会触发UT, 运行程序内的单元测试,单元测试之后有一定的质量统计,比如覆盖率,一般的大厂的代码覆盖了阈值是90%, 即提交代码,UT 运行之后,代码的覆盖率达到 90% 才可以合入。否则,先完成代码覆盖率。

编程领域内还有一个重要的思想,叫TDD, 即测试驱动开发。

编写一个测试,再写函数,直到测试通过,如此循坏。(当然实际上测试驱动开发,真正实施还是略微有点困难,一般的做法都是开发、测试,而不是测试、开发、测试、开发)

一般的初学者,是不太会关注测试,在没有进入职场之前,我甚至完全没关注测试,直到走入职场…


1. 编写函数

这里我们列举一个非常简单的例子,实现两数相加。

func Add(argOne int, argTwo int) int {     return argOne + argTwo }  

没问题吧。两数相加。

2. 编写测试

测试需要有下面这些规范:

  • 文件名:_test.go 结尾
  • 函数名:Test 开头
  • 入参:(t *testing.T)
  • 内置库:testing
  • 报错信息:使用 testing 内置的方法:Errorf、Error 、Fail、Failed、Fatal、Fatalf、Log、Logf 等

一般的测试这么写

func TestAdd2(t *testing.T) {     var result int     result = Add(1, 2)     if result != 3 {         t.Errorf("wrong: result=%d actual=%d", result, 3)     } }  

我这边只是举了个特别简单的例子,1+2=3, 实际上一般的测试例子应该选一些有代表性的,比如是否会越界啊、入参是否正确啊、等等。

上面的例子存在什么问题呢?

  • 测试数据和函数紧密耦合
  • 不利于写多个测试

如何解决这个问题呢?

  • 表格测试法:测试数据 和 函数 低耦合,便于写出多个测试用例
func TestAdd(test *testing.T) {     tt := []struct {         argOne int         argTwo int         result int     }{         {             argOne: 1,             argTwo: 2,             result: 3,         },         {             argOne: -1,             argTwo: 1,             result: 0,         },         {             argOne: math.MaxInt8,             argTwo: 1,             result: 1 << 7,         }, {             argOne: math.MaxInt16,             argTwo: 1,             result: 1 << 15,         },     }     for _, t := range tt {         var result int         result = Add(t.argOne, t.argTwo)         if result != t.result {             test.Errorf("wrong: result=%d actual=%d", result, t.result)         }     } }  

先给定一堆测试数据,再遍历测试数据,调用函数,看结果是否和预期一致。遍历过程中不知道预期值,不重要,调用下函数即可,根据报错信息,再进行修正。比如 math.MaxInt8 + 1 我可能不知道等于多少。那么可以 result = 0, 再看报错信息,纠正 result 即可。

这样测试数据和函数隔离,能写出更好的测试用例。

当然真实的情况远比这个例子需要复杂,比如:遇到了网络连接、遇到了读写文件、遇到了操作数据库。

这些一般怎么处理呢?测试中有一个名词叫 mock , 即打桩,意思是,给某个地方模拟它的值,即给定一个假的符合要求的值,比如网络请求,需要得到网页信息,那真实的单元测试不进行真实的网络操作,可以将请求打桩,返回一个指定的网页信息即可。

打桩又分给过程打桩,给函数打桩,给变量打桩等。这些问题,下次再补充,今天只讲单元测试。

3. 测试框架

内置的 testing 库其实挺好用的,但遇到复杂的问题,还是需要即用一些成熟的第三方库的测试框架。

GoConvey是一款针对Golang的测试框架,可以管理和运行测试用例,同时提供了丰富的断言函数,并支持很多 Web 界面特性。

func TestAdd3(t *testing.T) {     Convey("Testing Add", t, func() {         tt := []struct {             a int             b int             c int         }{             {                 a: 1,                 b: 2,                 c: 3,             },             {                 a: 4,                 b: 5,                 c: 9,             },         }         So(Add(tt[0].a, tt[0].b), ShouldEqual, tt[0].c)         So(Add(tt[1].a, tt[1].b), ShouldEqual, tt[1].c)     }) }  

还支持嵌套,文档:GoConvey

4. 如何运行测试用例

如果你使用的是Goland , 那么你可以单个测试进行运行。

『Go 语言学习专栏』-- 第十一期

go-test.png

也可以终端下运行:(测试文件所在目录,比如 add_test.go 所在目录)

go test  

结果:

.. 2 total assertions  PASS ok      go-example-for-live/eleven/infra        0.070s 

想查看更详细的信息:

go test -v 
λ go test -v === RUN   TestAdd --- PASS: TestAdd (0.00s) === RUN   TestAdd2 --- PASS: TestAdd2 (0.00s) === RUN   TestAdd3    Testing Add ..   2 total assertions  --- PASS: TestAdd3 (0.00s) PASS ok      go-example-for-live/eleven/infra        0.067s  
go test -run=Add -v 

支持 正则,即所有以Add 开头的测试函数都会被运行。

λ go test -run=Add -v === RUN   TestAdd --- PASS: TestAdd (0.00s) === RUN   TestAdd2 --- PASS: TestAdd2 (0.00s) === RUN   TestAdd3    Testing Add ..   2 total assertions  --- PASS: TestAdd3 (0.00s) PASS ok      go-example-for-live/eleven/infra        0.076s 

5. 覆盖率相关

上文讲过,一般的大厂,代码的合入有一定的准则,覆盖率是其中的一项,那如何使用 go 自带的命令行工具进行覆盖率的操作呢?

λ go test  -coverprofile cover.out .. 2 total assertions  PASS coverage: 100.0% of statements ok      go-example-for-live/eleven/infra        0.059s 

当前目录下一个 cover.out 文件, 上文显示 Add 函数的覆盖率为 100%。

当然这只是一个文件的操作,那如何进行整个项目所有测试用例的测试是否通过呢?

官方没给出答案,所以可以借助第三方,或者自己写,本质上进行代码行数的统计,和测试用例覆盖率的统计,再进行汇总,得出整个项目的覆盖率的统计,这样虽然有可能不太准确,但至少是一种思路。

6. 总结

本节探讨了go 中的单元测试的编写,主要是包括:一般单元测试的编写、表格驱动的单元测试的编写、第三方库框架的单元测试的编写。

希望对你有所启发。

如果你对TDD 感兴趣,可以看看 Github 上这个项目:learn-go-with-tests

再会,我是谢伟。

转载本站任何文章请注明:转载至神刀安全网,谢谢神刀安全网 » 『Go 语言学习专栏』– 第十一期

分享到:更多 ()