使用 Go 框架进行 Mocking 和 Stubbing 的技巧和窍门-Golang-PHP中文网

使用 Go 框架进行 Mocking 和 Stubbing 的技巧和窍门

王林

发布： 2024-07-12 14:36:01

原创

409人浏览过

go 中进行 mocking 和 stubbing 的技巧和窍门：使用 moq 包生成自动生成的 mocking 接口。使用 testify/mock 包创建 go 接口的假实现，并 stub 接口的方法行为。使用 gomock 包在一个 mocking 对象中结合 mocking 和 stubbing。实战案例演示了如何使用这些技术简化对持久层（数据库访问）的测试。

使用 Go 框架进行 Mocking 和 Stubbing 的技巧和窍门

使用 Go 框架进行 Mocking 和 Stubbing 的技巧和窍门

前言

在软件开发中，Mocking 和 Stubbing 是单元和集成测试中的关键技术。它们允许我们隔离测试中的外部依赖关系，在不影响系统其余部分的情况下专注于特定组件的测试。在 Go 中，有一些框架可以简化 Mocking 和 Stubbing 的过程，让我们来探索其中最有用的工具和技术。

1. 使用 moq 包进行 Mocking

moq 是一个 Go 包，用于生成自动生成的 Mocking 接口。它使用代码生成器来自现有接口生成Mock实现，使您可以轻松创建针对目标接口的 Mock。

package example

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

// UserService 接口
type UserService interface {
    CreateUser(user *User) (*User, error)
    UpdateUser(user *User) (*User, error)
    DeleteUser(id int) error
}

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

    // 创建一个 UserService 的 Mock
    mockUserService := mock_example.NewMockUserService(ctrl)

    // 设置 Mock 的期望：CreateUser 返回一个错误
    mockUserService.EXPECT().CreateUser(gomock.Any()).Return(nil, errors.New("error"))

    // 创建一个 UserService 的实例，该实例使用 Mock
    userService := UserService(mockUserService)

    // 进行测试
    user, err := userService.CreateUser(newUser())
    if err == nil {
        t.Error("CreateUser should have returned an error")
    }
}

登录后复制

2. 使用 testify/mock 包进行 Stubbing

testify/mock 包允许您创建 Go 接口的假实现。它提供了 Stub 接口的方法，使您能够自定义方法的行为。

package example

import (
    "errors"

    "github.com/stretchr/testify/mock"
)

// Database 接口
type Database interface {
    Query(query string) ([]map[string]interface{}, error)
}

func TestQuery(t *testing.T) {
    mockDB := new(mock.Mock)
    mockDB.On("Query", "SELECT * FROM users").Return([]map[string]interface{}{}, nil)

    // 创建一个 Database 的实例，该实例使用 Stub
    database := Database(mockDB)

    // 进行测试
    rows, err := database.Query("SELECT * FROM users")
    if err != nil {
        t.Error("Query should have returned nil error")
    }

    if len(rows) == 0 {
        t.Error("Query should have returned non-empty result")
    }
}

登录后复制

3. 使用 gomock 包进行 Mocking 和 Stubbing

gomock 是一个高级 Mocking 和 Stubbing 框架，提供了对前两种方法的统一界面。它允许您在单个 Mocking 对象中结合 Mocking 和 Stubbing。

package example

import (
    "errors"

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

// UserService 接口
type UserService interface {
    CreateUser(user *User) (*User, error)
    UpdateUser(user *User) (*User, error)
    DeleteUser(id int) error
}

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

    // 创建一个 UserService 的 Mock
    mockUserService := mock_example.NewMockUserService(ctrl)

    // Stub CreateUser 方法的行为
    mockUserService.EXPECT().CreateUser(gomock.Any()).Return(nil, errors.New("error"))

    // 创建一个 UserService 的实例，该实例使用 Mock
    userService := UserService(mockUserService)

    // 进行测试
    user, err := userService.CreateUser(newUser())
    if err == nil {
        t.Error("CreateUser should have returned an error")
    }
}

登录后复制

实战案例

我们来演示如何使用 Mocking 和 Stubbing 简化对持久层（如数据库访问）的测试。

package example

import (
    "errors"

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

// Database 接口
type Database interface {
    Query(query string) ([]map[string]interface{}, error)
}

// UserService 接口
type UserService interface {
    CreateUser(user *User) (*User, error)
}

type userServiceImpl struct {
    db Database
}

// NewUserService 实例化 UserService
func NewUserService(db Database) UserService {
    return &userServiceImpl{
        db: db,
    }
}

// CreateUser 创建一个用户
func (s *userServiceImpl) CreateUser(user *User) (*User, error) {
    query := "INSERT INTO users (name, email) VALUES (?, ?)"
    params := []interface{}{user.Name, user.Email}
    _, err := s.db.Query(query, params...)
    if err != nil {
        return nil, err
    }

    return user, nil
}

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

    // 创建一个 Database 的 Mock
    mockDB := mock_example.NewMockDatabase(ctrl)

    // Stub Query 方法的行为
    mockDB.EXPECT().Query(
        "INSERT INTO users (name, email) VALUES (?, ?)",
        []interface{}{"John", "john@doe.com"},
    ).Return(nil, nil)

    // 创建一个 UserService 的实例，该实例使用 Mock
    userService := NewUserService(mockDB)

    // 进行测试
    user, err := userService.CreateUser(&User{Name: "John", Email: "john@doe.com"})
    if err != nil {
        t.Error("CreateUser should have returned nil error")
    }

    if user.Name != "John" || user.Email != "john@doe.com" {
        t.Error("CreateUser should have returned the correct user")
    }
}

登录后复制

结论

使用 Go 框架进行 Mocking 和 Stubbing 可以显著提高单元和集成测试的效率和可靠性。通过使用 moq、testify/mock 和 gomock 等框架，我们可以轻松地隔离外部依赖关系，专注于测试目标组件的功能。

以上就是使用 Go 框架进行 Mocking 和 Stubbing 的技巧和窍门的详细内容，更多请关注php中文网其它相关文章！