PHPUnitのテスト結果が見やすくなるプラグイン「phpunit-pretty-result-printer」



 PHPUnit のテスト結果を見易く表示してくれるプラグイン「phpunit-pretty-result-printer」の紹介です。

 PHPUnit は PHPでテストを書く時によく使われているTDD形式のライブラリで、PHPでプロジェクトを進めている時は 毎日のように使っている人も多いかもしれません。

 そんな PHPUnitの実行結果を 今以上に見通しを よくしてくれそうなプラグインが「phpunit-pretty-result-printer」です。

phpunit-result-printer で出来ること

- PHPUnit のテスト結果をグラフィカルに表示できる

phpunit-result-printer を適応してユニットテストを実行したGIF 


phpunit-result-printer のインストール

 phpunit-result-printer は コマンドライン上から ' composer ' を使ってインストールします。

# phpunit-result-printerをインストール * phpunitが 5.2以上の必要があります
composer require --dev codedungeon/phpunit-result-printer


phpunit-result-printer の設定

 phpunit-result-printer は、' phpunit.xml ' ファイルに 設定を一行追加するだけで適応させることができ、そのまま phpunitのテストコマンドを実行させれば適応されます。

<!-- phpunit タグ内に下の設定を追加 -->
printerClass="Codedungeon\PHPUnitPrettyResultPrinter\Printer"

<!-- 実際に追加する時は下記のようになります -->
<?xml version="1.0" encoding="UTF-8"?>
  <phpunit printerClass="Codedungeon\PHPUnitPrettyResultPrinter\Printer">
    // ....
  </phpunit>


また、' phpunit.xml ' に設定を追加しない場合は、phpunit 実行時に下記のオプションを渡せば実行時に プラグインが適応されます。

phpunit --printer=Codedungeon\\PHPUnitPrettyResultPrinter\\Printer

通常のPHPUnitと、phpunit-result-printerを適応させた時のユニットテストの結果画面の比較

phpunit-result-printerを通して、エラーが発生した時の画面


Summary

 以上が phpunit-pretty-result-printerの紹介でした。テスト項目が多いプロジェクトに適応させると、エラーを起こしたファイルがひと目でわかるようになります。

また、PHP 7.1以上をお使いの人は ' collision ' と組み合わせれば Unitテストの結果表示が更に良くなりそうです。

GitHub : mikeerickson/phpunit-pretty-result-printer

 

この記事のカテゴリ
プログラミング

この記事に付けられているタグ