PHPUnitでできる単体テスト

目的に応じて適材適所で使うPHPライブラリ（10）

テストの失敗

　前項で成功したテストが失敗だった場合の例です。

　以下のように住所を違ったものに書き換えてテストを実行してみます。

リスト10　UtilTest.php（抜粋）

// 浅草寺
$address = $this->object->getGoogleMapAddress('35.714731', '139.796756');
$this->assertEquals('東京都台東区浅草２丁目３-２', $address['pref'] . $address['city'] . $address['town'] . $address['detail']);

　前項と同じようにphpunitコマンドでテストを実行すると以下のように表示されます。

リスト11　テスト実行（エラー結果）

[root@localhost sample]# phpunit UtilTest.php 

F

There was 1 failure:

1) UtilTest::testGetGoogleMapAddress
Failed asserting that two strings are equal.
--- Expected
+++ Actual
@@ @@
-東京都台東区浅草２丁目３-２
+東京都台東区浅草２丁目３-１

UtilTest.php:49

FAILURES!
Tests: 1, Assertions: 3, Failures: 1.

　エラーの数だけでなく、エラーを起こしたメソッド名、エラーを起こした理由、テスト時に期待された値と実際の値の比較、エラーを起こした箇所まで表示されていることが分かります。

　PHPUnitを使うとこのようにエラーが起きた原因の詳細がすぐに分かります。

データプロバイダ

　前項までのコードの書き方では、メソッドと値をテストの数だけコードに書いていくことになり、テスト用のクラスが煩雑になりがちです。

　PHPUnitではテスト用のデータとメソッドを分けて記述できるデータプロバイダというアノテーションが用意されています。

　データプロバイダを使ってtestGetGoogleMapAddressメソッドを書きなおすと以下のようになります。

リスト12　UtilTest.php（抜粋）

public static function forTestGetGoogleMapAddress(){
    return array(  
        array('35.658611', '139.745556', '東京都港区芝公園４丁目２-８'),
        array('35.696233', '139.570431', '東京都三鷹市下連雀１丁目１-８３'),
        array('35.714731', '139.796756', '東京都台東区浅草２丁目３-１'),
    );
}

/** 
* @dataProvider forTestGetGoogleMapAddress
*/  
public function testGetGoogleMapAddress($lat, $lon, $expected) { 
    $address = $this->object->getGoogleMapAddress($lat, $lon);
    $this->assertEquals($expected, $address['pref'] . $address['city'] . $address['town'] . $address['detail']);  
}

　データを受け取るメソッドの前に「@dataProvider データを渡すメソッド名」を記述することでデータのみ渡すメソッドからデータを受け取ることができます。

　データを渡すメソッドはstaticで定義して、データは配列で返却するように記述します。

　上記ではforTestGetGoogleMapAddressメソッドで定義したデータをtestGetGoogleMapAddressメソッドに渡してテストを実行します。

　渡すデータは緯度、経度、getGoogleMapAddressで得られると期待される住所 です。

　データプロバイダを利用すると、上記のように同じテストでまとめてコードを短く書くことができます。