一、前言
1、单测的定位
单测在软件工程中的地位毋庸置疑，它要求工程师必须去主动思考代码的边界，异常处理等等。另一方面，它又是代码最好的说明书，你的函数具体做了什么，输入和输出一目了然。
计算机科学家Edsger Dijkstra曾说过：“测试能证明缺陷存在，而无法证明没有缺陷。”再多的测试也不能证明一个程序没有BUG。在最好的情况下，测试可以增强我们的信心：代码在很多重要场景下是可以正常工作的。
参考：go语言圣经之测试函数
2、vscode中生成单测
参考：在 VS Code 快速生成单元测试
vscodefunc TestGenerateStsTokenService(t *testing.T) {
type args struct {
ctx context.Context
generateStsData *dto.GenerateStsReqParams
}
tests := []struct {
name string
args args
wantResp *common.RESTResp
wantErr bool
}{
{
name: "测试正常生成sts",
args: args{
ctx: context.TODO(),
generateStsData: &dto.GenerateStsReqParams{
SessionName: "webApp",
AuthParams: &dto.AuthParamsData{},
},
},
wantResp: &common.RESTResp{
Code: 0,
Data: &dto.OssStsRespData{
},
},
wantErr: false,
},
{
name: "测试异常生成sts",
args: args{
ctx: context.TODO(),
generateStsData: &dto.GenerateStsReqParams{
SessionName: "liteApp",
AuthParams: &dto.AuthParamsData{},
},
},
wantResp: &common.RESTResp{
Code: 20003,
Data: interface{}(nil),
},
wantErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gotResp, err := GenerateStsTokenService(tt.args.ctx, tt.args.generateStsData)
if (err != nil) != tt.wantErr {
t.Errorf("GenerateStsTokenService() error = %v, wantErr %v", err, tt.wantErr)
return
}
if !reflect.DeepEqual(gotResp, tt.wantResp) {
t.Errorf("GenerateStsTokenService() = %v, want %v", gotResp, tt.wantResp)
}
})
}
}
二、构造测试case的注意事项
1、项目初始化
// TestMain会在执行其他测试用例的时候，自动执行
func TestMain(m *testing.M) {
setup() //初始化函数
retCode := m.Run() // 运行单元测试
teardown() //后置校验，钩子函数，可不实现
os.Exit(retCode) //清理结果
}
2、构造空interface{}
// 直接给Data赋值为nil的话，验证会失败，
// 单纯的nil和(*infra.QueryOneMappingCode)(nil)是不一样的
wantResp: &common.RESTResp{
Code: 0,
Message: "",
Data: (*infra.QueryOneMappingCode)(nil),
},
// 数组类型的空
// []dto.OneMappingCode{}也会验证失败
wantRes: []dto.OneMappingCode(nil),
3、构造结构体的time.Time类型
Data: &infra.xxx{
ID: 54,
Code: "338798",
TakerUid: "",
State: 1,
Type: 1,
CreatedAt: time.Date(2023, time.June, 9, 16, 32, 59, 0, time.Local),
},
也可以直接打印接口的返回，看看CreatedAt返回的是什么，然后构造一下就可以。
t.Logf("gotResp:(%#v)", gotResp.Data)
4、构造json格式的test case
wantResp: &common.RESTResp{
Code: 0,
Message: "success",
Data: `{
"id": 54,
"code": "338798",
"creator_uid": "12345",
"client_appId": "1234",
"taker_uid": "",
"state": 1,
"type": 1,
"created_at": "2023-06-09T16:32:59+08:00"
}`,
},
三、运行单测文件
1、整体运行单测文件
cd /xxx 单测目录
go test
成功输出：
PASS
ok
2、运行单个单测文件报错
错误提示如下：
# command-line-arguments [command-line-arguments.test]
./base_test.go:26:18: undefined: Ping
Pingundefinedcommand-line-arguments（1）command-line-arguments是什么
go test [flags] [packages] [build flags] [packages]
命令行参数中指定的每个包或文件都将被视为一个要进行测试的包。而 "command-line-arguments"
这个标识符就是用来表示上述情况中命令行参数中指定的文件。
这样可以使 go test 命令将指定的文件作为单独的包进行处理，并执行其中的测试函数。
（2）undefined发生原因
错误提示build失败，也就是说我们需要把单测文件依赖的文件也传入进去。比如我这里单测base_test.go文件，则需要把base.go也写到命令行参数中。
具体参考：【Golang】解决Go test执行单个测试文件提示未定义问题
go test ./base.go ./base_test.go
（3）缺少初始化导致的发生panic
一般来说我们在一个package下，定义一个TestMain()函数就可以了，进行代码的初始化。但是当我们需要运行单个测试文件的时候，有可能这个测试文件里面恰好没有TestMain()了咋整。
api_test.go
TestMain()
base_test.go // 没有TestMain()函数
// 解决方案
1、初始化代码放到setup()函数中
2、go命令行
go test ./base.go ./base_test.go ./api_test.go ./api.go
3、只想运行base_test.go怎么办
base_test.go中加上自己的setuoBase()
3、查看单测覆盖率
go test -cover
coverage: 80.4% of statements
4、单测覆盖文件解读
go test -coverprofile=coverage.out
// 打开单测覆盖率文件
mode: set
base.go:10.118,14.23 3 1
base.go:14.23,17.3 2 1
解释如下：
10.118,14.23 3 1 表示第 10 行到第 14 行代码被测试覆盖到了，且覆盖
率为 3/1 (即 300%)。这是因为第 10 行至少执行了一次，如果执行了三次，则覆盖率为 300%。
14.23,17.3 2 1 表示第 14 行到第 17 行代码被测试覆盖到了，且覆盖率为 2/1 (即 200%)。
5、生成可被浏览器打开的单测文件
go test -coverprofile=coverage.out
go tool cover -html=coverage.out -o coverage.html
绿色代表被覆盖到的代码，红色代表没有被覆盖到的代码。
左上角是运行单测命令目录下，所有go文件的覆盖率。
可以考虑新增单测case来覆盖到这部分红色。
6、单测覆盖率的问题
100%100%100%并bug50%30%四、关于单测粒度的问题
写单测的时候，总会疑问到底要写的多细呢？特别是原来项目没有单测的时候，补单测的代码比业务逻辑代码还多。。。
本例中，目录结构如下：
domain:
base.go
code.go
code_test.go
util.go
code.gobase.goutil.gocode_test.go80%code_test.go1、chatgpt的回答
base.goutil.gobase.goutil.go2、个人理解
code_test.gomockPASScasecode_test.gobase.goutil.gomock37%base_test.goutil_test.go82%拆分的粒度变细，更加关注每个函数的输入和输出。特别是当修改某个函数的时候，只需要使用对应的单测来进行验证，而不需要从入口处进行测试。毕竟单元测试不是集成测试。
参考：
Golang 单元测试：有哪些误区和实践？
Go的单元测试技巧
五、mock数据
mockmockmock1、mock组件选择
参考：如何做好单元测试？Golang Mock”三剑客“ gomock、monkey、sqlmock
GO进阶单元测试
mockmonkeygomonkeygomonkey 项目库
解析 Golang 测试（8）- gomonkey 实战
2、mock实操
（1）mock函数调用
A->BA->Cmock BCpatches := gomonkey.ApplyFunc(queryOneMappCode, func(ctx context.Context, code string) (*infra.QueryOneMappingCode, error) {
// 参数大于6则返回空
if len(code) > 6 {
return nil, nil
}
return &infra.QueryOneMappingCode{
ID: 54,
Code: "338798",
CreatedAt: time.Date(2023, time.June, 9, 16, 32, 59, 0, time.Local),
}, nil
})
defer patches.Reset()
（2）mock方法调用
1、实例化接口
var mockProvider = provider.Test
// 接口如下
type TestDbProvider interface {
SetDb(db *sqlx.DB)
GetOne(dest interface{}, sql string, args interface{}) (resp *infra.QueryOneMappingCode, err error)
}
2、mock对应的查询方法
// 注意，第一个参数不能是指针，不然mock会失效
// 例如 var oss_bucket_obj *oss.Bucket ，传入target为: *oss_bucket_obj
// 传地址会报错
patches := gomonkey.ApplyMethodFunc(mockProvider, "GetOne", func(dest interface{}, sql string, args interface{}) (resp *infra.QueryOneMappingCode, err error) {
code := args.(string)
if code == "123456" {
return &infra.QueryOneMappingCode{
ID: 1,
Code: "123456",
CreatedAt: time.Date(2023, time.June, 9, 16, 32, 59, 0, time.Local),
}, nil
} else if code == "456789" {
return &infra.QueryOneMappingCode{
ID: 1,
Code: "456789",
CreatedAt: time.Date(2023, time.June, 9, 16, 32, 59, 0, time.Local),
}, nil
} else {
return nil, nil
}
})
defer patches.Reset()
（3）mock其他包的函数
xx_testxx_test.goxx.gopatches := gomonkey.ApplyFunc(util.GenerateRandomCode, func(numDigits int) string {
return "123456"
})
defer patches.Reset()
（4）mock循环中的函数
比如在A函数中，循环3次调用了B函数，那么mock如下：
createA := &infra.CreateMappingCode{Code: "933903"}
createB := &infra.CreateMappingCode{Code: "601690"}
createC := &infra.CreateMappingCode{Code: "798493"}
p := gomonkey.ApplyFuncSeq(structureMappingCodeRecord, []gomonkey.OutputCell{
{Values: gomonkey.Params{createA}},
{Values: gomonkey.Params{createB}},
{Values: gomonkey.Params{createC}},
})
defer p.Reset() // 恢复原始函数
（5）mock http调用
// vscode自动生成的test代码
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
// mock httptest
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
w.WriteHeader(http.StatusNotFound)
}
// 构造返回参数
w.WriteHeader(http.StatusOK)
// 获取POST请求的参数，根据参数返回不同的响应
bodyBytes, err := io.ReadAll(r.Body)
if err != nil {
// 处理错误
w.WriteHeader(http.StatusBadRequest)
}
// 获取post参数
params := new(dto.GenerateStsReqParams)
json.Unmarshal(bodyBytes, params)
// 根据传递的参数返回不同的响应
res := new(common.RESTResp)
if params.SessionName == "webApp" {
res = &common.RESTResp{
Code: 0,
Message: "success",
Data: &dto.OssStsRespData{
Region: "hangzhou",
Bucket: "test",
},
}
} else {
res = &common.RESTResp{
Code: 1,
Message: "failed",
Data: &dto.OssStsRespData{},
}
}
// 模拟接口的返回，http接口返回是字节数据，因此需要json.Marshal
jsonStr, _ := json.Marshal(res)
w.Write(jsonStr)
}))
defer ts.Close()
// 替换原来的url为mock的url
GenerateOssStsUrl = ts.URL
// 发起请求，请求中的http会被mock掉
gotResp, err := GenerateStsTokenService(tt.args.ctx, tt.args.generateStsData)
if (err != nil) != tt.wantErr {
t.Errorf("GenerateStsTokenService() error = %v, wantErr %v", err, tt.wantErr)
return
}
t.Logf("gotResp:(%#v) ,wantResp:(%#v)", gotResp, tt.wantResp)
if !reflect.DeepEqual(gotResp, tt.wantResp) {
t.Errorf("GenerateStsTokenService() = %v, want %v", gotResp, tt.wantResp)
}
})
}
3、对于mock的看法
mock一方的人主张不要滥用mock，能不mock就不mock。被测单元也不一定是具体的一个
函数，可能是多个函数本来就应该串起来，必要的时候再mock。
一方则主张将被测函数所有调用的外面函数全部mock掉，只关注被测函数自己的
一行行代码，只要调用其他函数，全都mock掉，用假数据来测试。
本来处于懒惰和少写单测的角度，我是支持第一种方式的。
例如：
单测函数：A函数
内部逻辑：
A->B : B函数全是业务逻辑
A->C : C函数包括mysql或者redis操作
A->D->E: D函数纯业务逻辑，构造请求参数。E函数对外发起http请求
mock CEABDBB1B2DD1D2D2AmockAAmockB,C,D,EB,C,D,EB,C,D,ED2D2mysql,redis,mqmockA_test.goA.goB.goB_test.goend