PHPUnitでカバレッジがうまく取れなくて嵌った話

実際に上記の図のサンプルコードの様に記載していきました。
こちらのアノテーションが起因していました。

見落としていたもの

調べていて初めて気づきました orz

@covers アノテーションが利用された場合、出力されるコードカバレッジの算出方法が変わります。 アノテーションで自身を指定するテストから実行された場合のみ、「covered」と判定されます。 アノテーションで自身を指定していないテストから間接的に利用されたとしても、「covered」とは判定されません。 これによって、コードカバレッジが実際よりも高く出る false positive を避けることができます。

確かにテストコード内で直接呼び出しを行っているコード。。特にprivateメソッドは全てカバレッジが取得されていませんでした。

対応したこと

• テストクラスのdocblokに @coversDefaultClass に指定したクラスを @covers にも指定する
• 上記とあわせて、テスト対象クラスが依存しているファイルもあわせて @covers に追加する
  単体テストが書かれているものは記載せず、単体テストが難しい ^[1] クラス。。例えばEloquentモデルとかを追加
• PHPUnitの設定に forceCoversAnnotation="true" を追加
  これを入れておくとテスト実行時にアノテーションが未指定の場合にWARNとなります

やらなかったこと

このアノテーションはテストクラスの docblock に記載することも、個別のテストメソッドの docblock に記載することもできますが、 テストクラスの docblock に記載することが推奨され、個別のテストメソッドの docblock に記載することは推奨されません。

@covers を個別のテストメソッドの docblock に記載することは推奨されないっぽいですが、上述のIDEの恩恵にあやかりたく、直接テストメソッドまでjumpさせたかったのでこちらの推奨は守りませんでした

所管

@coversDefaultClass をテストクラスの docblock に記載したら、その対象クラスが全て全てcoverage対象になってくれれば良いのに。。と思いつつも

コードカバレッジが実際よりも高く出る false positive を避けることができます。

こちらを優先されたんだろうなーと。
厳密にテスト対象を把握させろ（しろ）という意思を感じました

この記事で伝えたかったこと

ですハイ。
肝に命じます。。
あと @covers の指定はこうやって書くんだよーというのがあれば知りたいです。