pictcode

<?php

/**

 * ExceptionRendererTest file

 *

 * CakePHP(tm) Tests <http://book.cakephp.org/2.0/en/development/testing.html>

 * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)

 *

 * Licensed under The MIT License

 * For full copyright and license information, please see the LICENSE.txt

 * Redistributions of files must retain the above copyright notice

 *

 * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)

 * @link          http://book.cakephp.org/2.0/en/development/testing.html CakePHP(tm) Tests

 * @package       Cake.Test.Case.Error

 * @since         CakePHP(tm) v 2.0

 * @license       http://www.opensource.org/licenses/mit-license.php MIT License

 */

App::uses('ExceptionRenderer', 'Error');

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

App::uses('Component', 'Controller');

App::uses('Router', 'Routing');

/**

 * Short description for class.

 *

 * @package       Cake.Test.Case.Error

 */

class AuthBlueberryUser extends CakeTestModel {

/**

 * useTable property

 *

 * @var string

 */

        public $useTable = false;

}

/**

 * BlueberryComponent class

 *

 * @package       Cake.Test.Case.Error

 */

class BlueberryComponent extends Component {

/**

 * testName property

 *

 * @return void

 */

        public $testName = null;

/**

 * initialize method

 *

 * @return void

 */

        public function initialize(Controller $controller) {

                $this->testName = 'BlueberryComponent';

        }

}

/**

 * TestErrorController class

 *

 * @package       Cake.Test.Case.Error

 */

class TestErrorController extends Controller {

/**

 * uses property

 *

 * @var array

 */

        public $uses = array();

/**

 * components property

 *

 * @return void

 */

        public $components = array('Blueberry');

/**

 * beforeRender method

 *

 * @return void

 */

        public function beforeRender() {

                echo $this->Blueberry->testName;

        }

/**

 * index method

 *

 * @return void

 */

        public function index() {

                $this->autoRender = false;

                return 'what up';

        }

}

/**

 * MyCustomExceptionRenderer class

 *

 * @package       Cake.Test.Case.Error

 */

class MyCustomExceptionRenderer extends ExceptionRenderer {

/**

 * custom error message type.

 *

 * @return void

 */

        public function missingWidgetThing() {

                echo 'widget thing is missing';

        }

}

/**

 * Exception class for testing app error handlers and custom errors.

 *

 * @package       Cake.Test.Case.Error

 */

class MissingWidgetThingException extends NotFoundException {

}

/**

 * ExceptionRendererTest class

 *

 * @package       Cake.Test.Case.Error

 */

class ExceptionRendererTest extends CakeTestCase {

        protected $_restoreError = false;

/**

 * setup create a request object to get out of router later.

 *

 * @return void

 */

        public function setUp() {

                parent::setUp();

                Configure::write('Config.language', 'eng');

                App::build(array(

                        'View' => array(

                                CAKE . 'Test' . DS . 'test_app' . DS . 'View' . DS

                        )

                ), App::RESET);

                Router::reload();

                $request = new CakeRequest(null, false);

                $request->base = '';

                Router::setRequestInfo($request);

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

        }

/**

 * tearDown

 *

 * @return void

 */

        public function tearDown() {

                parent::tearDown();

                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

 */

        public 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->assertEquals('widget thing is missing', $result);

        }

/**

 * test that subclass methods are not converted when debug = 0

 *

 * @return void

 */

        public function testSubclassMethodsNotBeingConvertedDebug0() {

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

                $exception = new MissingWidgetThingException('Widget not found');

                $ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception));

                $this->assertEquals('missingWidgetThing', $ExceptionRenderer->method);

                ob_start();

                $ExceptionRenderer->render();

                $result = ob_get_clean();

                $this->assertEquals('widget thing is missing', $result, 'Method declared in subclass converted to error400');

        }

/**

 * test that ExceptionRenderer subclasses properly convert framework errors.

 *

 * @return void

 */

        public function testSubclassConvertingFrameworkErrors() {

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

                $exception = new MissingControllerException('PostsController');

                $ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception));

                $this->assertEquals('error400', $ExceptionRenderer->method);

                ob_start();

                $ExceptionRenderer->render();

                $result = ob_get_clean();

                $this->assertRegExp('/Not Found/', $result, 'Method declared in error handler not converted to error400. %s');

        }

/**

 * test things in the constructor.

 *

 * @return void

 */

        public 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

 */

        public 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 helpers in custom CakeErrorController are not lost

 *

 * @return void

 */

        public function testCakeErrorHelpersNotLost() {

                $testApp = CAKE . 'Test' . DS . 'test_app' . DS;

                App::build(array(

                        'Controller' => array(

                                $testApp . 'Controller' . DS

                        ),

                        'View/Helper' => array(

                                $testApp . 'View' . DS . 'Helper' . DS

                        ),

                        'View/Layouts' => array(

                                $testApp . 'View' . DS . 'Layouts' . DS

                        ),

                        'Error' => array(

                                $testApp . 'Error' . DS

                        ),

                ), App::RESET);

                App::uses('TestAppsExceptionRenderer', 'Error');

                $exception = new SocketException('socket exception');

                $renderer = new TestAppsExceptionRenderer($exception);

                ob_start();

                $renderer->render();

                $result = ob_get_clean();

                $this->assertContains('<b>peeled</b>', $result);

        }

/**

 * test that unknown exception types with valid status codes are treated correctly.

 *

 * @return void

 */

        public 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();

                $result = ob_get_clean();

                $this->assertFalse(method_exists($ExceptionRenderer, 'missingWidgetThing'), 'no method should exist.');

                $this->assertEquals('error400', $ExceptionRenderer->method, 'incorrect method coercion.');

                $this->assertContains('coding fail', $result, 'Text should show up.');

        }

/**

 * test that unknown exception types with valid status codes are treated correctly.

 *

 * @return void

 */

        public 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();

                $result = ob_get_clean();

                $this->assertEquals('error500', $ExceptionRenderer->method, 'incorrect method coercion.');

                $this->assertContains('foul ball.', $result, 'Text should show up as its debug mode.');

        }

/**

 * test that unknown exceptions have messages ignored.

 *

 * @return void

 */

        public function testUnknownExceptionInProduction() {

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

                $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();

                $result = ob_get_clean();

                $this->assertEquals('error500', $ExceptionRenderer->method, 'incorrect method coercion.');

                $this->assertNotContains('foul ball.', $result, 'Text should no show up.');

                $this->assertContains('Internal Error', $result, 'Generic message only.');

        }

/**

 * test that unknown exception types with valid status codes are treated correctly.

 *

 * @return void

 */

        public 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();

                $result = ob_get_clean();

                $this->assertEquals('error500', $ExceptionRenderer->method, 'incorrect method coercion.');

                $this->assertContains('foul ball.', $result, 'Text should show up as its debug mode.');

        }

/**

 * testerror400 method

 *

 * @return void

 */

        public 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->assertRegExp('/<h2>Custom message<\/h2>/', $result);

                $this->assertRegExp("/<strong>'.*?\/posts\/view\/1000'<\/strong>/", $result);

        }

/**

 * test that error400 only modifies the messages on CakeExceptions.

 *

 * @return void

 */

        public function testerror400OnlyChangingCakeException() {

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

                $exception = new NotFoundException('Custom message');

                $ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));

                ob_start();

                $ExceptionRenderer->render();

                $result = ob_get_clean();

                $this->assertContains('Custom message', $result);

                $exception = new MissingActionException(array('controller' => 'PostsController', 'action' => 'index'));

                $ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));

                ob_start();

                $ExceptionRenderer->render();

                $result = ob_get_clean();

                $this->assertContains('Not Found', $result);

        }

/**

 * test that error400 doesn't expose XSS

 *

 * @return void

 */

        public function testError400NoInjection() {

                Router::reload();

                $request = new CakeRequest('pages/<span id=333>pink</span></id><script>document.body.style.background = t=document.getElementById(333).innerHTML;window.alert(t);</script>', false);

                Router::setRequestInfo($request);

                $exception = new NotFoundException('Custom message');

                $ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));

                ob_start();

                $ExceptionRenderer->render();

                $result = ob_get_clean();

                $this->assertNotRegExp('#<script>document#', $result);

                $this->assertNotRegExp('#alert\(t\);</script>#', $result);

        }

/**

 * testError500 method

 *

 * @return void

 */

        public function testError500Message() {

                $exception = new InternalErrorException('An Internal Error Has Occurred');

                $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();

                $result = ob_get_clean();

                $this->assertRegExp('/<h2>An Internal Error Has Occurred<\/h2>/', $result);

        }

/**

 * testExceptionResponseHeader method

 *

 * @return void

 */

        public function testExceptionResponseHeader() {

                $exception = new MethodNotAllowedException('Only allowing POST and DELETE');

                $exception->responseHeader(array('Allow: POST, DELETE'));

                $ExceptionRenderer = new ExceptionRenderer($exception);

                //Replace response object with mocked object add back the original headers which had been set in ExceptionRenderer constructor

                $headers = $ExceptionRenderer->controller->response->header();

                $ExceptionRenderer->controller->response = $this->getMock('CakeResponse', array('_sendHeader'));

                $ExceptionRenderer->controller->response->header($headers);

                $ExceptionRenderer->controller->response->expects($this->at(1))->method('_sendHeader')->with('Allow', 'POST, DELETE');

                ob_start();

                $ExceptionRenderer->render();

                ob_get_clean();

        }

/**

 * testMissingController method

 *

 * @return void

 */

        public function testMissingController() {

                $exception = new MissingControllerException(array('class' => 'PostsController'));

                $ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));

                ob_start();

                $ExceptionRenderer->render();

                $result = ob_get_clean();

                $this->assertRegExp('/<h2>Missing Controller<\/h2>/', $result);

                $this->assertRegExp('/<em>PostsController<\/em>/', $result);

        }

/**

 * Returns an array of tests to run for the various CakeException classes.

 *

 * @return void

 */

        public static function testProvider() {

                return array(

                        array(

                                new MissingActionException(array('controller' => 'PostsController', 'action' => 'index')),

                                array(

                                        '/<h2>Missing Method in PostsController<\/h2>/',

                                        '/<em>PostsController::<\/em><em>index\(\)<\/em>/'

                                ),

                                404

                        ),

                        array(

                                new PrivateActionException(array('controller' => 'PostsController', 'action' => '_secretSauce')),

                                array(

                                        '/<h2>Private Method in PostsController<\/h2>/',

                                        '/<em>PostsController::<\/em><em>_secretSauce\(\)<\/em>/'

                                ),

                                404

                        ),

                        array(

                                new MissingTableException(array('table' => 'articles', 'class' => 'Article', 'ds' => 'test')),

                                array(

                                        '/<h2>Missing Database Table<\/h2>/',

                                        '/Table <em>articles<\/em> for model <em>Article<\/em> was not found in datasource <em>test<\/em>/'

                                ),

                                500

                        ),

                        array(

                                new MissingDatabaseException(array('connection' => 'default')),

                                array(

                                        '/<h2>Missing Database Connection<\/h2>/',

                                        '/Confirm you have created the file/'

                                ),

                                500

                        ),

                        array(

                                new MissingViewException(array('file' => '/posts/about.ctp')),

                                array(

                                        "/posts\/about.ctp/"

                                ),

                                500

                        ),

                        array(

                                new MissingLayoutException(array('file' => 'layouts/my_layout.ctp')),

                                array(

                                        "/Missing Layout/",

                                        "/layouts\/my_layout.ctp/"

                                ),

                                500

                        ),

                        array(

                                new MissingConnectionException(array('class' => 'Mysql')),

                                array(

                                        '/<h2>Missing Database Connection<\/h2>/',

                                        '/A Database connection using "Mysql" was missing or unable to connect./',

                                ),

                                500

                        ),

                        array(

                                new MissingConnectionException(array('class' => 'Mysql', 'enabled' => false)),

                                array(

                                        '/<h2>Missing Database Connection<\/h2>/',

                                        '/A Database connection using "Mysql" was missing or unable to connect./',

                                        '/Mysql driver is NOT enabled/'

                                ),

                                500

                        ),

                        array(

                                new MissingDatasourceConfigException(array('config' => 'default')),

                                array(

                                        '/<h2>Missing Datasource Configuration<\/h2>/',

                                        '/The datasource configuration <em>default<\/em> was not found in database.php/'

                                ),

                                500

                        ),

                        array(

                                new MissingDatasourceException(array('class' => 'MyDatasource', 'plugin' => 'MyPlugin')),

                                array(

                                        '/<h2>Missing Datasource<\/h2>/',

                                        '/Datasource class <em>MyPlugin.MyDatasource<\/em> could not be found/'

                                ),

                                500

                        ),

                        array(

                                new MissingHelperException(array('class' => 'MyCustomHelper')),

                                array(

                                        '/<h2>Missing Helper<\/h2>/',

                                        '/<em>MyCustomHelper<\/em> could not be found./',

                                        '/Create the class <em>MyCustomHelper<\/em> below in file:/',

                                        '/(\/|\\\)MyCustomHelper.php/'

                                ),

                                500

                        ),

                        array(

                                new MissingBehaviorException(array('class' => 'MyCustomBehavior')),

                                array(

                                        '/<h2>Missing Behavior<\/h2>/',

                                        '/Create the class <em>MyCustomBehavior<\/em> below in file:/',

                                        '/(\/|\\\)MyCustomBehavior.php/'

                                ),

                                500

                        ),

                        array(

                                new MissingComponentException(array('class' => 'SideboxComponent')),

                                array(

                                        '/<h2>Missing Component<\/h2>/',

                                        '/Create the class <em>SideboxComponent<\/em> below in file:/',

                                        '/(\/|\\\)SideboxComponent.php/'

                                ),

                                500

                        ),

                        array(

                                new Exception('boom'),

                                array(

                                        '/Internal Error/'

                                ),

                                500

                        ),

                        array(

                                new RuntimeException('another boom'),

                                array(

                                        '/Internal Error/'

                                ),

                                500

                        ),

                        array(

                                new CakeException('base class'),

                                array('/Internal Error/'),

                                500

                        ),

                        array(

                                new ConfigureException('No file'),

                                array('/Internal Error/'),

                                500

                        )

                );

        }

/**

 * Test the various CakeException sub classes

 *

 * @dataProvider testProvider

 * @return void

 */

        public function testCakeExceptionHandling($exception, $patterns, $code) {

                $ExceptionRenderer = new ExceptionRenderer($exception);

                $ExceptionRenderer->controller->response = $this->getMock('CakeResponse', array('statusCode', '_sendHeader'));

                $ExceptionRenderer->controller->response->expects($this->once())

                        ->method('statusCode')

                        ->with($code);

                ob_start();

                $ExceptionRenderer->render();

                $result = ob_get_clean();

                foreach ($patterns as $pattern) {

                        $this->assertRegExp($pattern, $result);

                }

        }

/**

 * Test exceptions being raised when helpers are missing.

 *

 * @return void

 */

        public function testMissingRenderSafe() {

                $exception = new MissingHelperException(array('class' => 'Fail'));

                $ExceptionRenderer = new ExceptionRenderer($exception);

                $ExceptionRenderer->controller = $this->getMock('Controller', array('render'));

                $ExceptionRenderer->controller->helpers = array('Fail', 'Boom');

                $ExceptionRenderer->controller->request = $this->getMock('CakeRequest');

                $ExceptionRenderer->controller->expects($this->at(0))

                        ->method('render')

                        ->with('missingHelper')

                        ->will($this->throwException($exception));

                $response = $this->getMock('CakeResponse');

                $response->expects($this->once())

                        ->method('body')

                        ->with($this->stringContains('Helper class Fail'));

                $ExceptionRenderer->controller->response = $response;

                $ExceptionRenderer->render();

                sort($ExceptionRenderer->controller->helpers);

                $this->assertEquals(array('Form', 'Html', 'Session'), $ExceptionRenderer->controller->helpers);

        }

/**

 * Test that exceptions in beforeRender() are handled by outputMessageSafe

 *

 * @return void

 */

        public function testRenderExceptionInBeforeRender() {

                $exception = new NotFoundException('Not there, sorry');

                $ExceptionRenderer = new ExceptionRenderer($exception);

                $ExceptionRenderer->controller = $this->getMock('Controller', array('beforeRender'));

                $ExceptionRenderer->controller->request = $this->getMock('CakeRequest');

                $ExceptionRenderer->controller->expects($this->any())

                        ->method('beforeRender')

                        ->will($this->throwException($exception));

                $response = $this->getMock('CakeResponse');

                $response->expects($this->once())

                        ->method('body')

                        ->with($this->stringContains('Not there, sorry'));

                $ExceptionRenderer->controller->response = $response;

                $ExceptionRenderer->render();

        }

/**

 * Test that missing subDir/layoutPath don't cause other fatal errors.

 *

 * @return void

 */

        public function testMissingSubdirRenderSafe() {

                $exception = new NotFoundException();

                $ExceptionRenderer = new ExceptionRenderer($exception);

                $ExceptionRenderer->controller = $this->getMock('Controller', array('render'));

                $ExceptionRenderer->controller->helpers = array('Fail', 'Boom');

                $ExceptionRenderer->controller->layoutPath = 'json';

                $ExceptionRenderer->controller->subDir = 'json';

                $ExceptionRenderer->controller->viewClass = 'Json';

                $ExceptionRenderer->controller->request = $this->getMock('CakeRequest');

                $ExceptionRenderer->controller->expects($this->once())

                        ->method('render')

                        ->with('error400')

                        ->will($this->throwException($exception));

                $response = $this->getMock('CakeResponse');

                $response->expects($this->once())

                        ->method('body')

                        ->with($this->stringContains('Not Found'));

                $response->expects($this->once())

                        ->method('type')

                        ->with('html');

                $ExceptionRenderer->controller->response = $response;

                $ExceptionRenderer->render();

                $this->assertEquals('', $ExceptionRenderer->controller->layoutPath);

                $this->assertEquals('', $ExceptionRenderer->controller->subDir);

                $this->assertEquals('Errors', $ExceptionRenderer->controller->viewPath);

        }

/**

 * Test that missing plugin disables Controller::$plugin if the two are the same plugin.

 *

 * @return void

 */

        public function testMissingPluginRenderSafe() {

                $exception = new NotFoundException();

                $ExceptionRenderer = new ExceptionRenderer($exception);

                $ExceptionRenderer->controller = $this->getMock('Controller', array('render'));

                $ExceptionRenderer->controller->plugin = 'TestPlugin';

                $ExceptionRenderer->controller->request = $this->getMock('CakeRequest');

                $exception = new MissingPluginException(array('plugin' => 'TestPlugin'));

                $ExceptionRenderer->controller->expects($this->once())

                        ->method('render')

                        ->with('error400')

                        ->will($this->throwException($exception));

                $response = $this->getMock('CakeResponse');

                $response->expects($this->once())

                        ->method('body')

                        ->with($this->logicalAnd(

                                $this->logicalNot($this->stringContains('test plugin error500')),

                                $this->stringContains('Not Found')

                        ));

                $ExceptionRenderer->controller->response = $response;

                $ExceptionRenderer->render();

        }

/**

 * Test that missing plugin doesn't disable Controller::$plugin if the two aren't the same plugin.

 *

 * @return void

 */

        public function testMissingPluginRenderSafeWithPlugin() {

                App::build(array(

                        'Plugin' => array(CAKE . 'Test' . DS . 'test_app' . DS . 'Plugin' . DS)

                ), App::RESET);

                CakePlugin::load('TestPlugin');

                $exception = new NotFoundException();

                $ExceptionRenderer = new ExceptionRenderer($exception);

                $ExceptionRenderer->controller = $this->getMock('Controller', array('render'));

                $ExceptionRenderer->controller->plugin = 'TestPlugin';

                $ExceptionRenderer->controller->request = $this->getMock('CakeRequest');

                $exception = new MissingPluginException(array('plugin' => 'TestPluginTwo'));

                $ExceptionRenderer->controller->expects($this->once())

                        ->method('render')