面试题：Go语言中如何进行Mock测试

Question

在Go项目中，有一个函数`func FetchDataFromDB() (string, error)`用于从数据库获取数据，现有另一个函数`func ProcessData() (string, error)`依赖`FetchDataFromDB`，但在测试`ProcessData`时不想真正连接数据库，如何使用Mock技术来模拟`FetchDataFromDB`的行为并对`ProcessData`进行测试，请写出详细实现步骤和代码示例。

Answer 1

1. 安装依赖：
   • Go 1.18 及以上版本内置了 testing 包和 mockgen 工具，用于生成 mock 代码。如果是旧版本，可以使用 go get 安装 github.com/golang/mock/gomock 和 github.com/golang/mock/mockgen。
2. 定义接口：
   • 为了便于使用 mock，先定义一个接口，FetchDataFromDB 函数将通过实现此接口来工作。

   type DataFetcher interface {
       FetchDataFromDB() (string, error)
   }
   

3. 修改 ProcessData 函数：
   • 让 ProcessData 函数依赖这个接口，而不是直接调用 FetchDataFromDB 函数。

   func ProcessData(fetcher DataFetcher) (string, error) {
       data, err := fetcher.FetchDataFromDB()
       if err!= nil {
           return "", err
       }
       // 对 data 进行处理，这里简单返回 data
       return data, nil
   }
   

4. 生成 mock 代码：
   • 使用 mockgen 工具生成 mock 代码。假设上述代码在 main.go 文件中，执行以下命令：

   mockgen -destination mock_data_fetcher.go -package main main DataFetcher
   

   • 这会在 mock_data_fetcher.go 文件中生成 DataFetcher 接口的 mock 实现，代码大致如下：

   // Code generated by MockGen. DO NOT EDIT.
   // Source: main.go
   
   package main
   
   import (
       "context"
       mock "github.com/golang/mock/gomock"
   )
   
   // MockDataFetcher is a mock of DataFetcher interface.
   type MockDataFetcher struct {
       ctrl     *mock.Controller
       recorder *MockDataFetcherMockRecorder
   }
   
   // MockDataFetcherMockRecorder is the mock recorder for MockDataFetcher.
   type MockDataFetcherMockRecorder struct {
       mock *mock.Controller
   }
   
   // NewMockDataFetcher creates a new mock instance.
   func NewMockDataFetcher(ctrl *mock.Controller) *MockDataFetcher {
       mock := &MockDataFetcher{ctrl: ctrl}
       mock.recorder = &MockDataFetcherMockRecorder{mock}
       return mock
   }
   
   // EXPECT returns an object that allows the caller to indicate expected use.
   func (m *MockDataFetcher) EXPECT() *MockDataFetcherMockRecorder {
       return m.recorder
   }
   
   // FetchDataFromDB mocks base method.
   func (m *MockDataFetcher) FetchDataFromDB() (string, error) {
       ret := m.ctrl.Call(m, "FetchDataFromDB")
       ret0, _ := ret[0].(string)
       ret1, _ := ret[1].(error)
       return ret0, ret1
   }
   
   // FetchDataFromDB indicates an expected call of FetchDataFromDB.
   func (mr *MockDataFetcherMockRecorder) FetchDataFromDB() *mock.Call {
       return mr.mock.Call("FetchDataFromDB")
   }
   

5. 编写测试代码：
   • 使用生成的 mock 代码来测试 ProcessData 函数。

   package main
   
   import (
       "testing"
   
       "github.com/golang/mock/gomock"
   )
   
   func TestProcessData(t *testing.T) {
       ctrl := gomock.NewController(t)
       defer ctrl.Finish()
   
       mockFetcher := NewMockDataFetcher(ctrl)
       expectedData := "test data"
       mockFetcher.EXPECT().FetchDataFromDB().Return(expectedData, nil)
   
       result, err := ProcessData(mockFetcher)
       if err!= nil {
           t.Errorf("ProcessData() error = %v", err)
       }
       if result!= expectedData {
           t.Errorf("ProcessData() result = %v, want %v", result, expectedData)
       }
   }
   

以上步骤和代码示例展示了如何使用 Mock 技术在不连接真实数据库的情况下测试 ProcessData 函数。