/
CookieCollectionTest.php
246 lines (220 loc) · 7.6 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
<?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\Cookie\Cookie;
use Cake\Http\Cookie\CookieCollection;
use Cake\Http\ServerRequest;
use Cake\Http\Response;
use Cake\TestSuite\TestCase;
/**
* 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');
$collection = new CookieCollection([]);
$new = $collection->add($remember)->add($rememberNo);
$this->assertCount(2, $new);
$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');
$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('/app', $new->get('test')->getPath(), 'cookies should inherit request path');
$this->assertSame('/', $new->get('expiring')->getPath(), 'path attribute should be used.');
$this->assertSame(0, $new->get('test')->getExpiry(), 'No expiry');
$this->assertSame(0, $new->get('session')->getExpiry(), 'No expiry');
$this->assertSame(
'2021-06-09 10:18:14',
date('Y-m-d H:i:s', $new->get('expiring')->getExpiry()),
'Has expiry'
);
}
/**
* 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=/; HttpOnly; Secure;');
$new = $collection->addFromResponse($response, $request);
$this->assertFalse($new->has('expired'),'Should drop expired cookies');
}
}