手っ取り早く使ってみたかったので、最初に Jenkins からコーディング規
約チェック出来るようにしてみた。単体テストだと、最初にテストコード
を書かなくちゃいけないからね。

PHP_CodeSniffer のインストール

インストールすると、phpcs コマンドを使えるようになる。

pear コマンドでインストール出来るが、

% sudo pear install PHP_CodeSniffer

エラーが発生してインストールできなかったので、

downloading PHP_CodeSniffer-1.3.2.tgz ...
Starting to download PHP_CodeSniffer-1.3.2.tgz (328,845 bytes)
......................done: 328,845 bytes
PHP Fatal error:  Allowed memory size of 16777216 bytes exhausted (tried to allocate 23378 bytes) in /usr/share/pear/PEAR.php on line 252
PHP Stack trace:
PHP   1. {main}() /usr/share/pear/pearcmd.php:0
PHP   2. PEAR_Command_Common->run() /usr/share/pear/pearcmd.php:305
PHP   3. PEAR_Command_Install->doInstall() /usr/share/pear/PEAR/Command/Common.php:271
PHP   4. PEAR_Installer->install() /usr/share/pear/PEAR/Command/Install.php:708
PHP   5. PEAR_Installer->_installFile2() /usr/share/pear/PEAR/Installer.php:1406
PHP   6. PEAR->isError() /usr/share/pear/PEAR/Installer.php:600
PHP   7. is_a() /usr/share/pear/PEAR.php:252

/etc/php.ini をこのように修正した。

memory_limit = 16M
↓
memory_limit = 32M

※ 以降のどこの操作かは忘れましたが、同じ現象が発生したため、私の環
境では最終的に 256M に落ち着きました。

PHP_CodeSniffer をインストールできた。

% phpcs --version
PHP_CodeSniffer version 1.3.2 (stable) by Squiz Pty Ltd. (http://www.squiz.net)
% phpcs -i
The installed coding standards are MySource, PEAR, PHPCS, Squiz and Zend

CakePHP 用の規約は同封されていないので、別途インストールした。

% cd ~/tmp
% git clone git://github.com/jrbasso/CodeSniffer_CakePHP.git
% cd /usr/lib/php/pear/PHP/CodeSniffer/Standards
% sudo cp -r ~masutaka/tmp/CodeSniffer_CakePHP CakePHP

無事追加された。

% phpcs -i
The installed coding standards are CakePHP, MySource, PEAR, PHPCS, Squiz and Zend

app/controllers 以下とかでチェックできるようになった。

% phpcs --report=summary --report-checkstyle=phpcs.xml --standard=CakePHP --extensions=php .

Jenkins 側の設定

Git プラグインと、Check-Style プラグインのインストール

  1. トップの「Jenkinsの管理」>「プラグインの管理」をクリックする。
  2. 「利用可能」タブをクリックし、Git Plugin と Checkstyle Plugin を
    選択し、インストールする。

ジョブを作成する

  1. トップから「新規ジョブ作成」をクリックする。
  2. 「ジョブ名(要はプロジェクト名)」に適当な名前(例:hoge)を指定する。
    /var/lib/jenkins/workspace 以下に同じ名前のディレクトリが作られるの
    で英語名が良い。
  3. 「フリースタイル・プロジェクトのビルド」を選択し、OK をクリック。
  4. 「ソースコード管理システム」の Git を選択。Repository URL を指定
    する(例:/home/foo/hoge.git)。

Check-Style プラグインを設定する

  1. そのまま同じ設定画面の「ビルド」>「ビルド手順の追加」>「シェルの
    実行」をクリック。Controller と Model 以下の .php ファイルを対象と
    したい場合は、以下を設定する。
cd ${WORKSPACE}/app
mkdir -p results
find Controller Model -type f -name "*.php" ! -name AppController.php -print0 | \
	xargs -0 phpcs --report=summary --report-checkstyle=results/phpcs.xml --standard=CakePHP --extensions=php || id

※ １つでもエラーがあるとビルド失敗だと判断されてしまうので、この例
では最後に id コマンドを実行して、常にビルドが成功するようにしている。
2. 「ビルド後の処理」>「CheckStyle警告の集計」をクリック。「集計す
るファイル」に app/results/phpcs.xml を指定する。

あとはビルドを実行するだけ。警告出まくりだけど、Jenkins から
CakePHP コーディング規約をチェック出来た。

参考 URL:
CakePHPのコーディング規約違反をPHP_CodeSnifferでチェックする #CakephpAdvent2011 : candycane development blog