-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ExceptionRendererTest.php
737 lines (643 loc) · 20.3 KB
/
ExceptionRendererTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
<?php
/**
* ExceptionRendererTest file
*
* PHP 5
*
* CakePHP(tm) Tests <http://book.cakephp.org/view/1196/Testing>
* Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice
*
* @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests
* @package Cake.Test.Case.Error
* @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.Test.Case.Error
*/
class AuthBlueberryUser extends CakeTestModel {
/**
* name property
*
* @var string 'AuthBlueberryUser'
*/
public $name = 'AuthBlueberryUser';
/**
* 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) {
$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 {
public $_restoreError = false;
/**
* setup create a request object to get out of router later.
*
* @return void
*/
public function setUp() {
parent::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
*/
public function tearDown() {
Configure::write('debug', $this->_debug);
Configure::write('Error', $this->_error);
App::build();
if ($this->_restoreError) {
restore_error_handler();
}
parent::tearDown();
}
/**
* 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($result, 'widget thing is missing');
}
/**
* 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($result, 'widget thing is missing', '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 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);
}
/**
* 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' => 'Article')),
array(
'/<h2>Missing Database Connection<\/h2>/',
'/Article requires a database connection/'
),
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');
$ExceptionRenderer->controller->helpers = array('Fail', 'Boom');
$ExceptionRenderer->controller->request = $this->getMock('CakeRequest');
$ExceptionRenderer->controller->expects($this->at(2))
->method('render')
->with('missingHelper')
->will($this->throwException($exception));
$ExceptionRenderer->controller->expects($this->at(4))
->method('render')
->with('error500')
->will($this->returnValue(true));
$ExceptionRenderer->controller->response = $this->getMock('CakeResponse');
$ExceptionRenderer->render();
sort($ExceptionRenderer->controller->helpers);
$this->assertEquals(array('Form', 'Html', 'Session'), $ExceptionRenderer->controller->helpers);
}
/**
* 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');
$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->at(1))
->method('render')
->with('error400')
->will($this->throwException($exception));
$ExceptionRenderer->controller->expects($this->at(3))
->method('render')
->with('error500')
->will($this->returnValue(true));
$ExceptionRenderer->controller->response = $this->getMock('CakeResponse');
$ExceptionRenderer->controller->response->expects($this->once())
->method('type')
->with('html');
$ExceptionRenderer->render();
$this->assertEquals('', $ExceptionRenderer->controller->layoutPath);
$this->assertEquals('', $ExceptionRenderer->controller->subDir);
$this->assertEquals('View', $ExceptionRenderer->controller->viewClass);
}
/**
* Test that exceptions can be rendered when an 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);
$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->assertContains('Internal Error', $result);
}
/**
* 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 = array('seven' => 7);
$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->assertContains('<h2>Database Error</h2>', $result);
$this->assertContains('There was an error in the SQL query', $result);
$this->assertContains('SELECT * from poo_query < 5 and :seven', $result);
$this->assertContains("'seven' => (int) 7", $result);
}
}