一羹应、gomock 工具介紹

gomock 是一個 Go 語言的測試框架倚评，在實際項目中丘逸，需要進行單元測試的時候单鹿。卻往往發(fā)現(xiàn)有一大堆依賴項。這時候就是 Gomock 大顯身手的時候了深纲，用于編寫單元測試時模擬和測試依賴于外部服務(wù)的代碼仲锄。它允許你創(chuàng)建模擬對象（Mock Objects），這些對象可以預(yù)設(shè)期望的行為湃鹊，以便在測試時模擬外部依賴儒喊，通常使用它對代碼中的那些接口類型進行mock。

原本 Go 團隊提供了一個 mock 工具 https://github.com/golang/mock币呵，但在今年放棄維護了怀愧，改用 https://github.com/uber-go/mock。

二余赢、安裝

要安裝 gomock芯义，你可以使用 Go 包管理器 go get：

go install go.uber.org/mock/mockgen@latest

三、使用

首先確保你已經(jīng)安裝了gomock 妻柒，并且在項目中執(zhí)行了go mod tidy

3.1 指定三個參數(shù)

在使用 mockgen 生成模擬對象（Mock Objects）時扛拨，通常需要指定三個主要參數(shù)：

• source：這是你想要生成模擬對象的接口定義所在的文件路徑。
• destination：這是你想要生成模擬對象代碼的目標路徑举塔。
• package：這是生成代碼的包名绑警。

3.2 使用命令為接口生成 mock 實現(xiàn)

一旦你指定了上述參數(shù)求泰，mockgen 就會為你提供的接口生成模擬實現(xiàn)。生成的模擬實現(xiàn)將包含一個 EXPECT 方法计盒，用于設(shè)置預(yù)期的行為拜秧，以及一些方法實現(xiàn)，這些實現(xiàn)將返回默認值或調(diào)用真實的實現(xiàn)章郁。

例如，如果你的接口定義在 ./webook/internal/service/user.go 文件中志衍，你可以使用以下命令來生成模擬對象：

mockgen -source=./webook/internal/service/user.go -package=svcmocks destination=./webook/internal/service/mocks/user.mock.go

3.3 使用make 命令封裝處理mock

在實際項目中暖庄，你可能會使用 make 命令來自動化構(gòu)建過程，包括生成模擬對象楼肪。你可以創(chuàng)建一個 Makefile 或 make.bash 文件培廓，并添加一個目標來處理 mockgen 的調(diào)用。例如：

# Makefile 示例
# mock 目標 春叫，可以直接使用 make mock命令
.PHONY: mock
# 生成模擬對象
mock:
    @mockgen -source=internal/service/user.go -package=svcmocks -destination=internal/service/mocks/user.mock.go
    @mockgen -package=redismocks -destination=internal/repository/cache/redismocks/cmdable.mock.go github.com/redis/go-redis/v9 Cmdable
    @go mod tidy

最后肩钠，只要我們執(zhí)行make mock 命令，就會生成mock文件暂殖。

四价匠、接口單元測試步驟

1. 想清楚整體邏輯
2. 定義想要（模擬）依賴項的interface（接口）
3. 使用mockgen命令對所需mock的interface生成mock文件
4. 編寫單元測試的邏輯，在測試中使用mock
5. 進行單元測試的驗證

三呛每、小黃書Service層單元測試

這里我們已注冊接口為例子踩窖，代碼如下：

// gmock/webook/backend/internal/web/user.go
func (u *UserHandler) SignUp(ctx *gin.Context) {
    type SignUpReq struct {
        Email           string `json:"email"`
        ConfirmPassword string `json:"confirmPassword"`
        Password        string `json:"password"`
    }

    var req SignUpReq
    // Bind 方法會根據(jù) Content-Type 來解析你的數(shù)據(jù)到 req 里面
    // 解析錯了，就會直接寫回一個 400 的錯誤
    if err := ctx.Bind(&req); err != nil {
        return
    }

    ok, err := u.emailExp.MatchString(req.Email)
    if err != nil {
        ctx.String(http.StatusOK, "系統(tǒng)錯誤")
        return
    }
    if !ok {
        ctx.String(http.StatusOK, "你的郵箱格式不對")
        return
    }
    if req.ConfirmPassword != req.Password {
        ctx.String(http.StatusOK, "兩次輸入的密碼不一致")
        return
    }
    ok, err = u.passwordExp.MatchString(req.Password)
    if err != nil {
        // 記錄日志
        ctx.String(http.StatusOK, "系統(tǒng)錯誤")
        return
    }
    if !ok {
        ctx.String(http.StatusOK, "密碼必須大于8位晨横，包含數(shù)字洋腮、特殊字符")
        return
    }

    // 調(diào)用一下 svc 的方法
    err = u.svc.SignUp(ctx, domain.User{
        Email:    req.Email,
        Password: req.Password,
    })
    if err == service.ErrUserDuplicateEmail {
        ctx.String(http.StatusOK, "郵箱沖突")
        return
    }
    if err != nil {
        ctx.String(http.StatusOK, "系統(tǒng)異常")
        return
    }

    ctx.String(http.StatusOK, "注冊成功")
}

執(zhí)行命令，生成mock文件：

mockgen -source=./webook/internal/service/user.go -package=svcmocks destination=./webook/internal/service/mocks/user.mock.go

接著我們編寫單元測試手形，代碼如下：

// gmock/webook/backend/internal/web/user_test.go
package web

import (
    "bytes"
    "context"
    "errors"
    "github.com/gin-gonic/gin"
    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/require"
    "go.uber.org/mock/gomock"
    "golang.org/x/crypto/bcrypt"
    "net/http"
    "net/http/httptest"
    "testing"
    "webook/internal/domain"
    "webook/internal/service"
    svcmocks "webook/internal/service/mocks"
)

func TestEncrypt(t *testing.T) {
    _ = NewUserHandler(nil, nil)
    password := "hello#world123"
    encrypted, err := bcrypt.GenerateFromPassword([]byte(password), bcrypt.DefaultCost)
    if err != nil {
        t.Fatal(err)
    }
    err = bcrypt.CompareHashAndPassword(encrypted, []byte(password))
    assert.NoError(t, err)
}

func TestNil(t *testing.T) {
    testTypeAssert(nil)
}

func testTypeAssert(c any) {
    _, ok := c.(*UserClaims)
    println(ok)
}

func TestUserHandler_SignUp(t *testing.T) {
    testCases := []struct {
        name string

        mock func(ctrl *gomock.Controller) service.UserService

        reqBody string

        wantCode int
        wantBody string
    }{
        {
            name: "注冊成功",
            mock: func(ctrl *gomock.Controller) service.UserService {
                usersvc := svcmocks.NewMockUserService(ctrl)
                usersvc.EXPECT().SignUp(gomock.Any(), domain.User{
                    Email:    "123@qq.com",
                    Password: "hello#world123",
                }).Return(nil)
                // 注冊成功是 return nil
                return usersvc
            },

            reqBody: `
{
    "email": "123@qq.com",
    "password": "hello#world123",
    "confirmPassword": "hello#world123"
}
`,
            wantCode: http.StatusOK,
            wantBody: "注冊成功",
        },
        {
            name: "參數(shù)不對啥供，bind 失敗",
            mock: func(ctrl *gomock.Controller) service.UserService {
                usersvc := svcmocks.NewMockUserService(ctrl)
                // 注冊成功是 return nil
                return usersvc
            },

            reqBody: `
{
    "email": "123@qq.com",
    "password": "hello#world123"
`,
            wantCode: http.StatusBadRequest,
        },
        {
            name: "郵箱格式不對",
            mock: func(ctrl *gomock.Controller) service.UserService {
                usersvc := svcmocks.NewMockUserService(ctrl)
                return usersvc
            },

            reqBody: `
{
    "email": "123@q",
    "password": "hello#world123",
    "confirmPassword": "hello#world123"
}
`,
            wantCode: http.StatusOK,
            wantBody: "你的郵箱格式不對",
        },
        {
            name: "兩次輸入密碼不匹配",
            mock: func(ctrl *gomock.Controller) service.UserService {
                usersvc := svcmocks.NewMockUserService(ctrl)
                return usersvc
            },

            reqBody: `
{
    "email": "123@qq.com",
    "password": "hello#world1234",
    "confirmPassword": "hello#world123"
}
`,
            wantCode: http.StatusOK,
            wantBody: "兩次輸入的密碼不一致",
        },
        {
            name: "密碼格式不對",
            mock: func(ctrl *gomock.Controller) service.UserService {
                usersvc := svcmocks.NewMockUserService(ctrl)
                return usersvc
            },
            reqBody: `
{
    "email": "123@qq.com",
    "password": "hello123",
    "confirmPassword": "hello123"
}
`,
            wantCode: http.StatusOK,
            wantBody: "密碼必須大于8位，包含數(shù)字库糠、特殊字符",
        },
        {
            name: "郵箱沖突",
            mock: func(ctrl *gomock.Controller) service.UserService {
                usersvc := svcmocks.NewMockUserService(ctrl)
                usersvc.EXPECT().SignUp(gomock.Any(), domain.User{
                    Email:    "123@qq.com",
                    Password: "hello#world123",
                }).Return(service.ErrUserDuplicateEmail)
                // 注冊成功是 return nil
                return usersvc
            },

            reqBody: `
{
    "email": "123@qq.com",
    "password": "hello#world123",
    "confirmPassword": "hello#world123"
}
`,
            wantCode: http.StatusOK,
            wantBody: "郵箱沖突",
        },
        {
            name: "系統(tǒng)異常",
            mock: func(ctrl *gomock.Controller) service.UserService {
                usersvc := svcmocks.NewMockUserService(ctrl)
                usersvc.EXPECT().SignUp(gomock.Any(), domain.User{
                    Email:    "123@qq.com",
                    Password: "hello#world123",
                }).Return(errors.New("隨便一個 error"))
                // 注冊成功是 return nil
                return usersvc
            },

            reqBody: `
{
    "email": "123@qq.com",
    "password": "hello#world123",
    "confirmPassword": "hello#world123"
}
`,
            wantCode: http.StatusOK,
            wantBody: "系統(tǒng)異常",
        },
    }

    for _, tc := range testCases {
        t.Run(tc.name, func(t *testing.T) {
            ctrl := gomock.NewController(t)
            defer ctrl.Finish()
            server := gin.Default()
            // 用不上 codeSvc
            h := NewUserHandler(tc.mock(ctrl), nil)
            h.RegisterRoutes(server)

            req, err := http.NewRequest(http.MethodPost,
                "/users/signup", bytes.NewBuffer([]byte(tc.reqBody)))
            require.NoError(t, err)
            // 數(shù)據(jù)是 JSON 格式
            req.Header.Set("Content-Type", "application/json")
            // 這里你就可以繼續(xù)使用 req

            resp := httptest.NewRecorder()
            // 這就是 HTTP 請求進去 GIN 框架的入口伙狐。
            // 當你這樣調(diào)用的時候，GIN 就會處理這個請求
            // 響應(yīng)寫回到 resp 里
            server.ServeHTTP(resp, req)

            assert.Equal(t, tc.wantCode, resp.Code)
            assert.Equal(t, tc.wantBody, resp.Body.String())

        })
    }
}

func TestMock(t *testing.T) {
    ctrl := gomock.NewController(t)
    defer ctrl.Finish()

    usersvc := svcmocks.NewMockUserService(ctrl)

    usersvc.EXPECT().SignUp(gomock.Any(), gomock.Any()).
        Return(errors.New("mock error"))

    //usersvc.EXPECT().SignUp(gomock.Any(), domain.User{
    //  Email: "124@qq.com",
    //}).Return(errors.New("mock error"))

    err := usersvc.SignUp(context.Background(), domain.User{
        Email: "123@qq.com",
    })
    t.Log(err)
}

四曼玩、flags

gomock 有一些命令行標志鳞骤，可以幫助你控制生成過程。這些標志通常在 gomock 工具的幫助下使用黍判，例如 gomock generate豫尽。

mockgen 命令用來為給定一個包含要mock的接口的Go源文件，生成mock類源代碼顷帖。它支持以下標志：

• -source：包含要mock的接口的文件美旧。
• -destination：生成的源代碼寫入的文件渤滞。如果不設(shè)置此項，代碼將打印到標準輸出榴嗅。
• -package：用于生成的模擬類源代碼的包名妄呕。如果不設(shè)置此項包名默認在原包名前添加mock_前綴。
• -imports：在生成的源代碼中使用的顯式導(dǎo)入列表嗽测。值為foo=bar/baz形式的逗號分隔的元素列表绪励，其中bar/baz是要導(dǎo)入的包，foo是要在生成的源代碼中用于包的標識符唠粥。
• -aux_files：需要參考以解決的附加文件列表疏魏，例如在不同文件中定義的嵌入式接口。指定的值應(yīng)為foo=bar/baz.go形式的以逗號分隔的元素列表晤愧，其中bar/baz.go是源文件大莫，foo是-source文件使用的文件的包名。
• -build_flags：（僅反射模式）一字不差地傳遞標志給go build
• -mock_names：生成的模擬的自定義名稱列表官份。這被指定為一個逗號分隔的元素列表只厘，形式為Repository = MockSensorRepository,Endpoint=MockSensorEndpoint，其中Repository是接口名稱舅巷，mockSensorrepository是所需的mock名稱(mock工廠方法和mock記錄器將以mock命名)羔味。如果其中一個接口沒有指定自定義名稱，則將使用默認命名約定钠右。
• -self_package：生成的代碼的完整包導(dǎo)入路徑介评。使用此flag的目的是通過嘗試包含自己的包來防止生成代碼中的循環(huán)導(dǎo)入。如果mock的包被設(shè)置為它的一個輸入(通常是主輸入)爬舰，并且輸出是stdio们陆，那么mockgen就無法檢測到最終的輸出包，這種情況就會發(fā)生情屹。設(shè)置此標志將告訴 mockgen 排除哪個導(dǎo)入
• -copyright_file：用于將版權(quán)標頭添加到生成的源代碼中的版權(quán)文件
• -debug_parser：僅打印解析器結(jié)果
• -exec_only：（反射模式） 如果設(shè)置坪仇，則執(zhí)行此反射程序
• -prog_only：（反射模式）只生成反射程序；將其寫入標準輸出并退出垃你。
• -write_package_comment：如果為true椅文，則寫入包文檔注釋 (godoc)。（默認為true）

五惜颇、打樁（stub）

在測試中皆刺，打樁是一種測試術(shù)語，用于為函數(shù)或方法設(shè)置一個預(yù)設(shè)的返回值凌摄，而不是調(diào)用真實的實現(xiàn)羡蛾。在 gomock 中，打樁通常通過設(shè)置期望的行為來實現(xiàn)锨亏。
例如痴怨，您可以為 myServiceMock 的 DoSomething 方法設(shè)置一個期望的行為忙干，并返回一個特定的錯誤。這可以通過調(diào)用 myServiceMock.EXPECT().DoSomething().Return(error) 來實現(xiàn)浪藻。
在單元測試中捐迫，使用 gomock 可以幫助你更有效地模擬外部依賴，從而編寫更可靠和更高效的測試爱葵。通常用來屏蔽或補齊業(yè)務(wù)邏輯中的關(guān)鍵代碼方便進行單元測試施戴。

屏蔽：不想在單元測試用引入數(shù)據(jù)庫連接等重資源

補齊：依賴的上下游函數(shù)或方法還未實現(xiàn)

gomock支持針對參數(shù)、返回值萌丈、調(diào)用次數(shù)暇韧、調(diào)用順序等進行打樁操作。

參數(shù)

參數(shù)相關(guān)的用法有：

• gomock.Eq(value)：表示一個等價于value值的參數(shù)
• gomock.Not(value)：表示一個非value值的參數(shù)
• gomock.Any()：表示任意值的參數(shù)
• gomock.Nil()：表示空值的參數(shù)
• SetArg(n, value)：設(shè)置第n（從0開始）個參數(shù)的值浓瞪，通常用于指針參數(shù)或切片

六、總結(jié)

6.1 測試用例定義

測試用例定義巧婶，最完整的情況下應(yīng)該包含：

• 名字：簡明扼要說清楚你測試的場景乾颁，建議用中文。
• 預(yù)期輸入：也就是作為你方法的輸入艺栈。如果測試的是定義在類型上的方法英岭，那么也可以包含類型實例。
• 預(yù)期輸出：你的方法執(zhí)行完畢之后湿右，預(yù)期返回的數(shù)據(jù)诅妹。如果方法是定義在類型上的方法，那么也可以包含執(zhí)行之后的實例的狀態(tài)毅人。
• mock：每一個測試需要使用到的mock狀態(tài)吭狡。單元測試里面常見，集成測試一般沒有丈莺。
• 數(shù)據(jù)準備：每一個測試用例需要的數(shù)據(jù)划煮。集成測試里常見。
• 數(shù)據(jù)清理：每一個測試用例在執(zhí)行完畢之后缔俄，需要執(zhí)行一些數(shù)據(jù)清理動作弛秋。集成測試里常見。

如果你要測試的方法很簡單俐载，那么你用不上全部字段蟹略。

6.2 設(shè)計測試用例

測試用例定義和運行測試用例都是很模板化的東西。測試用例就是要根據(jù)具體的方法來設(shè)計遏佣。

• 如果是單元測試：看代碼挖炬，最起碼做到分支覆蓋。
• 如果是集成測試：至少測完業(yè)務(wù)層面的主要正常流程和主要異常流程状婶。

單元測試覆蓋率做到80%以上茅茂，在這個要求之下捏萍，只有極少數(shù)的異常分支沒有測試。其它測試就不是我們研發(fā)要考慮的了空闲，讓測試團隊去搞令杈。

6.3 執(zhí)行測試用例代碼

測試用例定義出來之后，怎么執(zhí)行這些用例碴倾，就已經(jīng)呼之欲出了逗噩。

這里分成幾個部分：

• 初始化 mock 控制器，每個測試用例都有獨立的 mock 控制器跌榔。
• 使用控制器 ctrl 調(diào)用 tc.mock异雁，拿到 mock 的 UserService 和 CodeService。
• 使用 mock 的服務(wù)初始化 UserHandler僧须，并且注冊路由纲刀。
• 構(gòu)造 HTTP 請求和響應(yīng) Recorder。
• 發(fā)起調(diào)用 ServeHTTP担平。

6.4 運行測試用例

測試里面的testCases是一個匿名結(jié)構(gòu)體的切片示绊，所以運行的時候就是直接遍歷。

那么針對每一個測試用例：

• 首先調(diào)用mock部分暂论，或者執(zhí)行before面褐。
• 執(zhí)行測試的方法。
• 比較預(yù)期結(jié)果取胎。
• 調(diào)用after方法展哭。

注意運行的時候，先調(diào)用了t.Run闻蛀，并且傳入了測試用例的名字匪傍。

6.5 不是所有的場景都很好測試

即便你的代碼寫得非常好，但是有一些場景基本上不可能測試到觉痛。如圖中的error分支析恢，就是屬于很難測試的。

因為bcrypt包你控制不住秧饮，Generate這個方法只有在超時的時候才會返回error映挂。那么你不測試也是可以的，代碼review可以確保這邊正確處理了error盗尸。

記赘檀：沒有測試到的代碼，一定要認真review泼各。

小黃書單元測試代碼：https://github.com/tao-xiaoxin/demo/tree/main/gotest/gmock/webook/backend