一文带你了解单元测试和基准测试干货

Posted 2021-08-13 测试员小静

 在平时，通过代码实战部分你可以看到，在写每个功能的时候，都会编写测试代码。那是因为 TDD（Test-Driven Development，测试驱动开发）中提倡先编写测试代码，然后再编写功能代码，每做一个修改后，都要执行一次单元测试和基准测试，以此来验证功能和性能是否有问题。

特别是业务系统代码经常变更，单元测试和基准测试也就显得非常重要。而每种语言都有自己的测试框架，比如 Go 语言，它是门注重工程效率的语言，有着非常强大的工具链，它自带的测试框架，能满足我们大部分测试要求。

所以，这里介绍如何使用Go测试框架做性能测试中的单元测试和基准测试。（文末有学习笔记分享）

单元测试

Go 测试框架中支持白盒测试和黑盒测试。现在我就以 xx.go 这个文件为例，给你详细介绍下如何做单元测试。

总体步骤

总的来说，用 Go 测试框架做单元测试主要有这几个步骤。

• 第一，Go 测试框架要求测试代码文件名以 _test.go 结尾。为了测试 cache.go，我们需要在 infrastructure/stores 目录下创建一个 cache_test.go 文件。

• 第二，cache_test.go 中第一行如果是 package stores，则表示该测试是白盒测试，这意味着除了这个包的全局函数外，你还可以测试它的私有函数；如果是 package stores_test，则表示黑盒测试，你只可以测试全局函数，里面的具体实现对于你来说是个黑盒子。

• 第三，Go 测试框架要求单元测试函数需要以 Test 开头。为了测试 IntCache 和 ObjCache，我们需要实现 TestIntCache 和 TestObjCache 这两个函数，它们的参数类型都是 testing.T 指针。

• 第四，在测试过程中，如果发现错误，可以通过测试框架的 Error 方法或者 Fatal 方法输出错误。不同的是，Error 方法仅仅输出错误，而 Fatal 方法却会结束当前测试。

• 第五，在终端进入项目根目录下，执行 go test ./infrastructure/stores 命令，将会执行 infrastructure/stores 目录下的所有单元测试。

结果通常会有三列：

1. 第一列是测试结果，ok 表示成功，FAIL 表示失败；

2. 第二列是被测试包的完整路径；

3. 第三列是执行测试耗费的时间。

当测试失败时，输出结果还会告诉你在哪一行报错了，格式通常是：第一行是测试函数，第二行是文件名和该文件的第几行，后面再跟上具体错误日志。比如，TestIntCache 这个测试函数在 cache_test.go 文件第 19 行报错。

覆盖率

在单元测试中，除了测试功能是否正常外，还有个很重要的指标：覆盖率。覆盖率用来衡量单元测试覆盖了多少代码，它是由覆盖测试统计出来的。覆盖率越高，说明单元测试越完备，对代码质量更有保障。

Go 的覆盖测试使用很简单，在 go test 命令后加上 -cover 参数即可。如执行 go test -cover ./infrastructure/stores 将会在之前的输出结果后面加上 coverage 开头的日志。比如 coverage: 61.0% of statements 。

虽然覆盖测试工具用起来很简单，但要想将覆盖率提升到 100% 则是非常困难。

第一，你需要找出来哪些地方没有覆盖到。

这里我们需要用到 -coverprofile 参数，将详细的结果输出到文件中。比如 go test -coverprofile cover.out 便是将覆盖测试的结果输出到 cover.out 中。然后我们用命令 go tool cover -html=cover.out -o cover.html 将测试结果输出为 html 文件，再用浏览器打开便可以看到哪些代码被单元测试覆盖到了，哪些没有被覆盖到。其中绿色部分表示已覆盖到的代码，红色部分表示没有覆盖到。效果如下：

我们可以看到，Add 方法有大片代码没被测试覆盖到，我们可以通过修改测试代码来覆盖这部分代码的测试。

第二，你需要对代码逻辑非常熟悉，特别是熟悉代码中的各种边界条件，并在测试代码中构造出这些边界条件来测试。

假如代码里有三个条件分支 A、B、C，你需要将这三个条件都构造出来，才能覆盖到它们各自分支下面的代码。这意味着，你在编写测试代码的时候，需要编写大量的测试用例，也就是构造大量的能触发边界条件的参数。如果没有好的代码功底，你的测试代码容易因为大量参数而变得混乱、臃肿。

有时候，一个功能可能会有多个参数，每个参数又有多个边界值。当我们采用控制变量法来测试的时候，所有参数的边界值又会产生多种组合，这个数量通常是每个参数边界值数量的乘积。比如 A 参数有 2 个边界值，B 参数有 3 个边界值，那么将会存在 6 种组合 。为了便于管理，我们需要将这些参数提取到核心测试代码之外，用数组和循环来管理测试用例。

比如我们在测试 IntCache 的 Add 方法时，按照 key、delta 这两个参数的边界情况，就有 key 存在、不存在两种情况与 delta 为 -1、0、1 这三种情况的组合。我们将 Add 方法的 key、delta 参数以及期望返回值的配置，用一个结构体数组来管理，并用循环遍历数组，根据数组中每个元素的值调用 Add 方法并判断返回值与期望值是否相等。如果不相等则报错，输出有问题的测试用例，并终止测试。我们可以得到如下代码：

func TestIntCache_Add(t *testing.T) {

   cache := NewIntCache()

   cases := []struct {

      key    string

      delta  int64

      expect int64

   }{

      {"test1", 0, 0},

      {"test1", 1, 1},

      {"test1", -1, 0},

      {"test1", 0, 0},

      {"test2", 1, 1},

      {"test3", -1, -1},

   }

   for _, c := range cases {

      if cache.Add(c.key, c.delta) != c.expect {

         t.Fatal(c)

      }

   }

}
复制代码

再次执行覆盖测试，你将看到代码覆盖率从 61.0% 提升到了 76.3%，Add 方法只剩下一行代码没覆盖到，而这行代码需要通过构造并发条件才能覆盖到。效果如下：

基准测试

基准测试属于性能测试，通常用于对具体的功能函数做性能分析，比如加密算法函数。基准测试需要有对比测试，以便衡量不同代码实现之间的性能差异，从中选取性能最好的实现方式。

在 Go 测试框架中，基准测试函数需要以 Benchmark 开头。比如 BenchmarkIntCache_Set 表示对 IntCache 的 Set 方法进行基准测试。为了与 sync.Map 和 ObjCache 对比，我们还需要实现 BenchmarkObjCache_Set 和 BenchmarkSyncMap_Set 这两个函数。

不过，当我们要测试对象的方法比较多时，为每个对象的每个方法都实现一个独立的测试函数并不是很方便。对此，我们通常我们采用分组测试的方式。Go 测试框架提供了一个 Run 方法可用于执行分组中的子测试，它有两个参数，第一个是子测试的名称，第二个是测试函数。

这里，我们可以实现一个 BenchmarkCache_Set 函数来作为 Set 方法的测试组入口，里面包含 intCache、objCache、syncMap 这三个子测试。这样我们可以为每个子测试统一初始化公共资源，并复用核心代码逻辑。

为了复用代码，我实现了一个 benchmarkCacheSet 函数。它有三个参数：

• 测试框架生成的 testing.B 对象指针；

• setter 函数，它有 key 和 val 这两个参数，帮助设置被测对象中的 KV 值；

• 字符串数组 keys，表示用于测试的 key 集合。

在函数中，我们调用框架的 ReportAllocs 方法，用于输出内存分配信息。在循环开始前，调用框架的 StartTimer 开始计时，循环结束后调用 StopTimer 结束计时。

在 BenchmarkCache_Set 中先初始化 keys，然后在三个子测试中分别初始化 IntCache、ObjCache、sync.Map，生成各自的 setter，并调用 benchmarkCacheSet 函数。

最终，我们的测试代码如下：

func benchmarkCacheSet(b *testing.B, setter func(key string, val int64), keys []string) {

   b.ReportAllocs()

   b.StartTimer()

   l := len(keys)

   for i := 0; i < b.N; i++ {

      setter(keys[i%l], int64(i))

   }

   b.StopTimer()

}

func BenchmarkCache_Set(b *testing.B) {

   keys := make([]string, b.N, b.N)

   for i := 0; i < b.N; i++ {

      keys[i] = strconv.Itoa(i)

   }

   b.ResetTimer()

   b.Run("intCache", func(b *testing.B) {

      c := NewIntCache()

      setter := func(key string, val int64) {

         c.Set(key, val)

      }

      benchmarkCacheSet(b, setter, keys)

   })

   b.Run("objCache", func(b *testing.B) {

      c := NewObjCache()

      setter := func(key string, val int64) {

         c.Set(key, val)

      }

      benchmarkCacheSet(b, setter, keys)

   })

   b.Run("syncMap", func(b *testing.B) {

      c := sync.Map{}

      setter := func(key string, val int64) {

         c.Store(key, val)

      }

      benchmarkCacheSet(b, setter, keys)

   })

}
复制代码

我们可以在终端执行命令 go test -bench=BenchmarkCache_Set ./infrastructure/stores 来运行上面实现的测试代码，你可以看到以 BenchmarkCache_Set 开头的三个子测试的结果。

需要注意的是，每个子测试后面都有一个 -8，表示使用了 8 个 CPU 核。

另外，Go 测试框架默认会使用所有的 CPU 核，但由于电脑上通常会运行其他的程序，使用所有的核可能会导致不同程序之间抢夺资源，影响测试结果。基于这一点，我们可以在参数中指定 CPU 核数来测试。

具体来说，我们可以通过 -cpu 参数指定多种 CPU 核数来测试性能。比如，执行命令 go test -bench=BenchmarkCache_Set -cpu 1,2,3 ./infrastructure/stores 后，我们将看到每个子测试都用了不同 CPU 核数来测试。不过，由于我们的测试代码并没有用到并发，因此测试结果不受 CPU 核数的影响。

最后，为方便大家自学软件测试，特意给大家准备了一份13G的超实用干货学习资源，涉及的内容非常全面。

包括软件学习路线图，50多天的上课视频、16个突击实战项目，80余个软件测试用软件，37份测试文档，70个软件测试相关问题，40篇测试经验级文章，上千份测试真题分享,还有2021软件测试面试宝典，还有软件测试求职的各类精选简历，希望对大家有所帮助…..

关注我的微信公众号：【程序员小濠】就可以免费获取了~

我的软件测试交流群：175317069 欢迎大家一起讨论交流，里面也有各种软件测试资料和技术交流

如果对你有帮助的话，点个赞收个藏，给作者一个鼓励。也方便你下次能够快速查找。