* 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
* @since 2.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\Error;
use Cake\Controller\Component;
use Cake\Controller\Controller;
use Cake\Controller\Exception\MissingActionException;
use Cake\Controller\Exception\MissingComponentException;
use Cake\Core\App;
use Cake\Core\Configure;
use Cake\Core\Exception\MissingPluginException;
use Cake\Core\Plugin;
use Cake\Datasource\Exception\MissingDatasourceConfigException;
use Cake\Datasource\Exception\MissingDatasourceException;
use Cake\Error;
use Cake\Error\ExceptionRenderer;
use Cake\Event\Event;
use Cake\Event\EventManager;
use Cake\Network\Exception\InternalErrorException;
use Cake\Network\Exception\MethodNotAllowedException;
use Cake\Network\Exception\NotFoundException;
use Cake\Network\Exception\SocketException;
use Cake\Network\Request;
use Cake\ORM\Exception\MissingBehaviorException;
use Cake\Routing\Exception\MissingControllerException;
use Cake\Routing\Router;
use Cake\TestSuite\TestCase;
use Cake\View\Exception\MissingHelperException;
use Cake\View\Exception\MissingLayoutException;
use Cake\View\Exception\MissingTemplateException;
/**
* BlueberryComponent class
*
*/
class BlueberryComponent extends Component
{
/**
* testName property
*
* @return void
*/
public $testName = null;
/**
* initialize method
*
* @param array $config
* @return void
*/
public function initialize(array $config)
{
$this->testName = 'BlueberryComponent';
}
}
/**
* TestErrorController class
*
*/
class TestErrorController extends Controller
{
/**
* uses property
*
* @var array
*/
public $uses = [];
/**
* components property
*
* @return void
*/
public $components = ['Blueberry'];
/**
* beforeRender method
*
* @return void
*/
public function beforeRender(Event $event)
{
echo $this->Blueberry->testName;
}
/**
* index method
*
* @return void
*/
public function index()
{
$this->autoRender = false;
return 'what up';
}
}
/**
* MyCustomExceptionRenderer class
*
*/
class MyCustomExceptionRenderer extends ExceptionRenderer
{
/**
* custom error message type.
*
* @return void
*/
public function missingWidgetThing()
{
return 'widget thing is missing';
}
}
/**
* Exception class for testing app error handlers and custom errors.
*
*/
class MissingWidgetThingException extends NotFoundException
{
}
/**
* Exception class for testing app error handlers and custom errors.
*
*/
class MissingWidgetThing extends \Exception
{
}
/**
* ExceptionRendererTest class
*
*/
class ExceptionRendererTest extends TestCase
{
/**
* @var bool
*/
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');
Router::reload();
$request = new Request();
$request->base = '';
Router::setRequestInfo($request);
Configure::write('debug', true);
}
/**
* 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('Cake\Network\Response', ['_sendHeader']);
return $error;
}
/**
* test that methods declared in an ExceptionRenderer subclass are not converted
* into error400 when debug > 0
*
* @return void
*/
public function testSubclassMethodsNotBeingConvertedToError()
{
$exception = new MissingWidgetThingException('Widget not found');
$ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception));
$result = $ExceptionRenderer->render();
$this->assertEquals('widget thing is missing', $result->body());
}
/**
* test that subclass methods are not converted when debug = 0
*
* @return void
*/
public function testSubclassMethodsNotBeingConvertedDebug0()
{
Configure::write('debug', false);
$exception = new MissingWidgetThingException('Widget not found');
$ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception));
$result = $ExceptionRenderer->render();
$this->assertEquals('missingWidgetThing', $ExceptionRenderer->method);
$this->assertEquals(
'widget thing is missing',
$result->body(),
'Method declared in subclass converted to error400'
);
}
/**
* test that ExceptionRenderer subclasses properly convert framework errors.
*
* @return void
*/
public function testSubclassConvertingFrameworkErrors()
{
Configure::write('debug', false);
$exception = new MissingControllerException('PostsController');
$ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception));
$result = $ExceptionRenderer->render();
$this->assertRegExp(
'/Not Found/',
$result->body(),
'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('Cake\Controller\ErrorController', $ExceptionRenderer->controller);
$this->assertEquals($exception, $ExceptionRenderer->error);
}
/**
* test that exception message gets coerced when debug = 0
*
* @return void
*/
public function testExceptionMessageCoercion()
{
Configure::write('debug', false);
$exception = new MissingActionException('Secret info not to be leaked');
$ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));
$this->assertInstanceOf('Cake\Controller\ErrorController', $ExceptionRenderer->controller);
$this->assertEquals($exception, $ExceptionRenderer->error);
$result = $ExceptionRenderer->render()->body();
$this->assertEquals('error400', $ExceptionRenderer->template);
$this->assertContains('Not Found', $result);
$this->assertNotContains('Secret info not to be leaked', $result);
}
/**
* test that helpers in custom CakeErrorController are not lost
*
* @return void
*/
public function testCakeErrorHelpersNotLost()
{
Configure::write('App.namespace', 'TestApp');
$exception = new SocketException('socket exception');
$renderer = $this->_mockResponse(new \TestApp\Error\TestAppsExceptionRenderer($exception));
$result = $renderer->render();
$this->assertContains('peeled', $result->body());
}
/**
* 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('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(404);
$result = $ExceptionRenderer->render();
$this->assertFalse(method_exists($ExceptionRenderer, 'missingWidgetThing'), 'no method should exist.');
$this->assertContains('coding fail', $result->body(), '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('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())
->method('statusCode')
->with(500);
$result = $ExceptionRenderer->render();
$this->assertContains('foul ball.', $result->body(), 'Text should show up as its debug mode.');
}
/**
* test that unknown exceptions have messages ignored.
*
* @return void
*/
public function testUnknownExceptionInProduction()
{
Configure::write('debug', false);
$exception = new \OutOfBoundsException('foul ball.');
$ExceptionRenderer = new ExceptionRenderer($exception);
$ExceptionRenderer->controller->response = $this->getMock('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())
->method('statusCode')
->with(500);
$result = $ExceptionRenderer->render()->body();
$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('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(501);
$result = $ExceptionRenderer->render();
$this->assertContains('foul ball.', $result->body(), 'Text should show up as its debug mode.');
}
/**
* testerror400 method
*
* @return void
*/
public function testError400()
{
Router::reload();
$request = new Request('posts/view/1000');
Router::setRequestInfo($request);
$exception = new NotFoundException('Custom message');
$ExceptionRenderer = new ExceptionRenderer($exception);
$ExceptionRenderer->controller->response = $this->getMock('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(404);
$result = $ExceptionRenderer->render()->body();
$this->assertContains('
Custom message
', $result);
$this->assertRegExp("/'.*?\/posts\/view\/1000'<\/strong>/", $result);
}
/**
* test that error400 only modifies the messages on Cake Exceptions.
*
* @return void
*/
public function testerror400OnlyChangingCakeException()
{
Configure::write('debug', false);
$exception = new NotFoundException('Custom message');
$ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));
$result = $ExceptionRenderer->render();
$this->assertContains('Custom message', $result->body());
$exception = new MissingActionException(['controller' => 'PostsController', 'action' => 'index']);
$ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));
$result = $ExceptionRenderer->render();
$this->assertContains('Not Found', $result->body());
}
/**
* test that error400 doesn't expose XSS
*
* @return void
*/
public function testError400NoInjection()
{
Router::reload();
$request = new Request('pages/pink');
Router::setRequestInfo($request);
$exception = new NotFoundException('Custom message');
$ExceptionRenderer = $this->_mockResponse(new ExceptionRenderer($exception));
$result = $ExceptionRenderer->render()->body();
$this->assertNotContains('', $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('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(500);
$result = $ExceptionRenderer->render();
$this->assertContains('An Internal Error Has Occurred
', $result->body());
$this->assertContains('An Internal Error Has Occurred.', $result->body());
}
/**
* testExceptionResponseHeader method
*
* @return void
*/
public function testExceptionResponseHeader()
{
$exception = new MethodNotAllowedException('Only allowing POST and DELETE');
$exception->responseHeader(['Allow: POST, DELETE']);
$ExceptionRenderer = new ExceptionRenderer($exception);
$result = $ExceptionRenderer->render();
$headers = $result->header();
$this->assertArrayHasKey('Allow', $headers);
$this->assertEquals('POST, DELETE', $headers['Allow']);
}
/**
* testMissingController method
*
* @return void
*/
public function testMissingController()
{
$exception = new MissingControllerException([
'class' => 'Posts',
'prefix' => '',
'plugin' => '',
]);
$ExceptionRenderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception));
$result = $ExceptionRenderer->render()->body();
$this->assertEquals('missingController', $ExceptionRenderer->template);
$this->assertContains('Missing Controller', $result);
$this->assertContains('PostsController', $result);
}
/**
* Returns an array of tests to run for the various Cake Exception classes.
*
* @return array
*/
public static function exceptionProvider()
{
return [
[
new MissingActionException([
'controller' => 'PostsController',
'action' => 'index',
'prefix' => '',
'plugin' => '',
]),
[
'/Missing Method in PostsController/',
'/PostsController::index\(\)<\/em>/'
],
404
],
[
new MissingTemplateException(['file' => '/posts/about.ctp']),
[
"/posts\/about.ctp/"
],
500
],
[
new MissingLayoutException(['file' => 'layouts/my_layout.ctp']),
[
"/Missing Layout/",
"/layouts\/my_layout.ctp/"
],
500
],
[
new MissingHelperException(['class' => 'MyCustomHelper']),
[
'/Missing Helper/',
'/MyCustomHelper<\/em> could not be found./',
'/Create the class MyCustomHelper<\/em> below in file:/',
'/(\/|\\\)MyCustomHelper.php/'
],
500
],
[
new MissingBehaviorException(['class' => 'MyCustomBehavior']),
[
'/Missing Behavior/',
'/Create the class MyCustomBehavior<\/em> below in file:/',
'/(\/|\\\)MyCustomBehavior.php/'
],
500
],
[
new MissingComponentException(['class' => 'SideboxComponent']),
[
'/Missing Component/',
'/Create the class SideboxComponent<\/em> below in file:/',
'/(\/|\\\)SideboxComponent.php/'
],
500
],
[
new MissingDatasourceConfigException(['name' => 'MyDatasourceConfig']),
[
'/Missing Datasource Configuration/',
'/MyDatasourceConfig<\/em> was not found/'
],
500
],
[
new MissingDatasourceException(['class' => 'MyDatasource', 'plugin' => 'MyPlugin']),
[
'/Missing Datasource/',
'/MyPlugin.MyDatasource<\/em> could not be found./'
],
500
],
[
new \Exception('boom'),
[
'/Internal Error/'
],
500
],
[
new \RuntimeException('another boom'),
[
'/Internal Error/'
],
500
],
[
new \Cake\Core\Exception\Exception('base class'),
['/Internal Error/'],
500
]
];
}
/**
* Test the various Cake Exception sub classes
*
* @dataProvider exceptionProvider
* @return void
*/
public function testCakeExceptionHandling($exception, $patterns, $code)
{
$ExceptionRenderer = new ExceptionRenderer($exception);
$ExceptionRenderer->controller->response = $this->getMock('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())
->method('statusCode')
->with($code);
$result = $ExceptionRenderer->render()->body();
foreach ($patterns as $pattern) {
$this->assertRegExp($pattern, $result);
}
}
/**
* Test that class names not ending in Exception are not mangled.
*
* @return void
*/
public function testExceptionNameMangling()
{
$exceptionRenderer = new MyCustomExceptionRenderer(new MissingWidgetThing());
$result = $exceptionRenderer->render()->body();
$this->assertContains('widget thing is missing', $result);
}
/**
* Test exceptions being raised when helpers are missing.
*
* @return void
*/
public function testMissingRenderSafe()
{
$exception = new MissingHelperException(['class' => 'Fail']);
$ExceptionRenderer = new ExceptionRenderer($exception);
$ExceptionRenderer->controller = $this->getMock('Cake\Controller\Controller', ['render']);
$ExceptionRenderer->controller->helpers = ['Fail', 'Boom'];
$ExceptionRenderer->controller->request = new Request;
$ExceptionRenderer->controller->expects($this->at(0))
->method('render')
->with('missingHelper')
->will($this->throwException($exception));
$response = $this->getMock('Cake\Network\Response');
$response->expects($this->once())
->method('body')
->with($this->stringContains('Helper class Fail'));
$ExceptionRenderer->controller->response = $response;
$ExceptionRenderer->render();
sort($ExceptionRenderer->controller->helpers);
$this->assertEquals(['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('Cake\Controller\Controller', ['beforeRender']);
$ExceptionRenderer->controller->request = new Request;
$ExceptionRenderer->controller->expects($this->any())
->method('beforeRender')
->will($this->throwException($exception));
$response = $this->getMock('Cake\Network\Response');
$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('Cake\Controller\Controller', ['render']);
$ExceptionRenderer->controller->helpers = ['Fail', 'Boom'];
$ExceptionRenderer->controller->layoutPath = 'boom';
$ExceptionRenderer->controller->subDir = 'boom';
$ExceptionRenderer->controller->request = new Request;
$ExceptionRenderer->controller->expects($this->once())
->method('render')
->with('error400')
->will($this->throwException($exception));
$response = $this->getMock('Cake\Network\Response');
$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('Error', $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('Cake\Controller\Controller', ['render']);
$ExceptionRenderer->controller->plugin = 'TestPlugin';
$ExceptionRenderer->controller->request = $this->getMock('Cake\Network\Request');
$exception = new MissingPluginException(['plugin' => 'TestPlugin']);
$ExceptionRenderer->controller->expects($this->once())
->method('render')
->with('error400')
->will($this->throwException($exception));
$response = $this->getMock('Cake\Network\Response');
$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()
{
Plugin::load('TestPlugin');
$exception = new NotFoundException();
$ExceptionRenderer = new ExceptionRenderer($exception);
$ExceptionRenderer->controller = $this->getMock('Cake\Controller\Controller', ['render']);
$ExceptionRenderer->controller->plugin = 'TestPlugin';
$ExceptionRenderer->controller->request = $this->getMock('Cake\Network\Request');
$exception = new MissingPluginException(['plugin' => 'TestPluginTwo']);
$ExceptionRenderer->controller->expects($this->once())
->method('render')
->with('error400')
->will($this->throwException($exception));
$response = $this->getMock('Cake\Network\Response');
$response->expects($this->once())
->method('body')
->with($this->logicalAnd(
$this->stringContains('test plugin error500'),
$this->stringContains('Not Found')
));
$ExceptionRenderer->controller->response = $response;
$ExceptionRenderer->render();
Plugin::unload();
}
/**
* Test that exceptions can be rendered when a request hasn't been registered
* with Router
*
* @return void
*/
public function testRenderWithNoRequest()
{
Router::reload();
$this->assertNull(Router::getRequest(false));
$exception = new \Exception('Terrible');
$ExceptionRenderer = new ExceptionRenderer($exception);
$result = $ExceptionRenderer->render();
$this->assertContains('Internal Error', $result->body());
$this->assertEquals(500, $result->statusCode());
}
/**
* Test that rendering exceptions triggers shutdown events.
*
* @return void
*/
public function testRenderShutdownEvents()
{
$fired = [];
$listener = function ($event) use (&$fired) {
$fired[] = $event->name();
};
$events = EventManager::instance();
$events->attach($listener, 'Controller.shutdown');
$events->attach($listener, 'Dispatcher.afterDispatch');
$exception = new \Exception('Terrible');
$renderer = new ExceptionRenderer($exception);
$renderer->render();
$expected = ['Controller.shutdown', 'Dispatcher.afterDispatch'];
$this->assertEquals($expected, $fired);
}
/**
* test that subclass methods fire shutdown events.
*
* @return void
*/
public function testSubclassTriggerShutdownEvents()
{
$fired = [];
$listener = function ($event) use (&$fired) {
$fired[] = $event->name();
};
$events = EventManager::instance();
$events->attach($listener, 'Controller.shutdown');
$events->attach($listener, 'Dispatcher.afterDispatch');
$exception = new MissingWidgetThingException('Widget not found');
$renderer = $this->_mockResponse(new MyCustomExceptionRenderer($exception));
$renderer->render();
$expected = ['Controller.shutdown', 'Dispatcher.afterDispatch'];
$this->assertEquals($expected, $fired);
}
/**
* Tests the output of rendering a PDOException
*
* @return void
*/
public function testPDOException()
{
$exception = new \PDOException('There was an error in the SQL query');
$exception->queryString = 'SELECT * from poo_query < 5 and :seven';
$exception->params = ['seven' => 7];
$ExceptionRenderer = new ExceptionRenderer($exception);
$ExceptionRenderer->controller->response = $this->getMock('Cake\Network\Response', ['statusCode', '_sendHeader']);
$ExceptionRenderer->controller->response->expects($this->once())->method('statusCode')->with(500);
$result = $ExceptionRenderer->render()->body();
$this->assertContains('Database Error', $result);
$this->assertContains('There was an error in the SQL query', $result);
$this->assertContains(h('SELECT * from poo_query < 5 and :seven'), $result);
$this->assertContains("'seven' => (int) 7", $result);
}
}