CakePHPのPHPUnit

PHPUnitとは

メリット

デメリット

テストできないケース

• javascriptまわり
• privateメソッド

CakePHPに同梱されているPHPUnitを動かしてみる

http://localhost/hello_okinawa/test.php

通常画面にテスト項目画面を表示させる

<? php
App::import('vendor', 'vendor/autoload'); // ※bootstrap.phpに記述している場合は不要。
require_once CAKE . 'TestSuite' . DS . 'CakeTestSuiteDispatcher.php';
CakeTestSuiteDispatcher::run();
?>
		

「App::import('vendor', 'vendor/autoload');」について

App::import('vendor', 'vendor/autoload');

よく使うアサーション

参考リンク

テストクラスの基本クラスの種類

テストクラスの作り方と実行方法

	<?php
	App::uses('Model', 'Model');
	
	class Fish extends Model {
	
		public $name='Fish';
		public $useTable = false;
		public $validate = null;
		
		public function getName1(){
			return 'グルクン';
		}
		
		public function getValue1(){
			return 999;
		}
	}
		

手順：Fish.phpのテストクラス作成、テストコード記述、テスト実行

1. テストクラス「FishTest.php」を作成する。
   「hello_okinawa/app/Test/Case/Model」にFishTest.phpファイルを作成する。
   テストファイル名はテスト対象クラス名にTestの文字を付け加える必要がある。
   

   「クラス名 + Test.php」

   
2. FishTest.phpに以下のテストコードを記述する。

   	<?php
   	App::uses('Fish', 'Model');
   	
   	class FishTest extends CakeTestCase  {
   	
   	    // テストの準備
   	    public function setUp() {
   	        $this->Fish = new Fish;
   	        parent::setUp();
   	    }
   	    
   	    // テスト終了後の片づけ
   	    public function tearDown() {
   	        unset($this->Fish);
   	        parent::tearDown();
   	    }
   	
   	    public function testGetName1() {
   	    	
   	        $res = $this->Fish->getName1();
   	        $this->assertEquals('グルクン', $res);
   	    }
   	
   	    public function testGetValue1() {
   	    	
   	        $res = $this->Fish->getValue1();
   	        $this->assertEquals(999, $res);
   	    }
   	}				
   				

   class FishTest extends CakeTestCase {

   テストクラスでは「CakeTestCase」を継承する。
   CakeTestCaseはCakephp専用のPHPUnit基本クラスである。基本クラスには他にもいくつか種類がある。
   (テストクラスの基本クラスの種類)
   
   

   public function setUp() {

   テストコードを実行する前に呼び出される準備処理である。
   テスト対象クラスのインスタンスを生成など、テスト前の設定を行う。
   
   

   public function tearDown() {

   テストコードを実行が終わった後に呼び出される片づけ処理である。
   
   

   public function testGetName1() {

   実際のテストコードである。 テスト対象クラスのpublicメソッド１つに対し、1つのテスト用メソッド作成する。
   テスト用メソッドの名前は、getName1メソッドならtestを先頭に付け加えtestGetName1という名称にする。
   

   テスト用メソッド名 → test + メソッド名（先頭大文字）

   
   

   $this->assertEquals('グルクン', $res);

   この部分はアサーションと呼ぶ。
   アサーションでは予想値と実測値が一致しているか調べ、テスト画面に結果を表示する。
   

   $this->assertEquals(予測値, 実測値);

   アサーションは多数の種類が存座する。 (参考：よく使うアサーション)
   
   
3. これでテスト準備は終わりましたので、テスト実行画面を開く。
   テスト実行画面には以下のURLからアクセスできる。
   

   http://localhost/hello_okinawa/test.php

   
4. 「Model/Fish」をクリックしてテストを実行する。
   エラーがなければ緑色のバーが表示され、 エラーであれば赤色のバーが表示される。
   

PHP Unit でできるテストについて

コントローラのテスト

注意

テストコントローラの配置場所

テスト対象のコントローラ

	class FishController extends AppController {
		public $name = 'fish';
	
		function test1(){
	
			$this->render();
		}
	
	}
	

テストコントローラ

	class FishControllerTest extends ControllerTestCase {

		public function testTest() {
			
	 		$result=$this->testAction('/fish/test1');
			debug($result);//出力のみ
			$this->assertTextContains('Fish', $result);
	
		}
	
	}
	

test.php

参考リンク

• 公式ドキュメント
• CakePHPのControllerの画面遷移のユニットテストってどうやるの
• Controllerのテストを書くときに気をつけること

コントローラテストでPOSTデータを渡す方法

テスト対象のコントローラ

	class FishController extends AppController {
		public $name = 'fish';
	
		function test2(){
			
			$key1='none';
			if(!empty($this->request->data['Fish'])){
				$data = $this->request->data['Fish'];
				$key1 = $data['key1'];
			}
			
			$this->set(array('key1'=>$key1));
			$this->render();
		}
	
	}
	

テストコントローラ

	class FishControllerTest extends ControllerTestCase {

		public function testTest2() {
			$data = array(
					'Fish' => array(
							'key1' => 'hello world',
					)
			);
			$result = $this->testAction(
					'/fish/test2',
					array('data' => $data, 'method' => 'post')
					);
			debug($result);
	
			$this->assertTextContains('hello world', $result);
		
		}
	
	}
	

array('data' => $data, 'method' => 'get')

コントローラテストでリダイレクトをテスト

return $this->redirect(array('action' => 'index'));

テスト対象のコントローラ

	class FishController extends AppController {
		function test3(){
			$this->redirect(array('action' => 'test3_r'));
		}
		
		function test3_r(){
		
		}
	}
	

テストコントローラ

	class FishControllerTest extends ControllerTestCase {
		$this->testAction('/fish/test3');
		$this->assertContains('/test3_r', $this->headers['Location']);// リダイレクト先ページが「test3_r」であるかテストする。
	}
	

コントローラテストでセッションを渡す方法

テスト対象のコントローラ

	class FishController extends AppController {
		function test4(){
			$msg = $this->Session->read('test4_fish');
			$this->set(array('msg'=>$msg));
			$this->render();
		}
	}
	

テストコントローラ

	class FishControllerTest extends ControllerTestCase {
		public function testTest4() {
	
			// モックをセット
			$this->controller = $this->generate('Fish', array(
					'components' => array(
							'Session',
					)
			));
	
			// モックにセッションデータを仮セット
			$this->controller->Session->expects($this->any())
				->method('read')
				->will($this->returnValueMap([['test4_fish', '勝連城']]));
			
			$result = $this->testAction('/fish/test4');
			debug($result);
			$this->assertTextContains('勝連城', $result);
		
		}
	}
	

DBと結びついたモデルをテストする

テストコードの例（参照系）

	App::uses('Model', 'Model');

	class Fish extends Model {
	
		public $name='Fish';
	
		public function getRec($id){
			
			$conditions=array(
					"id = {$id}",
			);
			
			$data=$this->find('all',array(
					'conditions'=>$conditions,
			));
			
			return $data;
		}
	}
	

	App::uses('Fish', 'Model');
	
	class FishTest extends CakeTestCase  {
	
		public function testUpdateRec(){
			$this->Fish->begin();//トランザクション開始
			
			$res=$this->Fish->updateRec(2,"トビウオ");//テスト実施
			
			debug($res);
			$this->Fish->rollback();// ロールバック
	
			$this->assertEquals(2, $res['Fish']['id']);
			$this->assertEquals("トビウオ", $res['Fish']['fish_name']);
			
		}
	}
	

更新系のテストについて

フィクスチャとは

フィクスチャのメリット

フィクスチャのデメリット

フィクスチャを使うには

参考リンク

フィクスチャを使う前の準備

手順

1. 「app/Config/core.php」を開き、デバッグモードにする。

   Configure::write('debug', 2);

   1または2にする。0はデバッグモードOFF。
2. 実際のデータベースとは別にテスト用のデータベースを用意する。
3. 「app/Config/database.php」を開く
4. 「public $test ～」にテスト用データベースの設定を記述する。
   
   database.php

   class DATABASE_CONFIG {
   	public $default = array(
   			'datasource' => 'Database/Mysql',
   			'persistent' => false,
   			'host' => 'localhost',
   			'login' => 'root',
   			'password' => 'xxxxxx',
   			'database' => 'hello_okinawa',
   			'prefix' => '',
   			'encoding' => 'utf8',
   	);
   	
   	public $test = array(
   			'datasource' => 'Database/Mysql',
   			'persistent' => false,
   			'host' => 'localhost',
   			'login' => 'root',
   			'password' => 'xxxxxx',
   			'database' => 'hello_okinawa_test',
   			'prefix' => '',
   			'encoding' => 'utf8',
   	);
   	～　省略　～
   			

5. 以上の準備でフィクスチャを作成できるようになる。
   フィクスチャの作成方法については 「フィクスチャの作成方法とテストクラスの書き方」を参考。

フィクスチャの作成方法とテストクラスの書き方

手順

1. 「app/Test/Fixture」フォルダにフィクスチャをPHPファイルとして作成する。
   fishテーブルのフィクスチャを作成する場合、フィクスチャは「FishFixture.php」となる。
2. フィクスチャに仮データ等を記述する。

   	class FishFixture extends CakeTestFixture {
   	
   		// 異なるテスト用データソースにフィクスチャを読み込む時にこのプロパティを指定してください。
   		public $useDbConfig = 'test';
   	
   		public $import = 'Fish';// DBのfishテーブルからフィールド情報をインポートする。
   	
   		// 仮データをセットする
   		public $records = array(
   				array(
   						'id' => 1,
   						'fish_name' => 'First Fish',
   						'fish_date' => '2007-03-01',
   						'value1' => '10',
   				),
   				array(
   						'id' => 2,
   						'fish_name' => 'kani',
   						'fish_date' => '2007-03-02',
   						'value1' => '20',
   				),
   				array(
   						'id' => 3,
   						'fish_name' => 'サメ',
   						'fish_date' => '2007-03-03',
   						'value1' => '30',
   				),
   				array(
   						'id' => 4,
   						'fish_name' => 'グルクン',
   						'fish_date' => '2007-03-04',
   						'value1' => '40',
   				),
   		);
   		
   		// 動的な仮データをセットしたい場合は、こちらのメソッドでセットする
   		public function init() {
   			$this->records[3]['fish_date'] = date('Y-m-d');
   	
   			parent::init();
   		}
   	}
   			

3. 以上でフィクスチャーの作成は終了。続いてテストコードにフィクスチャを適用させる方法へ。
4. テストコードの「$fixtures」メンバに、適用するフィクスチャをセットするだけである。

   	App::uses('Fish', 'Model');
   	class FishTest extends CakeTestCase  {
   	
   		public $fixtures = array('app.fish');// フィクスチャをセットする。
   	
   		public function setUp() {
   			//$this->Fish = new Fish;
   			parent::setUp();
   			$this->Fish = ClassRegistry::init('Fish');
   		}
   	
   		public function tearDown() {
   			unset($this->Fish);
   			parent::tearDown();
   		}
   		
   		// 更新系メソッドのテストコード
   		public function testUpdateRec(){
   			
   			$this->Fish->begin();//トランザクション開始
   			$res=$this->Fish->updateRec(2,"トビウオ");//テスト実施
   			debug($res);
   			$this->Fish->rollback();// ロールバック
   			$this->assertEquals(2, $res['Fish']['id']);
   			$this->assertEquals("トビウオ", $res['Fish']['fish_name']);
   	
   		}
   	}
   			

5. 以上でテスト実行したとき、フィクスチャでセットした仮データからテストデータを取得するようになる。

DB登録系のモデルのメソッドをテストする方法

• モデルのINSERT系メソッドをテストする
• モデルのUPDATE系メソッドをテストする

モデルのINSERT系メソッドをテストする

モデル

	App::uses('Model', 'Model');
	class Fish extends Model {
		public $name='Fish';
		public function insertRec($fish_name){
			
			$rec=array(
					'fish_name' => $fish_name,
					'fish_date' => date('Y-m-d'),
					'value1' => 6,
			);
			
			$res=$this->save($rec, array('atomic' => false));
		
			return $res;
			
		}
	}
	

テストコード

	App::uses('Fish', 'Model');
	class FishTest extends CakeTestCase  {
	
	    // テストの準備
	    public function setUp() {
	        //$this->Fish = new Fish;
	        parent::setUp();
	        $this->Fish = ClassRegistry::init('Fish');
	    }
	    
	    // テスト終了後の片づけ
	    public function tearDown() {
	        unset($this->Fish);
	        parent::tearDown();
	    }
	    
	    public function testInsertRec(){
	    	$this->Fish->begin();//トランザクション開始
	    	$res=$this->Fish->insertRec("カツオ");//テスト実施
	    	debug($res);
	    	$this->Fish->rollback();// ロールバック
	    	$this->assertEquals("カツオ", $res['Fish']['fish_name']);
	    }
	}
	

モデルのUPDATE系メソッドをテストする

モデル

	App::uses('Model', 'Model');
	class Fish extends Model {
	
		public $name='Fish';
	
		public function updateRec($id,$fish_name){
			$rec=array(
					'id' => $id,
					'fish_name' => $fish_name,
					'fish_date' => date('Y-m-d'),
					'value1' => 6,
			);
			$res=$this->save($rec, array('atomic' => false));
			return $res;
		}
	}
	

テストコード

	App::uses('Fish', 'Model');
	class FishTest extends CakeTestCase  {
		// テストの準備
		public function setUp() {
			//$this->Fish = new Fish;
			parent::setUp();
			$this->Fish = ClassRegistry::init('Fish');
		}
		
		// テスト終了後の片づけ
		public function tearDown() {
			unset($this->Fish);
			parent::tearDown();
		}
		
		public function testUpdateRec(){
			$this->Fish->begin();//トランザクション開始
			$res=$this->Fish->updateRec(2,"トビウオ");//テスト実施
			debug($res);
			$this->Fish->rollback();// ロールバック
			$this->assertEquals(2, $res['Fish']['id']);
			$this->assertEquals("トビウオ", $res['Fish']['fish_name']);
		}
	}
	

saveとsaveAllの違い、およびトランザクション有無によるテスト難易度

$res=$this->save($rec, array('atomic' => false));

$res=$this->save($rec);

$res=$this->saveAll($data, array('atomic' => false));

$res=$this->saveAll($data);

テストスイートで まとめてテストを実行する

テストスイートの作成手順

1. app/Test/Caseに「AllTestsTest.php」を作成する。
   
2. AllTestsTest.phpに下記のソースコードを記述する。（そのままコピペで良い）

   	<?php
   	class AllTestsTest extends CakeTestSuite {
   	    public static function suite() {
   	        $suite = new CakeTestSuite('All tests');
   	        $suite->addTestDirectoryRecursive(TESTS . 'Case');
   	        return $suite;
   	    }
   	}
   			

3. 以上でテストスイートは完成。つづいてテストスイートでまとめてテストを実行する方法へ。
4. test.phpにアクセスする。
   
   例

   http://localhost/hello_okinawa/app/webroot/test.php

5. 「AllTests」リンクをクリックすれば、まとめてテストが実行される。
   

モデルのみ実行するテストスイート

	<?php
	class AllModelTest extends CakeTestSuite {
		public static function suite() {
			$suite = new CakeTestSuite('All model tests');
			$suite->addTestDirectory(TESTS . 'Case/Model');
			return $suite;
		}
	}
	

参考リンク

テスト計測の指標 | コードカバレッジ

注意

コードカバレッジを確認する手順

1. テスト実行画面のtest.phpにアクセスする。

   http://localhost/hello_okinawa/test.php

2. テスト対象を選びテストを実行する。
   
3. 「Analyze Code Coverage」をクリックするとコードカバレッジを確認できる。
   
   
   

   FishController.php Code coverage: 48.72%

   
   
   例の場合、コードカバレッジは48.72%なのでテストは不十分といえる。
   
   

テストの原則

テストパターンのヒント

• 境界値テスト
• コードカバレッジ | パターンの網羅
• 同値分割
• 文字列系のテスト入力パターン
• 数値系のテスト入力パターン
• 日付型のテスト入力パターン
• bool系のテスト入力パターン
• 計算系のテストパターン
• 電話番号のテスト入力パターン
• ブラウザのリロードによる二重登録テスト
• セッション切れのテスト
• 様々なブラウザでテスト
• セキュリティのテスト
• 認証機能のテスト
• レイアウトまわりのテスト
• 負荷テスト
• マルチスレッド、並列処理、排他制御のテスト

テストで入力する値のパターン

境界値テスト

PHPUnitで利用できる関数

コードカバレッジ | パターンの網羅

命令網羅 ＜ 分岐網羅 ＜ 条件網羅

命令網羅

• 3割引価格となるパターンでテスト

定義

if(...){
	～ 主な命令処理 ～
} else  {
	～ どうでもいい処理 ～
}
		

どのようなときに行うテストか？

分岐網羅

• 3割引価格となるパターンで1回テスト
• 通常価格となるパターンで1回テスト

定義

if(...){
	～ 分岐処理1 ～
} else if(...){
	～ 分岐処理2 ～
}
		

どのようなときに行うテストか？

条件網羅

定義

if( ～ 複雑な条件 ～){
	...
} else if ( ～ 複雑な条件 ～ )  {
	...
}
		

どのようなときに行うテストか？

同値分割

テンプレート