使用?gomonkey?Mock?函數(shù)及方法示例詳解
前言
在 Golang 語言中，寫單元測試的時候，不可避免的會涉及到對其他函數(shù)及方法的 Mock，即在假設其他函數(shù)及方法響應預期結果的同時，校驗被測函數(shù)的響應是否符合預期。
其中，在 Mock 其他函數(shù)及方法的時候，我們常用到的一個測試類庫是「gomonkey」。特別地，對于方法和函數(shù)的 Mock，略有差異，在這里我們就分別給出函數(shù)和方法 Mock 示例，方便大家參考。
函數(shù)
在 Golang 語言中，函數(shù)是沒有接受者的方法，其形式為
func function_name([parameter list]) [return_types] {
函數(shù)體
}對于函數(shù)的 Mock 相對來說比較簡單，假設我們對 A 函數(shù)進行單元測試，且 A 函數(shù)里面又調用了 B 函數(shù)，例如
func A(ctx context.Context, str string) error {
if len(str) == 0 {
return errors.New("str is empty")
}
return test_package_name.B(ctx, str)
}為了將 A 函數(shù)的每一行代碼都覆蓋到，則其單元測試可以寫為：
func TestA(t *testing.T) {
type args struct {
ctx context.Context
str string
}
tests := []struct {
name string
args args
Setup func(t *testing.T)
wantErr error
}{
{
name: "len(str) == 0",
wantErr: errors.New("str is empty")
},
{
name: "正常響應",
Setup: func(t *testing.T) {
patches := gomonkey.ApplyFunc(test_package_name.B, func(_ context.Context, _ string) error {
return nil
})
t.Cleanup(func() {
patches.Reset()
})
},
args: args{
ctx: context.Background(),
str: "test",
},
wantErr: nil,
},
}
// 執(zhí)行測試用例
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.Setup != nil {
tt.Setup(t)
}
err := A(tt.args.ctx, tt.args.str)
if err != nil {
assert.EqualError(t, err, tt.wantErr.Error(), "error 不符合預期")
}
})
}
}其中，ApplyFunc函數(shù)是用來 Mock 函數(shù)的，其第一個參數(shù)為需要 Mock 的函數(shù)名稱（不需要寫參數(shù)列表），第二個參數(shù)為需要 Mock 的函數(shù)結果；特別地，在Setup里面，我們要記得顯式調用Cleanup對patches進行Reset操作，防止該 Mock 影響其他測試用例。
方法
在 Golang 語言中，方法是含有接受者的函數(shù)，其形式為
func (variable_name variable_data_type) function_name([parameter list]) [return_type]{
函數(shù)體
}對于方法的 Mock 相對來說復雜一下，假設我們對 A 函數(shù)進行單元測試，且 A 函數(shù)里面又調用了結構 C 的 B 方法，例如
func A(ctx context.Context, str string) error {
if len(str) == 0 {
return errors.New("str is empty")
}
c := &test_package_name.C{}
return c.B(ctx, str)
}
為了將 A 函數(shù)的每一行代碼都覆蓋到，則其單元測試可以寫為：
func TestA(t *testing.T) {
// 初始化C結構
var c *test_package_name.C
type args struct {
ctx context.Context
str string
}
tests := []struct {
name string
args args
Setup func(t *testing.T)
wantErr error
}{
{
name: "len(str) == 0",
wantErr: errors.New("str is empty")
},
{
name: "正常響應",
Setup: func(t *testing.T) {
patches := gomonkey.ApplyMethod(reflect.TypeOf(c), "B", func(_ *test_package_name.C, _ context.Context, _ string) error {
return nil
})
t.Cleanup(func() {
patches.Reset()
})
},
args: args{
ctx: context.Background(),
str: "test",
},
wantErr: nil,
},
}
// 執(zhí)行測試用例
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.Setup != nil {
tt.Setup(t)
}
err := A(tt.args.ctx, tt.args.str)
if err != nil {
assert.EqualError(t, err, tt.wantErr.Error(), "error 不符合預期")
}
})
}
}
其中，ApplyMethod函數(shù)是用來 Mock 方法的，其第一個參數(shù)為需要 Mock 的方法的接受者類型，第二個參數(shù)為需要 Mock 的方法名稱（字符串類型），第三個參數(shù)為需要 Mock 的方法的定義及 Mock 結果；特別地，第一個參數(shù)和第三個參數(shù)需要我們注意：
- 第一個參數(shù)，需要使用
reflect.TypeOf獲取接受者的類型，初始化的接受者必須是真正的類型，如結構 C 組合了結構 D，而B方法是通過組合 D 得到的，則初始化的時候需要定義結構 D，而不是結構 C，否則會報空指針異常； - 第三個參數(shù)，雖然
B方法的聲明是func(ctx context.Context, str string)，但是在使用ApplyMethod的時候，需要將B方法的聲明修改為func(c *test_package_name.C, ctx context.Context, str string)，即需要將方法的接受者置為方法的第一個參數(shù)。
參考
還有就是，大家在使用gomonkey的時候，有可能遇到權限校驗的問題以及非 Debug 模式運行失敗的問題，可以參考：
golang使用gomonkey和monkey來mock方法或者函數(shù)時報panic: permission denied
使用 gomonkey 遇到非 debug 模式執(zhí)行失敗的問題及解決方法
到這里，本文就要結束了，希望對大家有所幫助。
到此這篇關于使用 gomonkey Mock 函數(shù)及方法的文章就介紹到這了,更多相關gomonkey Mock 函數(shù)內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
Go語言開源庫實現(xiàn)Onvif協(xié)議客戶端設備搜索
這篇文章主要為大家介紹了Go語言Onvif協(xié)議客戶端設備搜索示例實現(xiàn)，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-04-04
這篇文章介紹了Go語言中循環(huán)Loop的用法，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-07-07
Go?中有一個特別的?init()?函數(shù),它主要用于包的初始化,這篇文章將以此為主題介紹?Go?中?init()?函數(shù)的使用和常見使用場景,希望對大家有所幫助2024-02-02
Go語言同步與異步執(zhí)行多個任務封裝詳解(Runner和RunnerAsync)
這篇文章主要給大家介紹了關于Go語言同步與異步執(zhí)行多個任務封裝(Runner和RunnerAsync)的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧。2018-01-01
這篇文章主要和大家分享一下Go語言中文件的寫入操作，文中的示例代碼講解詳細，對我們學習Go語言有一定的幫助，需要的小伙伴可以參考一下2022-12-12
Go 語言為我們提供了豐富的并發(fā)原語，且大多數(shù)都位于 sync 包下,今天我們來探討一下該庫下的原語之一：errgroup，感興趣的小伙伴可以了解一下2023-05-05
這篇文章主要為大家介紹了golang?字符串拼接方法對比分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-09-09
在Go中,有幾種方式可以處理包含多種引號的字符串,以確保代碼的可讀性和正確性,本文將給大家詳細介紹了這幾種處理方式,并通過代碼示例講解的非常詳細,需要的朋友可以參考下2024-04-04
go語言的ent框架是facebook開源的ORM框架,是go語言開發(fā)中的常用框架,而關聯(lián)查詢又是日常開發(fā)中的常見數(shù)據(jù)庫操作,故文本給出一個使用ent做關聯(lián)查詢的使用示例,需要的朋友可以參考下2024-02-02
這篇文章介紹Go語言之數(shù)組與切片，數(shù)組是具有相同唯一類型的一組已編號且長度固定的數(shù)據(jù)項序列，這種類型可是任意的原始類型如整形、字符串或自定義類型。切片是數(shù)組的一個引用，因此切片是引用類型，在進行傳遞時，遵守引用傳遞的機制，下面我們就來詳細了解一下該內容2021-10-10