使用 Golang Mock 进行函数测试

简介

函数测试是针对特定函数进行的测试，以验证其预期行为。在 Golang 中，可以使用 mock 程序包来创建函数的模拟实现，以用于测试。

安装和配置

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

要在项目中使用 mock 程序包，请使用以下命令安装：

go get github.com/golang/mock/gomock

创建 Mock

要创建函数的 Mock 实现，需要创建一个接口定义函数签名，并在 Mock 结构中实现这些函数。例如，考虑以下函数：

func Add(a, b int) int {
  return a + b
}

它的 Mock 实现如下：

// mockGomock嵌入了Mocking方法
type MockAdder struct {
    m *gomock.Mock
}

//NewMockAdder创建MockAdder模拟对象
func NewMockAdder(ctrl *gomock.Controller) *MockAdder {
    m := &MockAdder{m: ctrl.NewMock()}
    return m
}

// Add模拟Add函数的实现
func (m *MockAdder) Add(a, b int) int {
    ret := m.m.Called(a, b)
    return ret.Get(0).(int)
}

编写测试

有了 Mock 实现，就可以编写函数测试了。例如，以下测试验证 Add 函数正常工作：

func TestAdd(t *testing.T) {
    ctrl := gomock.NewController(t)
    adder := NewMockAdder(ctrl)
    //将Adder对象替换为Mock
    underTest = adder

    // 设置 Mock 的预期行为
    adder.EXPECT().Add(2, 3).Return(5)

    result := underTest.Add(2, 3)
    //Result值应该为5
    if result != 5 {
        t.Errorf("Add() returned %d; want 5", result)
    }
    ctrl.Finish()
}

结论

使用 mock 程序包，可以轻松创建函数的 Mock 实现，用于在函数测试中验证预期行为。这使开发者能够分离函数的逻辑和测试逻辑，并提高测试的可靠性。