* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org) * * Licensed under The MIT License * Redistributions of files must retain the above copyright notice * * @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org) * @link http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests * @package cake.tests.cases.libs * @since CakePHP(tm) v 2.0 * @license MIT License (http://www.opensource.org/licenses/mit-license.php) */ App::uses('ExceptionRenderer', 'Error'); App::uses('Controller', 'Controller'); App::uses('AppController', 'Controller'); App::uses('Component', 'Controller'); App::uses('Router', 'Routing'); /** * Short description for class. * * @package cake.tests.cases.libs */ class AuthBlueberryUser extends CakeTestModel { /** * name property * * @var string 'AuthBlueberryUser' * @access public */ public $name = 'AuthBlueberryUser'; /** * useTable property * * @var string * @access public */ public $useTable = false; } /** * BlueberryComponent class * * @package cake.tests.cases.libs */ class BlueberryComponent extends Component { /** * testName property * * @access public * @return void */ public $testName = null; /** * initialize method * * @access public * @return void */ function initialize(&$controller) { $this->testName = 'BlueberryComponent'; } } /** * TestErrorController class * * @package cake.tests.cases.libs */ class TestErrorController extends Controller { /** * uses property * * @var array * @access public */ public $uses = array(); /** * components property * * @access public * @return void */ public $components = array('Blueberry'); /** * beforeRender method * * @access public * @return void */ function beforeRender() { echo $this->Blueberry->testName; } /** * index method * * @access public * @return void */ function index() { $this->autoRender = false; return 'what up'; } } /** * MyCustomExceptionRenderer class * * @package cake.tests.cases.libs */ class MyCustomExceptionRenderer extends ExceptionRenderer { /** * custom error message type. * * @return void */ function missingWidgetThing() { echo 'widget thing is missing'; } } /** * Exception class for testing app error handlers and custom errors. * * @package cake.test.cases.libs */ class MissingWidgetThingException extends NotFoundException { } /** * ExceptionRendererTest class * * @package cake.tests.cases.libs */ class ExceptionRendererTest extends CakeTestCase { var $_restoreError = false; /** * setup create a request object to get out of router later. * * @return void */ function setUp() { App::build(array( 'views' => array( CAKE . 'Test' . DS . 'test_app' . DS . 'View'. DS ) ), true); Router::reload(); $request = new CakeRequest(null, false); $request->base = ''; Router::setRequestInfo($request); $this->_debug = Configure::read('debug'); $this->_error = Configure::read('Error'); Configure::write('debug', 2); } /** * teardown * * @return void */ function teardown() { Configure::write('debug', $this->_debug); Configure::write('Error', $this->_error); App::build(); if ($this->_restoreError) { restore_error_handler(); } } /** * Mocks out the response on the ExceptionRenderer object so headers aren't modified. * * @return void */ protected function _mockResponse($error) { $error->controller->response = $this->getMock('CakeResponse', array('_sendHeader')); return $error; } /** * test that methods declared in an ExceptionRenderer subclass are not converted * into error400 when debug > 0 * * @return void */ function testSubclassMethodsNotBeingConvertedToError() { Configure::write('debug', 2); $exception = new MissingWidgetThingException('Widget not found'); $ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception)); ob_start(); $ExceptionRenderer->render(); $result = ob_get_clean(); $this->assertEqual($result, 'widget thing is missing'); } /** * test that subclass methods are not converted when debug = 0 * * @return void */ function testSubclassMethodsNotBeingConvertedDebug0() { Configure::write('debug', 0); $exception = new MissingWidgetThingException('Widget not found'); $ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception)); $this->assertEqual('missingWidgetThing', $ExceptionRenderer->method); ob_start(); $ExceptionRenderer->render(); $result = ob_get_clean(); $this->assertEqual($result, 'widget thing is missing', 'Method declared in subclass converted to error400'); } /** * test that ExceptionRenderer subclasses properly convert framework errors. * * @return void */ function testSubclassConvertingFrameworkErrors() { Configure::write('debug', 0); $exception = new MissingControllerException('PostsController'); $ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception)); $this->assertEqual('error400', $ExceptionRenderer->method); ob_start(); $ExceptionRenderer->render(); $result = ob_get_clean(); $this->assertPattern('/Not Found/', $result, 'Method declared in error handler not converted to error400. %s'); } /** * test things in the constructor. * * @return void */ function testConstruction() { $exception = new NotFoundException('Page not found'); $ExceptionRenderer = new ExceptionRenderer($exception); $this->assertInstanceOf('CakeErrorController', $ExceptionRenderer->controller); $this->assertEquals('error400', $ExceptionRenderer->method); $this->assertEquals($exception, $ExceptionRenderer->error); } /** * test that method gets coerced when debug = 0 * * @return void */ function testErrorMethodCoercion() { Configure::write('debug', 0); $exception = new MissingActionException('Page not found'); $ExceptionRenderer = new ExceptionRenderer($exception); $this->assertInstanceOf('CakeErrorController', $ExceptionRenderer->controller); $this->assertEquals('error400', $ExceptionRenderer->method); $this->assertEquals($exception, $ExceptionRenderer->error); } /** * test that unknown exception types with valid status codes are treated correctly. * * @return void */ function testUnknownExceptionTypeWithExceptionThatHasA400Code() { $exception = new MissingWidgetThingException('coding fail.'); $ExceptionRenderer = new ExceptionRenderer($exception); $ExceptionRenderer->controller->response = $this->getMock('CakeResponse', array('statusCode', '_sendHeader')); $ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(404); ob_start(); $ExceptionRenderer->render(); $results = ob_get_clean(); $this->assertFalse(method_exists($ExceptionRenderer, 'missingWidgetThing'), 'no method should exist.'); $this->assertEquals('error400', $ExceptionRenderer->method, 'incorrect method coercion.'); } /** * test that unknown exception types with valid status codes are treated correctly. * * @return void */ function testUnknownExceptionTypeWithNoCodeIsA500() { $exception = new OutOfBoundsException('foul ball.'); $ExceptionRenderer = new ExceptionRenderer($exception); $ExceptionRenderer->controller->response = $this->getMock('CakeResponse', array('statusCode', '_sendHeader')); $ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(500); ob_start(); $ExceptionRenderer->render(); $results = ob_get_clean(); $this->assertEquals('error500', $ExceptionRenderer->method, 'incorrect method coercion.'); } /** * test that unknown exception types with valid status codes are treated correctly. * * @return void */ function testUnknownExceptionTypeWithCodeHigherThan500() { $exception = new OutOfBoundsException('foul ball.', 501); $ExceptionRenderer = new ExceptionRenderer($exception); $ExceptionRenderer->controller->response = $this->getMock('CakeResponse', array('statusCode', '_sendHeader')); $ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(501); ob_start(); $ExceptionRenderer->render(); $results = ob_get_clean(); $this->assertEquals('error500', $ExceptionRenderer->method, 'incorrect method coercion.'); } /** * testerror400 method * * @access public * @return void */ function testError400() { Router::reload(); $request = new CakeRequest('posts/view/1000', false); Router::setRequestInfo($request); $exception = new NotFoundException('Custom message'); $ExceptionRenderer = new ExceptionRenderer($exception); $ExceptionRenderer->controller->response = $this->getMock('CakeResponse', array('statusCode', '_sendHeader')); $ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(404); ob_start(); $ExceptionRenderer->render(); $result = ob_get_clean(); $this->assertPattern('/