Mockery项目中如何优雅地模拟"永不调用"的方法

在Go语言的单元测试中，我们经常会遇到需要模拟某些方法"永远不应该被调用"的场景。本文将深入探讨在Mockery项目中如何优雅地实现这一需求，并分析各种实现方式的优缺点。

问题背景

在编写单元测试时，有时我们需要确保被测代码在特定条件下不会调用某些方法。例如，当测试一个条件分支时，我们希望验证在某个分支下不会调用特定的依赖方法。这种情况下，我们需要一种方式来明确表达"这个方法永远不应该被调用"的预期。

常见解决方案

1. 使用panic的原始方式

最初开发者可能会采用以下方式：

mock.On("SomeFunc", ctx).
    Run(func(args mock.Arguments) {
        panic("should not be called!")
    }).
    Return(nil, errors.New("panic")).
    Maybe()

这种方式虽然能达到目的，但存在几个问题：

• 代码冗长且不够直观
• 使用了panic，可能会影响测试框架的错误报告
• 需要额外处理返回值，即使这些返回值实际上不会被使用

2. 更优雅的解决方案：Times(0)

Mockery实际上已经提供了更优雅的解决方案：

mock.On("SomeFunc", ctx).Times(0)

这种方式：

• 语义明确，直接表达了"这个方法不应该被调用"的意图
• 不需要处理panic或返回值
• 当方法被意外调用时，Mockery会自动报告测试失败

3. 不设置预期的隐式方式

另一种方式是根本不设置对该方法的任何预期：

// 不设置SomeFunc的任何mock预期

然后依赖Mockery的AssertExpectations()功能，它会在测试结束时自动检查是否有未预期的调用发生。这种方式：

• 最简单直接
• 适用于不关心具体参数的情况
• 错误报告可能不够具体

最佳实践建议

1. 参数明确时：使用Times(0)方式，因为它既能明确表达意图，又能在错误发生时提供详细的错误信息。

2. 不关心参数时：可以不设置预期，依赖AssertExpectations()来捕获意外调用。

3. 避免使用panic：除非有特殊需求，否则应该避免在测试中使用panic来验证调用情况。

深入理解Times(0)的工作原理

Mockery的Times(0)实际上是设置了一个预期计数器，当方法被调用时，这个计数器会递增。在测试验证阶段，Mockery会检查所有预期调用的实际调用次数是否符合预期。对于Times(0)的情况，任何调用都会导致验证失败。

实际应用示例

假设我们有一个缓存服务，在缓存命中时不应该调用底层数据库：

func TestCacheHit(t *testing.T) {
    dbMock := new(DatabaseMock)
    cache := NewCacheService(dbMock)
    
    // 设置缓存命中的测试数据
    cache.Set("key", "value")
    
    // 明确表示GetFromDB不应该被调用
    dbMock.On("GetFromDB", "key").Times(0)
    
    // 执行测试
    result, err := cache.Get("key")
    require.NoError(t, err)
    require.Equal(t, "value", result)
    
    // 自动验证mock预期
    dbMock.AssertExpectations(t)
}

总结

在Mockery项目中，验证方法"永不调用"的最佳方式是使用Times(0)。这种方式简洁、明确，并且能提供良好的错误报告。理解并正确使用这一特性，可以大大提高单元测试的可读性和可维护性。