Completed
Pull Request — 3.x (#677)
by
unknown
03:09 queued 54s
created

ModelManagerTest::getVersionDataProvider()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 7
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 7
rs 9.4285
cc 1
eloc 4
nc 1
nop 0
1
<?php
2
3
/*
4
 * This file is part of the Sonata Project package.
5
 *
6
 * (c) Thomas Rabaix <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace Sonata\DoctrineORMAdminBundle\Tests\Model;
13
14
use Doctrine\DBAL\Types\Type;
15
use Doctrine\ORM\Mapping\ClassMetadata;
16
use Doctrine\ORM\OptimisticLockException;
17
use Doctrine\ORM\Version;
18
use Sonata\DoctrineORMAdminBundle\Admin\FieldDescription;
19
use Sonata\DoctrineORMAdminBundle\Model\ModelManager;
20
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\DoctrineType\UuidType;
21
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\AssociatedEntity;
22
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\ContainerEntity;
23
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\Embeddable\EmbeddedEntity;
24
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\UuidEntity;
25
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\VersionedEntity;
26
use Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Util\NonIntegerIdentifierTestClass;
27
use Sonata\DoctrineORMAdminBundle\Tests\Helpers\PHPUnit_Framework_TestCase;
28
29
class ModelManagerTest extends PHPUnit_Framework_TestCase
30
{
31
    public static function setUpBeforeClass()
32
    {
33
        if (!Type::hasType('uuid')) {
34
            Type::addType('uuid', 'Sonata\DoctrineORMAdminBundle\Tests\Fixtures\DoctrineType\UuidType');
35
        }
36
    }
37
38
    public function testSortParameters()
39
    {
40
        $registry = $this->createMock('Symfony\Bridge\Doctrine\RegistryInterface');
41
42
        $manager = new ModelManager($registry);
43
44
        $datagrid1 = $this->createMock('Sonata\AdminBundle\Datagrid\Datagrid');
45
        $datagrid2 = $this->createMock('Sonata\AdminBundle\Datagrid\Datagrid');
46
47
        $field1 = new FieldDescription();
48
        $field1->setName('field1');
49
50
        $field2 = new FieldDescription();
51
        $field2->setName('field2');
52
53
        $field3 = new FieldDescription();
54
        $field3->setName('field3');
55
        $field3->setOption('sortable', 'field3sortBy');
56
57
        $datagrid1
58
            ->expects($this->any())
59
            ->method('getValues')
60
            ->will($this->returnValue(array(
61
                '_sort_by' => $field1,
62
                '_sort_order' => 'ASC',
63
            )));
64
65
        $datagrid2
66
            ->expects($this->any())
67
            ->method('getValues')
68
            ->will($this->returnValue(array(
69
                '_sort_by' => $field3,
70
                '_sort_order' => 'ASC',
71
            )));
72
73
        $parameters = $manager->getSortParameters($field1, $datagrid1);
74
75
        $this->assertEquals('DESC', $parameters['filter']['_sort_order']);
76
        $this->assertEquals('field1', $parameters['filter']['_sort_by']);
77
78
        $parameters = $manager->getSortParameters($field2, $datagrid1);
79
80
        $this->assertEquals('ASC', $parameters['filter']['_sort_order']);
81
        $this->assertEquals('field2', $parameters['filter']['_sort_by']);
82
83
        $parameters = $manager->getSortParameters($field3, $datagrid1);
84
85
        $this->assertEquals('ASC', $parameters['filter']['_sort_order']);
86
        $this->assertEquals('field3sortBy', $parameters['filter']['_sort_by']);
87
88
        $parameters = $manager->getSortParameters($field3, $datagrid2);
89
90
        $this->assertEquals('DESC', $parameters['filter']['_sort_order']);
91
        $this->assertEquals('field3sortBy', $parameters['filter']['_sort_by']);
92
    }
93
94
    public function getVersionDataProvider()
95
    {
96
        return array(
97
            array(true),
98
            array(false),
99
        );
100
    }
101
102
    /**
103
     * @dataProvider getVersionDataProvider
104
     */
105
    public function testGetVersion($isVersioned)
106
    {
107
        $object = new VersionedEntity();
108
109
        $modelManager = $this->getMockBuilder('Sonata\DoctrineORMAdminBundle\Model\ModelManager')
110
            ->disableOriginalConstructor()
111
            ->setMethods(array('getMetadata'))
112
            ->getMock();
113
114
        $metadata = $this->getMetadata(get_class($object), $isVersioned);
115
116
        $modelManager->expects($this->any())
117
            ->method('getMetadata')
118
            ->will($this->returnValue($metadata));
119
120
        if ($isVersioned) {
121
            $object->version = 123;
122
123
            $this->assertNotNull($modelManager->getLockVersion($object));
124
        } else {
125
            $this->assertNull($modelManager->getLockVersion($object));
126
        }
127
    }
128
129
    public function lockDataProvider()
130
    {
131
        return array(
132
            array(true,  false),
133
            array(true,  true),
134
            array(false, false),
135
        );
136
    }
137
138
    /**
139
     * @dataProvider lockDataProvider
140
     */
141
    public function testLock($isVersioned, $expectsException)
142
    {
143
        $object = new VersionedEntity();
144
145
        $em = $this->getMockBuilder('Doctrine\ORM\EntityManager')
146
            ->disableOriginalConstructor()
147
            ->setMethods(array('lock'))
148
            ->getMock();
149
150
        $modelManager = $this->getMockBuilder('Sonata\DoctrineORMAdminBundle\Model\ModelManager')
151
            ->disableOriginalConstructor()
152
            ->setMethods(array('getMetadata', 'getEntityManager'))
153
            ->getMock();
154
155
        $modelManager->expects($this->any())
156
            ->method('getEntityManager')
157
            ->will($this->returnValue($em));
158
159
        $metadata = $this->getMetadata(get_class($object), $isVersioned);
160
161
        $modelManager->expects($this->any())
162
            ->method('getMetadata')
163
            ->will($this->returnValue($metadata));
164
165
        if ($expectsException) {
166
            $em->expects($this->once())
167
                ->method('lock')
168
                ->will($this->throwException(OptimisticLockException::lockFailed($object)));
169
170
            $this->setExpectedException('Sonata\AdminBundle\Exception\LockException');
171
        }
172
173
        $modelManager->lock($object, 123);
174
    }
175
176
    public function testGetParentMetadataForProperty()
177
    {
178
        if (version_compare(Version::VERSION, '2.5') < 0) {
179
            $this->markTestSkipped('Test for embeddables needs to run on Doctrine >= 2.5');
180
181
            return;
182
        }
183
184
        $containerEntityClass = 'Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\ContainerEntity';
185
        $associatedEntityClass = 'Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\AssociatedEntity';
186
        $embeddedEntityClass = 'Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\Embeddable\EmbeddedEntity';
187
        $modelManagerClass = 'Sonata\DoctrineORMAdminBundle\Model\ModelManager';
188
189
        $object = new ContainerEntity(new AssociatedEntity(), new EmbeddedEntity());
0 ignored issues
show
Unused Code introduced by
$object is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
190
191
        $em = $this->createMock('Doctrine\ORM\EntityManager');
192
193
        /** @var \PHPUnit_Framework_MockObject_MockObject|ModelManager $modelManager */
194
        $modelManager = $this->getMockBuilder($modelManagerClass)
195
            ->disableOriginalConstructor()
196
            ->setMethods(array('getMetadata', 'getEntityManager'))
197
            ->getMock();
198
199
        $modelManager->expects($this->any())
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Sonata\DoctrineOR...dle\Model\ModelManager>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
200
            ->method('getEntityManager')
201
            ->will($this->returnValue($em));
202
203
        $containerEntityMetadata = $this->getMetadataForContainerEntity();
204
        $associatedEntityMetadata = $this->getMetadataForAssociatedEntity();
205
        $embeddedEntityMetadata = $this->getMetadataForEmbeddedEntity();
206
207
        $modelManager->expects($this->any())->method('getMetadata')
0 ignored issues
show
Bug introduced by
The method expects() does not seem to exist on object<Sonata\DoctrineOR...dle\Model\ModelManager>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
208
            ->will(
209
                $this->returnValueMap(
210
                    array(
211
                        array($containerEntityClass, $containerEntityMetadata),
212
                        array($embeddedEntityClass, $embeddedEntityMetadata),
213
                        array($associatedEntityClass, $associatedEntityMetadata),
214
                    )
215
                )
216
            );
217
218
        /** @var ClassMetadata $metadata */
219
        list($metadata, $lastPropertyName) = $modelManager
220
            ->getParentMetadataForProperty($containerEntityClass, 'plainField');
221
        $this->assertEquals($metadata->fieldMappings[$lastPropertyName]['type'], 'integer');
222
223
        list($metadata, $lastPropertyName) = $modelManager
224
            ->getParentMetadataForProperty($containerEntityClass, 'associatedEntity.plainField');
225
        $this->assertEquals($metadata->fieldMappings[$lastPropertyName]['type'], 'string');
226
227
        list($metadata, $lastPropertyName) = $modelManager
228
            ->getParentMetadataForProperty($containerEntityClass, 'embeddedEntity.plainField');
229
        $this->assertEquals($metadata->fieldMappings[$lastPropertyName]['type'], 'boolean');
230
    }
231
232
    public function getMetadataForEmbeddedEntity()
233
    {
234
        $metadata = new ClassMetadata('Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\Embeddable\EmbeddedEntity');
235
236
        $metadata->fieldMappings = array(
237
            'plainField' => array(
238
                'fieldName' => 'plainField',
239
                'columnName' => 'plainField',
240
                'type' => 'boolean',
241
            ),
242
        );
243
244
        return $metadata;
245
    }
246
247
    public function getMetadataForAssociatedEntity()
248
    {
249
        $metadata = new ClassMetadata('Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\AssociatedEntity');
250
251
        $metadata->fieldMappings = array(
252
            'plainField' => array(
253
                'fieldName' => 'plainField',
254
                'columnName' => 'plainField',
255
                'type' => 'string',
256
            ),
257
        );
258
259
        return $metadata;
260
    }
261
262
    public function getMetadataForContainerEntity()
263
    {
264
        $containerEntityClass = 'Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\ContainerEntity';
265
        $associatedEntityClass = 'Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\AssociatedEntity';
266
        $embeddedEntityClass = 'Sonata\DoctrineORMAdminBundle\Tests\Fixtures\Entity\Embeddable\EmbeddedEntity';
267
268
        $metadata = new ClassMetadata($containerEntityClass);
269
270
        $metadata->fieldMappings = array(
271
            'plainField' => array(
272
                'fieldName' => 'plainField',
273
                'columnName' => 'plainField',
274
                'type' => 'integer',
275
            ),
276
        );
277
278
        $metadata->associationMappings['associatedEntity'] = array(
279
            'fieldName' => 'associatedEntity',
280
            'targetEntity' => $associatedEntityClass,
281
            'sourceEntity' => $containerEntityClass,
282
        );
283
284
        $metadata->embeddedClasses['embeddedEntity'] = array(
285
            'class' => $embeddedEntityClass,
286
            'columnPrefix' => 'embeddedEntity',
287
        );
288
289
        $metadata->inlineEmbeddable('embeddedEntity', $this->getMetadataForEmbeddedEntity());
290
291
        return $metadata;
292
    }
293
294
    public function testNonIntegerIdentifierType()
295
    {
296
        $uuid = new NonIntegerIdentifierTestClass('efbcfc4b-8c43-4d42-aa4c-d707e55151ac');
297
        $entity = new UuidEntity($uuid);
298
299
        $meta = $this->createMock('Doctrine\ORM\Mapping\ClassMetadataInfo');
300
        $meta->expects($this->any())
301
            ->method('getIdentifierValues')
302
            ->willReturn(array($entity->getId()));
303
        $meta->expects($this->any())
304
            ->method('getTypeOfField')
305
            ->willReturn(UuidType::NAME);
306
307
        $mf = $this->createMock('Doctrine\ORM\Mapping\ClassMetadataFactory');
308
        $mf->expects($this->any())
309
            ->method('getMetadataFor')
310
            ->willReturn($meta);
311
312
        $platform = $this->createMock('Doctrine\DBAL\Platforms\PostgreSqlPlatform');
313
314
        $conn = $this->createMock('Doctrine\DBAL\Connection');
315
        $conn->expects($this->any())
316
            ->method('getDatabasePlatform')
317
            ->willReturn($platform);
318
319
        $em = $this->createMock('Doctrine\ORM\EntityManager');
320
        $em->expects($this->any())
321
            ->method('getMetadataFactory')
322
            ->willReturn($mf);
323
        $em->expects($this->any())
324
            ->method('getConnection')
325
            ->willReturn($conn);
326
327
        $registry = $this->createMock('Symfony\Bridge\Doctrine\RegistryInterface');
328
        $registry->expects($this->any())
329
            ->method('getManagerForClass')
330
            ->willReturn($em);
331
332
        $manager = new ModelManager($registry);
333
        $result = $manager->getIdentifierValues($entity);
334
335
        $this->assertEquals($entity->getId()->toString(), $result[0]);
336
    }
337
338
    public function testAssociationIdentifierType()
339
    {
340
        $entity = new ContainerEntity(new AssociatedEntity(42), new EmbeddedEntity());
341
342
        $meta = $this->createMock('Doctrine\ORM\Mapping\ClassMetadataInfo');
343
        $meta->expects($this->any())
344
            ->method('getIdentifierValues')
345
            ->willReturn(array($entity->getAssociatedEntity()->getPlainField()));
346
        $meta->expects($this->any())
347
            ->method('getTypeOfField')
348
            ->willReturn(null);
349
350
        $mf = $this->createMock('Doctrine\ORM\Mapping\ClassMetadataFactory');
351
        $mf->expects($this->any())
352
            ->method('getMetadataFor')
353
            ->willReturn($meta);
354
355
        $platform = $this->createMock('Doctrine\DBAL\Platforms\PostgreSqlPlatform');
356
357
        $conn = $this->createMock('Doctrine\DBAL\Connection');
358
        $conn->expects($this->any())
359
            ->method('getDatabasePlatform')
360
            ->willReturn($platform);
361
362
        $em = $this->createMock('Doctrine\ORM\EntityManager');
363
        $em->expects($this->any())
364
            ->method('getMetadataFactory')
365
            ->willReturn($mf);
366
        $em->expects($this->any())
367
            ->method('getConnection')
368
            ->willReturn($conn);
369
370
        $registry = $this->createMock('Symfony\Bridge\Doctrine\RegistryInterface');
371
        $registry->expects($this->any())
372
            ->method('getManagerForClass')
373
            ->willReturn($em);
374
375
        $manager = new ModelManager($registry);
376
        $result = $manager->getIdentifierValues($entity);
377
378
        $this->assertSame(42, $result[0]);
379
    }
380
381
    private function getMetadata($class, $isVersioned)
382
    {
383
        $metadata = new ClassMetadata($class);
384
385
        $metadata->isVersioned = $isVersioned;
386
387
        if ($isVersioned) {
388
            $versionField = 'version';
389
            $metadata->versionField = $versionField;
390
            $metadata->reflFields[$versionField] = new \ReflectionProperty($class, $versionField);
391
        }
392
393
        return $metadata;
394
    }
395
}
396