在使用Golang进行单元测试时,go test命令默认会随机打乱测试用例的执行顺序,这是为了避免测试用例之间产生隐式依赖,保证单个测试用例的独立性。但在实际开发中,有些场景下我们需要控制测试的执行顺序,比如需要先执行环境初始化测试,再执行业务功能测试,最后执行环境清理测试。接下来就介绍几种控制Golang测试执行顺序的常用方法。

利用TestMain函数做全局前置处理
TestMain是Golang测试中一个特殊的函数,它会在当前包的所有测试用例执行前后被调用,可以用来做全局的初始化和清理工作,间接控制测试的前置依赖。
TestMain的函数签名固定为func TestMain(m *testing.M),我们需要在函数内部调用m.Run()来执行所有测试用例,并且可以根据需要在m.Run()前后添加逻辑。
package main
import (
"fmt"
"testing"
)
// TestMain 全局测试入口,在所有测试用例执行前后调用
func TestMain(m *testing.M) {
// 执行所有测试用例前的前置操作,比如初始化数据库连接、创建测试目录等
fmt.Println("开始执行全局前置初始化")
// 调用m.Run()执行所有测试用例,返回退出码
exitCode := m.Run()
// 所有测试用例执行完成后的清理操作,比如关闭数据库连接、删除测试目录等
fmt.Println("执行全局后置清理")
// 将退出码传递给系统
// os.Exit(exitCode) 这里实际使用时需要导入os包,示例中省略导入部分
}
这种方式适合做全局的初始化和清理,但无法控制单个测试用例之间的执行顺序,只能保证前置和清理逻辑在所有测试的前后执行。
通过子测试嵌套控制执行顺序
Golang的testing包支持子测试,通过t.Run方法可以创建子测试,而子测试的执行顺序默认是按照代码中的调用顺序来的,我们可以利用这个特性控制同一层级下的测试执行顺序。
我们可以在父测试中按照需要的顺序调用t.Run创建子测试,这样子测试就会按照调用顺序依次执行。
package main
import (
"fmt"
"testing"
)
// TestOrder 父测试,内部按顺序调用子测试
func TestOrder(t *testing.T) {
// 第一个子测试,先执行
t.Run("step1_init", func(t *testing.T) {
fmt.Println("执行第一步:初始化测试")
// 初始化逻辑
})
// 第二个子测试,在第一个子测试执行完成后执行
t.Run("step2_business", func(t *testing.T) {
fmt.Println("执行第二步:业务功能测试")
// 业务逻辑测试
})
// 第三个子测试,在第二个子测试执行完成后执行
t.Run("step3_cleanup", func(t *testing.T) {
fmt.Println("执行第三步:清理测试")
// 清理逻辑
})
}
这种方式的优点是逻辑清晰,执行顺序明确,缺点是所有的测试都嵌套在一个父测试下,如果测试用例很多,父测试的代码会比较冗长,而且子测试的命名需要规范,方便识别执行步骤。
自定义测试排序逻辑
如果测试用例数量较多,且需要按照自定义的规则排序,我们可以通过反射获取所有测试函数,按照规则排序后再依次执行。这种方式适合需要灵活定义排序规则的场景。
首先我们需要定义一个排序规则,比如按照测试函数名的特定前缀或者后缀排序,然后通过testing包的接口获取所有测试函数,排序后执行。
package main
import (
"fmt"
"reflect"
"sort"
"testing"
)
// 自定义测试排序规则,按照函数名的字典序排序
func sortTests(tests []testing.InternalTest) []testing.InternalTest {
sort.Slice(tests, func(i, j int) bool {
return tests[i].Name < tests[j].Name
})
return tests
}
// TestSorted 自定义排序后的测试执行入口
func TestSorted(t *testing.T) {
// 获取当前包的所有测试函数,这里实际使用时需要通过testing包的未导出接口获取,以下为简化示例
// 实际场景中可以通过go test的-run参数配合自定义逻辑实现,或者使用第三方测试框架
// 示例中直接使用固定的测试函数列表模拟
testFuncs := []testing.InternalTest{
{Name: "TestC", F: func(t *testing.T) { fmt.Println("执行TestC") }},
{Name: "TestA", F: func(t *testing.T) { fmt.Println("执行TestA") }},
{Name: "TestB", F: func(t *testing.T) { fmt.Println("执行TestB") }},
}
// 对测试函数排序
sortedTests := sortTests(testFuncs)
// 依次执行排序后的测试函数
for _, test := range sortedTests {
t.Run(test.Name, test.F)
}
}
需要注意的是,直接获取包内所有测试函数的方式在Golang标准库中没有公开的接口,实际使用中可以结合第三方测试框架,或者通过给测试函数添加特定标签,配合-run参数筛选执行顺序。
不同方式的适用场景
我们可以根据实际需求选择合适的方式控制测试执行顺序:
- 如果只需要全局的前置和清理,优先选择TestMain函数的方式,实现简单且符合Golang的测试规范。
- 如果测试用例数量不多,且需要明确的前置、执行、清理步骤,优先选择子测试嵌套的方式,逻辑清晰易维护。
- 如果测试用例数量多,且需要灵活的自定义排序规则,可以选择自定义测试排序逻辑的方式,或者使用支持测试排序的第三方Golang测试框架。
最后需要提醒的是,Golang默认随机测试顺序是为了保证测试用例的独立性,尽量还是不要让测试用例之间产生强依赖,如果必须使用顺序执行,要做好注释说明,避免后续维护时出现问题。