有没有办法让PHPUnit确定@method声明的代码覆盖率？

Question

我在类中使用标准phpdoc @method语法声明了许多方法，例如：

/**
 * @method string magicMethod(int $arg1, array $arg2) Method description.
 */
class ... { }

确定方法级代码覆盖率时，是否可以将PHPUnit配置为对照这些注释进行检查？ 目前，我的覆盖率是100％，尽管到目前为止，我仅接触了其中10％的魔术方法。

Answer 1

代码覆盖率只能基于现有代码来计算，而不能基于“虚拟”方法来计算。

为了获得更真实的统计信息，您应该减少意外生成的覆盖范围。 使用默认配置时，PHPUnit确实会为要执行的每一行代码生成覆盖率-这很糟糕，因为如果您无意间沿着没有经过断言测试的行运行，那么覆盖率根本无法告诉您任何信息（除了那里没有错误的事实）。

查看手册中的代码覆盖率章节时，您会看到可以指定要用测试测试的方法，并且只有那些方法才能生成覆盖率统计信息（“指定覆盖方法”一节）。

我更喜欢的方法是在phpunit.xml文件中设置选项mapTestClassNameToCoveredClassName="true" ，并将所有要测试的类添加到白名单中。 这样，覆盖范围将自动仅限于与测试类具有相同名称（减去后缀“ Test”）的类。 因此，如果您有一个测试“ MyGreatModelTest”，它将仅在“ MyGreatModel”类的任何方法中创建覆盖率，而不会在其他任何地方创建覆盖率。

而且，如果将包含代码的整个目录添加到白名单中，那么您还将捕获所有确实生成了0％覆盖率的文件，因此到目前为止它们还没有包括在统计信息中。

当心：这些设置可能会伤害您的感觉，但是它们将使您更加真实地了解哪些代码行在测试期间真正运行，哪些仅作为副作用通过。

Answer 2

PHPUnit使用适用于您的TestCase类的自身注释。 它不会解析测试类上的注释。

要限制特定测试的代码覆盖率分析期间使用的源代码行，必须使用@covers批注。

如果在测试的类中使用魔术方法：

/**
 * @covers My\Class::__call
 */
public function testMyMagicMethod()
{
     $this->assertSomething($this->subject->magicMethod());
}

由于__call（）是在您测试的类中调用的实际方法，因此覆盖的源代码行应位于其中。

Answer 3

我知道这已经很老了，但是您要寻找的答案是模拟__call方法。

$this->clientMock->expects(static::at(1))
        ->method('__call')
        ->with('get', [RedisAdapter::CONNECTION_TEST])
        ->will(static::returnValue(RedisAdapter::CONNECTION_TEST_VALUE));