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
|
<?php
namespace Illuminate\Tests\Foundation;
use Exception;
use Illuminate\Config\Repository as Config;
use Illuminate\Container\Container;
use Illuminate\Contracts\Routing\ResponseFactory as ResponseFactoryContract;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Contracts\View\Factory;
use Illuminate\Foundation\Exceptions\Handler;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Routing\Redirector;
use Illuminate\Routing\ResponseFactory;
use Illuminate\Support\MessageBag;
use Illuminate\Validation\ValidationException;
use Illuminate\Validation\Validator;
use Mockery as m;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
use RuntimeException;
use stdClass;
use Symfony\Component\HttpFoundation\Exception\SuspiciousOperationException;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\HttpException;
class FoundationExceptionsHandlerTest extends TestCase
{
protected $config;
protected $container;
protected $handler;
protected $request;
protected function setUp(): void
{
$this->config = m::mock(Config::class);
$this->request = m::mock(stdClass::class);
$this->container = Container::setInstance(new Container);
$this->container->singleton('config', function () {
return $this->config;
});
$this->container->singleton(ResponseFactoryContract::class, function () {
return new ResponseFactory(
m::mock(Factory::class),
m::mock(Redirector::class)
);
});
$this->handler = new Handler($this->container);
}
protected function tearDown(): void
{
m::close();
Container::setInstance(null);
}
public function testHandlerReportsExceptionAsContext()
{
$logger = m::mock(LoggerInterface::class);
$this->container->instance(LoggerInterface::class, $logger);
$logger->shouldReceive('error')->withArgs(['Exception message', m::hasKey('exception')]);
$this->handler->report(new RuntimeException('Exception message'));
}
public function testHandlerCallsReportMethodWithDependencies()
{
$reporter = m::mock(ReportingService::class);
$this->container->instance(ReportingService::class, $reporter);
$reporter->shouldReceive('send')->withArgs(['Exception message']);
$this->handler->report(new ReportableException('Exception message'));
}
public function testReturnsJsonWithStackTraceWhenAjaxRequestAndDebugTrue()
{
$this->config->shouldReceive('get')->with('app.debug', null)->once()->andReturn(true);
$this->request->shouldReceive('expectsJson')->once()->andReturn(true);
$response = $this->handler->render($this->request, new Exception('My custom error message'))->getContent();
$this->assertStringNotContainsString('<!DOCTYPE html>', $response);
$this->assertStringContainsString('"message": "My custom error message"', $response);
$this->assertStringContainsString('"file":', $response);
$this->assertStringContainsString('"line":', $response);
$this->assertStringContainsString('"trace":', $response);
}
public function testReturnsCustomResponseWhenExceptionImplementsResponsable()
{
$response = $this->handler->render($this->request, new CustomException)->getContent();
$this->assertSame('{"response":"My custom exception response"}', $response);
}
public function testReturnsJsonWithoutStackTraceWhenAjaxRequestAndDebugFalseAndExceptionMessageIsMasked()
{
$this->config->shouldReceive('get')->with('app.debug', null)->once()->andReturn(false);
$this->request->shouldReceive('expectsJson')->once()->andReturn(true);
$response = $this->handler->render($this->request, new Exception('This error message should not be visible'))->getContent();
$this->assertStringContainsString('"message": "Server Error"', $response);
$this->assertStringNotContainsString('<!DOCTYPE html>', $response);
$this->assertStringNotContainsString('This error message should not be visible', $response);
$this->assertStringNotContainsString('"file":', $response);
$this->assertStringNotContainsString('"line":', $response);
$this->assertStringNotContainsString('"trace":', $response);
}
public function testReturnsJsonWithoutStackTraceWhenAjaxRequestAndDebugFalseAndHttpExceptionErrorIsShown()
{
$this->config->shouldReceive('get')->with('app.debug', null)->once()->andReturn(false);
$this->request->shouldReceive('expectsJson')->once()->andReturn(true);
$response = $this->handler->render($this->request, new HttpException(403, 'My custom error message'))->getContent();
$this->assertStringContainsString('"message": "My custom error message"', $response);
$this->assertStringNotContainsString('<!DOCTYPE html>', $response);
$this->assertStringNotContainsString('"message": "Server Error"', $response);
$this->assertStringNotContainsString('"file":', $response);
$this->assertStringNotContainsString('"line":', $response);
$this->assertStringNotContainsString('"trace":', $response);
}
public function testReturnsJsonWithoutStackTraceWhenAjaxRequestAndDebugFalseAndAccessDeniedHttpExceptionErrorIsShown()
{
$this->config->shouldReceive('get')->with('app.debug', null)->once()->andReturn(false);
$this->request->shouldReceive('expectsJson')->once()->andReturn(true);
$response = $this->handler->render($this->request, new AccessDeniedHttpException('My custom error message'))->getContent();
$this->assertStringContainsString('"message": "My custom error message"', $response);
$this->assertStringNotContainsString('<!DOCTYPE html>', $response);
$this->assertStringNotContainsString('"message": "Server Error"', $response);
$this->assertStringNotContainsString('"file":', $response);
$this->assertStringNotContainsString('"line":', $response);
$this->assertStringNotContainsString('"trace":', $response);
}
public function testValidateFileMethod()
{
$argumentExpected = ['input' => 'My input value'];
$argumentActual = null;
$this->container->singleton('redirect', function () use (&$argumentActual) {
$redirector = m::mock(Redirector::class);
$redirector->shouldReceive('to')->once()
->andReturn($responser = m::mock(RedirectResponse::class));
$responser->shouldReceive('withInput')->once()->with(m::on(
function ($argument) use (&$argumentActual) {
$argumentActual = $argument;
return true;
}))->andReturn($responser);
$responser->shouldReceive('withErrors')->once()
->andReturn($responser);
return $redirector;
});
$file = m::mock(UploadedFile::class);
$file->shouldReceive('getPathname')->andReturn('photo.jpg');
$file->shouldReceive('getClientOriginalName')->andReturn('photo.jpg');
$file->shouldReceive('getClientMimeType')->andReturn(null);
$file->shouldReceive('getError')->andReturn(null);
$request = Request::create('/', 'POST', $argumentExpected, [], ['photo' => $file]);
$validator = m::mock(Validator::class);
$validator->shouldReceive('errors')->andReturn(new MessageBag(['error' => 'My custom validation exception']));
$validationException = new ValidationException($validator);
$validationException->redirectTo = '/';
$this->handler->render($request, $validationException);
$this->assertEquals($argumentExpected, $argumentActual);
}
public function testSuspiciousOperationReturns404WithoutReporting()
{
$this->config->shouldReceive('get')->with('app.debug', null)->once()->andReturn(true);
$this->request->shouldReceive('expectsJson')->once()->andReturn(true);
$response = $this->handler->render($this->request, new SuspiciousOperationException('Invalid method override "__CONSTRUCT"'));
$this->assertEquals(404, $response->getStatusCode());
$this->assertStringContainsString('"message": "Bad hostname provided."', $response->getContent());
$logger = m::mock(LoggerInterface::class);
$this->container->instance(LoggerInterface::class, $logger);
$logger->shouldNotReceive('error');
$this->handler->report(new SuspiciousOperationException('Invalid method override "__CONSTRUCT"'));
}
}
class CustomException extends Exception implements Responsable
{
public function toResponse($request)
{
return response()->json(['response' => 'My custom exception response']);
}
}
class ReportableException extends Exception
{
public function report(ReportingService $reportingService)
{
$reportingService->send($this->getMessage());
}
}
interface ReportingService
{
public function send($message);
}
|
