JenkinsでPHPの継続的インテグレーションを体験する 規約チェック編

Checkstyleプラグインを利用してコーディング規約のチェックを行ってみましょう。

Yiiの規約をインストールする

せっかくなのでYiiの規約でチェックを行ってみましょう。
yii-coding-standardから拾ってきます。
事前に動作確認も行っておきます。

$git clone git://github.com/Ardem/yii-coding-standard.git Yii
$ln -s /path/to/CodeSniffer/Standards/ Yii/Yii
$phpcs -i
>The installed coding standards are Zend, PSR2, MySource, PHPCS, PSR1, Squiz, PEAR and Yii
$phpcs --report=checkstyle --standard=Yii --report-checkstyle=./_report/checkstyle.xml --extensions=php --ignore=assets/*,commands/*,config/*,runtime/*,tests/*,vendor/*,views/*,web/* .

ジョブの作成

インストールしたPHP_CodeSnifferとCheckstyleプラグイン連携させる為にジョブを作成する必要があります。
さっそくジョブを登録してみましょう。

新規登録

ジョブ名をcheckstyleで新規登録します。
タイプは「フリースタイル・プロジェクトのビルド」を選択して下さい。

ビルド手順の追加でphpcsを起動するスクリプトを追加します。

cd ${WORKSPACE} && sudo phpcs --report=checkstyle --standard=Yii --report-checkstyle=./_report/checkstyle.xml --extensions=php --ignore=assets/*,commands/*,config/*,runtime/*,tests/*,vendor/*,views/*,web/* . || id

ビルド完了後に./_report/checkstyle.xmlが出力されるので集計します。

_report/checkstyle.xml

ジョブの実行

設定が完了したらジョブを実行してみましょう。
ジョブのメニューからビルドを実行して下さい。

実行中のプログレッシバーが表示されます。
しばらく待ちましょう。

規約は自分で修正することも可能なので、レポートを確認しながら適時調整してみてください。