Golang 單元測試 - 邏輯層

LinkinStar發表於2023-03-15
Golang

前面我們完成了最麻煩的資料層的單元測試，今天我們來看看單元測試中最容易做的一層，資料邏輯層，也就是我們通常說的 service 或者 biz 等，是描述具體業務邏輯的地方，這一層包含我們業務最重要的邏輯。

所以它的測試非常重要，通常它測試的透過就意味著你的業務邏輯能正常執行了。

而如何對它做單元測試呢？ 因為，這一層的依賴主要來源於資料層，通常這一層會呼叫資料層的介面來獲取或運算元據。 由於我們之前對於資料層已經做了單元測試，所以這一次，我們需要 mock 的不是資料庫了，而是資料層。

Golang 提供了 github.com/golang/mock 來實現 mock 介面的操作，本文就是使用它來完成我們的單元測試。

準備工作

安裝 go install github.com/golang/mock/mockgen@v1.6.0

基本 case 程式碼

首先我們還是基於上一次的例子，這裡給出上一次例子中所用到的介面

package service

import (
    "context"
    "fmt"

    "go-demo/m/unit-test/entity"
)

type UserRepo interface {
    AddUser(ctx context.Context, user *entity.User) (err error)
    DelUser(ctx context.Context, userID int) (err error)
    GetUser(ctx context.Context, userID int) (user *entity.User, exist bool, err error)
}

type UserService struct {
    userRepo UserRepo
}

func NewUserService(userRepo UserRepo) *UserService {
    return &UserService{userRepo: userRepo}
}

func (us *UserService) AddUser(ctx context.Context, username string) (err error) {
    if len(username) == 0 {
        return fmt.Errorf("username not specified")
    }
    return us.userRepo.AddUser(ctx, &entity.User{Username: username})
}

func (us *UserService) GetUser(ctx context.Context, userID int) (user *entity.User, err error) {
    userInfo, exist, err := us.userRepo.GetUser(ctx, userID)
    if err != nil {
        return nil, err
    }
    if !exist {
        return nil, fmt.Errorf("user %d not found", userID)
    }
    return userInfo, nil
}

可以看到我們的目標很明確，就是需要 mock 掉 UserRepo 介面的幾個方法，就可以測試我們 AddUser 和 GetUser 方法了

生成 mock 介面

使用 mockgen 命令可以生成我們所需要的 mock 介面

mockgen -source=./service/user.go -destination=./mock/user_mock.go -package=mock

引數名稱都很好理解，我這邊不贅述了。命令執行完成之後，會在 destination 生成對於的 mock 介面，就可以使用了。

生成的程式碼大致如下面的樣子，可以簡單瞄一眼：

// Code generated by MockGen. DO NOT EDIT.
// Source: ./user.go

// Package mock is a generated GoMock package.
package mock

import (
    context "context"
    entity "go-demo/m/unit-test/entity"
    reflect "reflect"

    gomock "github.com/golang/mock/gomock"
)

// MockUserRepo is a mock of UserRepo interface.
type MockUserRepo struct {
    ctrl     *gomock.Controller
    recorder *MockUserRepoMockRecorder
}

// MockUserRepoMockRecorder is the mock recorder for MockUserRepo.
type MockUserRepoMockRecorder struct {
    mock *MockUserRepo
}

// NewMockUserRepo creates a new mock instance.
func NewMockUserRepo(ctrl *gomock.Controller) *MockUserRepo {
    mock := &MockUserRepo{ctrl: ctrl}
    mock.recorder = &MockUserRepoMockRecorder{mock}
    return mock
}

// EXPECT returns an object that allows the caller to indicate expected use.
func (m *MockUserRepo) EXPECT() *MockUserRepoMockRecorder {
    return m.recorder
}

// AddUser mocks base method.
func (m *MockUserRepo) AddUser(ctx context.Context, user *entity.User) error {
    m.ctrl.T.Helper()
    ret := m.ctrl.Call(m, "AddUser", ctx, user)
    ret0, _ := ret[0].(error)
    return ret0
}

// AddUser indicates an expected call of AddUser.
func (mr *MockUserRepoMockRecorder) AddUser(ctx, user interface{}) *gomock.Call {
    mr.mock.ctrl.T.Helper()
    return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "AddUser", reflect.TypeOf((*MockUserRepo)(nil).AddUser), ctx, user)
}

// DelUser mocks base method.
func (m *MockUserRepo) DelUser(ctx context.Context, userID int) error {
    m.ctrl.T.Helper()
    ret := m.ctrl.Call(m, "DelUser", ctx, userID)
    ret0, _ := ret[0].(error)
    return ret0
}

// DelUser indicates an expected call of DelUser.
func (mr *MockUserRepoMockRecorder) DelUser(ctx, userID interface{}) *gomock.Call {
    mr.mock.ctrl.T.Helper()
    return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DelUser", reflect.TypeOf((*MockUserRepo)(nil).DelUser), ctx, userID)
}

// GetUser mocks base method.
func (m *MockUserRepo) GetUser(ctx context.Context, userID int) (*entity.User, bool, error) {
    m.ctrl.T.Helper()
    ret := m.ctrl.Call(m, "GetUser", ctx, userID)
    ret0, _ := ret[0].(*entity.User)
    ret1, _ := ret[1].(bool)
    ret2, _ := ret[2].(error)
    return ret0, ret1, ret2
}

// GetUser indicates an expected call of GetUser.
func (mr *MockUserRepoMockRecorder) GetUser(ctx, userID interface{}) *gomock.Call {
    mr.mock.ctrl.T.Helper()
    return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetUser", reflect.TypeOf((*MockUserRepo)(nil).GetUser), ctx, userID)
}

編寫單元測試

gomock 的單元測試編寫起來也很方便，只需要呼叫 EXPECT() 方法，將需要 mock 的介面對應需要的返回值就可以了。我們直接來看例子：

package service

import (
    "context"
    "testing"

    "github.com/golang/mock/gomock"
    "github.com/stretchr/testify/assert"
    "go-demo/m/unit-test/entity"
    "go-demo/m/unit-test/mock"
)

func TestUserService_AddUser(t *testing.T) {
    ctl := gomock.NewController(t)
    defer ctl.Finish()

    mockUserRepo := mock.NewMockUserRepo(ctl)
    userInfo := &entity.User{Username: "LinkinStar"}
    // 無論對 AddUser 方法輸入任意引數，均會返回 userInfo 資訊
    mockUserRepo.EXPECT().AddUser(gomock.Any(), gomock.Any()).Return(nil)

    userService := NewUserService(mockUserRepo)
    err := userService.AddUser(context.TODO(), userInfo.Username)
    assert.NoError(t, err)
}

func TestUserService_GetUser(t *testing.T) {
    ctl := gomock.NewController(t)
    defer ctl.Finish()

    userID := 1
    username := "LinkinStar"

    mockUserRepo := mock.NewMockUserRepo(ctl)
    // 只有當對於 GetUser 傳入 userID 為 1 時才會返回 user 資訊
    mockUserRepo.EXPECT().GetUser(context.TODO(), userID).Return(&entity.User{
        ID:       userID,
        Username: username,
    }, true, nil)

    userService := NewUserService(mockUserRepo)
    userInfo, err := userService.GetUser(context.TODO(), userID)
    assert.NoError(t, err)
    assert.Equal(t, username, userInfo.Username)
}

與之前一樣，我們依舊使用 github.com/stretchr/testify 做斷言來驗證最終結果。可以看到，單元測試編寫起來並不難。

最佳化

當然，如果我們每次修改介面或者新增介面都需要重新執行一次命令，一個檔案還好，當有很多檔案的時候肯定是非常困難的。所以我們需要使用 go:generate 來最佳化一下。

我們可以在需要 mock 的介面上方加入註釋(注意這裡寫的路徑要和實際路徑相符合)：

//go:generate mockgen -source=./user.go -destination=../mock/user_mock.go -package=mock
type UserRepo interface {
    AddUser(ctx context.Context, user *entity.User) (err error)
    DelUser(ctx context.Context, userID int) (err error)
    GetUser(ctx context.Context, userID int) (user *entity.User, exist bool, err error)
}

然後只需要使用命令

go generate ./...

就可以生成全部的 mock 嘞，所以及時檔案很多，只需要利用好 go:generate 也能一次搞定

mockgen

比如針對指定引數，我們偷懶可以都用 Any，但常常還需要用 gomock.Eq() 或 gomock.Not("Sam")
有關 gomock 還有很多方法在測試的使用也很有用，詳細的文件在：https://pkg.go.dev/github.com/golang/mock/gomock#pkg-index

有關於 github.com/golang/mock 的使用，官方給出了一些例子，可以參考 https://github.com/golang/mock/tree/main/sample

總結

其實通常來說資料邏輯層的測試反而不容易出現問題，原因是：我們 mock 的資料都是我們想要的資料。
所以對於嚴格的單元測試來說，需要多組資料的測試來保證我們在一些特殊場景上能正常執行，或者滿足期望執行。

相關文章