/
ErrorHandlerTest.php
474 lines (413 loc) · 13.6 KB
/
ErrorHandlerTest.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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 1.2.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\Error;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Error\ErrorHandler;
use Cake\Error\PHP7ErrorException;
use Cake\Http\ServerRequest;
use Cake\Log\Log;
use Cake\Network\Exception\ForbiddenException;
use Cake\Network\Exception\NotFoundException;
use Cake\Routing\Exception\MissingControllerException;
use Cake\Routing\Router;
use Cake\TestSuite\TestCase;
use ParseError;
/**
* Testing stub.
*/
class TestErrorHandler extends ErrorHandler
{
/**
* Access the response used.
*
* @var \Cake\Http\Response
*/
public $response;
/**
* Stub output clearing in tests.
*
* @return void
*/
protected function _clearOutput()
{
// noop
}
/**
* Stub sending responses
*
* @return void
*/
protected function _sendResponse($response)
{
$this->response = $response;
}
}
/**
* ErrorHandlerTest class
*/
class ErrorHandlerTest extends TestCase
{
protected $_restoreError = false;
/**
* setup create a request object to get out of router later.
*
* @return void
*/
public function setUp()
{
parent::setUp();
Router::reload();
$request = new ServerRequest();
$request->base = '';
$request->env('HTTP_REFERER', '/referer');
Router::setRequestInfo($request);
Configure::write('debug', true);
$this->_logger = $this->getMockBuilder('Psr\Log\LoggerInterface')->getMock();
Log::reset();
Log::config('error_test', [
'engine' => $this->_logger
]);
}
/**
* tearDown
*
* @return void
*/
public function tearDown()
{
parent::tearDown();
Log::reset();
if ($this->_restoreError) {
restore_error_handler();
restore_exception_handler();
}
}
/**
* test error handling when debug is on, an error should be printed from Debugger.
*
* @return void
*/
public function testHandleErrorDebugOn()
{
$errorHandler = new ErrorHandler();
$errorHandler->register();
$this->_restoreError = true;
ob_start();
$wrong = $wrong + 1;
$result = ob_get_clean();
$this->assertRegExp('/<pre class="cake-error">/', $result);
$this->assertRegExp('/<b>Notice<\/b>/', $result);
$this->assertRegExp('/variable:\s+wrong/', $result);
}
/**
* provides errors for mapping tests.
*
* @return void
*/
public static function errorProvider()
{
return [
[E_USER_NOTICE, 'Notice'],
[E_USER_WARNING, 'Warning'],
];
}
/**
* test error mappings
*
* @dataProvider errorProvider
* @return void
*/
public function testErrorMapping($error, $expected)
{
$errorHandler = new ErrorHandler();
$errorHandler->register();
$this->_restoreError = true;
ob_start();
trigger_error('Test error', $error);
$result = ob_get_clean();
$this->assertContains('<b>' . $expected . '</b>', $result);
}
/**
* test error prepended by @
*
* @return void
*/
public function testErrorSuppressed()
{
$errorHandler = new ErrorHandler();
$errorHandler->register();
$this->_restoreError = true;
ob_start();
//@codingStandardsIgnoreStart
@include 'invalid.file';
//@codingStandardsIgnoreEnd
$result = ob_get_clean();
$this->assertEmpty($result);
}
/**
* Test that errors go into Cake Log when debug = 0.
*
* @return void
*/
public function testHandleErrorDebugOff()
{
Configure::write('debug', false);
$errorHandler = new ErrorHandler();
$errorHandler->register();
$this->_restoreError = true;
$this->_logger->expects($this->once())
->method('log')
->with(
$this->matchesRegularExpression('(notice|debug)'),
'Notice (8): Undefined variable: out in [' . __FILE__ . ', line ' . (__LINE__ + 3) . ']' . "\n\n"
);
$out = $out + 1;
}
/**
* Test that errors going into Cake Log include traces.
*
* @return void
*/
public function testHandleErrorLoggingTrace()
{
Configure::write('debug', false);
$errorHandler = new ErrorHandler(['trace' => true]);
$errorHandler->register();
$this->_restoreError = true;
$this->_logger->expects($this->once())
->method('log')
->with(
$this->matchesRegularExpression('(notice|debug)'),
$this->logicalAnd(
$this->stringContains('Notice (8): Undefined variable: out in '),
$this->stringContains('Trace:'),
$this->stringContains(__NAMESPACE__ . '\ErrorHandlerTest::testHandleErrorLoggingTrace()'),
$this->stringContains('Request URL:'),
$this->stringContains('Referer URL:')
)
);
$out = $out + 1;
}
/**
* test handleException generating a page.
*
* @return void
*/
public function testHandleException()
{
$error = new NotFoundException('Kaboom!');
$errorHandler = new TestErrorHandler();
$errorHandler->handleException($error);
$this->assertContains('Kaboom!', $errorHandler->response->body(), 'message missing.');
}
/**
* test handleException generating log.
*
* @return void
*/
public function testHandleExceptionLog()
{
$errorHandler = new TestErrorHandler([
'log' => true,
'trace' => true,
]);
$error = new NotFoundException('Kaboom!');
$this->_logger->expects($this->at(0))
->method('log')
->with('error', $this->logicalAnd(
$this->stringContains('[Cake\Network\Exception\NotFoundException] Kaboom!'),
$this->stringContains('ErrorHandlerTest->testHandleExceptionLog')
));
$this->_logger->expects($this->at(1))
->method('log')
->with('error', $this->logicalAnd(
$this->stringContains('[Cake\Network\Exception\NotFoundException] Kaboom!'),
$this->logicalNot($this->stringContains('ErrorHandlerTest->testHandleExceptionLog'))
));
$errorHandler->handleException($error);
$this->assertContains('Kaboom!', $errorHandler->response->body(), 'message missing.');
$errorHandler = new TestErrorHandler([
'log' => true,
'trace' => false,
]);
$errorHandler->handleException($error);
}
/**
* test logging attributes with/without debug
*
* @return void
*/
public function testHandleExceptionLogAttributes()
{
$errorHandler = new TestErrorHandler([
'log' => true,
'trace' => true,
]);
$error = new MissingControllerException(['class' => 'Derp']);
$this->_logger->expects($this->at(0))
->method('log')
->with('error', $this->logicalAnd(
$this->stringContains(
'[Cake\Routing\Exception\MissingControllerException] ' .
'Controller class Derp could not be found.'
),
$this->stringContains('Exception Attributes:'),
$this->stringContains('Request URL:'),
$this->stringContains('Referer URL:')
));
$this->_logger->expects($this->at(1))
->method('log')
->with('error', $this->logicalAnd(
$this->stringContains(
'[Cake\Routing\Exception\MissingControllerException] ' .
'Controller class Derp could not be found.'
),
$this->logicalNot($this->stringContains('Exception Attributes:'))
));
$errorHandler->handleException($error);
Configure::write('debug', false);
$errorHandler->handleException($error);
}
/**
* test handleException generating log.
*
* @return void
*/
public function testHandleExceptionLogSkipping()
{
$notFound = new NotFoundException('Kaboom!');
$forbidden = new ForbiddenException('Fooled you!');
$this->_logger->expects($this->once())
->method('log')
->with(
'error',
$this->stringContains('[Cake\Network\Exception\ForbiddenException] Fooled you!')
);
$errorHandler = new TestErrorHandler([
'log' => true,
'skipLog' => ['Cake\Network\Exception\NotFoundException'],
]);
$errorHandler->handleException($notFound);
$this->assertContains('Kaboom!', $errorHandler->response->body(), 'message missing.');
$errorHandler->handleException($forbidden);
$this->assertContains('Fooled you!', $errorHandler->response->body(), 'message missing.');
}
/**
* tests it is possible to load a plugin exception renderer
*
* @return void
*/
public function testLoadPluginHandler()
{
Plugin::load('TestPlugin');
$errorHandler = new TestErrorHandler([
'exceptionRenderer' => 'TestPlugin.TestPluginExceptionRenderer',
]);
$error = new NotFoundException('Kaboom!');
$errorHandler->handleException($error);
$result = $errorHandler->response;
$this->assertEquals('Rendered by test plugin', $result);
}
/**
* test handleFatalError generating a page.
*
* These tests start two buffers as handleFatalError blows the outer one up.
*
* @return void
*/
public function testHandleFatalErrorPage()
{
$line = __LINE__;
$errorHandler = new TestErrorHandler();
Configure::write('debug', true);
$errorHandler->handleFatalError(E_ERROR, 'Something wrong', __FILE__, $line);
$result = $errorHandler->response->body();
$this->assertContains('Something wrong', $result, 'message missing.');
$this->assertContains(__FILE__, $result, 'filename missing.');
$this->assertContains((string)$line, $result, 'line missing.');
Configure::write('debug', false);
$errorHandler->handleFatalError(E_ERROR, 'Something wrong', __FILE__, $line);
$result = $errorHandler->response->body();
$this->assertNotContains('Something wrong', $result, 'message must not appear.');
$this->assertNotContains(__FILE__, $result, 'filename must not appear.');
$this->assertContains('An Internal Error Has Occurred.', $result);
}
/**
* test handleFatalError generating log.
*
* @return void
*/
public function testHandleFatalErrorLog()
{
$this->_logger->expects($this->at(0))
->method('log')
->with('error', $this->logicalAnd(
$this->stringContains(__FILE__ . ', line ' . (__LINE__ + 9)),
$this->stringContains('Fatal Error (1)'),
$this->stringContains('Something wrong')
));
$this->_logger->expects($this->at(1))
->method('log')
->with('error', $this->stringContains('[Cake\Error\FatalErrorException] Something wrong'));
$errorHandler = new TestErrorHandler(['log' => true]);
$errorHandler->handleFatalError(E_ERROR, 'Something wrong', __FILE__, __LINE__);
}
/**
* Tests Handling a PHP7 error
*
* @return void
*/
public function testHandlePHP7Error()
{
$this->skipIf(!class_exists('Error'), 'Requires PHP7');
$error = new PHP7ErrorException(new ParseError('Unexpected variable foo'));
$errorHandler = new TestErrorHandler();
$errorHandler->handleException($error);
$this->assertContains('Unexpected variable foo', $errorHandler->response->body(), 'message missing.');
}
/**
* Data provider for memory limit changing.
*
* @return array
*/
public function memoryLimitProvider()
{
return [
// start, adjust, expected
['256M', 4, '262148K'],
['262144K', 4, '262148K'],
['1G', 128, '1048704K'],
];
}
/**
* Test increasing the memory limit.
*
* @dataProvider memoryLimitProvider
* @return void
*/
public function testIncreaseMemoryLimit($start, $adjust, $expected)
{
$initial = ini_get('memory_limit');
$this->skipIf(strlen($initial) === 0, 'Cannot read memory limit, and cannot test increasing it.');
// phpunit.xml often has -1 as memory limit
ini_set('memory_limit', $start);
$errorHandler = new TestErrorHandler();
$this->assertNull($errorHandler->increaseMemoryLimit($adjust));
$new = ini_get('memory_limit');
$this->assertEquals($expected, $new, 'memory limit did not get increased.');
ini_set('memory_limit', $initial);
}
}