Golang 框架自动化测试:使用 Mock 模拟依赖和外部服务
在 Golang 项目中,当需要测试与依赖项或外部服务交互的代码时,模拟(Mock)技术非常有用。模拟允许创建测试双工,这些双工模拟依赖项的行为,使您能够验证应用程序逻辑而不与实际依赖项交互。
如何模拟依赖项
使用 GoMock
GoMock 是一个用于生成 Golang 接口模拟的框架。要使用 GoMock,请按照以下步骤操作:
立即学习“go语言免费学习笔记(深入)”;
- 安装 GoMock:go get github.com/golang/mock/gomock
- 定义要模拟的接口:
package example
import "fmt"
type MyInterface interface {
MyMethod(s string) string
}
- 生成模拟:
package example
import (
"github.com/golang/mock/gomock"
"testing"
)
func Test(t *testing.T) {
// 创建 gomock 控制器
ctrl := gomock.NewController(t)
defer ctrl.Finish()
// 创建 myInterface 模拟
mock := NewMockMyInterface(ctrl)
mock.EXPECT().MyMethod("hello").Return("HELLO")
}
在 Test() 函数中:
- 创建一个 gomock 控制器,用于管理模拟生命周期。
- 使用 NewMockMyInterface 创建一个 MyInterface 模拟。
- 设置一个期望,模拟调用的 MyMethod("hello") 方法并返回 "HELLO"。
使用 Mockito
Mockito 也是一个流行的 Golang 模拟框架。Mockito 使您可以使用注解来声明模拟行为,从而简化了测试代码的编写。要使用 Mockito,请按照以下步骤操作:
- 安装 Mockito:go get github.com/stretchr/testify/mock
- 定义要模拟的接口:
package example
import "fmt"
// 模仿 MyInterface 接口
type MyInterface interface {
MyMethod(s string) string
}
// 定义 MyInterface 的模拟类型
type MyInterfaceMock struct {
mock.Mock
}
- 生成模拟:
package example
import (
"testing"
"github.com/stretchr/testify/mock"
)
func Test(t *testing.T) {
// 创建 myInterface 模拟
mock := &MyInterfaceMock{}
// 使用 mock.On 设置期望
mock.On("MyMethod", "hello").Return("HELLO")
// 使用模拟测试逻辑
result := myFunction(mock)
if result != "HELLO" {
t.Errorf("Unexpected result: %s", result)
}
}
在 Test() 函数中:
- 创建一个 MyInterfaceMock 模拟并实现 MyMethod 方法。
- 使用 mock.On 设置期望,类似于 GoMock。
- 使用模拟进行测试并验证结果。
如何模拟外部服务
模拟外部服务时,您可以使用像[Wiremock](https://wiremock.org/)或[VCR](https://github.com/myzhan/go-vcr)等工具。这些工具允许您捕获与外部服务的真实交互并创建录音,供您在测试中重放。
要使用 Wiremock,请按照以下步骤操作:
- 安装 Wiremock:go get github.com/tomakehurst/wiremock/go-wiremock
- 启动 Wiremock 服务器:wiremock --standalone
- 设置 Wiremock 存根:
package example
import (
"net/http"
"testing"
"github.com/tomakehurst/wiremock/client"
)
func Test(t *testing.T) {
// 创建 Wiremock 客户端
wiremock, err := client.NewClient("localhost:8080")
if err != nil {
t.Fatal(err)
}
// 设置 GET /hello 存根
wiremock.Reset().
GivenThat(client.Get(client.Matching("/hello")).
WillReturn(http.StatusTeapot, client.BodyString("I'm a teapot")))
// 使用真实 HTTP 客户端进行测试
resp, err := http.Get("http://localhost:8080/hello")
if err != nil {
t.Fatal(err)
}
// 验证响应状态码和正文
if resp.StatusCode != http.StatusTeapot {
t.Errorf("Unexpected status code: %d", resp.StatusCode)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
t.Fatal(err)
}
if string(body) != "I'm a teapot" {
t.Errorf("Unexpected body: %s", string(body))
}
}
在 Test() 函数中:
- 创建一个 Wiremock 客户端并启动服务器。
- 使用 GivenThat 设置一个 Wiremock 存根,指定要捕获的请求并定义返回的响应。
- 使用真实 HTTP 客户端进行测试并验证响应。