使用 PHPUnit 测试受保护方法的最佳实践

Question

我发现Do you test private method 上的讨论内容丰富。

我已经决定，在某些类中，我希望拥有受保护的方法，但要对其进行测试。 其中一些方法是静态的和简短的。因为大多数公共方法都使用它们，所以我以后可能可以安全地删除测试。但是为了从 TDD 方法开始并避免调试，我真的很想测试它们。

我想到了以下几点：

• Method Object 在an answer 中的建议似乎是矫枉过正。
• 从公共方法开始，当代码覆盖率由更高级别的测试提供时，将它们设为保护并删除测试。
• 继承具有可测试接口的类，使受保护的方法公开

最佳做法是什么？还有什么吗？

看起来，JUnit 自动将受保护的方法更改为公共的，但我没有深入了解它。 PHP 不允许通过 reflection 进行此操作。

Answer 1

您似乎已经意识到了，但我还是要重申一下；如果您需要测试受保护的方法，这是一个不好的迹象。单元测试的目的是测试一个类的接口，受保护的方法是实现细节。也就是说，在某些情况下它是有意义的。如果使用继承，则可以将超类视为为子类提供接口。因此，在这里，您必须测试受保护的方法（但绝不是 private 方法）。对此的解决方案是创建一个用于测试目的的子类，并使用它来公开方法。例如：

class Foo {
  protected function stuff() {
    // secret stuff, you want to test
  }
}

class SubFoo extends Foo {
  public function exposedStuff() {
    return $this->stuff();
  }
}

请注意，您始终可以用组合替换继承。在测试代​​码时，处理使用这种模式的代码通常要容易得多，因此您可能需要考虑该选项。

Answer 2

我认为 troelskn 很接近。我会这样做：

class ClassToTest
{
   protected function testThisMethod()
   {
     // Implement stuff here
   }
}

然后，实现如下：

class TestClassToTest extends ClassToTest
{
  public function testThisMethod()
  {
    return parent::testThisMethod();
  }
}

然后您针对 TestClassToTest 运行测试。

应该可以通过解析代码自动生成这样的扩展类。如果 PHPUnit 已经提供了这样的机制，我不会感到惊讶（尽管我没有检查过）。

Answer 3

我建议对“Henrik Paul”的解决方法/想法采取以下解决方法：)

你知道你的类的私有方法的名字。例如，它们就像 _add()、_edit()、_delete() 等。

因此，当您想从单元测试方面对其进行测试时，只需通过为一些 common 词添加前缀和/或后缀来调用私有方法（例如 _addPhpunit），这样当 __call() 方法调用所有者类的（因为方法 _addPhpunit() 不存在），您只需将必要的代码放入 __call() 方法中以删除前缀/后缀单词/s（Phpunit），然后从那里调用推导的私有方法。这是魔术方法的另一个好用处。

试试看。

Answer 4

您确实可以以通用方式使用 __call() 来访问受保护的方法。为了能够测试这个类

class Example {
    protected function getMessage() {
        return 'hello';
    }
}

你在 ExampleTest.php 中创建一个子类：

class ExampleExposed extends Example {
    public function __call($method, array $args = array()) {
        if (!method_exists($this, $method))
            throw new BadMethodCallException("method '$method' does not exist");
        return call_user_func_array(array($this, $method), $args);
    }
}

请注意，__call() 方法不会以任何方式引用该类，因此您可以为每个具有要测试的受保护方法的类复制上述内容，只需更改类声明即可。你也许可以把这个函数放在一个通用的基类中，但我还没有尝试过。

现在测试用例本身的不同之处仅在于您构造要测试的对象的位置，在 ExampleExposed 中交换为 Example。

class ExampleTest extends PHPUnit_Framework_TestCase {
    function testGetMessage() {
        $fixture = new ExampleExposed();
        self::assertEquals('hello', $fixture->getMessage());
    }
}

我相信 PHP 5.3 允许您使用反射来直接更改方法的可访问性，但我认为您必须为每个方法单独这样做。

Answer 5

如果您将 PHP5 (>= 5.3.2) 与 PHPUnit 一起使用，则可以通过在运行测试之前使用反射将它们设置为公共来测试私有和受保护方法：

protected static function getMethod($name) {
  $class = new ReflectionClass('MyClass');
  $method = $class->getMethod($name);
  $method->setAccessible(true);
  return $method;
}

public function testFoo() {
  $foo = self::getMethod('foo');
  $obj = new MyClass();
  $foo->invokeArgs($obj, array(...));
  ...
}

Answer 6

我要把我的帽子扔进擂台上：

我使用 __call hack 取得了不同程度的成功。 我想出的替代方案是使用访问者模式：

1：生成stdClass或自定义类（强制类型）

2：使用所需的方法和参数进行初始化

3：确保您的 SUT 有一个 acceptVisitor 方法，该方法将使用访问类中指定的参数执行该方法

4：将其注入您要测试的类中

5：SUT将操作结果注入访问者

6：将您的测试条件应用于访问者的结果属性

Answer 7

我想对uckelman's answer 中定义的getMethod() 提出一个细微的修改。

此版本通过删除硬编码值并稍微简化使用来更改 getMethod()。我建议将其添加到您的 PHPUnitUtil 类中，如下例所示，或者添加到您的 PHPUnit_Framework_TestCase 扩展类中（或者，我想，全局添加到您的 PHPUnitUtil 文件中）。

因为 MyClass 无论如何都会被实例化，而 ReflectionClass 可以采用字符串或对象...

class PHPUnitUtil {
    /**
     * Get a private or protected method for testing/documentation purposes.
     * How to use for MyClass->foo():
     *      $cls = new MyClass();
     *      $foo = PHPUnitUtil::getPrivateMethod($cls, 'foo');
     *      $foo->invoke($cls, $...);
     * @param object $obj The instantiated instance of your class
     * @param string $name The name of your private/protected method
     * @return ReflectionMethod The method you asked for
     */
    public static function getPrivateMethod($obj, $name) {
      $class = new ReflectionClass($obj);
      $method = $class->getMethod($name);
      $method->setAccessible(true);
      return $method;
    }
    // ... some other functions
}

我还创建了一个别名函数 getProtectedMethod() 来明确预期的内容，但这取决于你。

Answer 8

teastburn 有正确的方法。更简单的是直接调用方法并返回答案：

class PHPUnitUtil
{
  public static function callMethod($obj, $name, array $args) {
        $class = new \ReflectionClass($obj);
        $method = $class->getMethod($name);
        $method->setAccessible(true);
        return $method->invokeArgs($obj, $args);
    }
}

您可以通过以下方式在测试中简单地调用它：

$returnVal = PHPUnitUtil::callMethod(
                $this->object,
                '_nameOfProtectedMethod', 
                array($arg1, $arg2)
             );

Answer 9

替代方案。以下代码作为示例提供。 它的实施可以更广泛。 它的实现将帮助您测试私有方法并替换私有属性。

    <?php
    class Helper{
        public static function sandbox(\Closure $call,$target,?string $slaveClass=null,...$args)
        {
            $slaveClass=!empty($slaveClass)?$slaveClass:(is_string($target)?$target:get_class($target));
            $target=!is_string($target)?$target:null;
            $call=$call->bindTo($target,$slaveClass);
            return $call(...$args);
        }
    }
    class A{
        private $prop='bay';
        public function get()
        {
            return $this->prop;    
        }
        
    }
    class B extends A{}
    $b=new B;
    $priv_prop=Helper::sandbox(function(...$args){
        return $this->prop;
    },$b,A::class);
    
    var_dump($priv_prop);// bay
    
    Helper::sandbox(function(...$args){
        $this->prop=$args[0];
    },$b,A::class,'hello');
    var_dump($b->get());// hello

Answer 10

您可以在下面的代码中使用Closure

<?php

class A
{
    private string $value = 'Kolobol';
    private string $otherPrivateValue = 'I\'m very private, like a some kind of password!';

    public function setValue(string $value): void
    {
        $this->value = $value;
    }

    private function getValue(): string
    {
        return $this->value . ': ' . $this->getVeryPrivate();
    }

    private function getVeryPrivate()
    {
        return $this->otherPrivateValue;
    }
}

$getPrivateProperty = function &(string $propName) {
    return $this->$propName;
};

$getPrivateMethod = function (string $methodName) {
    return Closure::fromCallable([$this, $methodName]);
};

$objA = new A;
$getPrivateProperty = Closure::bind($getPrivateProperty, $objA, $objA);
$getPrivateMethod = Closure::bind($getPrivateMethod, $objA, $objA);
$privateByLink = &$getPrivateProperty('value');
$privateMethod = $getPrivateMethod('getValue');

echo $privateByLink, PHP_EOL; // Kolobok

$objA->setValue('Zmey-Gorynich');
echo $privateByLink, PHP_EOL; // Zmey-Gorynich

$privateByLink = 'Alyonushka';
echo $privateMethod(); // Alyonushka: I'm very private, like a some kind of password!