Mockery项目中方法调用次数验证的常见误区解析

Mockery作为PHP生态中广泛使用的模拟对象框架，其灵活的API设计为单元测试带来了极大便利。但在实际使用过程中，开发者经常会遇到方法调用次数验证不通过的问题，特别是当测试用例中存在多个期望设置时。本文将通过一个典型场景，深入分析Mockery的期望机制原理，帮助开发者避免类似陷阱。

问题现象

在测试一个使用League\OpenAPIValidation\PSR7\ValidatorBuilder的服务类时，开发者发现即使被测代码确实调用了fromYaml()方法，Mockery仍然抛出InvalidCountException异常，提示方法调用次数不足。而同样的测试逻辑使用PHPUnit原生模拟功能却能正常通过。

核心原理分析

Mockery的期望机制遵循叠加原则，每次调用shouldReceive()都会为方法添加新的期望规则。这与PHPUnit的模拟对象工作方式有本质区别：

1. 期望叠加性：在Mockery中，对同一方法的多次shouldReceive调用会产生多个独立的期望
2. 严格验证：默认情况下Mockery会验证所有设置的期望
3. 执行顺序无关：期望的设置顺序不影响验证逻辑

典型错误模式

示例中出现的双重期望设置是常见错误模式：

// 在setUp方法中设置第一次期望
$this->validatorBuilder->shouldReceive('fromYaml')->andReturnSelf();

// 在测试方法中设置第二次期望
$this->validatorBuilder->shouldReceive('fromYaml')->once()->andReturnSelf();

这种情况下，Mockery实际上要求fromYaml方法被调用两次：

• 第一次调用满足setUp中的期望（不限制次数）
• 第二次调用满足测试方法中的期望（精确一次）

正确实践方案

根据测试意图的不同，有以下几种解决方案：

方案一：统一期望设置

protected function setUp(): void
{
    $this->validatorBuilder = \Mockery::mock(ValidatorBuilder::class);
    $this->validatorBuilder->shouldReceive('fromYaml')
        ->once()
        ->andReturnSelf();
    // 移出测试方法中的重复设置
}

方案二：使用期望修改

public function testThatItUsesTheApiSpecification()
{
    // 修改已有期望而非新增
    $this->validatorBuilder->shouldReceive('fromYaml')
        ->once()
        ->andReturnSelf()
        ->ordered();
}

方案三：重置模拟对象

public function testThatItUsesTheApiSpecification()
{
    // 清除之前所有期望
    \Mockery::resetContainer();
    // 重新设置期望
    $this->validatorBuilder->shouldReceive('fromYaml')
        ->once()
        ->andReturnSelf();
}

深入理解

Mockery的这种设计实际上提供了更灵活的测试能力：

1. 允许为同一方法设置不同参数下的不同期望
2. 支持验证方法调用的顺序性
3. 可以模拟方法在不同调用次数下的不同行为

理解这一机制后，开发者可以更精确地控制测试预期，编写出更健壮的单元测试。

最佳实践建议

1. 保持期望设置的集中性，避免分散在多处
2. 使用once()、twice()等明确指定调用次数
3. 考虑使用Mockery::spy()当只需要验证调用而不关心次数时
4. 复杂场景下可使用atLeast()、atMost()等更灵活的验证方式

通过掌握Mockery的这些特性，开发者可以避免常见的测试陷阱，构建更可靠的测试套件。