MakeGood Tip #1: Pyrusによるユーザー固有のPEAR環境の構築とMakeGoodからの利用
MakeGoodでテスティングフレームワークを使う場合の選択肢として、プロジェクトの外部に配置されているパッケージを使う方法と、内部に配置されているパッケージを使う方法があります。今日ではComposerを使うことで、開発時のみに必要とされるパッケージでも簡単にプロジェクトの内部に配置することができるようになりました。
必要なパッケージの多くをプロジェクトの内部に配置することは、アプリケーションの動作を保証する上で有用なプラクティスといえるでしょう。しかし、Eclipse PDTからの利用を考慮すると、多くのプロジェクトで使われることが予想されるテスティングフレームワークやモッキングフレームワーク等について、単一の環境のものを使うことによるパフォーマンス上のメリットは小さくはありません。また、通常のフレームワークやライブラリと比較すると、テストコードの動作に与える影響は極めて小さいため、外部のものを使うデメリットもほとんどないといっていいでしょう。
今回の記事では、PEARパッケージ管理システムPyrusを使用してプロジェクトの外部にユーザー固有のPEAR環境を構築し、それらをMakeGoodから利用する手順について解説します。
まず今回作成するPEAR環境のディレクトリ構造を以下に示します。インストールするPEARパッケージはPHPunitとPhakeとします。
├── bin │ └── pyrus.phar └── vendor ├── phake │ └── php │ ├── Phake └── phpunit └── php ├── PHPUnit
vendorディレクトリにはPHPUnitとPhake、それぞれ個別のPEARパッケージを配置します。binディレクトリには本環境で使用するPyrusのPharアーカイブを配置します。
PEAR環境のパスはどこでも構いませんが、ユーザーが書き込み権限を持つディレクトリを用意しましょう。本記事で使用するパスは~/site-phpとします。
PyrusのPharアーカイブpyrus.pharをPEAR2のWebサイトからダウンロードし、~/site-php/binディレクトリに配置します。
PEARパッケージのインストールの前にPyrusを設定します。まず以下のようにPyrusを初期化します。
$ php ~/site-php/bin/pyrus.phar Pyrus version 2.0.0a4 SHA-1: 72271D92C3AA1FA96DF9606CD538868544609A52 Pyrus: No user configuration file detected It appears you have not used Pyrus before, welcome! Initialize install? Please choose: yes no [yes] : Great. We will store your configuration in: /home/iteman/.pear/pearconfig.xml Where would you like to install packages by default? [/home/iteman] : /home/iteman/site-php You have chosen: /home/iteman/site-php Thank you, enjoy using Pyrus Documentation is at http://pear.php.net Using PEAR installation found at /home/iteman/site-php ...
$ php ~/site-php/bin/pyrus.phar set auto_discover 1 $ php ~/site-php/bin/pyrus.phar set cache_dir ~/site-php/tmp/pyrus/cache $ php ~/site-php/bin/pyrus.phar set temp_dir ~/site-php/tmp/pyrus/temp $ php ~/site-php/bin/pyrus.phar set download_dir ~/site-php/tmp/pyrus/downloads
次にPHPUnitとPhakeのPEARパッケージをインストールします。基本となるコマンドはmypearとinstallです。mypearコマンドで対象パッケージの配置先ディレクトリを決定し、installコマンドでインストールを実行します。
最初にPHPUnitをインストールします。基本と異なるのはパラメーターbin_dirを設定している箇所です。ここではbin_dirにPHPUnitの配置先ディレクトリを設定しています。
$ php ~/site-php/bin/pyrus.phar mypear ~/site-php/vendor/phpunit $ php ~/site-php/bin/pyrus.phar set bin_dir ~/site-php/vendor/phpunit/bin $ php ~/site-php/bin/pyrus.phar install pear.phpunit.de/phpunit Pyrus version 2.0.0a4 SHA-1: 72271D92C3AA1FA96DF9606CD538868544609A52 Using PEAR installation found at /home/iteman/site-php/vendor/phpunit Sorry, the channel "pear.phpunit.de" is unknown. Discovery of channel pear.phpunit.de successful Sorry, pear.phpunit.de/phpunit references an unknown channel pear.symfony-project.com for pear.symfony-project.com/YAML Discovery of channel pear.symfony-project.com successful Downloading pear.phpunit.de/PHPUnit ... Installed pear.phpunit.de/PHPUnit-3.6.12 Installed pear.phpunit.de/File_Iterator-1.3.1 Installed pear.phpunit.de/Text_Template-1.1.1 Installed pear.phpunit.de/PHP_CodeCoverage-1.1.3 Installed pear.phpunit.de/PHP_Timer-1.0.2 Installed pear.phpunit.de/PHPUnit_MockObject-1.1.1 Installed pear.symfony-project.com/YAML-1.0.6 Installed pear.phpunit.de/PHP_TokenStream-1.1.3 Optional dependencies that will not be installed, use --optionaldeps: pear.phpunit.de/PHP_Invoker depended on by pear.phpunit.de/PHPUnit
$ php ~/site-php/bin/pyrus.phar mypear ~/site-php/vendor/phake $ php ~/site-php/bin/pyrus.phar install pear.digitalsandwich.com/phake Pyrus version 2.0.0a4 SHA-1: 72271D92C3AA1FA96DF9606CD538868544609A52 Using PEAR installation found at /home/iteman/site-php/vendor/phake Sorry, the channel "pear.digitalsandwich.com" is unknown. Discovery of channel pear.digitalsandwich.com successful Downloading pear.digitalsandwich.com/Phake ... Installed pear.digitalsandwich.com/Phake-1.0.2
これでユーザー固有のPEAR環境の構築は完了です。
さて、この段階ではMakeGoodからPEAR環境を利用することができないため、MakeGoodビューには以下のようにPHPUnit_Framework_TestCaseクラスが利用できません。修正...というメッセージが表示されます。
プロジェクトからPEAR環境を利用するには、ユーザーライブラリの定義とプロジェクトへのユーザーライブラリの追加という2つの作業が必要になります。
ユーザーライブラリは、ユーザー環境のライブラリをプロジェクトから任意の名前によって参照するための仕組みです。ユーザー固有のライブラリパスをプロジェクトから隠蔽することができるため、PHPプロジェクトを複数人で共有する場合に重宝する機能です。
ここではさきほど準備したPHPUnitをユーザーライブラリとして定義します。まず、メニューバーからWindow -> Preferences...を選択し、続いてPHP -> PHP Librariesを選択します。次にNew...ボタンをクリックし、ライブラリの名前を入力後OKボタンをクリックします。
次に先程定義したユーザーライブラリを選択しAdd External folder...ボタンをクリックします。次にフォルダー選択ダイアログからPHPUnitが配置されているフォルダー/home/iteman/site-php/vendor/phpunit/phpを選択します。
同様の手順でPhakeをユーザーライブラリとして定義します。
プロジェクトからユーザーライブラリを参照するためには、プロジェクトにユーザーライブラリを追加する必要があります。まず、プロジェクトのプロパティを開きPHP Include PathのLibrariesタブを選択し、続いてAdd Library...ボタンをクリックします。次にUser Libraryを選択しNext >ボタンをクリックします。
次に先程定義したユーザーライブラリにチェックを入れてからFinishボタンをクリックします。
問題なければテストの実行を待っています...というメッセージがMakeGoodビューに表示されます。
概要 - MakeGood - Piece Framework
