Issues in AclHelperTest.php - All Issues - Inspection of "update webpack + add kunstmaan linters + cleanup g..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 91fdab...75a7b9 )

unknown

created 2018-11-22 13:42 UTC

Tests/unit/Helper/Security/Acl/AclHelperTest.php (1 issue)

Labels

Severity

Minor 1

Wim Vandersmissen 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Kunstmaan\AdminBundle\Tests\Helper\Security\Acl;

use Codeception\Stub;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Driver\Statement;
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\ORM\Configuration;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Mapping\QuoteStrategy;
use Doctrine\ORM\NativeQuery;
use Doctrine\ORM\Query;
use Doctrine\ORM\QueryBuilder;
use FOS\UserBundle\Model\UserInterface;
use Kunstmaan\AdminBundle\Helper\Security\Acl\AclHelper;
use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\MaskBuilder;
use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\PermissionDefinition;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Role\Role;
use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;

class AclHelperTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var EntityManager
     */
    protected $em;

    /**
     * @var TokenStorageInterface
     */
    protected $tokenStorage;

    /**
     * @var RoleHierarchyInterface
     */
    protected $rh;

    /**
     * @var TokenInterface
     */
    protected $token;

    /**
     * @var UserInterface
     */
    protected $user;

    /**
     * @var AclHelper
     */
    protected $object;

    /**
     * Sets up the fixture, for example, opens a network connection.
     * This method is called before a test is executed.
     */
    protected function setUp()
    {
        $this->em = $this->getMockBuilder('Doctrine\ORM\EntityManager')
            ->disableOriginalConstructor()
            ->getMock();

        /* @var $conn Connection */
        $conn = $this->getMockBuilder('Doctrine\DBAL\Connection')
            ->disableOriginalConstructor()
            ->getMock();

        $conn->expects($this->any())
            ->method('getDatabase')
            ->will($this->returnValue('myDatabase'));

        /* @var $platform AbstractPlatform */
        $platform = $this->getMockForAbstractClass('Doctrine\DBAL\Platforms\AbstractPlatform');

        $conn->expects($this->any())
            ->method('getDatabasePlatform')
            ->will($this->returnValue($platform));

        /* @var $stmt Statement */
        $stmt = Stub::makeEmpty(Statement::class);

        $conn->expects($this->any())
            ->method('executeQuery')
            ->will($this->returnValue($stmt));

        $this->em->expects($this->any())
            ->method('getConnection')
            ->will($this->returnValue($conn));

        /* @var $conf Configuration */
        $conf = $this->getMockBuilder('Doctrine\ORM\Configuration')
            ->disableOriginalConstructor()
            ->getMock();

        /* @var $strat QuoteStrategy */
        $strat = $this->getMockBuilder('Doctrine\ORM\Mapping\QuoteStrategy')
            ->disableOriginalConstructor()
            ->getMock();

        $strat->expects($this->any())
            ->method('getTableName')
            ->will($this->returnValue('rootTable'));

        $conf->expects($this->any())
            ->method('getQuoteStrategy')
            ->will($this->returnValue($strat));

        $conf->expects($this->any())
            ->method('getDefaultQueryHints')
            ->willReturn(array());

        $conf->expects($this->any())
            ->method('isSecondLevelCacheEnabled')
            ->willReturn(false);

        $this->em->expects($this->any())
            ->method('getConfiguration')
            ->will($this->returnValue($conf));

        /* @var $meta ClassMetadata */
        $meta = $this->getMockBuilder('Doctrine\ORM\Mapping\ClassMetadata')
            ->disableOriginalConstructor()
            ->getMock();

        $this->em->expects($this->any())
            ->method('getClassMetadata')
            ->will($this->returnValue($meta));

        $this->tokenStorage = $this->getMockBuilder('Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface')
            ->getMock();

        $this->token = $this->getMockBuilder('Symfony\Component\Security\Core\Authentication\Token\TokenInterface')
            ->getMock();

        $this->tokenStorage->expects($this->any())
            ->method('getToken')
            ->will($this->returnValue($this->token));

        $this->rh = $this->getMockBuilder('Symfony\Component\Security\Core\Role\RoleHierarchyInterface')
            ->getMock();

        $this->object = new AclHelper($this->em, $this->tokenStorage, $this->rh);
    }

    public function testConstructor()
    {
        new AclHelper($this->em, $this->tokenStorage, $this->rh);
    }

    public function testApply()
    {
        /* @var $queryBuilder QueryBuilder */
        $queryBuilder = $this->getMockBuilder('Doctrine\ORM\QueryBuilder')
            ->disableOriginalConstructor()
            ->getMock();

        $query = new Query($this->em);
        $query->setParameter('paramName', 'paramValue', 'paramType');
        $queryBuilder->expects($this->any())
            ->method('getQuery')
            ->will($this->returnValue($query));

        $queryBuilder->expects($this->once())
            ->method('getRootEntities')
            ->will($this->returnValue(array('Kunstmaan\NodeBundle\Entity\Node')));

        $queryBuilder->expects($this->once())
            ->method('getRootAliases')
            ->will($this->returnValue(array('n')));

        $user = $this->getMockBuilder('FOS\UserBundle\Model\UserInterface')
            ->getMock();

        $user->expects($this->any())
            ->method('getUsername')
            ->will($this->returnValue('MyUser'));

        $this->token->expects($this->any())
            ->method('getUser')
            ->will($this->returnValue($user));

        $roles = array(new Role('ROLE_KING'));
        $allRoles = array($roles[0], new Role('ROLE_SUBJECT'));

        $this->token->expects($this->once())
            ->method('getRoles')
            ->will($this->returnValue($roles));

        $this->rh->expects($this->once())
            ->method('getReachableRoles')
            ->with($roles)
            ->will($this->returnValue($allRoles));

        $permissionDef = new PermissionDefinition(array('view'), 'Kunstmaan\NodeBundle\Entity\Node');

        /* @var $query Query */
        $query = $this->object->apply($queryBuilder, $permissionDef);

        $this->assertEquals(MaskBuilder::MASK_VIEW, $query->getHint('acl.mask'));
        $this->assertEquals($permissionDef->getEntity(), $query->getHint('acl.root.entity'));
        $this->assertEquals('rootTable', $query->getHint('acl.entityRootTableName'));
        $this->assertEquals('n', $query->getHint('acl.entityRootTableDqlAlias'));

        $aclQuery = $query->getHint('acl.extra.query');
        $this->assertContains('"ROLE_SUBJECT"', $aclQuery);
        $this->assertContains('"ROLE_KING"', $aclQuery);
        $this->assertContains('"IS_AUTHENTICATED_ANONYMOUSLY"', $aclQuery);
        $this->assertContains('MyUser', $aclQuery);
    }

    public function testApplyAnonymous()
    {
        /* @var $queryBuilder QueryBuilder */
        $queryBuilder = $this->getMockBuilder('Doctrine\ORM\QueryBuilder')
            ->disableOriginalConstructor()
            ->getMock();

        $query = new Query($this->em);
        $query->setParameter('paramName', 'paramValue', 'paramType');
        $queryBuilder->expects($this->any())
            ->method('getQuery')
            ->will($this->returnValue($query));

        $queryBuilder->expects($this->once())
            ->method('getRootEntities')
            ->will($this->returnValue(array('Kunstmaan\NodeBundle\Entity\Node')));

        $queryBuilder->expects($this->once())
            ->method('getRootAliases')
            ->will($this->returnValue(array('n')));

        $roles = array();

        $this->token->expects($this->once())
            ->method('getRoles')
            ->will($this->returnValue($roles));

        $this->rh->expects($this->once())
            ->method('getReachableRoles')
            ->with($roles)
            ->will($this->returnValue($roles));

        $this->token->expects($this->any())
            ->method('getUser')
            ->will($this->returnValue('anon.'));

        $permissionDef = new PermissionDefinition(array('view'), 'Kunstmaan\NodeBundle\Entity\Node');

        /* @var $query Query */
        $query = $this->object->apply($queryBuilder, $permissionDef);

        $this->assertEquals(MaskBuilder::MASK_VIEW, $query->getHint('acl.mask'));
        $this->assertEquals($permissionDef->getEntity(), $query->getHint('acl.root.entity'));
        $this->assertEquals('rootTable', $query->getHint('acl.entityRootTableName'));
        $this->assertEquals('n', $query->getHint('acl.entityRootTableDqlAlias'));

        $aclQuery = $query->getHint('acl.extra.query');
        $this->assertContains('"IS_AUTHENTICATED_ANONYMOUSLY"', $aclQuery);
    }

    public function testGetAllowedEntityIds()
    {
        $roles = array(new Role('ROLE_KING'));
        $allRoles = array($roles[0], new Role('ROLE_SUBJECT'));

        $this->token->expects($this->once())
            ->method('getRoles')
            ->will($this->returnValue($roles));

        $this->rh->expects($this->once())
            ->method('getReachableRoles')
            ->with($roles)
            ->will($this->returnValue($allRoles));

        $user = $this->getMockBuilder('FOS\UserBundle\Model\UserInterface')
            ->getMock();

        $user->expects($this->any())
            ->method('getUsername')
            ->will($this->returnValue('MyUser'));

        $this->token->expects($this->any())
            ->method('getUser')
            ->will($this->returnValue($user));

        $hydrator = $this->getMockBuilder('Doctrine\ORM\Internal\Hydration\ScalarHydrator')
            ->disableOriginalConstructor()
            ->getMock();

        $rows = array(
            array('id' => 1),
            array('id' => 9)
        );

        $hydrator->expects($this->once())
            ->method('hydrateAll')
            ->will($this->returnValue($rows));

        $this->em->expects($this->any())
          ->method('newHydrator') // was ->method('getHydrator')

          ->will($this->returnValue($hydrator));

        /* @var $query NativeQuery */
        $query = new NativeQuery($this->em);

        $this->em->expects($this->once())
            ->method('createNativeQuery')
            ->will($this->returnValue($query));

        $permissionDef = new PermissionDefinition(array('view'), 'Kunstmaan\NodeBundle\Entity\Node', 'n');

        /* @var $result array */
        $result = $this->object->getAllowedEntityIds($permissionDef);

        $this->assertEquals(array(1, 9), $result);
    }

    public function testGetAllowedEntityIdsNoEntity()
    {
        $this->setExpectedException('InvalidArgumentException');

        $this->object->getAllowedEntityIds(new PermissionDefinition(array('view')));
    }

    public function testGetTokenStorage()
    {
        $this->assertSame($this->tokenStorage, $this->object->getTokenStorage());
    }
}


1			<?php
2
3			namespace Kunstmaan\AdminBundle\Tests\Helper\Security\Acl;
4
5			use Codeception\Stub;
6			use Doctrine\DBAL\Connection;
7			use Doctrine\DBAL\Driver\Statement;
8			use Doctrine\DBAL\Platforms\AbstractPlatform;
9			use Doctrine\ORM\Configuration;
10			use Doctrine\ORM\EntityManager;
11			use Doctrine\ORM\Mapping\ClassMetadata;
12			use Doctrine\ORM\Mapping\QuoteStrategy;
13			use Doctrine\ORM\NativeQuery;
14			use Doctrine\ORM\Query;
15			use Doctrine\ORM\QueryBuilder;
16			use FOS\UserBundle\Model\UserInterface;
17			use Kunstmaan\AdminBundle\Helper\Security\Acl\AclHelper;
18			use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\MaskBuilder;
19			use Kunstmaan\AdminBundle\Helper\Security\Acl\Permission\PermissionDefinition;
20			use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
21			use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
22			use Symfony\Component\Security\Core\Role\Role;
23			use Symfony\Component\Security\Core\Role\RoleHierarchyInterface;
24
25			class AclHelperTest extends \PHPUnit_Framework_TestCase
26			{
27			/**
28			* @var EntityManager
29			*/
30			protected $em;
31
32			/**
33			* @var TokenStorageInterface
34			*/
35			protected $tokenStorage;
36
37			/**
38			* @var RoleHierarchyInterface
39			*/
40			protected $rh;
41
42			/**
43			* @var TokenInterface
44			*/
45			protected $token;
46
47			/**
48			* @var UserInterface
49			*/
50			protected $user;
51
52			/**
53			* @var AclHelper
54			*/
55			protected $object;
56
57			/**
58			* Sets up the fixture, for example, opens a network connection.
59			* This method is called before a test is executed.
60			*/
61			protected function setUp()
62			{
63			$this->em = $this->getMockBuilder('Doctrine\ORM\EntityManager')
64			->disableOriginalConstructor()
65			->getMock();
66
67			/* @var $conn Connection */
68			$conn = $this->getMockBuilder('Doctrine\DBAL\Connection')
69			->disableOriginalConstructor()
70			->getMock();
71
72			$conn->expects($this->any())
73			->method('getDatabase')
74			->will($this->returnValue('myDatabase'));
75
76			/* @var $platform AbstractPlatform */
77			$platform = $this->getMockForAbstractClass('Doctrine\DBAL\Platforms\AbstractPlatform');
78
79			$conn->expects($this->any())
80			->method('getDatabasePlatform')
81			->will($this->returnValue($platform));
82
83			/* @var $stmt Statement */
84			$stmt = Stub::makeEmpty(Statement::class);
85
86			$conn->expects($this->any())
87			->method('executeQuery')
88			->will($this->returnValue($stmt));
89
90			$this->em->expects($this->any())
91			->method('getConnection')
92			->will($this->returnValue($conn));
93
94			/* @var $conf Configuration */
95			$conf = $this->getMockBuilder('Doctrine\ORM\Configuration')
96			->disableOriginalConstructor()
97			->getMock();
98
99			/* @var $strat QuoteStrategy */
100			$strat = $this->getMockBuilder('Doctrine\ORM\Mapping\QuoteStrategy')
101			->disableOriginalConstructor()
102			->getMock();
103
104			$strat->expects($this->any())
105			->method('getTableName')
106			->will($this->returnValue('rootTable'));
107
108			$conf->expects($this->any())
109			->method('getQuoteStrategy')
110			->will($this->returnValue($strat));
111
112			$conf->expects($this->any())
113			->method('getDefaultQueryHints')
114			->willReturn(array());
115
116			$conf->expects($this->any())
117			->method('isSecondLevelCacheEnabled')
118			->willReturn(false);
119
120			$this->em->expects($this->any())
121			->method('getConfiguration')
122			->will($this->returnValue($conf));
123
124			/* @var $meta ClassMetadata */
125			$meta = $this->getMockBuilder('Doctrine\ORM\Mapping\ClassMetadata')
126			->disableOriginalConstructor()
127			->getMock();
128
129			$this->em->expects($this->any())
130			->method('getClassMetadata')
131			->will($this->returnValue($meta));
132
133			$this->tokenStorage = $this->getMockBuilder('Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface')
134			->getMock();
135
136			$this->token = $this->getMockBuilder('Symfony\Component\Security\Core\Authentication\Token\TokenInterface')
137			->getMock();
138
139			$this->tokenStorage->expects($this->any())
140			->method('getToken')
141			->will($this->returnValue($this->token));
142
143			$this->rh = $this->getMockBuilder('Symfony\Component\Security\Core\Role\RoleHierarchyInterface')
144			->getMock();
145
146			$this->object = new AclHelper($this->em, $this->tokenStorage, $this->rh);
147			}
148
149			public function testConstructor()
150			{
151			new AclHelper($this->em, $this->tokenStorage, $this->rh);
152			}
153
154			public function testApply()
155			{
156			/* @var $queryBuilder QueryBuilder */
157			$queryBuilder = $this->getMockBuilder('Doctrine\ORM\QueryBuilder')
158			->disableOriginalConstructor()
159			->getMock();
160
161			$query = new Query($this->em);
162			$query->setParameter('paramName', 'paramValue', 'paramType');
163			$queryBuilder->expects($this->any())
164			->method('getQuery')
165			->will($this->returnValue($query));
166
167			$queryBuilder->expects($this->once())
168			->method('getRootEntities')
169			->will($this->returnValue(array('Kunstmaan\NodeBundle\Entity\Node')));
170
171			$queryBuilder->expects($this->once())
172			->method('getRootAliases')
173			->will($this->returnValue(array('n')));
174
175			$user = $this->getMockBuilder('FOS\UserBundle\Model\UserInterface')
176			->getMock();
177
178			$user->expects($this->any())
179			->method('getUsername')
180			->will($this->returnValue('MyUser'));
181
182			$this->token->expects($this->any())
183			->method('getUser')
184			->will($this->returnValue($user));
185
186			$roles = array(new Role('ROLE_KING'));
187			$allRoles = array($roles[0], new Role('ROLE_SUBJECT'));
188
189			$this->token->expects($this->once())
190			->method('getRoles')
191			->will($this->returnValue($roles));
192
193			$this->rh->expects($this->once())
194			->method('getReachableRoles')
195			->with($roles)
196			->will($this->returnValue($allRoles));
197
198			$permissionDef = new PermissionDefinition(array('view'), 'Kunstmaan\NodeBundle\Entity\Node');
199
200			/* @var $query Query */
201			$query = $this->object->apply($queryBuilder, $permissionDef);
202
203			$this->assertEquals(MaskBuilder::MASK_VIEW, $query->getHint('acl.mask'));
204			$this->assertEquals($permissionDef->getEntity(), $query->getHint('acl.root.entity'));
205			$this->assertEquals('rootTable', $query->getHint('acl.entityRootTableName'));
206			$this->assertEquals('n', $query->getHint('acl.entityRootTableDqlAlias'));
207
208			$aclQuery = $query->getHint('acl.extra.query');
209			$this->assertContains('"ROLE_SUBJECT"', $aclQuery);
210			$this->assertContains('"ROLE_KING"', $aclQuery);
211			$this->assertContains('"IS_AUTHENTICATED_ANONYMOUSLY"', $aclQuery);
212			$this->assertContains('MyUser', $aclQuery);
213			}
214
215			public function testApplyAnonymous()
216			{
217			/* @var $queryBuilder QueryBuilder */
218			$queryBuilder = $this->getMockBuilder('Doctrine\ORM\QueryBuilder')
219			->disableOriginalConstructor()
220			->getMock();
221
222			$query = new Query($this->em);
223			$query->setParameter('paramName', 'paramValue', 'paramType');
224			$queryBuilder->expects($this->any())
225			->method('getQuery')
226			->will($this->returnValue($query));
227
228			$queryBuilder->expects($this->once())
229			->method('getRootEntities')
230			->will($this->returnValue(array('Kunstmaan\NodeBundle\Entity\Node')));
231
232			$queryBuilder->expects($this->once())
233			->method('getRootAliases')
234			->will($this->returnValue(array('n')));
235
236			$roles = array();
237
238			$this->token->expects($this->once())
239			->method('getRoles')
240			->will($this->returnValue($roles));
241
242			$this->rh->expects($this->once())
243			->method('getReachableRoles')
244			->with($roles)
245			->will($this->returnValue($roles));
246
247			$this->token->expects($this->any())
248			->method('getUser')
249			->will($this->returnValue('anon.'));
250
251			$permissionDef = new PermissionDefinition(array('view'), 'Kunstmaan\NodeBundle\Entity\Node');
252
253			/* @var $query Query */
254			$query = $this->object->apply($queryBuilder, $permissionDef);
255
256			$this->assertEquals(MaskBuilder::MASK_VIEW, $query->getHint('acl.mask'));
257			$this->assertEquals($permissionDef->getEntity(), $query->getHint('acl.root.entity'));
258			$this->assertEquals('rootTable', $query->getHint('acl.entityRootTableName'));
259			$this->assertEquals('n', $query->getHint('acl.entityRootTableDqlAlias'));
260
261			$aclQuery = $query->getHint('acl.extra.query');
262			$this->assertContains('"IS_AUTHENTICATED_ANONYMOUSLY"', $aclQuery);
263			}
264
265			public function testGetAllowedEntityIds()
266			{
267			$roles = array(new Role('ROLE_KING'));
268			$allRoles = array($roles[0], new Role('ROLE_SUBJECT'));
269
270			$this->token->expects($this->once())
271			->method('getRoles')
272			->will($this->returnValue($roles));
273
274			$this->rh->expects($this->once())
275			->method('getReachableRoles')
276			->with($roles)
277			->will($this->returnValue($allRoles));
278
279			$user = $this->getMockBuilder('FOS\UserBundle\Model\UserInterface')
280			->getMock();
281
282			$user->expects($this->any())
283			->method('getUsername')
284			->will($this->returnValue('MyUser'));
285
286			$this->token->expects($this->any())
287			->method('getUser')
288			->will($this->returnValue($user));
289
290			$hydrator = $this->getMockBuilder('Doctrine\ORM\Internal\Hydration\ScalarHydrator')
291			->disableOriginalConstructor()
292			->getMock();
293
294			$rows = array(
295			array('id' => 1),
296			array('id' => 9)
297			);
298
299			$hydrator->expects($this->once())
300			->method('hydrateAll')
301			->will($this->returnValue($rows));
302
303			$this->em->expects($this->any())
304			->method('newHydrator') // was ->method('getHydrator')
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-11-21 06:15 UTC by Report Bug Copy Issue Report Show Similar Issues like this `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
305			->will($this->returnValue($hydrator));
306
307			/* @var $query NativeQuery */
308			$query = new NativeQuery($this->em);
309
310			$this->em->expects($this->once())
311			->method('createNativeQuery')
312			->will($this->returnValue($query));
313
314			$permissionDef = new PermissionDefinition(array('view'), 'Kunstmaan\NodeBundle\Entity\Node', 'n');
315
316			/* @var $result array */
317			$result = $this->object->getAllowedEntityIds($permissionDef);
318
319			$this->assertEquals(array(1, 9), $result);
320			}
321
322			public function testGetAllowedEntityIdsNoEntity()
323			{
324			$this->setExpectedException('InvalidArgumentException');
325
326			$this->object->getAllowedEntityIds(new PermissionDefinition(array('view')));
327			}
328
329			public function testGetTokenStorage()
330			{
331			$this->assertSame($this->tokenStorage, $this->object->getTokenStorage());
332			}
333			}
334

Kunstmaan / KunstmaanBundlesCMS

Push — master ( 91fdab...75a7b9 )

Tests/unit/Helper/Security/Acl/AclHelperTest.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like