Skip to content

Commit 1b15c27

Browse files
authored
Merge pull request #2900 from Coffreo/fix_deprecation
Replace has_role() by is_granted()
2 parents 07a41fe + 3d0f8b4 commit 1b15c27

File tree

6 files changed

+36
-36
lines changed

6 files changed

+36
-36
lines changed

tests/Annotation/ApiResourceTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class ApiResourceTest extends TestCase
2727
public function testConstruct()
2828
{
2929
$resource = new ApiResource([
30-
'accessControl' => 'has_role("ROLE_FOO")',
30+
'accessControl' => 'is_granted("ROLE_FOO")',
3131
'accessControlMessage' => 'You are not foo.',
3232
'attributes' => ['foo' => 'bar', 'validation_groups' => ['baz', 'qux'], 'cache_headers' => ['max_age' => 0, 'shared_max_age' => 0]],
3333
'collectionOperations' => ['bar' => ['foo']],
@@ -71,7 +71,7 @@ public function testConstruct()
7171
$this->assertSame([], $resource->subresourceOperations);
7272
$this->assertSame(['query' => ['normalization_context' => ['groups' => ['foo', 'bar']]]], $resource->graphql);
7373
$this->assertEquals([
74-
'access_control' => 'has_role("ROLE_FOO")',
74+
'access_control' => 'is_granted("ROLE_FOO")',
7575
'access_control_message' => 'You are not foo.',
7676
'denormalization_context' => ['groups' => ['foo']],
7777
'fetch_partial' => true,
@@ -118,7 +118,7 @@ public function testApiResourceAnnotation()
118118
$this->assertEquals([
119119
'foo' => 'bar',
120120
'route_prefix' => '/whatever',
121-
'access_control' => "has_role('ROLE_FOO')",
121+
'access_control' => "is_granted('ROLE_FOO')",
122122
'access_control_message' => 'You are not foo.',
123123
'cache_headers' => ['max_age' => 0, 'shared_max_age' => 0],
124124
], $resource->attributes);

tests/Fixtures/AnnotatedClass.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* graphql={"query"={"normalization_context"={"groups"={"foo", "bar"}}}},
2626
* attributes={"foo"="bar", "route_prefix"="/whatever", "cache_headers"={"max_age"=0, "shared_max_age"=0}},
2727
* routePrefix="/foo",
28-
* accessControl="has_role('ROLE_FOO')",
28+
* accessControl="is_granted('ROLE_FOO')",
2929
* accessControlMessage="You are not foo."
3030
* )
3131
*

tests/Fixtures/TestBundle/Document/SecuredDummy.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@
2424
* @author Alan Poulain <[email protected]>
2525
*
2626
* @ApiResource(
27-
* attributes={"access_control"="has_role('ROLE_USER')"},
27+
* attributes={"access_control"="is_granted('ROLE_USER')"},
2828
* collectionOperations={
2929
* "get",
30-
* "post"={"access_control"="has_role('ROLE_ADMIN')"}
30+
* "post"={"access_control"="is_granted('ROLE_ADMIN')"}
3131
* },
3232
* itemOperations={
33-
* "get"={"access_control"="has_role('ROLE_USER') and object.getOwner() == user"},
34-
* "put"={"access_control"="has_role('ROLE_USER') and previous_object.getOwner() == user"},
33+
* "get"={"access_control"="is_granted('ROLE_USER') and object.getOwner() == user"},
34+
* "put"={"access_control"="is_granted('ROLE_USER') and previous_object.getOwner() == user"},
3535
* },
3636
* graphql={
37-
* "query"={"access_control"="has_role('ROLE_USER') and object.getOwner() == user"},
37+
* "query"={"access_control"="is_granted('ROLE_USER') and object.getOwner() == user"},
3838
* "delete"={},
39-
* "update"={"access_control"="has_role('ROLE_USER') and previous_object.getOwner() == user"},
40-
* "create"={"access_control"="has_role('ROLE_ADMIN')", "access_control_message"="Only admins can create a secured dummy."}
39+
* "update"={"access_control"="is_granted('ROLE_USER') and previous_object.getOwner() == user"},
40+
* "create"={"access_control"="is_granted('ROLE_ADMIN')", "access_control_message"="Only admins can create a secured dummy."}
4141
* }
4242
* )
4343
* @ODM\Document

tests/Fixtures/TestBundle/Entity/SecuredDummy.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@
2323
* @author Kévin Dunglas <[email protected]>
2424
*
2525
* @ApiResource(
26-
* attributes={"access_control"="has_role('ROLE_USER')"},
26+
* attributes={"access_control"="is_granted('ROLE_USER')"},
2727
* collectionOperations={
2828
* "get",
29-
* "post"={"access_control"="has_role('ROLE_ADMIN')"}
29+
* "post"={"access_control"="is_granted('ROLE_ADMIN')"}
3030
* },
3131
* itemOperations={
32-
* "get"={"access_control"="has_role('ROLE_USER') and object.getOwner() == user"},
33-
* "put"={"access_control"="has_role('ROLE_USER') and previous_object.getOwner() == user"},
32+
* "get"={"access_control"="is_granted('ROLE_USER') and object.getOwner() == user"},
33+
* "put"={"access_control"="is_granted('ROLE_USER') and previous_object.getOwner() == user"},
3434
* },
3535
* graphql={
36-
* "query"={"access_control"="has_role('ROLE_USER') and object.getOwner() == user"},
36+
* "query"={"access_control"="is_granted('ROLE_USER') and object.getOwner() == user"},
3737
* "delete"={},
38-
* "update"={"access_control"="has_role('ROLE_USER') and previous_object.getOwner() == user"},
39-
* "create"={"access_control"="has_role('ROLE_ADMIN')", "access_control_message"="Only admins can create a secured dummy."}
38+
* "update"={"access_control"="is_granted('ROLE_USER') and previous_object.getOwner() == user"},
39+
* "create"={"access_control"="is_granted('ROLE_ADMIN')", "access_control_message"="Only admins can create a secured dummy."}
4040
* }
4141
* )
4242
* @ORM\Entity

tests/Security/EventListener/DenyAccessListenerTest.php

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,13 @@ public function testIsGranted()
7878
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
7979
$event = $eventProphecy->reveal();
8080

81-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")']);
81+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")']);
8282

8383
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
8484
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
8585

8686
$resourceAccessCheckerProphecy = $this->prophesize(ResourceAccessCheckerInterface::class);
87-
$resourceAccessCheckerProphecy->isGranted('Foo', 'has_role("ROLE_ADMIN")', Argument::type('array'))->willReturn(true)->shouldBeCalled();
87+
$resourceAccessCheckerProphecy->isGranted('Foo', 'is_granted("ROLE_ADMIN")', Argument::type('array'))->willReturn(true)->shouldBeCalled();
8888

8989
$listener = $this->getListener($resourceMetadataFactoryProphecy->reveal(), $resourceAccessCheckerProphecy->reveal());
9090
$listener->onKernelRequest($event);
@@ -100,13 +100,13 @@ public function testIsNotGranted()
100100
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
101101
$event = $eventProphecy->reveal();
102102

103-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")']);
103+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")']);
104104

105105
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
106106
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
107107

108108
$resourceAccessCheckerProphecy = $this->prophesize(ResourceAccessCheckerInterface::class);
109-
$resourceAccessCheckerProphecy->isGranted('Foo', 'has_role("ROLE_ADMIN")', Argument::type('array'))->willReturn(false)->shouldBeCalled();
109+
$resourceAccessCheckerProphecy->isGranted('Foo', 'is_granted("ROLE_ADMIN")', Argument::type('array'))->willReturn(false)->shouldBeCalled();
110110

111111
$listener = $this->getListener($resourceMetadataFactoryProphecy->reveal(), $resourceAccessCheckerProphecy->reveal());
112112
$listener->onKernelRequest($event);
@@ -123,13 +123,13 @@ public function testAccessControlMessage()
123123
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
124124
$event = $eventProphecy->reveal();
125125

126-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")', 'access_control_message' => 'You are not admin.']);
126+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")', 'access_control_message' => 'You are not admin.']);
127127

128128
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
129129
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
130130

131131
$resourceAccessCheckerProphecy = $this->prophesize(ResourceAccessCheckerInterface::class);
132-
$resourceAccessCheckerProphecy->isGranted('Foo', 'has_role("ROLE_ADMIN")', Argument::type('array'))->willReturn(false)->shouldBeCalled();
132+
$resourceAccessCheckerProphecy->isGranted('Foo', 'is_granted("ROLE_ADMIN")', Argument::type('array'))->willReturn(false)->shouldBeCalled();
133133

134134
$listener = $this->getListener($resourceMetadataFactoryProphecy->reveal(), $resourceAccessCheckerProphecy->reveal());
135135
$listener->onKernelRequest($event);
@@ -147,13 +147,13 @@ public function testIsGrantedLegacy()
147147
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
148148
$event = $eventProphecy->reveal();
149149

150-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")']);
150+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")']);
151151

152152
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
153153
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
154154

155155
$expressionLanguageProphecy = $this->prophesize(ExpressionLanguage::class);
156-
$expressionLanguageProphecy->evaluate('has_role("ROLE_ADMIN")', Argument::type('array'))->willReturn(true)->shouldBeCalled();
156+
$expressionLanguageProphecy->evaluate('is_granted("ROLE_ADMIN")', Argument::type('array'))->willReturn(true)->shouldBeCalled();
157157

158158
$listener = $this->getLegacyListener($resourceMetadataFactoryProphecy->reveal(), $expressionLanguageProphecy->reveal());
159159
$listener->onKernelRequest($event);
@@ -172,13 +172,13 @@ public function testIsNotGrantedLegacy()
172172
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
173173
$event = $eventProphecy->reveal();
174174

175-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")']);
175+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")']);
176176

177177
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
178178
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
179179

180180
$expressionLanguageProphecy = $this->prophesize(ExpressionLanguage::class);
181-
$expressionLanguageProphecy->evaluate('has_role("ROLE_ADMIN")', Argument::type('array'))->willReturn(false)->shouldBeCalled();
181+
$expressionLanguageProphecy->evaluate('is_granted("ROLE_ADMIN")', Argument::type('array'))->willReturn(false)->shouldBeCalled();
182182

183183
$listener = $this->getLegacyListener($resourceMetadataFactoryProphecy->reveal(), $expressionLanguageProphecy->reveal());
184184
$listener->onKernelRequest($event);
@@ -197,7 +197,7 @@ public function testSecurityComponentNotAvailable()
197197
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
198198
$event = $eventProphecy->reveal();
199199

200-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")']);
200+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")']);
201201

202202
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
203203
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
@@ -219,7 +219,7 @@ public function testExpressionLanguageNotInstalled()
219219
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
220220
$event = $eventProphecy->reveal();
221221

222-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")']);
222+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")']);
223223

224224
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
225225
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();
@@ -245,7 +245,7 @@ public function testNotBehindAFirewall()
245245
$eventProphecy->getRequest()->willReturn($request)->shouldBeCalled();
246246
$event = $eventProphecy->reveal();
247247

248-
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'has_role("ROLE_ADMIN")']);
248+
$resourceMetadata = new ResourceMetadata(null, null, null, null, null, ['access_control' => 'is_granted("ROLE_ADMIN")']);
249249

250250
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
251251
$resourceMetadataFactoryProphecy->create('Foo')->willReturn($resourceMetadata)->shouldBeCalled();

tests/Security/ResourceAccessCheckerTest.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class ResourceAccessCheckerTest extends TestCase
3333
public function testIsGranted(bool $granted)
3434
{
3535
$expressionLanguageProphecy = $this->prophesize(ExpressionLanguage::class);
36-
$expressionLanguageProphecy->evaluate('has_role("ROLE_ADMIN")', Argument::type('array'))->willReturn($granted)->shouldBeCalled();
36+
$expressionLanguageProphecy->evaluate('is_granted("ROLE_ADMIN")', Argument::type('array'))->willReturn($granted)->shouldBeCalled();
3737

3838
$authenticationTrustResolverProphecy = $this->prophesize(AuthenticationTrustResolverInterface::class);
3939
$tokenStorageProphecy = $this->prophesize(TokenStorageInterface::class);
@@ -46,7 +46,7 @@ public function testIsGranted(bool $granted)
4646
$tokenStorageProphecy->getToken()->willReturn($tokenProphecy);
4747

4848
$checker = new ResourceAccessChecker($expressionLanguageProphecy->reveal(), $authenticationTrustResolverProphecy->reveal(), null, $tokenStorageProphecy->reveal());
49-
$this->assertSame($granted, $checker->isGranted(Dummy::class, 'has_role("ROLE_ADMIN")'));
49+
$this->assertSame($granted, $checker->isGranted(Dummy::class, 'is_granted("ROLE_ADMIN")'));
5050
}
5151

5252
public function getGranted(): array
@@ -60,7 +60,7 @@ public function testSecurityComponentNotAvailable()
6060
$this->expectExceptionMessage('The "symfony/security" library must be installed to use the "access_control" attribute.');
6161

6262
$checker = new ResourceAccessChecker($this->prophesize(ExpressionLanguage::class)->reveal());
63-
$checker->isGranted(Dummy::class, 'has_role("ROLE_ADMIN")');
63+
$checker->isGranted(Dummy::class, 'is_granted("ROLE_ADMIN")');
6464
}
6565

6666
public function testExpressionLanguageNotInstalled()
@@ -73,7 +73,7 @@ public function testExpressionLanguageNotInstalled()
7373
$tokenStorageProphecy->getToken()->willReturn($this->prophesize(TokenInterface::class)->reveal());
7474

7575
$checker = new ResourceAccessChecker(null, $authenticationTrustResolverProphecy->reveal(), null, $tokenStorageProphecy->reveal());
76-
$checker->isGranted(Dummy::class, 'has_role("ROLE_ADMIN")');
76+
$checker->isGranted(Dummy::class, 'is_granted("ROLE_ADMIN")');
7777
}
7878

7979
public function testNotBehindAFirewall()
@@ -85,6 +85,6 @@ public function testNotBehindAFirewall()
8585
$tokenStorageProphecy = $this->prophesize(TokenStorageInterface::class);
8686

8787
$checker = new ResourceAccessChecker(null, $authenticationTrustResolverProphecy->reveal(), null, $tokenStorageProphecy->reveal());
88-
$checker->isGranted(Dummy::class, 'has_role("ROLE_ADMIN")');
88+
$checker->isGranted(Dummy::class, 'is_granted("ROLE_ADMIN")');
8989
}
9090
}

0 commit comments

Comments
 (0)