自分で使っていないのでPull Requestとか来てもそれが有効なものなのか判断がすぐにつかず、取り込むのが遅れてしまったり大丈夫だろうという軽い気持ちで取り込んでしまったりする恐れがあるため、誰かCIを現役で使っていてメンテやってくれる人いないかな〜とtwitterでつぶやいてみたところ、@NEKOGETさんが快くやってくれることになりました。

NEKOGETさんとは一度も会ったことはありませんが、twitter上では何度かやり取りしたことがあり、FuelPHPのドキュメントの日本語訳をこまめにやってるなぁ〜とずっと思っていました。NEKOGETさんは現役でCI、CIUnitを使っているらしく、これからも必然的にメンテが必要になるようでしたので、メンテをしてもらえないかとお願いしたところあっさり引き受けてもらえました。

NEKOGETさんありがとうございます！

CIUnit-for-CI2は、まだ自分が業務でCI2を使っている時にCIUnitのコードを見てなんとなく動くんじゃないかと思って修正したものが実際にCI2でも動作したのでgithub上で公開したわけですけど、コレまでいくつかPull Requestもいただいていて実際に使ってもらえてるようです。

自分の作ったコードを他人が使ってくれているというのは凄い励みになりますし、使ってくれるだけでなく、メンテまでやってもらえるなんて作った甲斐があります。これでCIUnit-for-CI2もメンテしてくれない自分じゃなく、メンテしてくれる（はず）のNEKOGETさんの手に渡って嬉しく思っていることでしょう。

CIUnit-for-CI2をこれからもよろしくお願いします。

そんな先行き不安なCodeIgniterのライブラリである「ci-log4php」に新たに機能を追加しました。

Issue #2: Allow array config params · fukata/ci-log4php

目的はlog4phpの動的な設定。

LoggerConfiguratorPhpを使えば、指定したphpファイルの設定を適用できるが、その中で利用できる値については、呼び出し元とスコープが異なるため、グローバルなどに変数を展開しておかないと利用できないと思われる。そこで、直に設定用変数をconfigureメソッドに渡せるようにLoggerconfiguratorPhpVariableというのを新たに追加しました。

コード自体もLoggerConfiguratorPhpとほぼ同じで、phpファイルから値を取得する部分がなくなっているだけです。

Issueでlog4php自体はPEARからインストールしたものを使いたいという要望があるが、log4php自体も修正しているので、コレは今のところスルーしようと思っています。確かにPEARのものをそのまま使えた方がバグフィックスなどに対応できるので良いのだけど、自分自身が既に使わなくなってしまっているので、それに対応しようという気が起きない。誰か熱心に使ってくれている人が居れば、forkしてそういう修正を加えてくれると嬉しいです。

自分も度々CIUnitをCIに適用しているとdatabase.phpの編集が特にめんどくさく感じていました。

で、簡単なインストールスクリプトを書いてみました。今のところ、CI v2.0.3を解凍した段階のプロジェクトには適用できると思います。

CIUnit Install Script — Gist

今回のインストールスクリプトについては、個人的にメンテナンスしているCIUnitのプロジェクトの方にも追加しておきました。

fukata/CIUnit-for-CI2 – GitHub

CodeIgniter用のCodeSnifferを作成してくれている方がいたので、forkして、正常に動作するように修正しました。（回避コードを追加しただけ）

バグの方は本家のIssueに登録しましたので、詳しくはそちらを参照下さい。

#8: segmentation fault – Issues – thomas-ernest/CodeIgniter-for-PHP_CodeSniffer – GitHub

また、今回使用したソースは下記のリポジトリにアップしています。

fukata/ciunit2_and_jenkins – GitHub

PHPによるJenkinsのインストールなどについては、下記のサイトがとても参考になりました。

PHPでTDD&CIワークショップ、Jenkins + PHP の各種プラグインパート資料 – Yamashiro0217の日記
Symfony2でJenkinsを使ってCI « symfonyで開発日記

今回はUbuntu 10.04 Server版を使ったため、Jenkinsはapt版を入れています。インストール方法はここに書かれている通りです。

wget -q -O - https://pkg.jenkins-ci.org/debian/jenkins-ci.org.key | sudo apt-key add -
sudo vim /etc/apt/sources.list
> 末尾に追加: deb https://pkg.jenkins-ci.org/debian binary/
sudo apt-get update
sudo apt-get install jenkins

build.xml作成

Jenkinsからプロジェクトをビルドする際に使用するbuild.xmlは上記のサイトでも行われているppwコマンドを利用しました。今回のプロジェクトだと下記のようになりました。

cd ciunit2_and_jenkins
ppw --name ciunit2_and_jenkins --source ./src/application/ --tests ./src/application/tests/ --bootstrap ./src/application/third_party/CIUnit/bootstrap_phpunit.php --phpcs PEAR .

ただ、CIUnitの場合、sourceで指定したディレクトリ内にCIUnitやtestsコードが含まれている為、これらを解析対象から除外したい場合には下記のように、生成されたbuild.xmlを修正します。

--- build.xml	2011-07-27 10:41:01.164477818 +0800
+++ build.xml.new	2011-07-27 10:40:51.814477818 +0800
@@ -49,7 +49,8 @@
    
+              --reportfile ${basedir}/build/logs/pmd.xml
+              --exclude third_party/CIUnit/" />
   
  
 
@@ -61,7 +62,7 @@
 
  
   
-   
+   
   
  
 
@@ -70,13 +71,14 @@
    
   
  
 
  
   
-   
+   
   
  

CodeIgniter用のCodeSniffer

ppwコマンドの–phpcsオプションでコードのスタイルチェックのモジュールを選べます。先ほどのコマンドではPEARを選択（デフォルトでもPEAR）したのですが、PEARのコード規約とCodeIgniterのコード規約がところどころ異なっており、CodeIgniterの規約的には正しいのに間違ってると警告されます。

上記のページを参考にphpcsをインストールした場合、linuxの場合、下記のディレクトリにインストールされていると思います。

/usr/share/php/PHP/CodeSniffer/Standards

初期でインストールされているのは、下記のみです。

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

インストールされているものを参考にCodeIgniter用のCodeSnifferを作成すれば、コードチェックについても正常に行えるようになります。

で、少し探してみたのですが、CodeIgniter用のCodeSnifferが見つからなかったので、作る必要があるかもしません。とりあえず、先走り気味にリポジトリだけ作成しました。

fukata/codesniffer_codeigniter – GitHub

@yterajimaさんから下記のリポジトリを教えてもらったので、これをforkすることにしました。
thomas-ernest/CodeIgniter-for-PHP_CodeSniffer – GitHub

おまけ：githubのプライベートリポジトリを利用する

jenkinsのgit pluginからgithubのプライベートリポジトリを利用する機会があったので、その時にはまったことについて書いておきます。

はまったのは、gitへ接続する際に利用するssh keyの設定についてです。

apt版jenkinsの場合、jenkinsの実行にはjenkinsユーザが行っているかと思います。そのjenkinsユーザのホームディレクトリが/var/lib/jenkinsに設定されており、/var/lib/jenkins/.sshがあるので、そこに必要な鍵等を入れます。で、次にjenkinsユーザでログインし、下記のコマンドでgithubに一度繋いでおきます。

ssh git@github.com

これで、jenkinsで、githubのプライベートリポジトリに対してgit cloneを正常に行えるようになります。

今回は他のフレームワークでよくあるような、表示する変数にデフォルトでエスケープするような処理を書いてみました。

動作検証はv2.0.2で行っています。実際に利用する場合は、下記のファイルを適当な場所にコピーしてもらい、escape_helperをロードしてください。また、application/config/config.phpに下記を追加してください。

$config['display_vars_default_escape'] = TRUE;

エスケープ前のデータが欲しい場合は「r」メソッドを使ってデコードするようにしました。

MY_Loader.php

64行目付近がその処理になります。

escape_helper.php

CIUnit本家の更新が３ヶ月ほど行われておらず、CodeIgniter 2.0.2への対応がされていなかったので、対応版として下記にアップしました。

fukata/CIUnit-for-CI2 – GitHub

まだ、完全に対応しきれているのか不明点はありますが、fixtureのロードやcontrollerやmodelのインスタンスは正常に取得できており、サンプルのテストコードは動作しています。

今回は、2.0.2へ対応した際に行ったこと（修正箇所）を書いておきます。

ディレクトリ構成の変更

本家のリポジトリをcloneして中身を確認したところ、applicationとtestsが同じディレクトリに存在していましたが、testsはapplication毎に書くだろうと思い、applicationの直下に移動しました。通常applicationは１つしかありませんが、場合によっては複数のapplicationからsystemを共有するような構成を取る場合もあると思ったからです。

ただ、これはCIUnitの動作に関係なく、私個人の好みが強く含まれているので、もしapplicationと同じディレクトリにtestsを置きたい場合はtestsディレクトリへのパスやphpunit.xml内に記載されているbootstrap_phpunit.phpへのパス等を修正してください。

CIUnit_Versionへの統一

本家のコードを見た時にCIUnitとCIUnit_Versionという二つの定数が定義されており、どちらも同じような意味で利用されていたので、CIUnit_Versionに全て統一しました。phpunit.xml内に定義されたCIUnitの値を見ても0.17とバージョンと思われる値だったのと、CIUnitはクラス名として定義されていたので紛らわしいと思い、CIUnit_Versionに統一しました。

phpunit.xmlの使用に限らずテスト実行

CIUnit定数がphpunit.xml内で定義されている為、本家のコードだとphpunit.xmlを使用して実行された場合にしか正しくテストが実行されませんでしが、phpunit.xmlの使用に関係なくテストが実行されるように変更しました。

コレは意図的にこのような実装を行っていたのかそれとも単なるバグなのか、実はよく分かっていません。テスト用のbootstrap経由で画面表示の確認（テスト用DBだけを使用等）などを行っていたという方居ればこの修正は、以前のものに変更したいと思います。

絶対パスの使用

third_party/CIUnit/bootstrap_phpunit.php内に相対パスで定義された場所があったので、dirname(__FILE__)を使用する形に変更しました。相対パスだと実行場所が限られてしまう可能性があるためです。

その他いくつかバグ修正

その他、戻り値が参照渡しになっていなかったり、変数名が間違っていた箇所を修正しています。

まとめ

• 本家コードの大部分が動いたので良かった
• PHPUnit最高
• 早く本家のメンテナンスが再開されて欲しい

をコマンドラインからテストする際はphpunitコマンドを叩けば良いのですが、Eclipseから利用する場合には「外部ツール」を設定します。MakeGoodというのがCIUnitにも対応している（設定項目は有）ようなのですが、動かなかったので、今回は外部ツールの設定を書いておきます。

外部ツール設定

[実行] -> [外部ツール] -> [外部ツールの設定]から以下の2つを設定します。

phpunitコマンドのパスについては、各自の環境で合わせてください。

CIUnit AllTests

phpunit.xmlを利用し、全テストを行います。

CIUnit UnitTest

選択中リソースのテストを行います。選択中リソースとは、PHPExplorerで選択しているフォルダやファイルのこと。フォルダを選択していれば、フォルダ内のファイルを全てテストします。

CIUnit AllTestsを実行した時にコンソールに表示された文字が文字化けする可能性があります。その時は、phpunit.xml内にあるcolors=”true”をfalseに変更してみてください。多分これで文字化けは解消すると思います。

ソースコードは下記に置いています。

fukata/CIUnit-for-CI2 – GitHub

本家をforkした方が良いかなと思ったのですが、個人的にMercurialは使いにくいのでgithubに作りました。本家が2.xへの対応をしてくれると信じ、とりあえずのリポジトリ程度にしか考えていません。

冒頭にも書いたようにデフォルトのテストコードが動作する（一部モデルの追加が必要）程度に修正したところです。なので、まだ全機能のテストが出来るとは思えません。自分自身も未検証状態です。実用的なソリューションなので、少しずつ修正していきたいと思います。

あと、自分自身が本家のCIUnitのコードをあまり理解しておらず、2.xへの対応として本家の意図しないコードが混じっている可能性もありますので、ご了承下さい。

今回は、log4phpのフル機能をサポートというわけではなく、最小限の機能だけに抑えました。log4phpの機能をフルに使いたければ、phpですし、CodeIgniterですし、直に使っちゃえばいいんじゃない？という風に考えています。

ソースは下記のgithubにおいています。インストール方法などについても下記のページに書いていますので、そちらを参照してください。

fukata/ci-log4php – GitHub

今のところ出来ることと言えば、ルートロガーを使ってロギングすることくらいです。あと、前々からlog_message関数は入力しにくい上にロギングレベルを毎回指定しないといけないのは怠いと感じていたので、log4php_helper.phpとしていくつか簡易メソッドを追加しています。

一応、CodeIgniter 2系をターゲットに作りましたが、ci_log4phpの配置先とlog4php.propertiesファイルパスをENVIRONMENTを考慮した形に実装しているので、検証はしていませんが、その辺を変更すれば1系でも動くんじゃないかと思います。

CodeIgniterのlog_messageからでも呼び出し元情報を正常に取得できるように、log4php自体も少し修正しています。なので、直に使いたい場合には、ci_log4phpは使わずに別途公式から提供されているものを使ってください。

application/config/config.php内のlog_pathを利用していなかったりしますし、まだまだ連携していない部分も多々あります。可能であれば、log4phpの機能をフルに提供したいところではありますが、冒頭にも書いたとおりそんなにフルで使いたければ直に使っても良いのかなと思っているので迷っているところではあります。

また、近いうちに勉強がてらにこれをsparksのパッケージとして構築しようかと思っています。

追記：2011-06-18 22:49
sparksだと読み込みタイミングがCodeIgniterの初期化が終わった後なので、起動時のログを出力する時には利用できないので、今のところは諦めました。読み込みタイミングがシビアなものは数少ないでしょうから、そういうのはapplication配下に置いて、標準の拡張方法を適用する方が良さそうです。