ProxyQueryTest::testGetFixedQueryBuilder() - Code Metrics - Inspection of "Manual Merge" - sonata-project/SonataDoctrineORMAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#804)

unknown

created 2018-02-01 19:13 UTC

ProxyQueryTest::testGetFixedQueryBuilder() B

↳ Parent: ProxyQueryTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	84
Code Lines	67

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	84
rs	8.7169
c	0
b	0
f	0
cc	1
eloc	67
nc	1
nop	6

How to fix Long Method

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\DoctrineORMAdminBundle\Tests\Datagrid;

use Doctrine\DBAL\Connection;
use Doctrine\DBAL\Platforms\PostgreSqlPlatform;
use Doctrine\DBAL\Types\Type;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Mapping\ClassMetadataFactory;
use Doctrine\ORM\Query\Expr\From;
use Doctrine\ORM\Query\Expr\OrderBy;
use Doctrine\ORM\QueryBuilder;
use Doctrine\ORM\Tools\SchemaTool;
use PHPUnit\Framework\TestCase;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery;
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\DoctrineType\UuidType;
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Util\NonIntegerIdentifierTestClass;
use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
use Symfony\Bridge\Doctrine\Tests\Fixtures\DoubleNameEntity;

class ProxyQueryTest extends TestCase
{
    /**
     * @var EntityManager
     */
    private $em;

    public static function setUpBeforeClass(): void
    {
        if (!Type::hasType('uuid')) {
            Type::addType('uuid', UuidType::class);
        }
    }

    protected function setUp(): void
    {
        $this->em = DoctrineTestHelper::createTestEntityManager();

        $schemaTool = new SchemaTool($this->em);
        $classes = [
            $this->em->getClassMetadata(DoubleNameEntity::class),
        ];

        try {
            $schemaTool->dropSchema($classes);
        } catch (\Exception $e) {

        }

        try {
            $schemaTool->createSchema($classes);
        } catch (\Exception $e) {

        }
    }

    protected function tearDown(): void
    {
        $this->em = null;
    }

    public function dataGetFixedQueryBuilder()
    {
        return [
            ['aaa', 'bbb', 'id', 'id_idx', 33, Type::INTEGER],
            ['aaa', 'bbb', 'associatedId', 'associatedId_idx', 33, null],
            ['aaa', 'bbb', 'id.value', 'id_value_idx', 33, Type::INTEGER],
            ['aaa', 'bbb', 'id.uuid', 'id_uuid_idx', new NonIntegerIdentifierTestClass('80fb6f91-bba1-4d35-b3d4-e06b24494e85'), UuidType::NAME],
        ];
    }

    /**
     * @dataProvider dataGetFixedQueryBuilder
     *
     * @param $class
     * @param $alias
     * @param $id
     */
    public function testGetFixedQueryBuilder($class, $alias, $id, $expectedId, $value, $identifierType): void
    {
        $meta = $this->createMock(ClassMetadata::class);
        $meta->expects($this->any())
            ->method('getIdentifierFieldNames')
            ->willReturn([$id]);
        $meta->expects($this->any())
            ->method('getTypeOfField')
            ->willReturn($identifierType);

        $mf = $this->createMock(ClassMetadataFactory::class);
        $mf->expects($this->any())
            ->method('getMetadataFor')
            ->with($this->equalTo($class))
            ->willReturn($meta);

        $platform = $this->createMock(PostgreSqlPlatform::class);

        $conn = $this->createMock(Connection::class);
        $conn->expects($this->any())
            ->method('getDatabasePlatform')
            ->willReturn($platform);

        $em = $this->createMock(EntityManager::class);
        $em->expects($this->any())
            ->method('getMetadataFactory')
            ->willReturn($mf);
        $em->expects($this->any())
            ->method('getConnection')
            ->willReturn($conn);

        // NEXT MAJOR: Replace this when dropping PHP < 5.6
        // $q = $this->createMock('PDOStatement');
        $q = $this->getMockBuilder('stdClass')
            ->setMethods(['execute', 'setHint'])
            ->getMock();
        $q->expects($this->once())
           ->method('setHint')
           ->willReturn($q);
        $q->expects($this->any())
            ->method('execute')
            ->willReturn([[$id => $value]]);

        $qb = $this->getMockBuilder(QueryBuilder::class)
            ->setConstructorArgs([$em])
            ->getMock();
        $qb->expects($this->any())
            ->method('getEntityManager')
            ->willReturn($em);
        $qb->expects($this->any())
            ->method('getQuery')
            ->willReturn($q);
        $qb->expects($this->once())
            ->method('setParameter')
            ->with($this->equalTo($expectedId), $this->equalTo([$value]));
        $qb->expects($this->any())
            ->method('getDQLPart')
            ->will($this->returnCallBack(function ($part) use ($class, $alias) {
                $parts = [
                    'from' => [new From($class, $alias)],
                    'orderBy' => [new OrderBy('whatever', 'DESC')],
                ];

                return $parts[$part];
            }));
        $qb->expects($this->once())
            ->method('addOrderBy')
            ->with("$alias.$id", null);
        $qb->expects($this->once())
            ->method('getRootEntities')
            ->willReturn([$class]);
        $qb->expects($this->exactly(2))
            ->method('getRootAliases')
            ->willReturn([$alias]);

        $pq = $this->getMockBuilder(ProxyQuery::class)
            ->setConstructorArgs([$qb])
            ->setMethods(['a'])
            ->getMock();

        /* Work */

        $pq->execute();
    }

    public function testSetHint()
    {
        $entity1 = new DoubleNameEntity(1, 'Foo', null);
        $entity2 = new DoubleNameEntity(2, 'Bar', null);

        $this->em->persist($entity1);
        $this->em->persist($entity2);
        $this->em->flush();

        $qb = $this->em->createQueryBuilder()
            ->select('o.id')
            ->from(DoubleNameEntity::class, 'o');

        $pq = new ProxyQuery($qb);
        $pq->setHint(
            Query::HINT_CUSTOM_OUTPUT_WALKER,
            FooWalker::class
        );
        $pq->setHint('hint', 'value');

        $result = $pq->execute();

        $this->assertEquals(2, $result[0]['id']);
    }

    public function testSortOrderValidatesItsInput()
    {
        $query = new ProxyQuery($this->em->createQueryBuilder());
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage(
            '"ASC,injection" is not a valid sort order, valid values are "ASC, DESC"'
        );
        $query->setSortOrder('ASC,injection');
    }

    public function validSortOrders()
    {
        return [
            ['ASC'],
            ['DESC'],
            ['asc'],
            ['desc'],
            ['AsC'],
            ['deSc'],
        ];
    }

    /**
     * @dataProvider validSortOrders
     */
    public function testItAllowsSortOrdersWithStrangeCase($validValue)
    {
        $query = new ProxyQuery($this->em->createQueryBuilder());
        $query->setSortOrder($validValue);
        $this->assertSame($validValue, $query->getSortOrder());
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\DoctrineORMAdminBundle\Tests\Datagrid;
15
16			use Doctrine\DBAL\Connection;
17			use Doctrine\DBAL\Platforms\PostgreSqlPlatform;
18			use Doctrine\DBAL\Types\Type;
19			use Doctrine\ORM\EntityManager;
20			use Doctrine\ORM\Mapping\ClassMetadata;
21			use Doctrine\ORM\Mapping\ClassMetadataFactory;
22			use Doctrine\ORM\Query\Expr\From;
23			use Doctrine\ORM\Query\Expr\OrderBy;
24			use Doctrine\ORM\QueryBuilder;
25			use Doctrine\ORM\Tools\SchemaTool;
26			use PHPUnit\Framework\TestCase;
27			use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery;
28			use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\DoctrineType\UuidType;
29			use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Util\NonIntegerIdentifierTestClass;
30			use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
31			use Symfony\Bridge\Doctrine\Tests\Fixtures\DoubleNameEntity;
32
33			class ProxyQueryTest extends TestCase
34			{
35			/**
36			* @var EntityManager
37			*/
38			private $em;
39
40			public static function setUpBeforeClass(): void
41			{
42			if (!Type::hasType('uuid')) {
43			Type::addType('uuid', UuidType::class);
44			}
45			}
46
47			protected function setUp(): void
48			{
49			$this->em = DoctrineTestHelper::createTestEntityManager();
50
51			$schemaTool = new SchemaTool($this->em);
52			$classes = [
53			$this->em->getClassMetadata(DoubleNameEntity::class),
54			];
55
56			try {
57			$schemaTool->dropSchema($classes);
58			} catch (\Exception $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-09-23 23:24 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
59			}
60
61			try {
62			$schemaTool->createSchema($classes);
63			} catch (\Exception $e) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-09-23 23:24 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
64			}
65			}
66
67			protected function tearDown(): void
68			{
69			$this->em = null;
70			}
71
72			public function dataGetFixedQueryBuilder()
73			{
74			return [
75			['aaa', 'bbb', 'id', 'id_idx', 33, Type::INTEGER],
76			['aaa', 'bbb', 'associatedId', 'associatedId_idx', 33, null],
77			['aaa', 'bbb', 'id.value', 'id_value_idx', 33, Type::INTEGER],
78			['aaa', 'bbb', 'id.uuid', 'id_uuid_idx', new NonIntegerIdentifierTestClass('80fb6f91-bba1-4d35-b3d4-e06b24494e85'), UuidType::NAME],
79			];
80			}
81
82			/**
83			* @dataProvider dataGetFixedQueryBuilder
84			*
85			* @param $class
86			* @param $alias
87			* @param $id
88			*/
89			public function testGetFixedQueryBuilder($class, $alias, $id, $expectedId, $value, $identifierType): void
90			{
91			$meta = $this->createMock(ClassMetadata::class);
92			$meta->expects($this->any())
93			->method('getIdentifierFieldNames')
94			->willReturn([$id]);
95			$meta->expects($this->any())
96			->method('getTypeOfField')
97			->willReturn($identifierType);
98
99			$mf = $this->createMock(ClassMetadataFactory::class);
100			$mf->expects($this->any())
101			->method('getMetadataFor')
102			->with($this->equalTo($class))
103			->willReturn($meta);
104
105			$platform = $this->createMock(PostgreSqlPlatform::class);
106
107			$conn = $this->createMock(Connection::class);
108			$conn->expects($this->any())
109			->method('getDatabasePlatform')
110			->willReturn($platform);
111
112			$em = $this->createMock(EntityManager::class);
113			$em->expects($this->any())
114			->method('getMetadataFactory')
115			->willReturn($mf);
116			$em->expects($this->any())
117			->method('getConnection')
118			->willReturn($conn);
119
120			// NEXT MAJOR: Replace this when dropping PHP < 5.6
121			// $q = $this->createMock('PDOStatement');
122			$q = $this->getMockBuilder('stdClass')
123			->setMethods(['execute', 'setHint'])
124			->getMock();
125			$q->expects($this->once())
126			->method('setHint')
127			->willReturn($q);
128			$q->expects($this->any())
129			->method('execute')
130			->willReturn([[$id => $value]]);
131
132			$qb = $this->getMockBuilder(QueryBuilder::class)
133			->setConstructorArgs([$em])
134			->getMock();
135			$qb->expects($this->any())
136			->method('getEntityManager')
137			->willReturn($em);
138			$qb->expects($this->any())
139			->method('getQuery')
140			->willReturn($q);
141			$qb->expects($this->once())
142			->method('setParameter')
143			->with($this->equalTo($expectedId), $this->equalTo([$value]));
144			$qb->expects($this->any())
145			->method('getDQLPart')
146			->will($this->returnCallBack(function ($part) use ($class, $alias) {
147			$parts = [
148			'from' => [new From($class, $alias)],
149			'orderBy' => [new OrderBy('whatever', 'DESC')],
150			];
151
152			return $parts[$part];
153			}));
154			$qb->expects($this->once())
155			->method('addOrderBy')
156			->with("$alias.$id", null);
157			$qb->expects($this->once())
158			->method('getRootEntities')
159			->willReturn([$class]);
160			$qb->expects($this->exactly(2))
161			->method('getRootAliases')
162			->willReturn([$alias]);
163
164			$pq = $this->getMockBuilder(ProxyQuery::class)
165			->setConstructorArgs([$qb])
166			->setMethods(['a'])
167			->getMock();
168
169			/* Work */
170
171			$pq->execute();
172			}
173
174			public function testSetHint()
175			{
176			$entity1 = new DoubleNameEntity(1, 'Foo', null);
177			$entity2 = new DoubleNameEntity(2, 'Bar', null);
178
179			$this->em->persist($entity1);
180			$this->em->persist($entity2);
181			$this->em->flush();
182
183			$qb = $this->em->createQueryBuilder()
184			->select('o.id')
185			->from(DoubleNameEntity::class, 'o');
186
187			$pq = new ProxyQuery($qb);
188			$pq->setHint(
189			Query::HINT_CUSTOM_OUTPUT_WALKER,
190			FooWalker::class
191			);
192			$pq->setHint('hint', 'value');
193
194			$result = $pq->execute();
195
196			$this->assertEquals(2, $result[0]['id']);
197			}
198
199			public function testSortOrderValidatesItsInput()
200			{
201			$query = new ProxyQuery($this->em->createQueryBuilder());
202			$this->expectException(\InvalidArgumentException::class);
203			$this->expectExceptionMessage(
204			'"ASC,injection" is not a valid sort order, valid values are "ASC, DESC"'
205			);
206			$query->setSortOrder('ASC,injection');
207			}
208
209			public function validSortOrders()
210			{
211			return [
212			['ASC'],
213			['DESC'],
214			['asc'],
215			['desc'],
216			['AsC'],
217			['deSc'],
218			];
219			}
220
221			/**
222			* @dataProvider validSortOrders
223			*/
224			public function testItAllowsSortOrdersWithStrangeCase($validValue)
225			{
226			$query = new ProxyQuery($this->em->createQueryBuilder());
227			$query->setSortOrder($validValue);
228			$this->assertSame($validValue, $query->getSortOrder());
229			}
230			}
231

sonata-project / SonataDoctrineORMAdminBundle

Pull Request — master (#804)

ProxyQueryTest::testGetFixedQueryBuilder() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like