如何使用 Gomock 编写 Golang 单元测试？

如何使用 Gomock 编写 Go 单元测试

什么是 Gomock？

Gomock 是一个 Go 语言框架，提供了一种编写隔离测试的方法，通过创建和控制测试用例中使用的模拟对象。

安装 Gomock

go get github.com/golang/mock/gomock

编写模拟对象

立即学习“go语言免费学习笔记（深入）”；

首先定义要模拟的接口：

type ExampleInterface interface {}

然后使用 Gomock 生成模拟对象：

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

var mockCtrl *gomock.Controller
var mockExample ExampleInterface

func TestSomething(t *testing.T) {
  // Before each test, set up the mock environment.
  mockCtrl = gomock.NewController(t)
  mockExample = mockCtrl.Finish().Interface.(ExampleInterface)
}

func TestSomethingElse(t *testing.T) {
  // Before each test, set up the mock environment.
  mockCtrl = gomock.NewController(t)
  mockExample = mockCtrl.Finish().Interface.(ExampleInterface)
}

配置模拟行为

Buildt.ai

AI驱动的软件开发平台，可以自动生成代码片段、代码分析及其他自动化任务

下载

使用 EXPECT() 方法为模拟对象设置期望行为：

// Expect that the GetSomething method will be called once with any argument and return the value "foo".
mockExample.EXPECT().GetSomething(gomock.Any()).Return("foo").Once()

验证期望

在测试的最后，使用 AssertExpectations() 方法验证所有期望是否已满足：

// Assert that all expectations have been met.
mockCtrl.AssertExpectations(t)

实战案例

考虑一个函数 NewExampleStruct，它使用 ExampleInterface 创建一个 ExampleStruct 实例：

func NewExampleStruct(e ExampleInterface) *ExampleStruct {
  return &ExampleStruct{e}
}

要编写针对 NewExampleStruct 的测试，我们可以使用 Gomock 创建一个模拟 ExampleInterface：

import "testing"

var mockCtrl *gomock.Controller
var mockExample ExampleInterface

func TestNewExampleStruct(t *testing.T) {
  defer mockCtrl.Finish()

  mockExample := mockCtrl.New().Interface().(ExampleInterface)

  // Expect that the GetSomething method will be called once with the argument "foo" and return the value "bar".
  mockExample.EXPECT().GetSomething("foo").Return("bar").Times(1)

  // Call the function under test.
  exampleStruct := NewExampleStruct(mockExample)

  // Assert that the function returned the expected value.
  if exampleStruct.GetSomething("foo") != "bar" {
    t.Errorf("Expected to get \"bar\", but got \"%s\"", exampleStruct.GetSomething("foo"))
  }
}

通过使用 Gomock，我们能够控制测试用例中的依赖对象，并验证是否调用了期望的方法，为我们提供了隔离和可预测的测试环境。