Go 单元测试之mock接口测试 - ToB企服应用市场:ToB评测及商务社交产业平台

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

复制代码

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

复制代码

# 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

复制代码

// 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 方法会根据 Content-Type 来解析你的数据到 req 里面
// 解析错了，就会直接写回一个 400 的错误
if err := ctx.Bind(&req); err != nil {
return
}
ok, err := u.emailExp.MatchString(req.Email)
if err != nil {
ctx.String(http.StatusOK, "系统错误")
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, "系统错误")
return
}
if !ok {
ctx.String(http.StatusOK, "密码必须大于8位，包含数字、特殊字符")
return
}
// 调用一下 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, "系统异常")
return
}
ctx.String(http.StatusOK, "注册成功")
}

复制代码

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: "参数不对，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位，包含数字、特殊字符",
},
{
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: "系统异常",
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: "系统异常",
},
}
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)
// 数据是 JSON 格式
req.Header.Set("Content-Type", "application/json")
// 这里你就可以继续使用 req
resp := httptest.NewRecorder()
// 这就是 HTTP 请求进去 GIN 框架的入口。
// 当你这样调用的时候，GIN 就会处理这个请求
// 响应写回到 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)
}

复制代码