NetCommonsModelTestCase.php

<?php
/**
 * NetCommonsModelTestCase class
 *
 * @author Noriko Arai <arai@nii.ac.jp>
 * @author Shohei Nakajima <nakajimashouhei@gmail.com>
 * @link http://www.netcommons.org NetCommons Project
 * @license http://www.netcommons.org/license.txt NetCommons License
 * @copyright Copyright 2014, NetCommons Project
 */

App::uses('NetCommonsCakeTestCase', 'NetCommons.TestSuite');
App::uses('Current', 'NetCommons.Utility');
App::uses('OriginalKeyBehavior', 'NetCommons.Model/Behavior');

/**
 * NetCommonsModelTestCase class
 *
 * @package NetCommons\NetCommons\TestSuite
 * @codeCoverageIgnore
 */
abstract class NetCommonsModelTestCase extends NetCommonsCakeTestCase {

/**
 * Called when a test case method is about to start (to be overridden when needed.)
 *
 * @param string $method Test method about to get executed.
 * @return void
 */
	public function startTest($method) {
		$instance = Current::getInstance();
		$instance->setCurrentLanguage();
	}

/**
 * setUp method
 *
 * @return void
 */
	public function setUp() {
		parent::setUp();

		if ($this->_modelName) {
			$model = $this->_modelName;
			//Tracableビヘイビアの削除
			if ($this->$model->Behaviors->loaded('NetCommons.Trackable')) {
				$this->$model->Behaviors->unload('NetCommons.Trackable');
				$this->$model->unbindModel(
					array('belongsTo' => ['TrackableCreator', 'TrackableUpdater']), false
				);
			}
			//MailQueueビヘイビアの削除
			if ($this->$model->Behaviors->loaded('Mails.MailQueue')) {
				$this->$model->Behaviors->unload('Mails.MailQueue');
			}
		}
	}

/**
 * tearDown method
 *
 * @return void
 */
	public function tearDown() {
		Current::$current = [];
		parent::tearDown();
	}

/**
 * Mockセット(戻り値：false)
 *
 * @param string $model モデル名
 * @param string $mockModel Mockのモデル
 * @param string $mockMethod Mockのメソッド
 * @param int $count Mockの呼び出し回数
 * @return void
 */
	protected function _mockForReturnFalse($model, $mockModel, $mockMethod, $count = 1) {
		$this->_mockForReturn($model, $mockModel, $mockMethod, false, $count);
	}

/**
 * Mockセット(戻り値：true)
 *
 * @param string $model モデル名
 * @param string $mockModel Mockのモデル
 * @param string $mockMethod Mockのメソッド
 * @param int $count Mockの呼び出し回数
 * @return void
 */
	protected function _mockForReturnTrue($model, $mockModel, $mockMethod, $count = 1) {
		$this->_mockForReturn($model, $mockModel, $mockMethod, true, $count);
	}

/**
 * Mockセット
 *
 * @param string $model モデル名
 * @param string $mockModel Mockのモデル
 * @param string $mockMethod Mockのメソッド
 * @param mixed $return 戻り値
 * @param int $count Mockの呼び出し回数
 * @return void
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 */
	protected function _mockForReturn($model, $mockModel, $mockMethod, $return, $count = 1) {
		list($mockPlugin, $mockModel) = pluginSplit($mockModel);

		if (is_string($mockMethod)) {
			$mockMethod = array($mockMethod);
		}
		if ($mockModel === $model) {
			// php7.2よりget_class()にnullを設定するとE_WARNING. http://php.net/manual/ja/function.get-class.php
			if (is_null($this->$mockModel) ||
					get_class($this->$mockModel) === $mockModel) {
				$this->$model = $this->getMockForModel(
					$mockPlugin . '.' . $mockModel, $mockMethod, array('plugin' => $mockPlugin)
				);
			}
		} else {
			if (is_object($this->$model->$mockModel)) {
				$mockClassName = get_class($this->$model->$mockModel);
			} else {
				$mockClassName = null;
			}
			if (! $mockClassName ||
					substr($mockClassName, 0, strlen('Mock_')) !== 'Mock_') {
				$this->$model->$mockModel = $this->getMockForModel(
					$mockPlugin . '.' . $mockModel, $mockMethod, array('plugin' => $mockPlugin)
				);
			}
		}
		foreach ($mockMethod as $method) {
			if ($count === 1) {
				$funcCount = $this->once();
			} else {
				$funcCount = $this->exactly($count);
			}
			if ($mockModel === $model) {
				$this->$model->expects($funcCount)
						->method($method)
						->will($this->returnValue($return));
			} else {
				$this->$model->$mockModel->expects($funcCount)
						->method($method)
						->will($this->returnValue($return));
			}
		}
	}

}