PHPUnitで保護されたメソッドをテストするためのベストプラクティス

私は上の議論見つけ、あなたがプライベートメソッドのテストドゥ参考に。

一部のクラスでは、メソッドを保護したいが、それらをテストしたいと思いました。これらのメソッドのいくつかは静的で短いものです。ほとんどのパブリックメソッドはそれらを使用するため、後でテストを安全に削除できるでしょう。しかし、TDDアプローチから始めてデバッグを回避するために、私は本当にそれらをテストしたいと思います。

私は次のことを考えました：

• 回答でアドバイスされているメソッドオブジェクトは、これではやり過ぎのようです。
• パブリックメソッドから開始し、上位レベルのテストによってコードカバレッジが提供されたら、それらを保護してテストを削除します。
• 保護されたメソッドをパブリックにするテスト可能なインターフェイスを持つクラスを継承します

ベストプラクティスはどれですか。他に何かありますか？

JUnitは自動的に保護されたメソッドをパブリックに変更するようですが、私はそれを深く見ていませんでした。PHPはリフレクションを介してこれを許可しません。

PHPUnitでPHP5（> = 5.3.2）を使用している場合、テストを実行する前にリフレクションを使用してプライベートメソッドと保護されたメソッドをパブリックに設定することでテストできます。

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(...));
  ...
}

あなたはすでに気づいているようですが、とにかく言い直します。保護されたメソッドをテストする必要がある場合、それは悪い兆候です。ユニットテストの目的は、クラスのインターフェースをテストすることであり、保護されたメソッドは実装の詳細です。そうは言っても、それが理にかなっている場合があります。継承を使用する場合、スーパークラスがサブクラスのインターフェースを提供していると見ることができます。したがって、ここでは、保護されたメソッドをテストする必要があります（ただし、プライベートメソッドは使用しないでください）。これに対する解決策は、テスト目的でサブクラスを作成し、これを使用してメソッドを公開することです。例えば。：

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

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

継承は常に合成で置き換えることができることに注意してください。コードをテストする場合、通常、このパターンを使用するコードを処理する方がはるかに簡単なので、そのオプションを検討することをお勧めします。

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)
             );

で定義されているgetMethod（）にわずかなバリエーションを提案したいと思います uckelmanの回答でます。

このバージョンでは、ハードコードされた値を削除し、使用法を少し簡略化することにより、getMethod（）を変更しています。以下の例のように、PHPUnitUtilクラスに追加するか、PHPUnit_Framework_TestCase-extendingクラスに追加することをお勧めします（または、おそらく、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（）も作成して、予期されるものを明示的にしましたが、それはあなた次第です。

乾杯！

troelsknは近いと思います。代わりにこれを行います：

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

次に、次のようなものを実装します。

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

次に、TestClassToTestに対してテストを実行します。

コードを解析することにより、このような拡張クラスを自動的に生成できるはずです。PHPUnitがすでにそのようなメカニズムを提供していても驚かないでしょう（私はチェックしていません）。

ここで帽子をリングに投げ込みます。

__callハックを使用して、成功の度合いはさまざまです。私が思いついた別の方法は、訪問者パターンを使用することでした：

1：stdClassまたはカスタムクラスを生成する（型を強制するため）

2：必要なメソッドと引数でそれを準備する

3：SUTに、Visitingクラスで指定された引数を使用してメソッドを実行するacceptVisitorメソッドがあることを確認します。

4：テストするクラスに挿入します

5：SUTは操作の結果をビジターに挿入します

6：訪問者の結果属性にテスト条件を適用する

実際、一般的な方法で__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では、リフレクションを使用してメソッドのアクセシビリティを直接変更できると思いますが、メソッドごとに個別に変更する必要があると思います。

「ヘンリクポール」の回避策/アイデアのための次の回避策をお勧めします:)

クラスのプライベートメソッドの名前を知っている。たとえば、_add（）、_ edit（）、_ delete（）などです。

したがって、単体テストの側面からテストしたい場合は、いくつかの一般的なプレフィックスまたはサフィックスを付けてプライベートメソッドを呼び出すだけです。 __ call（）メソッドが呼び出されたときに（メソッド_addPhpunit（）が呼び出されないように、単語（たとえば_addPhpunit）のサフィックスを存在）の所有者クラスの場合、__ call（）メソッドに必要なコードを挿入して、接頭辞付き/接尾辞付きの単語（Phpunit）を削除し、そこからその推論されたプライベートメソッドを呼び出します。これは、魔法の方法のもう1つの良い使い方です。

やってみよう。