カテゴリー: lifehack

symfony でのテストは機能テスト(functional test)、単体テスト(unit test)が標準でサポートされており、それぞれ以下の特徴があります。
 
□機能テスト
– モジュール生成時に test/functional に自動生成される。
– test/{$app}/{$module}ActionsTest.php というファイル名($app,$module はそれぞれテスト対象のアプリケーション名とモジュール名)
– テスト用仮想 symfony サイトブラウザ クラスの sfTestBrowser を使ったモジュール単位のテストが中心。
– 最初からデフォルトのテスト実装がある
  (ver 1.0.6 時点のデフォルトテスト実装は、モジュールの index アクションが初期のままではないかをテストするというもの)
– テスト実行は

symfony test-functional <appname>

  もしくは

symfony test-all

  で行う
 
□単体テスト
– 機能テストのような自動生成はされないが、test/bootstrap/unit.php をインクルードすることで容易にテストを作成可能。
– test/unit/{$testName}Test.php というファイル名($testName は任意の名前)
– 汎用単体テストクラス lime_test を使った、ライブラリ等のクラスを対象にした個別のテストが中心。
– テスト実行は

symfony test-unit

  もしくは

symfony test-all

  で行う
 
なお、単体、機能どちらのテストも

php test/functional/appname/fooActionsTest.php

のように PHP スクリプトとして実行すると、そのテストだけを実行することができます。
このようにすることで、失敗したテストがどの項目で失敗したかを調べることができます。
 
■sfTestBrowser クラス
sfBrowser クラスのテスト用実装版(sfBrowser の子クラス)。
sfBrowser クラスはTCP 等ネットワーク通信を伴わずに symfony サイト内ページのブラウジング可能な仮想ブラウザ実装です。
 
■lime_test クラス
lime の汎用単体テストクラス。
lime は symfony チーム開発のユニットテストユーティリティです。
 
備考:
 どちらのクラスについても、メソッドの戻り値いがオブジェクト自身のインスタンスを返してくれるので

$t->get(…)->is…(…)->is…(…)

のようにテストのチェインができるため、SimpleTest などの xUnit 互換のものより記述が容易になっています。
参考:
– sfTestBrowser (symfony API)
– sfBrowser (symfony API)
– lime_test class
 (lime_test クラスの phpdoc ドキュメント)
– 新しく採用されたテスティングフレームワークlimeの紹介(symfony で開発日記)
 lime_test クラスメソッドの日本語説明など。
– Chapter 15 – Unit And Fanctional Testing(The Definitive Guide to symfony)
– 15章 単体テストと機能テスト(上のリンクの日本語訳版)

APD(Advanced PHP Debugger)、便利ですよね。
 
APD の使い方について書いてあるページは多々あれど、pprofp についてはあまり触れられていなかったので、手前味噌ですが pprofp -h を日本語訳＋捕捉してみました。
 
書式(APD ver. 0.9):

pprofp <オプション> <解析するファイル>

 
並び順を指定するオプション:
  -a クラス、関数名のアルファベット順に表示する
  -l 関数の呼び出し回数順に表示する
  -m 関数呼び出し中のメモリ使用量順に表示する
  -r 関数の実際の処理時間(real time)順に表示する
  -R 関数の実際の処理時間順に表示する(子関数−関数内での関数呼び出し−の処理時間も含む)
  -s 関数のシステムモードでの処理時間(system time)順に表示する
  -S 関数のシステムモードでの処理時間順に表示する(子関数の処理時間も含む)
  -u 関数のユーザモードでの処理時間(user time)順に表示する
  -U 関数のユーザモードでの処理時間順に表示する(子関数の処理時間も含む)
  -v 関数の平均処理時間順に表示する
  -z 関数のユーザモード、システムモードの処理時間の合計順に表示する(省略時のデフォルト)
  
表示形式についてのオプション:
  -c 関数のコールツリーの横に実際の経過時間をつけて表示する(-t または -T とともに指定)
  -i PHP ビルトイン関数を出力に含めない
  -O <数値> 関数のリスト表示で最大何個の関数まで表示するか(デフォルトは 15 個)
  -t 関数のコールツリーを短縮して表示する
  -T 関数のコールツリーを短縮せず表示する
 
– – – –
捕捉:
処理を追う場合はコールツリー(-t あるいは -T)を使うと便利です。
-t と -T の違いは、
-T は

    doSomething
       define
       define
       define
       define
       echo

のように、同じ関数呼び出しが続いた場合もそのまま表示しますが、-t にすると

     doSomething
       define (4x)
       echo

のように、連続する関数呼び出しを一行に縮めて表示することで出力を短縮します。

HTTP_Request には setProxy() がありますが、HTTP_Client にはプロキシ指定メソッドが存在しません。
しかし、HTTP_Client のマニュアルには直接書かれていませんが、次のようにすることで HTTP_Client でも proxy を利用することができます。

$client =& new HTTP_Client(array(
    ‘proxy_host’ => $host, // proxy ホスト
    ‘proxy_port’ => $port, // proxy ポート(省略時 8080)
    ‘proxy_user’ => $user, // proxy の認証ユーザ名(省略時認証なし)
    ‘proxy_pass’ => $pass // proxy の認証パスワード(省略可)
));

内部的には第一引数が HTTP_Request のコンストラクタに渡され、HTTP_Request のコンストラクタで proxy を設定する、という流れになります。
参考:
– PEAR::Manual – HTTP_Client のコンストラクタ
– http://pear.php.net/package/HTTP_Request/docs/latest/HTTP_Request/HTTP_Request.html#methodHTTP_Request“>PEAR::Manual – HTTP_Request のコンストラクタ(API Docs)

symfony で Ajax を使って HellowWorld を表示するまでの手順は以下のようになります。
(前提として Apache, PHP, symfony がインストールされているものとします)
 
1. まずは symfony のお約束、project, application, module 作成から。

$ pwd
 /usr/local
$ mkdir sf_ajax
$ cd sf_ajax
$ symfony new sf_ajax
$ symfony app helloworld
$ symfony module helloworld ajax

プロジェクト名、アプリケーション名、モジュール名は任意の名前で構いませんが、ここではそれぞれ sf_ajax, helloworld, ajax としました。
 
ここで、プロジェクトフォルダの web/ に sf ディレクトリがない場合は

$ cp -pr /usr/local/share/pear/data/symfony/web/sf ./web/

または

$ ln -s /usr/local/share/pear/data/symfony/web/sf ./web/

のように、symfony のインストールフォルダからコピーするかシンボリックリンクを張ります。
 
2. プロジェクトフォルダの web/ を web からアクセスできるようにします
(注: Apacheの Rewrite エンジンを使ってアプリケーション名を判別させる場合は web/ を DocumentRootにする必要があります)。
 

$ # /var/www が Apache の DocumentRoot の場合
$ ln -s /usr/local/sf_ajax/web /var/www/sf

 
この時点で

http://localhost/sf/helloworld_dev/ajax

(DocumentRootにした場合は http://localhost/helloworld/ajax )
のようにして web ページを開くと

Module “ajax” created

という symfony のデフォルトページが表示されるはずです。
 
3. ajax モジュールのアクションを編集する

$ cd apps/hello
$ cd apps/helloworld/modules/ajax/
$ vi actions/actions.class.php

 
actions.class.php: (編集前)

class ajaxActions extends sfActions
{
  /**
   * Executes index action
   *
   */
  public function executeIndex()
  {
   // $this->forward(‘default’, ‘module’);
  }
}

actions.class.php: (編集後)

class ajaxActions extends sfActions
{
  /**
   * Executes index action
   *
   */
  public function executeIndex()
  {
    // $this->forward(‘default’, ‘module’); ←コメントアウト
  }
  // ↓ 追加
  public function executeTime()
  {
    return $this->renderText(“Hello world!! (at “.date(“Y-m-d H:i:s”).”)”);
  }
}

 
4. ajax モジュールのテンプレートを編集する

$ vi templates/indexSuccess.php

 
indexSuccess.php:

<?php use_helper(“Javascript”);?>
<div id=”res”></div>
<?= link_to_remote(“Click!!”,array(‘url’=>”ajax/time”, ‘update’=>”res”,)) ?>

1 行目: symfony で Ajax を使うために JavaScriptHelper を読み込みます。
2 行目: 結果表示先のタグ。
3 行目: Javascript を実行するアンカータグを生成します。
       url: クリック時に HTTP リクエストを行うURLのモジュール以降の部分を指定します。GET パラメータを指定する場合は ajax/time?key=value のようにします。
       update: url で指定したページの読み込みが完了した際に表示先にするDOM の id を指定します。
       
 
ここで再び先程のページ(http://localhost/sf/helloworld_dev/ajax)を開き、 Click!! という文字をクリックすれば, 押すたびに

Hello, world!! (at 2007-07-05 23:30:12)

の日時の部分が更新されて表示されるはずです。
 
5. さらに link_to_remote() の引数の配列パラメータを追加することでよりインタラクティブな動作を実現できます。

<?php use_helper(“Javascript”);?>
<div id=”res”></div>
<div id=”error” style=”color:red”></div>
<div id=”loading” style=”display:none”>Now loading…</div>
<?= link_to_remote(“Click!!”,array(
    ‘url’=>”ajax/time”,
    ‘update’=> array( // update は失敗時と成功時で反映先を変えることができます
         ‘success’ => ‘res’, // HTTP コード 2XX
         ‘failure’ => ‘error’, // それ以外
       ),
    // 以下コールバックイベント指定
    ‘loading’ => “Element.show(‘loading’)”, // 読み込み開始時に実行する JavaScript
    ‘success’ => “Element.hide(‘loading’)”, // 読み込み結果 HTTP コードが 2XX の場合実行する JavaScript
    ‘failure’ => “Element.show(‘error’); alert(‘Error!!’)”, // 読み込み結果 HTTP コードが 2XX 以外の場合実行する JavaScript
    ‘complete’ => visual_effect(‘blind_down’, ‘res’, array(‘duration’=>0.5)), // 読み込みの成否にかかわらず、読み込み完了後(success,failure 判別,実行後)に実行する JavaScript
)) ?>

コールバックイベントには他にも before, after, loaded, interactive, 404 といったものがあります。詳しくはsymfony bookの Javascript ヘルパー – コールバックの項を参照してください。
  
参考:
– symfony book 日本語ドキュメント Javascript ヘルパー
 Javascript ヘルパーの使い方について。
– script.aculo.us Documentation
  symfony で利用している Javascript クラスライブラリ scriptaculous のドキュメントページ。symfony に最初から組み込まれているので、 use_helper(“Javascript”) とすればそのまま使えます。
– symfony Code Snippets – ajax
symfony を使った実用ソースコード集。