Skip to content
Navigation Menu
{{ message }}
-
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathExceptionHandlerTest.php
More file actions
475 lines (445 loc) · 16.7 KB
/
Copy pathExceptionHandlerTest.php
File metadata and controls
475 lines (445 loc) · 16.7 KB
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
<?php
/*
* This file is part of Aplus Framework Debug Library.
*
* (c) Natan Felles <natanfelles@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Tests\Debug;
use Framework\CLI\Streams\Stderr;
use Framework\Debug\ExceptionHandler;
use Framework\Language\Language;
use Framework\Log\Log;
use Framework\Log\Logger;
use Framework\Log\Loggers\FileLogger;
use Framework\Log\Loggers\SysLogger;
use Framework\Log\LogLevel;
use PHPUnit\Framework\TestCase;
final class ExceptionHandlerTest extends TestCase
{
protected Logger $logger;
protected function getLogger() : Logger
{
return $this->logger
??= new FileLogger(\sys_get_temp_dir() . '/tests.log');
}
public function testEnvironments() : void
{
$exceptions = new ExceptionHandler(ExceptionHandler::DEVELOPMENT);
self::assertSame('development', $exceptions->getEnvironment());
$exceptions = new ExceptionHandler(ExceptionHandler::PRODUCTION);
self::assertSame('production', $exceptions->getEnvironment());
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid environment: foo');
new ExceptionHandler('foo');
}
public function testConstructorInstances() : void
{
$exceptions = new ExceptionHandler();
self::assertNull($exceptions->getLogger());
self::assertInstanceOf(Language::class, $exceptions->getLanguage());
$logger = new SysLogger();
$language = new Language();
$exceptions = new ExceptionHandler(logger: $logger, language: $language);
self::assertSame($logger, $exceptions->getLogger());
self::assertSame($language, $exceptions->getLanguage());
}
public function testDevelopmentView() : void
{
$exceptions = new ExceptionHandler();
$file = __DIR__ . '/../src/Views/exceptions/development.php';
self::assertSame(\realpath($file), $exceptions->getDevelopmentView());
$exceptions->setDevelopmentView($file);
self::assertSame(\realpath($file), $exceptions->getDevelopmentView());
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid exceptions view file: /unknown/foo.php');
$exceptions->setDevelopmentView('/unknown/foo.php');
}
public function testDevelopmentViewWithEnum() : void
{
$_ENV['logger.default.level'] = LogLevel::CRITICAL;
$exceptions = new ExceptionHandlerMock(ExceptionHandler::DEVELOPMENT);
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
\ob_end_clean();
self::assertTrue(true); // This test is only to increase coverage.
}
public function testProductionView() : void
{
$exceptions = new ExceptionHandler();
$file = __DIR__ . '/../src/Views/exceptions/production.php';
self::assertSame(\realpath($file), $exceptions->getProductionView());
$exceptions->setProductionView($file);
self::assertSame(\realpath($file), $exceptions->getProductionView());
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid exceptions view file: /unknown/foo.php');
$exceptions->setProductionView('/unknown/foo.php');
}
public function testCliException() : void
{
$exceptions = new ExceptionHandlerMock();
Stderr::init();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = Stderr::getContents();
self::assertStringContainsString('Exception: ', $contents);
self::assertStringContainsString('Message: Foo', $contents);
self::assertStringContainsString('File: ', $contents);
self::assertStringContainsString('Line: ', $contents);
self::assertStringContainsString('Trace: ', $contents);
self::assertStringNotContainsString('Log id: ', $contents);
}
public function testCliExceptionWithLog() : void
{
$exceptions = new ExceptionHandlerMock(logger: $this->getLogger());
Stderr::init();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = Stderr::getContents();
self::assertStringContainsString('Log id: ', $contents);
}
/**
* @dataProvider jsonHeadersProvider
*
* @runInSeparateProcess
*/
public function testJsonExceptionOnProduction(string $header, string $value) : void
{
$_SERVER[$header] = $value;
$exceptions = new ExceptionHandlerMock();
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
self::assertSame(500, \http_response_code());
self::assertSame([
'Content-Type: application/json; charset=UTF-8',
'Content-Language: en',
], xdebug_get_headers());
$contents = \json_decode($contents, true);
self::assertSame($contents, [
'status' => [
'code' => 500,
'reason' => 'Internal Server Error',
],
'data' => [
'message' => 'Something went wrong. Please, back later.',
],
]);
}
/**
* @dataProvider jsonHeadersProvider
*
* @runInSeparateProcess
*/
public function testJsonExceptionOnDevelopment(string $header, string $value) : void
{
$_SERVER[$header] = $value;
$exceptions = new ExceptionHandlerMock(ExceptionHandler::DEVELOPMENT);
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
self::assertSame(500, \http_response_code());
self::assertSame([
'Content-Type: application/json; charset=UTF-8',
'Content-Language: en',
], xdebug_get_headers());
$contents = \json_decode($contents, true);
self::assertSame($contents['status'], [
'code' => 500,
'reason' => 'Internal Server Error',
]);
self::assertSame($contents['data']['exception'], \Exception::class);
self::assertSame($contents['data']['message'], 'Foo');
self::assertArrayHasKey('file', $contents['data']);
self::assertArrayHasKey('line', $contents['data']);
self::assertArrayHasKey('trace', $contents['data']);
}
/**
* @dataProvider jsonHeadersProvider
*
* @runInSeparateProcess
*/
public function testJsonExceptionOnProductionWithLog(string $header, string $value) : void
{
$_SERVER[$header] = $value;
$exceptions = new ExceptionHandlerMock(logger: $this->getLogger());
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
$contents = \json_decode($contents, true);
self::assertSame($contents, [
'status' => [
'code' => 500,
'reason' => 'Internal Server Error',
],
'data' => [
'message' => 'Something went wrong. Please, back later.',
'log_id' => $this->getLogger()->getLastLog()->id,
],
]);
}
/**
* @dataProvider jsonHeadersProvider
*
* @runInSeparateProcess
*/
public function testJsonExceptionOnDevelopmentWithLog(string $header, string $value) : void
{
$_SERVER[$header] = $value;
$exceptions = new ExceptionHandlerMock(ExceptionHandler::DEVELOPMENT, $this->getLogger());
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
$contents = \json_decode($contents, true);
self::assertSame($contents['data']['log_id'], $this->getLogger()->getLastLog()->id);
}
/**
* @runInSeparateProcess
*/
public function testExceptionOnProduction() : void
{
$exceptions = new ExceptionHandlerMock();
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
self::assertSame(500, \http_response_code());
self::assertSame([
'Content-Type: text/html; charset=UTF-8',
'Content-Language: en',
], xdebug_get_headers());
self::assertStringContainsString(
'Error 500 - Internal Server Error',
$contents
);
self::assertStringContainsString(
'Something went wrong. Please, back later.',
$contents
);
self::assertStringNotContainsString('Log Id:', $contents);
}
/**
* @runInSeparateProcess
*/
public function testExceptionOnDevelopment() : void
{
$exceptions = new ExceptionHandlerMock(ExceptionHandler::DEVELOPMENT);
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
self::assertSame(500, \http_response_code());
self::assertSame([
'Content-Type: text/html; charset=UTF-8',
'Content-Language: en',
], xdebug_get_headers());
self::assertStringContainsString(
'Error 500 - Internal Server Error',
$contents
);
self::assertStringContainsString('Exception: Foo', $contents);
self::assertStringContainsString('Message:', $contents);
self::assertStringNotContainsString('Log:', $contents);
}
/**
* @runInSeparateProcess
*/
public function testExceptionOnDevelopmentWithHiddenInputs() : void
{
$_ENV = [];
$_GET = ['foo' => 'bar'];
$_POST = ['foo' => 'bar'];
$exceptions = new ExceptionHandlerMock(ExceptionHandler::DEVELOPMENT);
$exceptions->setHiddenInputs('$_POST', '$_GET', '$_ENV');
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
self::assertStringContainsString('<strong>$_GET</strong>', $contents);
self::assertStringContainsString('<strong>$_POST</strong>', $contents);
self::assertStringNotContainsString('<strong>$_ENV</strong>', $contents);
}
/**
* @runInSeparateProcess
*
* @dataProvider environmentsProvider
*/
public function testExceptionWithLogger(string $environment) : void
{
$exceptions = new ExceptionHandlerMock($environment, $this->getLogger());
$exceptions->cli = false;
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
\ob_get_clean();
self::assertNotEmpty($this->getLogger()->getLastLog());
}
/**
* @dataProvider errorProvider
*
* @param int $error
* @param string $type
*/
public function testErrorHandler(int $error, string $type) : void
{
$exceptions = new ExceptionHandler();
$exceptions->initialize();
\error_reporting(\E_CORE_ERROR);
\trigger_error('Error message', \E_USER_WARNING);
\error_reporting(\E_ALL);
$this->expectException(\ErrorException::class);
$this->expectExceptionMessage($type . ': Error message');
\trigger_error('Error message', $error);
}
public function testShowLogId() : void
{
$exceptions = new ExceptionHandler();
self::assertTrue($exceptions->isShowingLogId());
$exceptions->setShowLogId(false);
self::assertFalse($exceptions->isShowingLogId());
}
public function testJsonFlags() : void
{
$exceptions = new ExceptionHandler();
self::assertSame(
\JSON_THROW_ON_ERROR | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE,
$exceptions->getJsonFlags()
);
$flags = \JSON_PRETTY_PRINT | \JSON_OBJECT_AS_ARRAY;
$exceptions->setJsonFlags($flags);
self::assertSame($flags, $exceptions->getJsonFlags());
}
public function testGetLog() : void
{
$exceptions = new ExceptionHandler();
self::assertNull($exceptions->getLog());
$exceptions = new ExceptionHandler(logger: $this->getLogger());
self::assertNull($exceptions->getLog());
$this->getLogger()->logCritical('Ooops!');
self::assertInstanceOf(Log::class, $exceptions->getLog());
self::assertSame('Ooops!', $exceptions->getLog()->message);
$exceptions->setShowLogId(false);
self::assertNull($exceptions->getLog());
}
public function testGetSetHiddenInputs() : void
{
$exceptions = new ExceptionHandler();
self::assertEmpty($exceptions->getHiddenInputs());
$exceptions->setHiddenInputs('$_POST', '$_GET');
self::assertNotEmpty($exceptions->getHiddenInputs());
self::assertSame(['$_GET', '$_POST'], $exceptions->getHiddenInputs());
$exceptions->setHiddenInputs('$_POST', '$_SERVER', '$_ENV');
self::assertSame(['$_ENV', '$_POST', '$_SERVER'], $exceptions->getHiddenInputs());
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid input name: $_FOO');
$exceptions->setHiddenInputs('$_POST', '$_FOO', '$_ENV');
}
public function testIsHiddenInput() : void
{
$exceptions = new ExceptionHandler();
self::assertFalse($exceptions->isHiddenInput('$_GET'));
$exceptions->setHiddenInputs('$_GET');
self::assertTrue($exceptions->isHiddenInput('$_GET'));
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid input name: $_Bar');
$exceptions->isHiddenInput('$_Bar');
}
public function testAddAndRemoveHiddenInput() : void
{
$exceptions = new ExceptionHandler();
self::assertEmpty($exceptions->getHiddenInputs());
$exceptions->addHiddenInputs('$_ENV');
self::assertNotEmpty($exceptions->getHiddenInputs());
self::assertSame(
['$_ENV'],
$exceptions->getHiddenInputs()
);
$exceptions->addHiddenInputs('$_POST', '$_FILES');
self::assertSame(
['$_ENV', '$_FILES', '$_POST'],
$exceptions->getHiddenInputs()
);
$exceptions->removeHiddenInputs('$_FILES');
self::assertSame(
['$_ENV', '$_POST'],
$exceptions->getHiddenInputs()
);
}
/**
* @runInSeparateProcess
*
* @dataProvider environmentsProvider
*/
public function testExceptionsWithLtrLanguage(string $environment) : void
{
$_POST = ['foo' => 'bar'];
$language = new Language('en', [__DIR__ . '/../src/Languages']);
$exceptions = new ExceptionHandlerMock(
$environment,
$this->getLogger(),
$language
);
$exceptions->cli = false;
$exceptions->setHiddenInputs('$_POST');
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
self::assertStringContainsString('dir="ltr"', $contents);
}
/**
* @runInSeparateProcess
*
* @dataProvider environmentsProvider
*/
public function testExceptionsWithRtlLanguage(string $environment) : void
{
$_POST = ['foo' => 'bar'];
$language = new Language('he', [__DIR__ . '/../src/Languages']);
$exceptions = new ExceptionHandlerMock(
$environment,
$this->getLogger(),
$language
);
$exceptions->cli = false;
$exceptions->setHiddenInputs('$_POST');
\ob_start();
$exceptions->exceptionHandler(new \Exception('Foo'));
$contents = (string) \ob_get_clean();
self::assertStringContainsString('dir="rtl"', $contents);
}
/**
* @return array<array<string>>
*/
public static function environmentsProvider() : array
{
return [
[ExceptionHandler::DEVELOPMENT],
[ExceptionHandler::PRODUCTION],
];
}
/**
* @return array<array<int|string>>
*/
public static function errorProvider() : array
{
return [
[\E_USER_WARNING, 'User Warning'],
[\E_USER_DEPRECATED, 'User Deprecated'],
[\E_USER_NOTICE, 'User Notice'],
];
}
/**
* @return array<array<string>>
*/
public static function jsonHeadersProvider() : array
{
return [
['HTTP_ACCEPT', 'text/html; application/json'],
['HTTP_CONTENT_TYPE', 'application/json; charset=UTF-8'],
];
}
}
You can’t perform that action at this time.