[PHP] TraitのUnitテスト

PHPのtraitのユニットテストを書く方法です。

public関数

以下のようなtraitのpublicな関数を考えます。

<?php

trait SomeTrait
{
    public function greet(): string
    {
        return 'hello';
    }
}

traitを取り込んだテスト用のクラスを作ることでテストができます。

class TestTraitClass
{
    use SomeTrait;
}

-----

// チェック
$SUT = new TestTraitClass();
self::assertEquals('hello', $SUT->greeet());

もしくは、無名クラスでもOK。

$SUT = new class() { use SomeTrait; };
self::assertEquals('hello', $SUT->greeet());

protected関数

以下のように、テストしたいメソッドがprotectedな関数のときは一工夫が必要です。

<?php

trait SomeTrait
{
    protected function protectedGreet(): string
    {
        return 'hello';
    }
}

やることとしては、traitを取り込んだテスト用のクラスを作る時に、traitのメソッドをpublicでオーバーライドします。

皆れない構文ですが、traitをuseするときに{}で囲うことで、traitのメソッドに別名をつけることができます。
あとは、テストしたいメソッドと同名のメソッドをpublicで定義し、別名をつけたprotectedなtraitのメソッドに処理を委譲すればOKです。

class TestTraitClass
{
    use SomeTrait {
        protectedGreet as protected traitMethod;
    };

    public function protectedGreet(): string
    {
        return $this->traitMethod();
    }
}

終わりに

protected関数をテストしたくなること自体どうなの？って気持ちはあるけど、知ってて損はないかも。