Mockery项目中可变参数(variadic)的Mock生成问题解析

背景介绍

Mockery是一个流行的Go语言mock框架生成工具，它能够根据接口定义自动生成mock实现。在从Mockery v2升级到v3的过程中，一些开发者遇到了关于可变参数(variadic parameters)mock生成行为变化的问题。

问题现象

在Mockery v2中，对于包含可变参数的接口方法，如：

type DBExecutor interface {
    ExecContext(ctx context.Context, query string, args ...interface{}) (bool, error)
}

生成的mock代码能够正确处理可变参数，开发者可以这样使用：

dbExecutor.EXPECT().ExecContext(
    mock.Anything, mock.Anything,
    "arg1", "arg2", "arg3"
).Return(true, nil)

但在升级到Mockery v3后，同样的代码会报错"Provided 4 arguments, mocked for 3 arguments"，提示参数数量不匹配。

原因分析

这个行为变化源于Mockery v3中引入的一个配置选项unroll-variadic。在v2版本中，默认行为是"展开"可变参数(unroll)，即每个可变参数都被视为独立的参数。而在v3中，默认行为发生了变化，可变参数被视为一个切片整体。

具体代码生成差异：

v2生成的mock代码：

func (_m *DBExecutor) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
    var _ca []interface{}
    _ca = append(_ca, ctx, query)
    _ca = append(_ca, args...)
    ret := _m.Called(_ca...)
    // ...
}

v3生成的mock代码：

func (_mock *DBExecutor) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
    var tmpRet mock.Arguments
    if len(args) > 0 {
        tmpRet = _mock.Called(ctx, query, args) // args作为整体传递
    } else {
        tmpRet = _mock.Called(ctx, query)
    }
    // ...
}

解决方案

要恢复v2的行为，可以在Mockery配置文件中设置：

template-data:
  unroll-variadic: true

这个配置项控制是否将可变参数展开为独立参数。设置为true时，行为与v2一致；false时(默认)，可变参数被视为切片整体。

最佳实践建议

1. 明确配置：在配置文件中显式设置unroll-variadic，避免依赖默认值
2. 迁移注意：从v2升级到v3时，使用迁移工具自动处理配置变更
3. 测试覆盖：升级后应全面测试mock相关代码，特别是涉及可变参数的部分
4. 一致性：团队内部应统一配置，避免不同开发者环境行为不一致

总结

Mockery v3在可变参数处理上的行为变化是为了提供更灵活的mock生成选项。理解这个变化背后的设计意图，合理配置unroll-variadic参数，可以帮助开发者平滑过渡到新版本，同时保持测试代码的清晰性和一致性。