PHPUnit 严格模式 - setUp() - 覆盖范围

Question

当我遇到代码覆盖问题时，我目前开始在 PHPUnit 中使用 strict-Mode：

如果我使用setUp-方法创建我的类的新实例，__constructor-方法会列在我运行测试时所涵盖的代码覆盖范围中。

这是我的测试设置：

phpunit.config.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.5/phpunit.xsd"
    bootstrap="../vendor/autoload.php"
    backupGlobals="false"
    backupStaticAttributes="false"
    colors="true"
    verbose="true"    
    beStrictAboutOutputDuringTests="true"
    beStrictAboutTestSize="true"
    beStrictAboutTestsThatDoNotTestAnything="true"
    beStrictAboutTodoAnnotatedTests="true"

    checkForUnintentionallyCoveredCode="true"
    processIsolation="false"
>
<testsuites>
    <testsuite name="FooTests">
        <directory suffix="Test.php">../tests</directory>
    </testsuite>
</testsuites>
<filter>
    <whitelist>
        <directory suffix=".php">../src</directory>
    </whitelist>
</filter>
<logging>
    <log type="coverage-html" target="coverage/" higlight="true" showUncoveredFiles="true"></log>    
</logging>

Foo.php

class Foo
{

    protected $_bar;

    public function __construct($bar)
    {
        $this->_bar=$bar;             //Line 10
    }                                 //Line 11

    public function getBar()
    {
        return $this->_bar;
    }

    public function getBar2()
    {
        return $this->_bar;
    }

}

和测试：FooTest.php

class FooTest extends \PHPUnit_Framework_TestCase
{

    protected $_foo;

    protected function setUp()
    {
        $this->_foo=new Foo(10);
    }

    public function testGetBar()
    {
        $this->assertSame(10, $this->_foo->getBar());
    }

    /**
     * @covers Foo::getBar2
     */
    public function testGetBar2()
    {
        $this->assertSame(10, $this->_foo->getBar2());
    }

}

如果我运行测试，我会得到以下结果：

PHPUnit 4.5.0 by Sebastian Bergmann and contributors.

Configuration read from C:\xampp\htdocs\unittest\build\phpunit.config.xml

.R

Time: 88 ms, Memory: 3.50Mb

There was 1 risky test:
1) FooTest::testGetBar2
This test executed code that is not listed as code to be covered or used:
- C:\xampp\htdocs\unittest\src\Foo.php:10
- C:\xampp\htdocs\unittest\src\Foo.php:11

OK, but incomplete, skipped, or risky tests!
Tests: 2, Assertions: 2, Risky: 1.

Generating code coverage report in HTML format ... done

只要我在测试中指定@covers，就会出现问题。

这是预期的行为吗？

我尝试过的一些事情：

• 将checkForUnintentionallyCoveredCode 更改为false 显然可行，但我想使用此功能...
• 使用processIsolation="true" 也可以。不知道为什么？
• 将@covers 或@uses 添加到setUp() 不起作用
• 将setUp() 用于测试的@covers 添加到测试中确实有效，但测试实际上并未涵盖代码。 （如果测试变得更复杂，这似乎是很多写作......）
• 不同的phpunit-Version：我用4.3 和4.5 进行了尝试，结果相同
• 不同的 PHP 设置：我在带有 XAMPP 和 LinuxMint 的 Win8 上尝试了这个 - 结果相同

有没有办法从代码覆盖中删除setUp() 代码，并在测试中使用@covers 以及他们实际测试的方法？

编辑：这也会影响继承。因此，如果Bar 扩展Foo，并将参数传递给Foo::__construct，这也将出现在代码覆盖范围内——这使得为__construct 编写@covers 是一件痛苦的事情。

附加信息：

PHP 5.6.3 (cli) (built: Nov 12 2014 17:18:08)
Copyright (c) 1997-2014 The PHP Group
Zend Engine v2.6.0, Copyright (c) 1998-2014 Zend Technologies
with Xdebug v2.2.5, Copyright (c) 2002-2014, by Derick Rethans

Answer 1

自从这个问题开始获得一些动力：这是我对这个问题的一种解决方案。

Foo 的 unit-test (FooTest) 将始终使用 Foo，因此我将@uses Foo 添加到课程中。

如果 protected/private 函数被 public 函数使用，这也很重要，因为否则您必须将每个 protected/private 函数添加到测试中，如果类在内部使用该函数。我什至认为如果您进行单元测试是错误的，因为单元测试必须不关心类如何“填充”，它应该只断言特定输入导致特定输出。

（另外：构造函数应该只做赋值，没有别的。）

添加@uses后，错误将消失。

（您可以将@covers Foo::_construct 添加到类中以覆盖您的构造函数的代码。）

/**
 * @uses Foo 
 * (optional)@covers Foo::__construct
 */
class FooTest extends \PHPUnit_Framework_TestCase
{
    protected $_foo;

    protected function setUp()
    {
        $this->_foo=new Foo(10);
    }

    public function testGetBar()
    {
        $this->assertSame(10, $this->_foo->getBar());
    }

    /**
     * @covers Foo::getBar2
     */
    public function testGetBar2()
    {
        $this->assertSame(10, $this->_foo->getBar2());
    }
}

Answer 2

您已使用checkForUnintentionallyCoveredCode="true" 指定了严格的覆盖范围。由于PHPUnit 4.0 PHPUnit 具有以下行为：

处理无意覆盖的代码

PHPUnit 4.0 可以选择性地对无意覆盖的代码进行严格处理（严格 > 覆盖模式）。启用后，PHPUnit 将无法通过使用 @covers 注释的测试并执行未使用 @covers 注释指定的代码。

Answer 3

在 PHPUnit >= 6.0 上将 phpunit.xml 上的 beStrictAboutCoversAnnotation 设置为 false：

<phpunit
     // ....     
     beStrictAboutCoversAnnotation="false"
>
// ....

另外，你可以在没有 --strict-coverage 的情况下运行 phpunit

更多信息Risky Tests: Unintentionally Covered Code

Answer 4

我认为接受的答案不正确。它基本上说这个类中的任何东西都可以使用。这可能是也可能不是你想要的。特别是如果您想确保您的 testGetBar2() 方法不使用您无法使用的其他代码。

你可以做的是ignore你的设置方法做了什么。

    /**
     * @codeCoverageIgnore
     */
    protected function setUp()
    {
        $this->_foo=new Foo(10);
    }

这样，您在设置中添加的任何内容都不会被视为经过测试的代码，但您具体涉及的任何内容都会显示出来。

https://phpunit.de/manual/3.7/en/code-coverage-analysis.html#code-coverage-analysis.ignoring-code-blocks