在 go 中,mock 框架提供了创建模拟物的方法,用于隔离单元测试中的依赖项。常见的框架包括 mockgen、gomock 和 testify。可使用 mockgen 根据接口定义生成模拟物,然后导入 mock 包并创建和配置模拟物以进行测试。实战案例中,为从数据库获取用户信息的函数生成模拟物,并断言函数结果与预期值一致。
Golang 中 Mock 框架的使用
简介
Mock 框架是一种用于创建模拟物的工具,模拟物是测试中用来替代真实对象的对象。在 Go 中,Mock 框架提供了方便的方法来创建模拟物,以便在单元测试中隔离依赖关系。
常见的 Go Mock 框架
立即学习“go语言免费学习笔记(深入)”;
- [mockgen](https://github.com/golang/mock)
- [gomock](https://github.com/golang/mock/gomock)
- [Testify](https://github.com/stretchr/testify/tree/master/mock)
使用 Mockgen 创建模拟物
Mockgen 是一个命令行工具,可根据给定的接口定义自动生成模拟物。要使用 Mockgen,首先需要安装它:
go install github.com/golang/mock/mockgen@latest
然后,您可以使用以下命令为接口 MyInterface 生成 mock:
mockgen -source=my_interface.go -destination=my_interface_mock.go -package=mock
使用模拟物
要使用模拟物进行测试,请首先导入 mock 包:
import (
mock "github.com/stretchr/testify/mock"
"github.com/mypackage/mock"
)
然后,您可以创建一个模拟物并对其进行配置:
func TestMyFunction(t *testing.T) {
m := mock.NewMockMyInterface()
m.On("MyMethod").Return(10)
// 调用使用模拟物的函数
result := MyFunction(m)
// 断言结果
assert.Equal(t, 10, result)
}
实战案例
问题:我们有一个函数 GetUserInfo,它从数据库中获取用户信息。在单元测试中,我们希望隔离数据库依赖项。
解决方案:
- 使用 Mockgen 为 GetUserInfo 函数中的 UserRepository 接口生成模拟物。
- 在测试中,创建一个模拟物并配置它的期望行为。
- 调用 GetUserInfo 函数,其中使用的是模拟物。
- 断言函数的结果与预期值一致。
代码:
// user_repository.go
package user
import "context"
type UserRepository interface {
GetUserInfo(ctx context.Context, userID int) (*UserInfo, error)
}
// user_service.go
package user
import "context"
type UserService struct {
repo UserRepository
}
func (s *UserService) GetUserInfo(ctx context.Context, userID int) (*UserInfo, error) {
return s.repo.GetUserInfo(ctx, userID)
}
// user_service_test.go
package user
import (
"context"
"testing"
"github.com/stretchr/testify/assert"
mock "github.com/stretchr/testify/mock"
)
type MockUserRepository struct {
mock.Mock
}
func (m *MockUserRepository) GetUserInfo(ctx context.Context, userID int) (*UserInfo, error) {
args := m.Called(ctx, userID)
return args.Get(0).(*UserInfo), args.Error(1)
}
func TestGetUserInfo(t *testing.T) {
m := MockUserRepository{}
m.On("GetUserInfo").Return(&UserInfo{}, nil)
s := UserService{&m}
result, err := s.GetUserInfo(context.Background(), 1)
assert.NoError(t, err)
assert.Equal(t, &UserInfo{}, result)
}