Magento2项目中PHPUnit Mock类方法未纳入代码覆盖率的解决办法

嘿，我完全懂你在Magento2项目里遇到的这个痛点——用PHPUnit写单元测试时，Mock类的方法死活不被算进代码覆盖率，官方还说这是默认行为，确实挺闹心的。下面给你几个可行的解决思路，你可以根据自己的场景选：

1. 用@covers注解明确指定要覆盖的Mock方法 #

如果只是想统计某个特定Mock方法的调用情况，可以在测试方法上添加@covers注解，明确指向你要覆盖的类和方法。比如：

/**
 * @covers \Your\Magento\Module\Model\YourClass::yourMethod
 */
public function testYourMethod()
{
    $mock = $this->getMockBuilder(\Your\Magento\Module\Model\YourClass::class)
                 ->onlyMethods(['yourMethod'])
                 ->getMock();
    
    // 执行测试逻辑，调用mock的yourMethod
    $mock->yourMethod();
}

这样PHPUnit就会把这个Mock方法的调用纳入覆盖率统计了。如果要覆盖整个类的方法，可以用@coversDefaultClass \Your\Magento\Module\Model\YourClass。

2. 让Mock调用原始类方法（适用于需要执行真实逻辑的场景） #

如果你希望Mock在调用方法时执行原始类的真实代码，那么这些代码的执行自然会被统计进覆盖率。可以用enableProxyingToOriginalMethods()方法：

$mock = $this->getMockBuilder(\Your\Magento\Module\Model\YourClass::class)
             ->enableProxyingToOriginalMethods()
             ->onlyMethods(['otherMethod']) // 只Mock特定方法，其他方法走原始逻辑
             ->getMock();

这种方式适合你需要Mock部分方法，但保留其他方法真实逻辑的场景，原始方法的执行会被正常统计。

3. 调整PHPUnit的覆盖率过滤规则（不推荐，除非必要） #

官方默认不统计Mock是因为它们是动态生成的代理类，不属于你的项目业务代码。但如果你一定要把它们加进去，可以在phpunit.xml的<filter>配置里，把原始被Mock类的路径加入白名单：

<phpunit ...>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <!-- 你的项目代码目录 -->
            <directory suffix=".php">./app/code/Your/Module</directory>
            <!-- 加入原始被Mock类的路径，确保它们被纳入统计 -->
            <file>./app/code/Your/Module/Model/YourClass.php</file>
        </whitelist>
    </filter>
</phpunit>

不过要注意，这种方式可能会把一些无关的代码也统计进来，所以建议精准指定文件，而不是整个目录。

小提醒 #

其实官方默认不统计Mock是有道理的——Mock类本身不是你写的业务代码，统计它们可能会让覆盖率数据失真，掩盖真实未覆盖的业务逻辑。所以除非你有特别的需求（比如验证Mock方法的调用次数是否符合预期），否则优先考虑前面两种更精准的方式。

内容的提问来源于stack exchange，提问作者Kapil Yadav