/
AbstractTokenTest.php
360 lines (294 loc) · 10.4 KB
/
AbstractTokenTest.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
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Security\Core\Tests\Authentication\Token;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Security\Core\Authentication\Token\AbstractToken;
use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\User\User;
use Symfony\Component\Security\Core\User\UserInterface;
class AbstractTokenTest extends TestCase
{
public function testGetUsername()
{
$token = new ConcreteToken(['ROLE_FOO']);
$token->setUser('fabien');
$this->assertEquals('fabien', $token->getUsername());
$token->setUser(new TestUser('fabien'));
$this->assertEquals('fabien', $token->getUsername());
$user = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserInterface')->getMock();
$user->expects($this->once())->method('getUsername')->willReturn('fabien');
$token->setUser($user);
$this->assertEquals('fabien', $token->getUsername());
}
public function testEraseCredentials()
{
$token = new ConcreteToken(['ROLE_FOO']);
$user = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserInterface')->getMock();
$user->expects($this->once())->method('eraseCredentials');
$token->setUser($user);
$token->eraseCredentials();
}
public function testSerialize()
{
$token = new ConcreteToken(['ROLE_FOO', new Role('ROLE_BAR', false)]);
$token->setAttributes(['foo' => 'bar']);
$uToken = unserialize(serialize($token));
$this->assertEquals($token->getRoleNames(), $uToken->getRoleNames());
$this->assertEquals($token->getAttributes(), $uToken->getAttributes());
}
/**
* @group legacy
*/
public function testSerializeWithRoleObjects()
{
$user = new User('name', 'password', [new Role('ROLE_FOO'), new Role('ROLE_BAR')]);
$token = new ConcreteToken($user->getRoles(), $user);
$serialized = serialize($token);
$unserialized = unserialize($serialized);
$roles = $unserialized->getRoles();
$this->assertEquals($roles, $user->getRoles());
}
public function testConstructor()
{
$token = new ConcreteToken(['ROLE_FOO']);
$this->assertEquals(['ROLE_FOO'], $token->getRoleNames());
}
/**
* @group legacy
*/
public function testConstructorWithRoleObjects()
{
$token = new ConcreteToken([new Role('ROLE_FOO')]);
$this->assertEquals(['ROLE_FOO'], $token->getRoleNames());
$token = new ConcreteToken([new Role('ROLE_FOO'), 'ROLE_BAR']);
$this->assertEquals(['ROLE_FOO', 'ROLE_BAR'], $token->getRoleNames());
}
/**
* @group legacy
*/
public function testGetRoles()
{
$token = new ConcreteToken(['ROLE_FOO']);
$this->assertEquals([new Role('ROLE_FOO')], $token->getRoles());
$token = new ConcreteToken([new Role('ROLE_FOO')]);
$this->assertEquals([new Role('ROLE_FOO')], $token->getRoles());
$token = new ConcreteToken([new Role('ROLE_FOO'), 'ROLE_BAR']);
$this->assertEquals([new Role('ROLE_FOO'), new Role('ROLE_BAR')], $token->getRoles());
}
public function testAuthenticatedFlag()
{
$token = new ConcreteToken();
$this->assertFalse($token->isAuthenticated());
$token->setAuthenticated(true);
$this->assertTrue($token->isAuthenticated());
$token->setAuthenticated(false);
$this->assertFalse($token->isAuthenticated());
}
public function testAttributes()
{
$attributes = ['foo' => 'bar'];
$token = new ConcreteToken();
$token->setAttributes($attributes);
$this->assertEquals($attributes, $token->getAttributes(), '->getAttributes() returns the token attributes');
$this->assertEquals('bar', $token->getAttribute('foo'), '->getAttribute() returns the value of an attribute');
$token->setAttribute('foo', 'foo');
$this->assertEquals('foo', $token->getAttribute('foo'), '->setAttribute() changes the value of an attribute');
$this->assertTrue($token->hasAttribute('foo'), '->hasAttribute() returns true if the attribute is defined');
$this->assertFalse($token->hasAttribute('oof'), '->hasAttribute() returns false if the attribute is not defined');
try {
$token->getAttribute('foobar');
$this->fail('->getAttribute() throws an \InvalidArgumentException exception when the attribute does not exist');
} catch (\Exception $e) {
$this->assertInstanceOf('\InvalidArgumentException', $e, '->getAttribute() throws an \InvalidArgumentException exception when the attribute does not exist');
$this->assertEquals('This token has no "foobar" attribute.', $e->getMessage(), '->getAttribute() throws an \InvalidArgumentException exception when the attribute does not exist');
}
}
/**
* @dataProvider getUsers
*/
public function testSetUser($user)
{
$token = new ConcreteToken();
$token->setUser($user);
$this->assertSame($user, $token->getUser());
}
public function getUsers()
{
$user = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserInterface')->getMock();
return [
[$user],
[new TestUser('foo')],
['foo'],
];
}
/**
* @dataProvider getUserChanges
*/
public function testSetUserSetsAuthenticatedToFalseWhenUserChanges($firstUser, $secondUser)
{
$token = new ConcreteToken();
$token->setAuthenticated(true);
$this->assertTrue($token->isAuthenticated());
$token->setUser($firstUser);
$this->assertTrue($token->isAuthenticated());
$token->setUser($secondUser);
$this->assertFalse($token->isAuthenticated());
}
public function getUserChanges()
{
$user = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserInterface')->getMock();
return [
['foo', 'bar'],
['foo', new TestUser('bar')],
['foo', $user],
[$user, 'foo'],
[$user, new TestUser('foo')],
[new TestUser('foo'), new TestUser('bar')],
[new TestUser('foo'), 'bar'],
[new TestUser('foo'), $user],
];
}
/**
* @group legacy
*
* @dataProvider getUserChangesAdvancedUser
*/
public function testSetUserSetsAuthenticatedToFalseWhenUserChangesAdvancedUser($firstUser, $secondUser)
{
$token = new ConcreteToken();
$token->setAuthenticated(true);
$this->assertTrue($token->isAuthenticated());
$token->setUser($firstUser);
$this->assertTrue($token->isAuthenticated());
$token->setUser($secondUser);
$this->assertFalse($token->isAuthenticated());
}
public function getUserChangesAdvancedUser()
{
$user = $this->getMockBuilder('Symfony\Component\Security\Core\User\UserInterface')->getMock();
$advancedUser = $this->getMockBuilder('Symfony\Component\Security\Core\User\AdvancedUserInterface')->getMock();
return [
['foo', 'bar'],
['foo', new TestUser('bar')],
['foo', $user],
['foo', $advancedUser],
[$user, 'foo'],
[$advancedUser, 'foo'],
[$user, new TestUser('foo')],
[$advancedUser, new TestUser('foo')],
[new TestUser('foo'), new TestUser('bar')],
[new TestUser('foo'), 'bar'],
[new TestUser('foo'), $user],
[new TestUser('foo'), $advancedUser],
[$user, $advancedUser],
[$advancedUser, $user],
];
}
/**
* @dataProvider getUsers
*/
public function testSetUserDoesNotSetAuthenticatedToFalseWhenUserDoesNotChange($user)
{
$token = new ConcreteToken();
$token->setAuthenticated(true);
$this->assertTrue($token->isAuthenticated());
$token->setUser($user);
$this->assertTrue($token->isAuthenticated());
$token->setUser($user);
$this->assertTrue($token->isAuthenticated());
}
public function testIsUserChangedWhenSerializing()
{
$token = new ConcreteToken(['ROLE_ADMIN']);
$token->setAuthenticated(true);
$this->assertTrue($token->isAuthenticated());
$user = new SerializableUser('wouter', ['ROLE_ADMIN']);
$token->setUser($user);
$this->assertTrue($token->isAuthenticated());
$token = unserialize(serialize($token));
$token->setUser($user);
$this->assertTrue($token->isAuthenticated());
}
}
class TestUser
{
protected $name;
public function __construct($name)
{
$this->name = $name;
}
public function __toString(): string
{
return $this->name;
}
}
class SerializableUser implements UserInterface, \Serializable
{
private $roles;
private $name;
public function __construct($name, array $roles = [])
{
$this->name = $name;
$this->roles = $roles;
}
public function getUsername()
{
return $this->name;
}
public function getPassword()
{
return '***';
}
public function getRoles()
{
if (empty($this->roles)) {
return ['ROLE_USER'];
}
return $this->roles;
}
public function eraseCredentials()
{
}
public function getSalt()
{
return null;
}
public function serialize()
{
return serialize($this->name);
}
public function unserialize($serialized)
{
$this->name = unserialize($serialized);
}
}
class ConcreteToken extends AbstractToken
{
private $credentials = 'credentials_value';
public function __construct(array $roles = [], UserInterface $user = null)
{
parent::__construct($roles);
if (null !== $user) {
$this->setUser($user);
}
}
public function __serialize(): array
{
return [$this->credentials, parent::__serialize()];
}
public function __unserialize(array $data): void
{
[$this->credentials, $parentState] = $data;
parent::__unserialize($parentState);
}
public function getCredentials()
{
}
}