Total Complexity | 55 |
Total Lines | 1153 |
Duplicated Lines | 12.14 % |
Changes | 0 |
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like AbstractMappingDriverTest often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AbstractMappingDriverTest, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
43 | abstract class AbstractMappingDriverTest extends OrmTestCase |
||
44 | { |
||
45 | /** |
||
46 | * @var Mapping\ClassMetadataBuildingContext |
||
47 | */ |
||
48 | protected $metadataBuildingContext; |
||
49 | |||
50 | public function setUp() |
||
51 | { |
||
52 | parent::setUp(); |
||
53 | |||
54 | $this->metadataBuildingContext = new Mapping\ClassMetadataBuildingContext( |
||
55 | $this->createMock(ClassMetadataFactory::class), |
||
56 | new RuntimeReflectionService() |
||
57 | ); |
||
58 | } |
||
59 | |||
60 | abstract protected function loadDriver(); |
||
61 | |||
62 | public function createClassMetadata($entityClassName) |
||
63 | { |
||
64 | $mappingDriver = $this->loadDriver(); |
||
65 | |||
66 | $class = new ClassMetadata($entityClassName, $this->metadataBuildingContext); |
||
67 | |||
68 | $mappingDriver->loadMetadataForClass($entityClassName, $class, $this->metadataBuildingContext); |
||
69 | |||
70 | return $class; |
||
71 | } |
||
72 | |||
73 | protected function createClassMetadataFactory(EntityManagerInterface $em = null) : ClassMetadataFactory |
||
74 | { |
||
75 | $driver = $this->loadDriver(); |
||
76 | $em = $em ?: $this->getTestEntityManager(); |
||
77 | $factory = new ClassMetadataFactory(); |
||
78 | |||
79 | $em->getConfiguration()->setMetadataDriverImpl($driver); |
||
80 | $factory->setEntityManager($em); |
||
81 | |||
82 | return $factory; |
||
83 | } |
||
84 | |||
85 | /** |
||
86 | * @param ClassMetadata $class |
||
87 | */ |
||
88 | public function testEntityTableNameAndInheritance() |
||
89 | { |
||
90 | $class = $this->createClassMetadata(User::class); |
||
91 | |||
92 | self::assertEquals('cms_users', $class->getTableName()); |
||
93 | self::assertEquals(Mapping\InheritanceType::NONE, $class->inheritanceType); |
||
94 | |||
95 | return $class; |
||
96 | } |
||
97 | |||
98 | /** |
||
99 | * |
||
100 | * @param ClassMetadata $class |
||
101 | */ |
||
102 | public function testEntityIndexes() |
||
103 | { |
||
104 | $class = $this->createClassMetadata('Doctrine\Tests\ORM\Mapping\User'); |
||
105 | |||
106 | self::assertCount(2, $class->table->getIndexes()); |
||
107 | self::assertEquals( |
||
108 | [ |
||
109 | 'name_idx' => [ |
||
110 | 'name' => 'name_idx', |
||
111 | 'columns' => ['name'], |
||
112 | 'unique' => false, |
||
113 | 'options' => [], |
||
114 | 'flags' => [], |
||
115 | ], |
||
116 | 0 => [ |
||
117 | 'name' => null, |
||
118 | 'columns' => ['user_email'], |
||
119 | 'unique' => false, |
||
120 | 'options' => [], |
||
121 | 'flags' => [], |
||
122 | ] |
||
123 | ], |
||
124 | $class->table->getIndexes() |
||
125 | ); |
||
126 | |||
127 | return $class; |
||
128 | } |
||
129 | |||
130 | public function testEntityIndexFlagsAndPartialIndexes() |
||
131 | { |
||
132 | $class = $this->createClassMetadata(Comment::class); |
||
133 | |||
134 | self::assertEquals( |
||
135 | [ |
||
136 | 0 => [ |
||
137 | 'name' => null, |
||
138 | 'columns' => ['content'], |
||
139 | 'unique' => false, |
||
140 | 'flags' => ['fulltext'], |
||
141 | 'options' => ['where' => 'content IS NOT NULL'], |
||
142 | ] |
||
143 | ], |
||
144 | $class->table->getIndexes() |
||
145 | ); |
||
146 | } |
||
147 | |||
148 | /** |
||
149 | * @depends testEntityTableNameAndInheritance |
||
150 | * @param ClassMetadata $class |
||
151 | */ |
||
152 | public function testEntityUniqueConstraints($class) |
||
153 | { |
||
154 | self::assertCount(1, $class->table->getUniqueConstraints()); |
||
155 | self::assertEquals( |
||
156 | [ |
||
157 | 'search_idx' => [ |
||
158 | 'name' => 'search_idx', |
||
159 | 'columns' => ['name', 'user_email'], |
||
160 | 'options' => [], |
||
161 | 'flags' => [], |
||
162 | ] |
||
163 | ], |
||
164 | $class->table->getUniqueConstraints() |
||
165 | ); |
||
166 | |||
167 | return $class; |
||
168 | } |
||
169 | |||
170 | /** |
||
171 | * @depends testEntityTableNameAndInheritance |
||
172 | * @param ClassMetadata $class |
||
173 | */ |
||
174 | public function testEntityOptions($class) |
||
175 | { |
||
176 | self::assertCount(2, $class->table->getOptions()); |
||
177 | self::assertEquals( |
||
178 | [ |
||
179 | 'foo' => 'bar', |
||
180 | 'baz' => ['key' => 'val'] |
||
181 | ], |
||
182 | $class->table->getOptions() |
||
183 | ); |
||
184 | |||
185 | return $class; |
||
186 | } |
||
187 | |||
188 | /** |
||
189 | * @depends testEntityOptions |
||
190 | * @param ClassMetadata $class |
||
191 | */ |
||
192 | public function testEntitySequence($class) |
||
193 | { |
||
194 | self::assertInternalType( |
||
195 | 'array', |
||
196 | $class->getProperty('id')->getValueGenerator()->getDefinition(), |
||
|
|||
197 | 'No Sequence Definition set on this driver.' |
||
198 | ); |
||
199 | self::assertEquals( |
||
200 | [ |
||
201 | 'sequenceName' => 'tablename_seq', |
||
202 | 'allocationSize' => 100, |
||
203 | ], |
||
204 | $class->getProperty('id')->getValueGenerator()->getDefinition() |
||
205 | ); |
||
206 | } |
||
207 | |||
208 | View Code Duplication | public function testEntityCustomGenerator() |
|
209 | { |
||
210 | $class = $this->createClassMetadata(Animal::class); |
||
211 | |||
212 | self::assertEquals(Mapping\GeneratorType::CUSTOM, $class->getProperty('id')->getValueGenerator()->getType(), "Generator Type"); |
||
213 | self::assertEquals( |
||
214 | [ |
||
215 | 'class' => 'stdClass', |
||
216 | 'arguments' => [], |
||
217 | ], |
||
218 | $class->getProperty('id')->getValueGenerator()->getDefinition(), |
||
219 | "Generator Definition" |
||
220 | ); |
||
221 | } |
||
222 | |||
223 | |||
224 | /** |
||
225 | * @depends testEntityTableNameAndInheritance |
||
226 | * @param ClassMetadata $class |
||
227 | */ |
||
228 | public function testProperties($class) |
||
229 | { |
||
230 | self::assertCount(7, $class->getDeclaredPropertiesIterator()); |
||
231 | |||
232 | self::assertNotNull($class->getProperty('id')); |
||
233 | self::assertNotNull($class->getProperty('name')); |
||
234 | self::assertNotNull($class->getProperty('email')); |
||
235 | self::assertNotNull($class->getProperty('version')); |
||
236 | self::assertNotNull($class->getProperty('version')); |
||
237 | |||
238 | return $class; |
||
239 | } |
||
240 | |||
241 | /** |
||
242 | * @depends testProperties |
||
243 | * @param ClassMetadata $class |
||
244 | */ |
||
245 | public function testVersionProperty($class) |
||
246 | { |
||
247 | self::assertTrue($class->isVersioned()); |
||
248 | self::assertNotNull($class->versionProperty); |
||
249 | |||
250 | $versionPropertyName = $class->versionProperty->getName(); |
||
251 | |||
252 | self::assertEquals("version", $versionPropertyName); |
||
253 | self::assertNotNull($class->getProperty($versionPropertyName)); |
||
254 | } |
||
255 | |||
256 | /** |
||
257 | * @depends testEntityTableNameAndInheritance |
||
258 | * @param ClassMetadata $class |
||
259 | */ |
||
260 | public function testFieldMappingsColumnNames($class) |
||
261 | { |
||
262 | self::assertNotNull($class->getProperty('id')); |
||
263 | self::assertNotNull($class->getProperty('name')); |
||
264 | self::assertNotNull($class->getProperty('email')); |
||
265 | |||
266 | self::assertEquals("id", $class->getProperty('id')->getColumnName()); |
||
267 | self::assertEquals("name", $class->getProperty('name')->getColumnName()); |
||
268 | self::assertEquals("user_email", $class->getProperty('email')->getColumnName()); |
||
269 | |||
270 | return $class; |
||
271 | } |
||
272 | |||
273 | /** |
||
274 | * @depends testEntityTableNameAndInheritance |
||
275 | * @param ClassMetadata $class |
||
276 | */ |
||
277 | public function testStringFieldMappings($class) |
||
278 | { |
||
279 | self::assertNotNull($class->getProperty('name')); |
||
280 | |||
281 | $property = $class->getProperty('name'); |
||
282 | |||
283 | self::assertEquals('string', $property->getTypeName()); |
||
284 | self::assertEquals(50, $property->getLength()); |
||
285 | self::assertTrue($property->isNullable()); |
||
286 | self::assertTrue($property->isUnique()); |
||
287 | |||
288 | return $class; |
||
289 | } |
||
290 | |||
291 | /** |
||
292 | * @depends testEntityTableNameAndInheritance |
||
293 | * |
||
294 | * @param ClassMetadata $class |
||
295 | * |
||
296 | * @return ClassMetadata |
||
297 | */ |
||
298 | public function testFieldOptions(ClassMetadata $class) |
||
299 | { |
||
300 | self::assertNotNull($class->getProperty('name')); |
||
301 | |||
302 | $property = $class->getProperty('name'); |
||
303 | $expected = ['foo' => 'bar', 'baz' => ['key' => 'val'], 'fixed' => false]; |
||
304 | |||
305 | self::assertEquals($expected, $property->getOptions()); |
||
306 | |||
307 | return $class; |
||
308 | } |
||
309 | |||
310 | /** |
||
311 | * @depends testEntityTableNameAndInheritance |
||
312 | * @param ClassMetadata $class |
||
313 | */ |
||
314 | public function testIdFieldOptions($class) |
||
315 | { |
||
316 | self::assertNotNull($class->getProperty('id')); |
||
317 | |||
318 | $property = $class->getProperty('id'); |
||
319 | $expected = ['foo' => 'bar', 'unsigned' => false]; |
||
320 | |||
321 | self::assertEquals($expected, $property->getOptions()); |
||
322 | |||
323 | return $class; |
||
324 | } |
||
325 | |||
326 | /** |
||
327 | * @depends testProperties |
||
328 | * @param ClassMetadata $class |
||
329 | */ |
||
330 | View Code Duplication | public function testIdentifier($class) |
|
341 | } |
||
342 | |||
343 | /** |
||
344 | * @group #6129 |
||
345 | * |
||
346 | * @return ClassMetadata |
||
347 | */ |
||
348 | public function testBooleanValuesForOptionIsSetCorrectly() |
||
349 | { |
||
350 | $class = $this->createClassMetadata(User::class); |
||
351 | |||
352 | $idOptions = $class->getProperty('id')->getOptions(); |
||
353 | $nameOptions = $class->getProperty('name')->getOptions(); |
||
354 | |||
355 | self::assertInternalType('bool', $idOptions['unsigned']); |
||
356 | self::assertFalse($idOptions['unsigned']); |
||
357 | self::assertInternalType('bool', $nameOptions['fixed']); |
||
358 | self::assertFalse($nameOptions['fixed']); |
||
359 | |||
360 | return $class; |
||
361 | } |
||
362 | |||
363 | /** |
||
364 | * @depends testProperties |
||
365 | * @param ClassMetadata $class |
||
366 | */ |
||
367 | public function testOwningOneToOneAssociation($class) |
||
368 | { |
||
369 | self::assertArrayHasKey('address', iterator_to_array($class->getDeclaredPropertiesIterator())); |
||
370 | |||
371 | $association = $class->getProperty('address'); |
||
372 | |||
373 | self::assertTrue($association->isOwningSide()); |
||
374 | self::assertEquals('user', $association->getInversedBy()); |
||
375 | // Check cascading |
||
376 | self::assertEquals(['remove'], $association->getCascade()); |
||
377 | |||
378 | return $class; |
||
379 | } |
||
380 | |||
381 | /** |
||
382 | * @depends testOwningOneToOneAssociation |
||
383 | * @param ClassMetadata $class |
||
384 | */ |
||
385 | View Code Duplication | public function testInverseOneToManyAssociation($class) |
|
386 | { |
||
387 | self::assertArrayHasKey('phonenumbers', iterator_to_array($class->getDeclaredPropertiesIterator())); |
||
388 | |||
389 | $association = $class->getProperty('phonenumbers'); |
||
390 | |||
391 | self::assertFalse($association->isOwningSide()); |
||
392 | self::assertTrue($association->isOrphanRemoval()); |
||
393 | |||
394 | // Check cascading |
||
395 | self::assertEquals(['persist', 'remove'], $association->getCascade()); |
||
396 | |||
397 | // Test Order By |
||
398 | self::assertEquals(['number' => 'ASC'], $association->getOrderBy()); |
||
399 | |||
400 | return $class; |
||
401 | } |
||
402 | |||
403 | /** |
||
404 | * @depends testInverseOneToManyAssociation |
||
405 | * @param ClassMetadata $class |
||
406 | */ |
||
407 | View Code Duplication | public function testManyToManyAssociationWithCascadeAll($class) |
|
408 | { |
||
409 | self::assertArrayHasKey('groups', iterator_to_array($class->getDeclaredPropertiesIterator())); |
||
410 | |||
411 | $association = $class->getProperty('groups'); |
||
412 | |||
413 | self::assertTrue($association->isOwningSide()); |
||
414 | |||
415 | // Make sure that cascade-all works as expected |
||
416 | self::assertEquals(['remove', 'persist', 'refresh'], $association->getCascade()); |
||
417 | |||
418 | // Test Order By |
||
419 | self::assertEquals([], $association->getOrderBy()); |
||
420 | |||
421 | return $class; |
||
422 | } |
||
423 | |||
424 | /** |
||
425 | * @depends testManyToManyAssociationWithCascadeAll |
||
426 | * @param ClassMetadata $class |
||
427 | */ |
||
428 | public function testLifecycleCallbacks($class) |
||
429 | { |
||
430 | self::assertCount(2, $class->lifecycleCallbacks); |
||
431 | self::assertEquals($class->lifecycleCallbacks['prePersist'][0], 'doStuffOnPrePersist'); |
||
432 | self::assertEquals($class->lifecycleCallbacks['postPersist'][0], 'doStuffOnPostPersist'); |
||
433 | |||
434 | return $class; |
||
435 | } |
||
436 | |||
437 | /** |
||
438 | * @depends testManyToManyAssociationWithCascadeAll |
||
439 | * @param ClassMetadata $class |
||
440 | */ |
||
441 | public function testLifecycleCallbacksSupportMultipleMethodNames($class) |
||
442 | { |
||
443 | self::assertCount(2, $class->lifecycleCallbacks['prePersist']); |
||
444 | self::assertEquals($class->lifecycleCallbacks['prePersist'][1], 'doOtherStuffOnPrePersistToo'); |
||
445 | |||
446 | return $class; |
||
447 | } |
||
448 | |||
449 | /** |
||
450 | * @depends testLifecycleCallbacksSupportMultipleMethodNames |
||
451 | * @param ClassMetadata $class |
||
452 | */ |
||
453 | public function testJoinColumnUniqueAndNullable($class) |
||
454 | { |
||
455 | // Non-Nullability of Join Column |
||
456 | $association = $class->getProperty('groups'); |
||
457 | $joinTable = $association->getJoinTable(); |
||
458 | $joinColumns = $joinTable->getJoinColumns(); |
||
459 | $joinColumn = reset($joinColumns); |
||
460 | |||
461 | self::assertFalse($joinColumn->isNullable()); |
||
462 | self::assertFalse($joinColumn->isUnique()); |
||
463 | |||
464 | return $class; |
||
465 | } |
||
466 | |||
467 | /** |
||
468 | * @depends testJoinColumnUniqueAndNullable |
||
469 | * @param ClassMetadata $class |
||
470 | */ |
||
471 | public function testColumnDefinition($class) |
||
472 | { |
||
473 | self::assertNotNull($class->getProperty('email')); |
||
474 | |||
475 | $property = $class->getProperty('email'); |
||
476 | $association = $class->getProperty('groups'); |
||
477 | $joinTable = $association->getJoinTable(); |
||
478 | $inverseJoinColumns = $joinTable->getInverseJoinColumns(); |
||
479 | $inverseJoinColumn = reset($inverseJoinColumns); |
||
480 | |||
481 | self::assertEquals("CHAR(32) NOT NULL", $property->getColumnDefinition()); |
||
482 | self::assertEquals("INT NULL", $inverseJoinColumn->getColumnDefinition()); |
||
483 | |||
484 | return $class; |
||
485 | } |
||
486 | |||
487 | /** |
||
488 | * @depends testColumnDefinition |
||
489 | * @param ClassMetadata $class |
||
490 | */ |
||
491 | public function testJoinColumnOnDelete($class) |
||
492 | { |
||
493 | $association = $class->getProperty('address'); |
||
494 | $joinColumns = $association->getJoinColumns(); |
||
495 | $joinColumn = reset($joinColumns); |
||
496 | |||
497 | self::assertEquals('CASCADE', $joinColumn->getOnDelete()); |
||
498 | |||
499 | return $class; |
||
500 | } |
||
501 | |||
502 | /** |
||
503 | * @group DDC-514 |
||
504 | */ |
||
505 | public function testDiscriminatorColumnDefaults() |
||
506 | { |
||
507 | if (strpos(get_class($this), 'PHPMappingDriver') !== false) { |
||
508 | $this->markTestSkipped('PHP Mapping Drivers have no defaults.'); |
||
509 | } |
||
510 | |||
511 | $class = $this->createClassMetadata(Animal::class); |
||
512 | |||
513 | self::assertNotNull($class->discriminatorColumn); |
||
514 | |||
515 | $discrColumn = $class->discriminatorColumn; |
||
516 | |||
517 | self::assertEquals('Animal', $discrColumn->getTableName()); |
||
518 | self::assertEquals('discr', $discrColumn->getColumnName()); |
||
519 | self::assertEquals('string', $discrColumn->getTypeName()); |
||
520 | self::assertEquals(32, $discrColumn->getLength()); |
||
521 | self::assertNull($discrColumn->getColumnDefinition()); |
||
522 | } |
||
523 | |||
524 | /** |
||
525 | * @group DDC-869 |
||
526 | */ |
||
527 | public function testMappedSuperclassWithRepository() |
||
528 | { |
||
529 | $em = $this->getTestEntityManager(); |
||
530 | $factory = $this->createClassMetadataFactory($em); |
||
531 | $class = $factory->getMetadataFor(DDC869CreditCardPayment::class); |
||
532 | |||
533 | self::assertNotNull($class->getProperty('id')); |
||
534 | self::assertNotNull($class->getProperty('value')); |
||
535 | self::assertNotNull($class->getProperty('creditCardNumber')); |
||
536 | self::assertEquals($class->getCustomRepositoryClassName(), DDC869PaymentRepository::class); |
||
537 | self::assertInstanceOf(DDC869PaymentRepository::class, $em->getRepository(DDC869CreditCardPayment::class)); |
||
538 | self::assertTrue($em->getRepository(DDC869ChequePayment::class)->isTrue()); |
||
539 | |||
540 | $class = $factory->getMetadataFor(DDC869ChequePayment::class); |
||
541 | |||
542 | self::assertNotNull($class->getProperty('id')); |
||
543 | self::assertNotNull($class->getProperty('value')); |
||
544 | self::assertNotNull($class->getProperty('serialNumber')); |
||
545 | self::assertEquals($class->getCustomRepositoryClassName(), DDC869PaymentRepository::class); |
||
546 | self::assertInstanceOf(DDC869PaymentRepository::class, $em->getRepository(DDC869ChequePayment::class)); |
||
547 | self::assertTrue($em->getRepository(DDC869ChequePayment::class)->isTrue()); |
||
548 | } |
||
549 | |||
550 | /** |
||
551 | * @group DDC-1476 |
||
552 | */ |
||
553 | public function testDefaultFieldType() |
||
554 | { |
||
555 | $factory = $this->createClassMetadataFactory(); |
||
556 | $class = $factory->getMetadataFor(DDC1476EntityWithDefaultFieldType::class); |
||
557 | |||
558 | self::assertNotNull($class->getProperty('id')); |
||
559 | self::assertNotNull($class->getProperty('name')); |
||
560 | |||
561 | $idProperty = $class->getProperty('id'); |
||
562 | $nameProperty = $class->getProperty('name'); |
||
563 | |||
564 | self::assertInstanceOf(Mapping\FieldMetadata::class, $idProperty); |
||
565 | self::assertInstanceOf(Mapping\FieldMetadata::class, $nameProperty); |
||
566 | |||
567 | self::assertEquals('string', $idProperty->getTypeName()); |
||
568 | self::assertEquals('string', $nameProperty->getTypeName()); |
||
569 | |||
570 | self::assertEquals('id', $idProperty->getName()); |
||
571 | self::assertEquals('name', $nameProperty->getName()); |
||
572 | |||
573 | self::assertEquals('id', $idProperty->getColumnName()); |
||
574 | self::assertEquals('name', $nameProperty->getColumnName()); |
||
575 | |||
576 | self::assertFalse($idProperty->hasValueGenerator()); |
||
577 | } |
||
578 | |||
579 | /** |
||
580 | * @group DDC-1170 |
||
581 | */ |
||
582 | public function testIdentifierColumnDefinition() |
||
583 | { |
||
584 | $class = $this->createClassMetadata(DDC1170Entity::class); |
||
585 | |||
586 | self::assertNotNull($class->getProperty('id')); |
||
587 | self::assertNotNull($class->getProperty('value')); |
||
588 | |||
589 | self::assertEquals("INT unsigned NOT NULL", $class->getProperty('id')->getColumnDefinition()); |
||
590 | self::assertEquals("VARCHAR(255) NOT NULL", $class->getProperty('value')->getColumnDefinition()); |
||
591 | } |
||
592 | |||
593 | /** |
||
594 | * @group DDC-559 |
||
595 | */ |
||
596 | public function testNamingStrategy() |
||
597 | { |
||
598 | $em = $this->getTestEntityManager(); |
||
599 | $factory = $this->createClassMetadataFactory($em); |
||
600 | |||
601 | self::assertInstanceOf(DefaultNamingStrategy::class, $em->getConfiguration()->getNamingStrategy()); |
||
602 | $em->getConfiguration()->setNamingStrategy(new UnderscoreNamingStrategy(CASE_UPPER)); |
||
603 | self::assertInstanceOf(UnderscoreNamingStrategy::class, $em->getConfiguration()->getNamingStrategy()); |
||
604 | |||
605 | $class = $factory->getMetadataFor(DDC1476EntityWithDefaultFieldType::class); |
||
606 | $idProperty = $class->getProperty('id'); |
||
607 | $nameProperty = $class->getProperty('name'); |
||
608 | |||
609 | self::assertEquals('ID', $idProperty->getColumnName()); |
||
610 | self::assertEquals('NAME', $nameProperty->getColumnName()); |
||
611 | self::assertEquals('DDC1476ENTITY_WITH_DEFAULT_FIELD_TYPE', $class->table->getName()); |
||
612 | } |
||
613 | |||
614 | /** |
||
615 | * @group DDC-807 |
||
616 | * @group DDC-553 |
||
617 | */ |
||
618 | public function testDiscriminatorColumnDefinition() |
||
619 | { |
||
620 | $class = $this->createClassMetadata(DDC807Entity::class); |
||
621 | |||
622 | self::assertNotNull($class->discriminatorColumn); |
||
623 | |||
624 | $discrColumn = $class->discriminatorColumn; |
||
625 | |||
626 | self::assertEquals('dtype', $discrColumn->getColumnName()); |
||
627 | self::assertEquals("ENUM('ONE','TWO')", $discrColumn->getColumnDefinition()); |
||
628 | } |
||
629 | |||
630 | /** |
||
631 | * @group DDC-889 |
||
632 | */ |
||
633 | public function testInvalidEntityOrMappedSuperClassShouldMentionParentClasses() |
||
634 | { |
||
635 | $this->expectException(MappingException::class); |
||
636 | $this->expectExceptionMessage('Class "Doctrine\Tests\Models\DDC889\DDC889Class" sub class of "Doctrine\Tests\Models\DDC889\DDC889SuperClass" is not a valid entity or mapped super class.'); |
||
637 | |||
638 | $this->createClassMetadata(DDC889Class::class); |
||
639 | } |
||
640 | |||
641 | /** |
||
642 | * @group DDC-889 |
||
643 | */ |
||
644 | public function testIdentifierRequiredShouldMentionParentClasses() |
||
645 | { |
||
646 | $factory = $this->createClassMetadataFactory(); |
||
647 | |||
648 | $this->expectException(MappingException::class); |
||
649 | $this->expectExceptionMessage('No identifier/primary key specified for Entity "Doctrine\Tests\Models\DDC889\DDC889Entity" sub class of "Doctrine\Tests\Models\DDC889\DDC889SuperClass". Every Entity must have an identifier/primary key.'); |
||
650 | |||
651 | $factory->getMetadataFor(DDC889Entity::class); |
||
652 | } |
||
653 | |||
654 | public function testNamedQuery() |
||
655 | { |
||
656 | $driver = $this->loadDriver(); |
||
657 | $class = $this->createClassMetadata(User::class); |
||
658 | |||
659 | self::assertCount(1, $class->getNamedQueries(), sprintf("Named queries not processed correctly by driver %s", get_class($driver))); |
||
660 | } |
||
661 | |||
662 | /** |
||
663 | * @group DDC-1663 |
||
664 | */ |
||
665 | public function testNamedNativeQuery() |
||
666 | { |
||
667 | $class = $this->createClassMetadata(CmsAddress::class); |
||
668 | |||
669 | // named native query |
||
670 | self::assertCount(3, $class->namedNativeQueries); |
||
671 | self::assertArrayHasKey('find-all', $class->namedNativeQueries); |
||
672 | self::assertArrayHasKey('find-by-id', $class->namedNativeQueries); |
||
673 | |||
674 | $findAllQuery = $class->getNamedNativeQuery('find-all'); |
||
675 | |||
676 | self::assertEquals('mapping-find-all', $findAllQuery['resultSetMapping']); |
||
677 | self::assertEquals('SELECT id, country, city FROM cms_addresses', $findAllQuery['query']); |
||
678 | |||
679 | $findByIdQuery = $class->getNamedNativeQuery('find-by-id'); |
||
680 | |||
681 | self::assertEquals(CmsAddress::class,$findByIdQuery['resultClass']); |
||
682 | self::assertEquals('SELECT * FROM cms_addresses WHERE id = ?', $findByIdQuery['query']); |
||
683 | |||
684 | $countQuery = $class->getNamedNativeQuery('count'); |
||
685 | |||
686 | self::assertEquals('mapping-count', $countQuery['resultSetMapping']); |
||
687 | self::assertEquals('SELECT COUNT(*) AS count FROM cms_addresses', $countQuery['query']); |
||
688 | |||
689 | // result set mapping |
||
690 | self::assertCount(3, $class->sqlResultSetMappings); |
||
691 | self::assertArrayHasKey('mapping-count', $class->sqlResultSetMappings); |
||
692 | self::assertArrayHasKey('mapping-find-all', $class->sqlResultSetMappings); |
||
693 | self::assertArrayHasKey('mapping-without-fields', $class->sqlResultSetMappings); |
||
694 | |||
695 | $findAllMapping = $class->getSqlResultSetMapping('mapping-find-all'); |
||
696 | |||
697 | self::assertEquals(CmsAddress::class, $findAllMapping['entities'][0]['entityClass']); |
||
698 | self::assertEquals(['name'=>'id','column'=>'id'], $findAllMapping['entities'][0]['fields'][0]); |
||
699 | self::assertEquals(['name'=>'city','column'=>'city'], $findAllMapping['entities'][0]['fields'][1]); |
||
700 | self::assertEquals(['name'=>'country','column'=>'country'], $findAllMapping['entities'][0]['fields'][2]); |
||
701 | |||
702 | $withoutFieldsMapping = $class->getSqlResultSetMapping('mapping-without-fields'); |
||
703 | |||
704 | self::assertEquals('__CLASS__', $withoutFieldsMapping['entities'][0]['entityClass']); |
||
705 | self::assertEquals([], $withoutFieldsMapping['entities'][0]['fields']); |
||
706 | |||
707 | $countMapping = $class->getSqlResultSetMapping('mapping-count'); |
||
708 | |||
709 | self::assertEquals(['name'=>'count'], $countMapping['columns'][0]); |
||
710 | |||
711 | } |
||
712 | |||
713 | /** |
||
714 | * @group DDC-1663 |
||
715 | */ |
||
716 | public function testSqlResultSetMapping() |
||
717 | { |
||
718 | $userMetadata = $this->createClassMetadata(CmsUser::class); |
||
719 | $personMetadata = $this->createClassMetadata(CompanyPerson::class); |
||
720 | |||
721 | // user asserts |
||
722 | self::assertCount(4, $userMetadata->getSqlResultSetMappings()); |
||
723 | |||
724 | $mapping = $userMetadata->getSqlResultSetMapping('mappingJoinedAddress'); |
||
725 | |||
726 | self::assertEquals([],$mapping['columns']); |
||
727 | self::assertEquals('mappingJoinedAddress', $mapping['name']); |
||
728 | |||
729 | self::assertNull($mapping['entities'][0]['discriminatorColumn']); |
||
730 | |||
731 | self::assertEquals(['name'=>'id','column'=>'id'], $mapping['entities'][0]['fields'][0]); |
||
732 | self::assertEquals(['name'=>'name','column'=>'name'], $mapping['entities'][0]['fields'][1]); |
||
733 | self::assertEquals(['name'=>'status','column'=>'status'], $mapping['entities'][0]['fields'][2]); |
||
734 | self::assertEquals(['name'=>'address.zip','column'=>'zip'], $mapping['entities'][0]['fields'][3]); |
||
735 | self::assertEquals(['name'=>'address.city','column'=>'city'], $mapping['entities'][0]['fields'][4]); |
||
736 | self::assertEquals(['name'=>'address.country','column'=>'country'], $mapping['entities'][0]['fields'][5]); |
||
737 | self::assertEquals(['name'=>'address.id','column'=>'a_id'], $mapping['entities'][0]['fields'][6]); |
||
738 | self::assertEquals('__CLASS__', $mapping['entities'][0]['entityClass']); |
||
739 | |||
740 | $mapping = $userMetadata->getSqlResultSetMapping('mappingJoinedPhonenumber'); |
||
741 | |||
742 | self::assertEquals([],$mapping['columns']); |
||
743 | self::assertEquals('mappingJoinedPhonenumber', $mapping['name']); |
||
744 | |||
745 | self::assertNull($mapping['entities'][0]['discriminatorColumn']); |
||
746 | |||
747 | self::assertEquals(['name'=>'id','column'=>'id'], $mapping['entities'][0]['fields'][0]); |
||
748 | self::assertEquals(['name'=>'name','column'=>'name'], $mapping['entities'][0]['fields'][1]); |
||
749 | self::assertEquals(['name'=>'status','column'=>'status'], $mapping['entities'][0]['fields'][2]); |
||
750 | self::assertEquals(['name'=>'phonenumbers.phonenumber','column'=>'number'], $mapping['entities'][0]['fields'][3]); |
||
751 | self::assertEquals($userMetadata->getClassName(), $mapping['entities'][0]['entityClass']); |
||
752 | |||
753 | $mapping = $userMetadata->getSqlResultSetMapping('mappingUserPhonenumberCount'); |
||
754 | |||
755 | self::assertEquals(['name'=>'numphones'],$mapping['columns'][0]); |
||
756 | self::assertEquals('mappingUserPhonenumberCount', $mapping['name']); |
||
757 | |||
758 | self::assertNull($mapping['entities'][0]['discriminatorColumn']); |
||
759 | |||
760 | self::assertEquals(['name'=>'id','column'=>'id'], $mapping['entities'][0]['fields'][0]); |
||
761 | self::assertEquals(['name'=>'name','column'=>'name'], $mapping['entities'][0]['fields'][1]); |
||
762 | self::assertEquals(['name'=>'status','column'=>'status'], $mapping['entities'][0]['fields'][2]); |
||
763 | self::assertEquals($userMetadata->getClassName(), $mapping['entities'][0]['entityClass']); |
||
764 | |||
765 | $mapping = $userMetadata->getSqlResultSetMapping('mappingMultipleJoinsEntityResults'); |
||
766 | |||
767 | self::assertEquals(['name'=>'numphones'],$mapping['columns'][0]); |
||
768 | self::assertEquals('mappingMultipleJoinsEntityResults', $mapping['name']); |
||
769 | |||
770 | self::assertNull($mapping['entities'][0]['discriminatorColumn']); |
||
771 | |||
772 | self::assertEquals(['name'=>'id','column'=>'u_id'], $mapping['entities'][0]['fields'][0]); |
||
773 | self::assertEquals(['name'=>'name','column'=>'u_name'], $mapping['entities'][0]['fields'][1]); |
||
774 | self::assertEquals(['name'=>'status','column'=>'u_status'], $mapping['entities'][0]['fields'][2]); |
||
775 | self::assertEquals('__CLASS__', $mapping['entities'][0]['entityClass']); |
||
776 | |||
777 | self::assertNull($mapping['entities'][1]['discriminatorColumn']); |
||
778 | |||
779 | self::assertEquals(['name'=>'id','column'=>'a_id'], $mapping['entities'][1]['fields'][0]); |
||
780 | self::assertEquals(['name'=>'zip','column'=>'a_zip'], $mapping['entities'][1]['fields'][1]); |
||
781 | self::assertEquals(['name'=>'country','column'=>'a_country'], $mapping['entities'][1]['fields'][2]); |
||
782 | self::assertEquals(CmsAddress::class, $mapping['entities'][1]['entityClass']); |
||
783 | |||
784 | //person asserts |
||
785 | self::assertCount(1, $personMetadata->getSqlResultSetMappings()); |
||
786 | |||
787 | $mapping = $personMetadata->getSqlResultSetMapping('mappingFetchAll'); |
||
788 | |||
789 | self::assertEquals([], $mapping['columns']); |
||
790 | self::assertEquals('mappingFetchAll', $mapping['name']); |
||
791 | |||
792 | self::assertEquals('discriminator', $mapping['entities'][0]['discriminatorColumn']); |
||
793 | |||
794 | self::assertEquals(['name'=>'id','column'=>'id'], $mapping['entities'][0]['fields'][0]); |
||
795 | self::assertEquals(['name'=>'name','column'=>'name'], $mapping['entities'][0]['fields'][1]); |
||
796 | self::assertEquals('__CLASS__', $mapping['entities'][0]['entityClass']); |
||
797 | } |
||
798 | |||
799 | /* |
||
800 | * @group DDC-964 |
||
801 | */ |
||
802 | public function testAssociationOverridesMapping() |
||
871 | } |
||
872 | |||
873 | /* |
||
874 | * @group DDC-3579 |
||
875 | */ |
||
876 | View Code Duplication | public function testInversedByOverrideMapping() |
|
877 | { |
||
878 | $factory = $this->createClassMetadataFactory(); |
||
879 | $adminMetadata = $factory->getMetadataFor(DDC3579Admin::class); |
||
880 | |||
881 | // assert groups association mappings |
||
882 | self::assertArrayHasKey('groups', iterator_to_array($adminMetadata->getDeclaredPropertiesIterator())); |
||
883 | |||
884 | $adminGroups = $adminMetadata->getProperty('groups'); |
||
885 | |||
886 | // assert override |
||
887 | self::assertEquals('admins', $adminGroups->getInversedBy()); |
||
888 | } |
||
889 | |||
890 | /** |
||
891 | * @group DDC-5934 |
||
892 | */ |
||
893 | View Code Duplication | public function testFetchOverrideMapping() |
|
894 | { |
||
895 | // check override metadata |
||
896 | $contractMetadata = $this->createClassMetadataFactory()->getMetadataFor(DDC5934Contract::class); |
||
897 | |||
898 | self::assertArrayHasKey('members', iterator_to_array($contractMetadata->getDeclaredPropertiesIterator())); |
||
899 | |||
900 | $contractMembers = $contractMetadata->getProperty('members'); |
||
901 | |||
902 | self::assertSame(Mapping\FetchMode::EXTRA_LAZY, $contractMembers->getFetchMode()); |
||
903 | } |
||
904 | |||
905 | /** |
||
906 | * @group DDC-964 |
||
907 | */ |
||
908 | public function testAttributeOverridesMapping() |
||
909 | { |
||
910 | $factory = $this->createClassMetadataFactory(); |
||
911 | $adminMetadata = $factory->getMetadataFor(DDC964Admin::class); |
||
912 | |||
913 | self::assertEquals( |
||
914 | [ |
||
915 | 'user_id' => 'id', |
||
916 | 'user_name' => 'name', |
||
917 | 'adminaddress_id' => 'address', |
||
918 | ], |
||
919 | $adminMetadata->fieldNames |
||
920 | ); |
||
921 | |||
922 | self::assertNotNull($adminMetadata->getProperty('id')); |
||
923 | |||
924 | $idProperty = $adminMetadata->getProperty('id'); |
||
925 | |||
926 | self::assertTrue($idProperty->isPrimaryKey()); |
||
927 | self::assertEquals('id', $idProperty->getName()); |
||
928 | self::assertEquals('user_id', $idProperty->getColumnName()); |
||
929 | |||
930 | self::assertNotNull($adminMetadata->getProperty('name')); |
||
931 | |||
932 | $nameProperty = $adminMetadata->getProperty('name'); |
||
933 | |||
934 | self::assertEquals('name', $nameProperty->getName()); |
||
935 | self::assertEquals('user_name', $nameProperty->getColumnName()); |
||
936 | self::assertEquals(250, $nameProperty->getLength()); |
||
937 | self::assertTrue($nameProperty->isNullable()); |
||
938 | self::assertFalse($nameProperty->isUnique()); |
||
939 | |||
940 | $guestMetadata = $factory->getMetadataFor(DDC964Guest::class); |
||
941 | |||
942 | self::assertEquals( |
||
943 | [ |
||
944 | 'guest_id' => 'id', |
||
945 | 'guest_name' => 'name', |
||
946 | 'address_id' => 'address', |
||
947 | ], |
||
948 | $guestMetadata->fieldNames |
||
949 | ); |
||
950 | |||
951 | self::assertNotNull($guestMetadata->getProperty('id')); |
||
952 | |||
953 | $idProperty = $guestMetadata->getProperty('id'); |
||
954 | |||
955 | self::assertTrue($idProperty->isPrimaryKey()); |
||
956 | self::assertEquals('id', $idProperty->getName()); |
||
957 | self::assertEquals('guest_id', $idProperty->getColumnName()); |
||
958 | |||
959 | self::assertNotNull($guestMetadata->getProperty('name')); |
||
960 | |||
961 | $nameProperty = $guestMetadata->getProperty('name'); |
||
962 | |||
963 | self::assertEquals('name', $nameProperty->getName()); |
||
964 | self::assertEquals('guest_name', $nameProperty->getColumnName()); |
||
965 | self::assertEquals(240, $nameProperty->getLength()); |
||
966 | self::assertFalse($nameProperty->isNullable()); |
||
967 | self::assertTrue($nameProperty->isUnique()); |
||
968 | } |
||
969 | |||
970 | /** |
||
971 | * @group DDC-1955 |
||
972 | */ |
||
973 | public function testEntityListeners() |
||
974 | { |
||
975 | $factory = $this->createClassMetadataFactory(); |
||
976 | $superClass = $factory->getMetadataFor(CompanyContract::class); |
||
977 | $flexClass = $factory->getMetadataFor(CompanyFixContract::class); |
||
978 | $fixClass = $factory->getMetadataFor(CompanyFlexContract::class); |
||
979 | |||
980 | self::assertArrayHasKey(Events::prePersist, $superClass->entityListeners); |
||
981 | self::assertArrayHasKey(Events::postPersist, $superClass->entityListeners); |
||
982 | |||
983 | self::assertCount(1, $superClass->entityListeners[Events::prePersist]); |
||
984 | self::assertCount(1, $superClass->entityListeners[Events::postPersist]); |
||
985 | |||
986 | $postPersist = $superClass->entityListeners[Events::postPersist][0]; |
||
987 | $prePersist = $superClass->entityListeners[Events::prePersist][0]; |
||
988 | |||
989 | self::assertEquals(CompanyContractListener::class, $postPersist['class']); |
||
990 | self::assertEquals(CompanyContractListener::class, $prePersist['class']); |
||
991 | self::assertEquals('postPersistHandler', $postPersist['method']); |
||
992 | self::assertEquals('prePersistHandler', $prePersist['method']); |
||
993 | |||
994 | //Inherited listeners |
||
995 | self::assertEquals($fixClass->entityListeners, $superClass->entityListeners); |
||
996 | self::assertEquals($flexClass->entityListeners, $superClass->entityListeners); |
||
997 | } |
||
998 | |||
999 | /** |
||
1000 | * @group DDC-1955 |
||
1001 | */ |
||
1002 | public function testEntityListenersOverride() |
||
1003 | { |
||
1004 | $factory = $this->createClassMetadataFactory(); |
||
1005 | $ultraClass = $factory->getMetadataFor(CompanyFlexUltraContract::class); |
||
1006 | |||
1007 | //overridden listeners |
||
1008 | self::assertArrayHasKey(Events::postPersist, $ultraClass->entityListeners); |
||
1009 | self::assertArrayHasKey(Events::prePersist, $ultraClass->entityListeners); |
||
1010 | |||
1011 | self::assertCount(1, $ultraClass->entityListeners[Events::postPersist]); |
||
1012 | self::assertCount(3, $ultraClass->entityListeners[Events::prePersist]); |
||
1013 | |||
1014 | $postPersist = $ultraClass->entityListeners[Events::postPersist][0]; |
||
1015 | $prePersist = $ultraClass->entityListeners[Events::prePersist][0]; |
||
1016 | |||
1017 | self::assertEquals(CompanyContractListener::class, $postPersist['class']); |
||
1018 | self::assertEquals(CompanyContractListener::class, $prePersist['class']); |
||
1019 | self::assertEquals('postPersistHandler', $postPersist['method']); |
||
1020 | self::assertEquals('prePersistHandler', $prePersist['method']); |
||
1021 | |||
1022 | $prePersist = $ultraClass->entityListeners[Events::prePersist][1]; |
||
1023 | self::assertEquals(CompanyFlexUltraContractListener::class, $prePersist['class']); |
||
1024 | self::assertEquals('prePersistHandler1', $prePersist['method']); |
||
1025 | |||
1026 | $prePersist = $ultraClass->entityListeners[Events::prePersist][2]; |
||
1027 | self::assertEquals(CompanyFlexUltraContractListener::class, $prePersist['class']); |
||
1028 | self::assertEquals('prePersistHandler2', $prePersist['method']); |
||
1029 | } |
||
1030 | |||
1031 | |||
1032 | /** |
||
1033 | * @group DDC-1955 |
||
1034 | */ |
||
1035 | public function testEntityListenersNamingConvention() |
||
1084 | } |
||
1085 | |||
1086 | /** |
||
1087 | * @group DDC-2183 |
||
1088 | */ |
||
1089 | public function testSecondLevelCacheMapping() |
||
1090 | { |
||
1091 | $factory = $this->createClassMetadataFactory(); |
||
1092 | $class = $factory->getMetadataFor(City::class); |
||
1093 | |||
1094 | self::assertNotNull($class->getCache()); |
||
1095 | self::assertEquals(Mapping\CacheUsage::READ_ONLY, $class->getCache()->getUsage()); |
||
1096 | self::assertEquals('doctrine_tests_models_cache_city', $class->getCache()->getRegion()); |
||
1097 | |||
1098 | self::assertArrayHasKey('state', iterator_to_array($class->getDeclaredPropertiesIterator())); |
||
1099 | |||
1100 | $stateAssociation = $class->getProperty('state'); |
||
1101 | |||
1102 | self::assertNotNull($stateAssociation->getCache()); |
||
1103 | self::assertEquals(Mapping\CacheUsage::READ_ONLY, $stateAssociation->getCache()->getUsage()); |
||
1104 | self::assertEquals('doctrine_tests_models_cache_city__state', $stateAssociation->getCache()->getRegion()); |
||
1105 | |||
1106 | self::assertArrayHasKey('attractions', iterator_to_array($class->getDeclaredPropertiesIterator())); |
||
1107 | |||
1108 | $attractionsAssociation = $class->getProperty('attractions'); |
||
1109 | |||
1110 | self::assertNotNull($attractionsAssociation->getCache()); |
||
1111 | self::assertEquals(Mapping\CacheUsage::READ_ONLY, $attractionsAssociation->getCache()->getUsage()); |
||
1112 | self::assertEquals('doctrine_tests_models_cache_city__attractions', $attractionsAssociation->getCache()->getRegion()); |
||
1113 | } |
||
1114 | |||
1115 | /** |
||
1116 | * @group DDC-2825 |
||
1117 | * @group 881 |
||
1118 | */ |
||
1119 | View Code Duplication | public function testSchemaDefinitionViaExplicitTableSchemaAnnotationProperty() |
|
1120 | { |
||
1121 | $factory = $this->createClassMetadataFactory(); |
||
1122 | $metadata = $factory->getMetadataFor(ExplicitSchemaAndTable::class); |
||
1123 | |||
1124 | self::assertSame('explicit_schema', $metadata->getSchemaName()); |
||
1125 | self::assertSame('explicit_table', $metadata->getTableName()); |
||
1126 | } |
||
1127 | |||
1128 | /** |
||
1129 | * @group DDC-2825 |
||
1130 | * @group 881 |
||
1131 | */ |
||
1132 | View Code Duplication | public function testSchemaDefinitionViaSchemaDefinedInTableNameInTableAnnotationProperty() |
|
1139 | } |
||
1140 | |||
1141 | /** |
||
1142 | * @group DDC-514 |
||
1143 | * @group DDC-1015 |
||
1144 | */ |
||
1145 | View Code Duplication | public function testDiscriminatorColumnDefaultLength() |
|
1146 | { |
||
1147 | if (strpos(get_class($this), 'PHPMappingDriver') !== false) { |
||
1148 | $this->markTestSkipped('PHP Mapping Drivers have no defaults.'); |
||
1149 | } |
||
1150 | |||
1151 | $class = $this->createClassMetadata(SingleTableEntityNoDiscriminatorColumnMapping::class); |
||
1152 | |||
1153 | self::assertEquals(255, $class->discriminatorColumn->getLength()); |
||
1154 | |||
1155 | $class = $this->createClassMetadata(SingleTableEntityIncompleteDiscriminatorColumnMapping::class); |
||
1156 | |||
1157 | self::assertEquals(255, $class->discriminatorColumn->getLength()); |
||
1158 | } |
||
1159 | |||
1160 | /** |
||
1161 | * @group DDC-514 |
||
1162 | * @group DDC-1015 |
||
1163 | */ |
||
1164 | View Code Duplication | public function testDiscriminatorColumnDefaultType() |
|
1177 | } |
||
1178 | |||
1179 | /** |
||
1180 | * @group DDC-514 |
||
1181 | * @group DDC-1015 |
||
1182 | */ |
||
1183 | View Code Duplication | public function testDiscriminatorColumnDefaultName() |
|
1184 | { |
||
1185 | if (strpos(get_class($this), 'PHPMappingDriver') !== false) { |
||
1186 | $this->markTestSkipped('PHP Mapping Drivers have no defaults.'); |
||
1187 | } |
||
1188 | |||
1196 | } |
||
1197 | } |
||
1198 | |||
1199 | /** |
||
1591 |
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.