privateメソッドのユニットテストは書くの？書かないの？

privateメソッドのユニットテストを書きたいんだけど

privateメソッドをテストする４つの方法

パブリックメソッド経由でテストする

class Foo
{
    public function bar()
    {
        $c = $this->tiny($a, $b):
    }

    private function tiny($a, $b)
    {
    }
}Code language: PHP (php)

別クラスのpublicメソッドにする

class Foo
{
    public function bar()
    {
        $baz = new Baz();
        $c = $baz->tiny($a, $b);
    }
}

class Baz
{
    public function tiny($a, $b)
    {
    }
}Code language: PHP (php)

テスト対象の可視性を（やや）上げる

class Foo
{
    private function tiny($a, $b)
    {
    }
}Code language: PHP (php)

class Foo
{
    protected function tiny($a, $b)
    {
    }
}Code language: PHP (php)

class FooMock extends Foo
{
    public function tiny($a, $b)
    {
        return parent::tiny($a, $b);
    }
}Code language: PHP (php)

privateのまま、リフレクションでアクセスしてテストを書く

class Foo
{
    private function tiny($a, $b)
    {
    }
}

class FooTest
{
    public function testTiny()
    {
        $foo = new Foo();
        $tiny = new ReflectionMethod(get_class($foo), 'tiny');
        $tiny->setAccessible(true);

        // $c = $foo->tiny($a, $b); と同等
        $c = $tiny->invoke($foo, $a, $b);
    }
}Code language: PHP (php)

なぜprivateメソッドはテストしなくてもいいのか？

内部の変数をチェックしてはいけない

コードがきちんと動いているかどうかを変数を使って確かめたくなるときは、設計を改善する機会であると私は考えている。不安に負けて変数をチェックしてしまえば、改善の機会は失われる。

『テスト駆動開発』 第29章 xUnitのパターン p.226

ContractオブジェクトがStatusオブジェクトを保持していて、そのStatusは具体的にはOfferedクラスかRunningクラスのどちらかのインスタンスだとする。実装を想像して次のようなテストを書いてしまいがちだ。

ContractTest.java

Contract contract = new Contract(); // ステータスはOffered
contract.begin(); // ステータスをRunningに変更
assertEquals(Running.class, contract.status.class);Code language: Java (java)

このテストは実装に依存しすぎている。statusの表現が真偽値に変わっても通るようなテストを書きたい。statusがRunningに変わったのなら、開始日を尋ねてみるのはどうだろうか。

// ステータスがOfferedのときは例外が発生する
assertEquals(today, contract.startDate());Code language: Java (java)

privateメソッドのテストは内部の実装のテストになりやすい

しかし、プライベートメソッドに対するテストは内部の実装に対するテストになってしまうことが多く、そして内部の実装に対するテストはリファクタリングの妨げになりがちです。

設計が浮かばないときは、変数をチェックする

リフレクションを使えばプライベートなメソッドのテストは「できる」のですが、そのテストはやがて実装改善の邪魔になりかねません。

まとめ