-
Notifications
You must be signed in to change notification settings - Fork 638
/
RequestTest.php
490 lines (440 loc) · 14.4 KB
/
RequestTest.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
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace TYPO3\CMS\Core\Tests\Unit\Http;
use Psr\Http\Message\StreamInterface;
use TYPO3\CMS\Core\Http\Request;
use TYPO3\CMS\Core\Http\Stream;
use TYPO3\CMS\Core\Http\Uri;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
/**
* Testcase for \TYPO3\CMS\Core\Http\Request
*
* Adapted from https://github.com/phly/http/
*/
final class RequestTest extends UnitTestCase
{
protected ?Request $request;
protected function setUp(): void
{
parent::setUp();
$this->request = new Request();
}
/**
* @test
*/
public function getMethodIsGetByDefault(): void
{
self::assertEquals('GET', $this->request->getMethod());
}
/**
* @test
*/
public function getMethodMutatorReturnsCloneWithChangedMethod(): void
{
$request = $this->request->withMethod('GET');
self::assertNotSame($this->request, $request);
self::assertEquals('GET', $request->getMethod());
}
/**
* @test
*/
public function withUriReturnsNewInstanceWithNewUri(): void
{
$request = $this->request->withUri(new Uri('https://example.com:10082/foo/bar?baz=bat'));
self::assertNotSame($this->request, $request);
$request2 = $request->withUri(new Uri('/baz/bat?foo=bar'));
self::assertNotSame($this->request, $request2);
self::assertNotSame($request, $request2);
self::assertEquals('/baz/bat?foo=bar', (string)$request2->getUri());
}
/**
* @test
*/
public function constructorCanAcceptAllMessageParts(): void
{
$uri = new Uri('http://example.com/');
$body = new Stream('php://memory');
$headers = [
'x-foo' => ['bar'],
];
$request = new Request(
$uri,
'POST',
$body,
$headers
);
self::assertSame($uri, $request->getUri());
self::assertEquals('POST', $request->getMethod());
self::assertSame($body, $request->getBody());
$testHeaders = $request->getHeaders();
foreach ($headers as $key => $value) {
self::assertArrayHasKey($key, $testHeaders);
self::assertEquals($value, $testHeaders[$key]);
}
}
/**
* @test
*/
public function constructorRaisesExceptionForInvalidMethodByString(): void
{
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionCode(1436717275);
new Request(null, 'BOGUS-METHOD');
}
public static function invalidRequestBodyDataProvider(): array
{
return [
'true' => [true],
'false' => [false],
'int' => [1],
'float' => [1.1],
'array' => [['BODY']],
'stdClass' => [(object)['body' => 'BODY']],
];
}
/**
* @dataProvider invalidRequestBodyDataProvider
* @test
*/
public function constructorRaisesExceptionForInvalidBody($body): void
{
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionCode(1436717271);
new Request(null, 'GET', $body);
}
public static function validRequestBodyDataProvider(): array
{
return [
'stringResourceIdentifier' => ['php://input'],
'streamResource' => [fopen('php://memory', 'r')],
'streamInterface' => [new Stream(fopen('php://memory', 'r'))],
'null' => [null],
];
}
/**
* @param resource|StreamInterface|string|null $body
* @dataProvider validRequestBodyDataProvider
* @test
*/
public function constructorDoesNotRaiseExceptionForValidBody($body): void
{
new Request(null, 'GET', $body);
}
/**
* @test
*/
public function constructorIgnoresInvalidHeaders(): void
{
$headers = [
['INVALID'],
'x-invalid-null' => null,
'x-invalid-object' => (object)['INVALID'],
'x-valid-true' => true,
'x-valid-false' => false,
'x-valid-int' => 1,
'x-valid-float' => 1.5,
'x-valid-string' => 'VALID',
'x-valid-array' => ['VALID'],
];
$expected = [
'x-valid-true' => ['1'],
'x-valid-false' => [''],
'x-valid-int' => ['1'],
'x-valid-float' => ['1.5'],
'x-valid-string' => ['VALID'],
'x-valid-array' => ['VALID'],
];
$request = new Request(null, 'GET', 'php://memory', $headers);
self::assertEquals($expected, $request->getHeaders());
}
/**
* @test
*/
public function getRequestTargetIsSlashWhenNoUriPresent(): void
{
$request = new Request();
self::assertEquals('/', $request->getRequestTarget());
}
/**
* @test
*/
public function getRequestTargetIsSlashWhenUriHasNoPathOrQuery(): void
{
$request = (new Request())
->withUri(new Uri('http://example.com'));
self::assertEquals('/', $request->getRequestTarget());
}
public static function requestsWithUriDataProvider(): array
{
return [
'absolute-uri' => [
(new Request())
->withUri(new Uri('https://api.example.com/user'))
->withMethod('POST'),
'/user',
],
'absolute-uri-with-query' => [
(new Request())
->withUri(new Uri('https://api.example.com/user?foo=bar'))
->withMethod('POST'),
'/user?foo=bar',
],
'relative-uri' => [
(new Request())
->withUri(new Uri('/user'))
->withMethod('GET'),
'/user',
],
'relative-uri-with-query' => [
(new Request())
->withUri(new Uri('/user?foo=bar'))
->withMethod('GET'),
'/user?foo=bar',
],
];
}
/**
* @dataProvider requestsWithUriDataProvider
* @test
*/
public function getRequestTargetWhenUriIsPresent($request, $expected): void
{
self::assertEquals($expected, $request->getRequestTarget());
}
public static function validRequestTargetsDataProvider(): array
{
return [
'asterisk-form' => ['*'],
'authority-form' => ['api.example.com'],
'absolute-form' => ['https://api.example.com/users'],
'absolute-form-query' => ['https://api.example.com/users?foo=bar'],
'origin-form-path-only' => ['/users'],
'origin-form' => ['/users?id=foo'],
];
}
/**
* @dataProvider validRequestTargetsDataProvider
* @test
*/
public function getRequestTargetCanProvideARequestTarget($requestTarget): void
{
$request = (new Request())->withRequestTarget($requestTarget);
self::assertEquals($requestTarget, $request->getRequestTarget());
}
/**
* @test
*/
public function withRequestTargetCannotContainWhitespace(): void
{
$request = new Request();
$this->expectException(\InvalidArgumentException::class);
$this->expectExceptionCode(1436717273);
$request->withRequestTarget('foo bar baz');
}
/**
* @test
*/
public function getRequestTargetDoesNotCacheBetweenInstances(): void
{
$request = (new Request())->withUri(new Uri('https://example.com/foo/bar'));
$original = $request->getRequestTarget();
$newRequest = $request->withUri(new Uri('http://mwop.net/bar/baz'));
self::assertNotEquals($original, $newRequest->getRequestTarget());
}
/**
* @test
*/
public function getRequestTargetIsResetWithNewUri(): void
{
$request = (new Request())->withUri(new Uri('https://example.com/foo/bar'));
$request->getRequestTarget();
$request->withUri(new Uri('http://mwop.net/bar/baz'));
}
/**
* @test
*/
public function getHeadersContainsHostHeaderIfUriWithHostIsPresent(): void
{
$request = new Request('http://example.com');
$headers = $request->getHeaders();
self::assertArrayHasKey('host', $headers);
self::assertContains('example.com', $headers['host']);
}
/**
* @test
*/
public function getHeadersContainsNoHostHeaderIfNoUriPresent(): void
{
$request = new Request();
$headers = $request->getHeaders();
self::assertArrayNotHasKey('host', $headers);
}
/**
* @test
*/
public function getHeadersContainsNoHostHeaderIfUriDoesNotContainHost(): void
{
$request = new Request(new Uri());
$headers = $request->getHeaders();
self::assertArrayNotHasKey('host', $headers);
}
/**
* @test
*/
public function getHeaderWithHostReturnsUriHostWhenPresent(): void
{
$request = new Request('http://example.com');
$header = $request->getHeader('host');
self::assertEquals(['example.com'], $header);
}
/**
* @test
*/
public function getHeaderWithHostReturnsEmptyArrayIfNoUriPresent(): void
{
$request = new Request();
self::assertSame([], $request->getHeader('host'));
}
/**
* @test
*/
public function getHeaderWithHostReturnsEmptyArrayIfUriDoesNotContainHost(): void
{
$request = new Request(new Uri());
self::assertSame([], $request->getHeader('host'));
}
/**
* @test
*/
public function getHeaderLineWithHostReturnsUriHostWhenPresent(): void
{
$request = new Request('http://example.com');
$header = $request->getHeaderLine('host');
self::assertStringContainsString('example.com', $header);
}
/**
* @test
*/
public function getHeaderLineWithHostReturnsEmptyStringIfNoUriPresent(): void
{
$request = new Request();
self::assertSame('', $request->getHeaderLine('host'));
}
/**
* @test
*/
public function getHeaderLineWithHostReturnsEmptyStringIfUriDoesNotContainHost(): void
{
$request = new Request(new Uri());
self::assertSame('', $request->getHeaderLine('host'));
}
/**
* @test
*/
public function getHeaderLineWithHostTakesPrecedenceOverModifiedUri(): void
{
$request = (new Request())
->withAddedHeader('Host', 'example.com');
$uri = (new Uri())->withHost('www.example.com');
$new = $request->withUri($uri, true);
self::assertEquals('example.com', $new->getHeaderLine('Host'));
}
/**
* @test
*/
public function getHeaderLineWithHostTakesPrecedenceOverEmptyUri(): void
{
$request = (new Request())
->withAddedHeader('Host', 'example.com');
$uri = new Uri();
$new = $request->withUri($uri);
self::assertEquals('example.com', $new->getHeaderLine('Host'));
}
/**
* @test
*/
public function getHeaderLineWithHostDoesNotTakePrecedenceOverHostWithPortFromUri(): void
{
$request = (new Request())
->withAddedHeader('Host', 'example.com');
$uri = (new Uri())
->withHost('www.example.com')
->withPort(10081);
$new = $request->withUri($uri);
self::assertEquals('www.example.com:10081', $new->getHeaderLine('Host'));
}
public static function headersWithUpperAndLowerCaseValuesDataProvider(): array
{
// 'name' => [$headerName, $headerValue, $expectedValue]
return [
'Foo' => ['Foo', 'bar', 'bar'],
'foo' => ['foo', 'bar', 'bar'],
'Foo-with-array' => ['Foo', ['bar'], 'bar'],
'foo-with-array' => ['foo', ['bar'], 'bar'],
];
}
/**
* @test
* @dataProvider headersWithUpperAndLowerCaseValuesDataProvider
*/
public function headerCanBeRetrieved($header, $value, $expected): void
{
$request = new Request(null, 'GET', 'php://memory', [$header => $value]);
self::assertEquals([$expected], $request->getHeader(strtolower($header)));
self::assertEquals([$expected], $request->getHeader(strtoupper($header)));
}
public static function headersWithInjectionVectorsDataProvider(): array
{
return [
'name-with-cr' => ["X-Foo\r-Bar", 'value'],
'name-with-lf' => ["X-Foo\n-Bar", 'value'],
'name-with-crlf' => ["X-Foo\r\n-Bar", 'value'],
'name-with-2crlf' => ["X-Foo\r\n\r\n-Bar", 'value'],
'value-with-cr' => ['X-Foo-Bar', "value\rinjection"],
'value-with-lf' => ['X-Foo-Bar', "value\ninjection"],
'value-with-crlf' => ['X-Foo-Bar', "value\r\ninjection"],
'value-with-2crlf' => ['X-Foo-Bar', "value\r\n\r\ninjection"],
'array-value-with-cr' => ['X-Foo-Bar', ["value\rinjection"]],
'array-value-with-lf' => ['X-Foo-Bar', ["value\ninjection"]],
'array-value-with-crlf' => ['X-Foo-Bar', ["value\r\ninjection"]],
'array-value-with-2crlf' => ['X-Foo-Bar', ["value\r\n\r\ninjection"]],
];
}
/**
* @test
* @dataProvider headersWithInjectionVectorsDataProvider
*/
public function constructorRaisesExceptionForHeadersWithCRLFVectors($name, $value): void
{
$this->expectException(\InvalidArgumentException::class);
new Request(null, 'GET', 'php://memory', [$name => $value]);
}
/**
* @test
*/
public function supportedRequestMethodsWork(): void
{
$request = new Request('some-uri', 'PURGE');
self::assertEquals('PURGE', $request->getMethod());
}
/**
* @test
*/
public function nonSupportedRequestMethodsRaisesException(): void
{
$this->expectException(\InvalidArgumentException::class);
new Request('some-uri', 'UNSUPPORTED');
}
}