/
CookieCollectionTest.php
466 lines (421 loc) · 15.9 KB
/
CookieCollectionTest.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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.5.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Test\TestCase\Http\Cookie;
use Cake\Http\Client\Request as ClientRequest;
use Cake\Http\Client\Response as ClientResponse;
use Cake\Http\Cookie\Cookie;
use Cake\Http\Cookie\CookieCollection;
use Cake\Http\Response;
use Cake\Http\ServerRequest;
use Cake\TestSuite\TestCase;
use DateTime;
/**
* Cookie collection test.
*/
class CookieCollectionTest extends TestCase
{
/**
* Test constructor
*
* @return void
*/
public function testConstructorWithEmptyArray()
{
$collection = new CookieCollection([]);
$this->assertCount(0, $collection);
}
/**
* Test valid cookies
*
* @return void
*/
public function testConstructorWithCookieArray()
{
$cookies = [
new Cookie('one', 'one'),
new Cookie('two', 'two')
];
$collection = new CookieCollection($cookies);
$this->assertCount(2, $collection);
}
/**
* Test iteration
*
* @return void
*/
public function testIteration()
{
$cookies = [
new Cookie('remember_me', 'a'),
new Cookie('gtm', 'b'),
new Cookie('three', 'tree')
];
$collection = new CookieCollection($cookies);
$names = [];
foreach ($collection as $cookie) {
$names[] = $cookie->getName();
}
$this->assertSame(['remember_me', 'gtm', 'three'], $names);
}
/**
* Test adding cookies
*
* @return void
*/
public function testAdd()
{
$cookies = [];
$collection = new CookieCollection($cookies);
$this->assertCount(0, $collection);
$remember = new Cookie('remember_me', 'a');
$new = $collection->add($remember);
$this->assertNotSame($new, $collection->add($remember));
$this->assertCount(0, $collection, 'Original instance not modified');
$this->assertCount(1, $new);
$this->assertFalse($collection->has('remember_me'), 'Original instance not modified');
$this->assertTrue($new->has('remember_me'));
$this->assertSame($remember, $new->get('remember_me'));
}
/**
* Cookie collections need to support duplicate cookie names because
* of use cases in Http\Client
*
* @return void
*/
public function testAddDuplicates()
{
$remember = new Cookie('remember_me', 'yes');
$rememberNo = new Cookie('remember_me', 'no', null, '/path2');
$this->assertNotEquals($remember->getId(), $rememberNo->getId(), 'Cookies should have different ids');
$collection = new CookieCollection([]);
$new = $collection->add($remember)->add($rememberNo);
$this->assertCount(2, $new, 'Cookies with different ids create duplicates.');
$this->assertNotSame($new, $collection);
$this->assertSame($remember, $new->get('remember_me'), 'get() fetches first cookie');
}
/**
* Test has()
*
* @return void
*/
public function testHas()
{
$cookies = [
new Cookie('remember_me', 'a'),
new Cookie('gtm', 'b')
];
$collection = new CookieCollection($cookies);
$this->assertFalse($collection->has('nope'));
$this->assertTrue($collection->has('remember_me'));
$this->assertTrue($collection->has('REMEMBER_me'), 'case insensitive cookie names');
}
/**
* Test removing cookies
*
* @return void
*/
public function testRemove()
{
$cookies = [
new Cookie('remember_me', 'a'),
new Cookie('gtm', 'b')
];
$collection = new CookieCollection($cookies);
$this->assertInstanceOf(Cookie::class, $collection->get('REMEMBER_me'), 'case insensitive cookie names');
$new = $collection->remove('remember_me');
$this->assertTrue($collection->has('remember_me'), 'old instance not modified');
$this->assertNotSame($new, $collection);
$this->assertFalse($new->has('remember_me'), 'should be removed');
$this->assertNull($new->get('remember_me'), 'should be removed');
}
/**
* Test getting cookies by name
*
* @return void
*/
public function testGetByName()
{
$cookies = [
new Cookie('remember_me', 'a'),
new Cookie('gtm', 'b')
];
$collection = new CookieCollection($cookies);
$this->assertNull($collection->get('nope'));
$this->assertInstanceOf(Cookie::class, $collection->get('REMEMBER_me'), 'case insensitive cookie names');
$this->assertInstanceOf(Cookie::class, $collection->get('remember_me'));
$this->assertSame($cookies[0], $collection->get('remember_me'));
}
/**
* Test that the constructor takes only an array of objects implementing
* the CookieInterface
*
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Expected `Cake\Http\Cookie\CookieCollection[]` as $cookies but instead got `array` at index 1
* @return void
*/
public function testConstructorWithInvalidCookieObjects()
{
$array = [
new Cookie('one', 'one'),
[]
];
new CookieCollection($array);
}
/**
* Test adding cookies from a response.
*
* @return void
*/
public function testAddFromResponse()
{
$collection = new CookieCollection();
$request = new ServerRequest([
'url' => '/app'
]);
$response = (new Response())
->withAddedHeader('Set-Cookie', 'test=value')
->withAddedHeader('Set-Cookie', 'expiring=soon; Expires=Wed, 09-Jun-2021 10:18:14 GMT; Path=/; HttpOnly; Secure;')
->withAddedHeader('Set-Cookie', 'session=123abc; Domain=www.example.com')
->withAddedHeader('Set-Cookie', 'maxage=value; Max-Age=60; Expires=Wed, 09-Jun-2021 10:18:14 GMT;');
$new = $collection->addFromResponse($response, $request);
$this->assertNotSame($new, $collection, 'Should clone collection');
$this->assertTrue($new->has('test'));
$this->assertTrue($new->has('session'));
$this->assertTrue($new->has('expiring'));
$this->assertSame('value', $new->get('test')->getValue());
$this->assertSame('123abc', $new->get('session')->getValue());
$this->assertSame('soon', $new->get('expiring')->getValue());
$this->assertSame('value', $new->get('maxage')->getValue());
$this->assertSame('/app', $new->get('test')->getPath(), 'cookies should inherit request path');
$this->assertSame('/', $new->get('expiring')->getPath(), 'path attribute should be used.');
$this->assertNull($new->get('test')->getExpiry(), 'No expiry');
$this->assertSame(
'2021-06-09 10:18:14',
$new->get('expiring')->getExpiry()->format('Y-m-d H:i:s'),
'Has expiry'
);
$session = $new->get('session');
$this->assertNull($session->getExpiry(), 'No expiry');
$this->assertSame('www.example.com', $session->getDomain(), 'Has domain');
$maxage = $new->get('maxage');
$this->assertLessThanOrEqual(
(new DateTime('60 seconds'))->format('Y-m-d H:i:s'),
$maxage->getExpiry()->format('Y-m-d H:i:s'),
'Has max age'
);
}
/**
* Test adding cookies that contain URL encoded data
*
* @return void
*/
public function testAddFromResponseValueUrldecodeData()
{
$collection = new CookieCollection();
$request = new ServerRequest([
'url' => '/app'
]);
$response = (new Response())
->withAddedHeader('Set-Cookie', 'test=val%3Bue; Path=/example; Secure;');
$new = $collection->addFromResponse($response, $request);
$this->assertTrue($new->has('test'));
$test = $new->get('test');
$this->assertSame('val;ue', $test->getValue());
$this->assertSame('/example', $test->getPath());
}
/**
* Test adding cookies from a response ignores expired cookies
*
* @return void
*/
public function testAddFromResponseIgnoreExpired()
{
$collection = new CookieCollection();
$request = new ServerRequest([
'url' => '/app'
]);
$response = (new Response())
->withAddedHeader('Set-Cookie', 'test=value')
->withAddedHeader('Set-Cookie', 'expired=soon; Expires=Wed, 09-Jun-2012 10:18:14 GMT; Path=/;');
$new = $collection->addFromResponse($response, $request);
$this->assertFalse($new->has('expired'), 'Should drop expired cookies');
}
/**
* Test adding cookies from a response removes existing cookies if
* the new response marks them as expired.
*
* @return void
*/
public function testAddFromResponseRemoveExpired()
{
$collection = new CookieCollection([
new Cookie('expired', 'not yet', null, '/', 'example.com')
]);
$request = new ServerRequest([
'url' => '/app',
'environment' => [
'HTTP_HOST' => 'example.com'
]
]);
$response = (new Response())
->withAddedHeader('Set-Cookie', 'test=value')
->withAddedHeader('Set-Cookie', 'expired=soon; Expires=Wed, 09-Jun-2012 10:18:14 GMT; Path=/;');
$new = $collection->addFromResponse($response, $request);
$this->assertFalse($new->has('expired'), 'Should drop expired cookies');
}
/**
* Test adding cookies from responses updates cookie values.
*
* @return void
*/
public function testAddFromResponseUpdateExisting()
{
$collection = new CookieCollection([
new Cookie('key', 'old value', null, '/', 'example.com')
]);
$request = new ServerRequest([
'url' => '/',
'environment' => [
'HTTP_HOST' => 'example.com'
]
]);
$response = (new Response())->withAddedHeader('Set-Cookie', 'key=new value');
$new = $collection->addFromResponse($response, $request);
$this->assertTrue($new->has('key'));
$this->assertSame('new value', $new->get('key')->getValue());
}
/**
* Test adding cookies from the collection to request.
*
* @return void
*/
public function testAddToRequest()
{
$collection = new CookieCollection();
$collection = $collection
->add(new Cookie('api', 'A', null, '/api', 'example.com'))
->add(new Cookie('blog', 'b', null, '/blog', 'blog.example.com'))
->add(new Cookie('expired', 'ex', new DateTime('-2 seconds'), '/', 'example.com'));
$request = new ClientRequest('http://example.com/api');
$request = $collection->addToRequest($request);
$this->assertSame('api=A', $request->getHeaderLine('Cookie'));
$request = new ClientRequest('http://example.com/');
$request = $collection->addToRequest($request);
$this->assertSame('', $request->getHeaderLine(''));
$request = new ClientRequest('http://example.com/blog');
$request = $collection->addToRequest($request);
$this->assertSame('', $request->getHeaderLine('Cookie'), 'domain matching should apply');
$request = new ClientRequest('http://foo.blog.example.com/blog');
$request = $collection->addToRequest($request);
$this->assertSame('blog=b', $request->getHeaderLine('Cookie'));
}
/**
* Test adding no cookies
*
* @return void
*/
public function testAddToRequestNoCookies()
{
$collection = new CookieCollection();
$request = new ClientRequest('http://example.com/api');
$request = $collection->addToRequest($request);
$this->assertFalse($request->hasHeader('Cookie'), 'No header should be set.');
}
/**
* Test adding cookies from the collection to request.
*
* @return void
*/
public function testAddToRequestExtraCookies()
{
$collection = new CookieCollection();
$collection = $collection
->add(new Cookie('api', 'A', null, '/api', 'example.com'))
->add(new Cookie('blog', 'b', null, '/blog', 'blog.example.com'))
->add(new Cookie('expired', 'ex', new DateTime('-2 seconds'), '/', 'example.com'));
$request = new ClientRequest('http://example.com/api');
$request = $collection->addToRequest($request, ['b' => 'B']);
$this->assertSame('api=A; b=B', $request->getHeaderLine('Cookie'));
$request = new ClientRequest('http://example.com/api');
$request = $collection->addToRequest($request, ['api' => 'custom']);
$this->assertSame('api=custom', $request->getHeaderLine('Cookie'), 'Extra cookies overwrite values in jar');
}
/**
* Test adding cookies ignores leading dot
*
* @return void
*/
public function testAddToRequestLeadingDot()
{
$collection = new CookieCollection();
$collection = $collection
->add(new Cookie('public', 'b', null, '/', '.example.com'));
$request = new ClientRequest('http://example.com/blog');
$request = $collection->addToRequest($request);
$this->assertSame('public=b', $request->getHeaderLine('Cookie'));
}
/**
* Test adding cookies checks the secure crumb
*
* @return void
*/
public function testAddToRequestSecureCrumb()
{
$collection = new CookieCollection();
$collection = $collection
->add(new Cookie('secret', 'A', null, '/', 'example.com', true))
->add(new Cookie('public', 'b', null, '/', '.example.com', false));
$request = new ClientRequest('https://example.com/api');
$request = $collection->addToRequest($request);
$this->assertSame('secret=A; public=b', $request->getHeaderLine('Cookie'));
// no HTTPS set.
$request = new ClientRequest('http://example.com/api');
$request = $collection->addToRequest($request);
$this->assertSame('public=b', $request->getHeaderLine('Cookie'));
}
/**
* test createFromHeader() building cookies from a header string.
*
* @return void
*/
public function testCreateFromHeader()
{
$header = [
'http=name; HttpOnly; Secure;',
'expires=expiring; Expires=Wed, 15-Jun-2022 10:22:22; Path=/api; HttpOnly; Secure;',
'expired=expired; version=1; Expires=Wed, 15-Jun-2015 10:22:22;',
];
$cookies = CookieCollection::createFromHeader($header);
$this->assertCount(3, $cookies);
$this->assertTrue($cookies->has('http'));
$this->assertTrue($cookies->has('expires'));
$this->assertTrue($cookies->has('expired'), 'Expired cookies should be present');
}
/**
* test createFromServerRequest() building cookies from a header string.
*
* @return void
*/
public function testCreateFromServerRequest()
{
$request = new ServerRequest(['cookies' => ['name' => 'val', 'cakephp' => 'rocks']]);
$cookies = CookieCollection::createFromServerRequest($request);
$this->assertCount(2, $cookies);
$this->assertTrue($cookies->has('name'));
$this->assertTrue($cookies->has('cakephp'));
$cookie = $cookies->get('name');
$this->assertSame('val', $cookie->getValue());
$this->assertSame('', $cookie->getPath(), 'No path on request cookies');
$this->assertSame('', $cookie->getDomain(), 'No domain on request cookies');
}
}