Use intersection types in tests

derrabus · derrabus · commit 06d87a5957c2 · 2022-08-04T01:20:06.000+02:00
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -132,6 +132,11 @@
         <exclude-pattern>tests/Doctrine/Tests/Models/DDC1872/DDC1872ExampleTrait.php</exclude-pattern>
     </rule>
 
+    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses.UnusedUse">
+        <!-- The Sniff does not understand native intersection types -->
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+
     <rule name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingAnyTypeHint">
         <exclude-pattern>*/tests/*</exclude-pattern>
     </rule>
diff --git a/tests/Doctrine/Tests/ORM/Cache/CacheLoggerChainTest.php b/tests/Doctrine/Tests/ORM/Cache/CacheLoggerChainTest.php
@@ -19,9 +19,7 @@
 class CacheLoggerChainTest extends DoctrineTestCase
 {
     private CacheLoggerChain $logger;
-
-    /** @var CacheLogger&MockObject */
-    private CacheLogger $mock;
+    private CacheLogger&MockObject $mock;
 
     protected function setUp(): void
     {
diff --git a/tests/Doctrine/Tests/ORM/Cache/DefaultCacheFactoryTest.php b/tests/Doctrine/Tests/ORM/Cache/DefaultCacheFactoryTest.php
@@ -36,9 +36,7 @@
  */
 class DefaultCacheFactoryTest extends OrmTestCase
 {
-    /** @var CacheFactory&MockObject */
-    private CacheFactory $factory;
-
+    private CacheFactory&MockObject $factory;
     private EntityManagerMock $em;
     private RegionsConfiguration $regionsConfig;
 
diff --git a/tests/Doctrine/Tests/ORM/Cache/Persister/Collection/CollectionPersisterTestCase.php b/tests/Doctrine/Tests/ORM/Cache/Persister/Collection/CollectionPersisterTestCase.php
@@ -22,12 +22,8 @@
  */
 abstract class CollectionPersisterTestCase extends OrmTestCase
 {
-    /** @var Region&MockObject */
-    protected Region $region;
-
-    /** @var CollectionPersister&MockObject */
-    protected CollectionPersister $collectionPersister;
-
+    protected Region&MockObject $region;
+    protected CollectionPersister&MockObject $collectionPersister;
     protected EntityManagerMock $em;
 
     abstract protected function createPersister(EntityManagerInterface $em, CollectionPersister $persister, Region $region, array $mapping): AbstractCollectionPersister;
@@ -43,10 +39,7 @@ protected function setUp(): void
         $this->collectionPersister = $this->createMock(CollectionPersister::class);
     }
 
-    /**
-     * @return Region&MockObject
-     */
-    protected function createRegion(): Region
+    protected function createRegion(): Region&MockObject
     {
         return $this->createMock(Region::class);
     }
diff --git a/tests/Doctrine/Tests/ORM/Cache/Persister/Collection/ReadWriteCachedCollectionPersisterTest.php b/tests/Doctrine/Tests/ORM/Cache/Persister/Collection/ReadWriteCachedCollectionPersisterTest.php
@@ -26,10 +26,7 @@ protected function createPersister(EntityManagerInterface $em, CollectionPersist
         return new ReadWriteCachedCollectionPersister($persister, $region, $em, $mapping);
     }
 
-    /**
-     * @return ConcurrentRegion&MockObject
-     */
-    protected function createRegion(): ConcurrentRegion
+    protected function createRegion(): ConcurrentRegion&MockObject
     {
         return $this->createMock(ConcurrentRegion::class);
     }
diff --git a/tests/Doctrine/Tests/ORM/Cache/Persister/Entity/EntityPersisterTestCase.php b/tests/Doctrine/Tests/ORM/Cache/Persister/Entity/EntityPersisterTestCase.php
@@ -25,12 +25,8 @@
  */
 abstract class EntityPersisterTestCase extends OrmTestCase
 {
-    /** @var Region&MockObject */
-    protected Region $region;
-
-    /** @var EntityPersister&MockObject */
-    protected EntityPersister $entityPersister;
-
+    protected Region&MockObject $region;
+    protected EntityPersister&MockObject $entityPersister;
     protected EntityManagerMock $em;
 
     abstract protected function createPersister(EntityManagerInterface $em, EntityPersister $persister, Region $region, ClassMetadata $metadata): AbstractEntityPersister;
@@ -46,10 +42,7 @@ protected function setUp(): void
         $this->entityPersister = $this->createMock(EntityPersister::class);
     }
 
-    /**
-     * @return Region&MockObject
-     */
-    protected function createRegion(): Region
+    protected function createRegion(): Region&MockObject
     {
         return $this->createMock(Region::class);
     }
diff --git a/tests/Doctrine/Tests/ORM/Cache/Persister/Entity/ReadWriteCachedEntityPersisterTest.php b/tests/Doctrine/Tests/ORM/Cache/Persister/Entity/ReadWriteCachedEntityPersisterTest.php
@@ -14,6 +14,7 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Persisters\Entity\EntityPersister;
 use Doctrine\Tests\Models\Cache\Country;
+use PHPUnit\Framework\MockObject\MockObject;
 use ReflectionProperty;
 
 /**
@@ -26,7 +27,7 @@ protected function createPersister(EntityManagerInterface $em, EntityPersister $
         return new ReadWriteCachedEntityPersister($persister, $region, $em, $metadata);
     }
 
-    protected function createRegion(): Region
+    protected function createRegion(): ConcurrentRegion&MockObject
     {
         return $this->createMock(ConcurrentRegion::class);
     }
diff --git a/tests/Doctrine/Tests/ORM/Functional/SQLFilterTest.php b/tests/Doctrine/Tests/ORM/Functional/SQLFilterTest.php
@@ -204,10 +204,7 @@ private function configureFilters(EntityManagerInterface $em): void
         $config->addFilter('soft_delete', '\Doctrine\Tests\ORM\Functional\MySoftDeleteFilter');
     }
 
-    /**
-     * @return Connection&MockObject
-     */
-    private function getMockConnection(): Connection
+    private function getMockConnection(): Connection&MockObject
     {
         $connection = $this->createMock(Connection::class);
         $connection->method('getEventManager')
@@ -216,20 +213,12 @@ private function getMockConnection(): Connection
         return $connection;
     }
 
-    /**
-     * @return EntityManagerInterface&MockObject
-     */
-    private function getMockEntityManager(): EntityManagerInterface
+    private function getMockEntityManager(): EntityManagerInterface&MockObject
     {
         return $this->createMock(EntityManagerInterface::class);
     }
 
-    /**
-     * @psalm-param EntityManagerInterface&MockObject $em
-     *
-     * @return FilterCollection&MockObject
-     */
-    private function addMockFilterCollection(EntityManagerInterface $em): FilterCollection
+    private function addMockFilterCollection(EntityManagerInterface&MockObject $em): FilterCollection&MockObject
     {
         $filterCollection = $this->createMock(FilterCollection::class);
 
diff --git a/tests/Doctrine/Tests/ORM/Hydration/AbstractHydratorTest.php b/tests/Doctrine/Tests/ORM/Hydration/AbstractHydratorTest.php
@@ -23,17 +23,10 @@
  */
 class AbstractHydratorTest extends OrmFunctionalTestCase
 {
-    /** @var EventManager&MockObject */
-    private EventManager $mockEventManager;
-
-    /** @var Result&MockObject */
-    private Result $mockResult;
-
-    /** @var ResultSetMapping&MockObject */
-    private ResultSetMapping $mockResultMapping;
-
-    /** @var AbstractHydrator&MockObject */
-    private AbstractHydrator $hydrator;
+    private EventManager&MockObject $mockEventManager;
+    private Result&MockObject $mockResult;
+    private ResultSetMapping&MockObject $mockResultMapping;
+    private AbstractHydrator&MockObject $hydrator;
 
     protected function setUp(): void
     {
diff --git a/tests/Doctrine/Tests/ORM/Internal/HydrationCompleteHandlerTest.php b/tests/Doctrine/Tests/ORM/Internal/HydrationCompleteHandlerTest.php
@@ -24,12 +24,8 @@
  */
 class HydrationCompleteHandlerTest extends TestCase
 {
-    /** @var ListenersInvoker&MockObject */
-    private $listenersInvoker;
-
-    /** @var EntityManagerInterface&MockObject */
-    private $entityManager;
-
+    private ListenersInvoker&MockObject $listenersInvoker;
+    private EntityManagerInterface&MockObject $entityManager;
     private HydrationCompleteHandler $handler;
 
     protected function setUp(): void
diff --git a/tests/Doctrine/Tests/ORM/LazyCriteriaCollectionTest.php b/tests/Doctrine/Tests/ORM/LazyCriteriaCollectionTest.php
@@ -17,11 +17,8 @@
  */
 class LazyCriteriaCollectionTest extends TestCase
 {
-    /** @var EntityPersister&MockObject */
-    private $persister;
-
+    private EntityPersister&MockObject $persister;
     private Criteria $criteria;
-
     private LazyCriteriaCollection $lazyCriteriaCollection;
 
     protected function setUp(): void
diff --git a/tests/Doctrine/Tests/ORM/Repository/DefaultRepositoryFactoryTest.php b/tests/Doctrine/Tests/ORM/Repository/DefaultRepositoryFactoryTest.php
@@ -22,12 +22,8 @@
  */
 class DefaultRepositoryFactoryTest extends TestCase
 {
-    /** @var EntityManagerInterface&MockObject */
-    private EntityManagerInterface $entityManager;
-
-    /** @var Configuration&MockObject */
-    private Configuration $configuration;
-
+    private EntityManagerInterface&MockObject $entityManager;
+    private Configuration&MockObject $configuration;
     private DefaultRepositoryFactory $repositoryFactory;
 
     protected function setUp(): void
@@ -109,12 +105,11 @@ public function testCachesDistinctRepositoriesPerDistinctEntityManager(): void
     /**
      * @psalm-param class-string<TEntity> $className
      *
-     * @return ClassMetadata&MockObject
      * @psalm-return ClassMetadata<TEntity>&MockObject
      *
      * @template TEntity of object
      */
-    private function buildClassMetadata(string $className): ClassMetadata
+    private function buildClassMetadata(string $className): ClassMetadata&MockObject
     {
         $metadata = $this->createMock(ClassMetadata::class);
         $metadata->method('getName')->will(self::returnValue($className));
@@ -125,10 +120,7 @@ private function buildClassMetadata(string $className): ClassMetadata
         return $metadata;
     }
 
-    /**
-     * @return EntityManagerInterface&MockObject
-     */
-    private function createEntityManager(): EntityManagerInterface
+    private function createEntityManager(): EntityManagerInterface&MockObject
     {
         $entityManager = $this->createMock(EntityManagerInterface::class);
         $entityManager->method('getConfiguration')->willReturn($this->configuration);
diff --git a/tests/Doctrine/Tests/ORM/Tools/Pagination/PaginatorTest.php b/tests/Doctrine/Tests/ORM/Tools/Pagination/PaginatorTest.php
@@ -18,12 +18,9 @@
 
 class PaginatorTest extends OrmTestCase
 {
-    /** @var Connection&MockObject */
-    private $connection;
-    /** @var EntityManagerInterface&MockObject */
-    private $em;
-    /** @var AbstractHydrator&MockObject */
-    private $hydrator;
+    private Connection&MockObject $connection;
+    private EntityManagerInterface&MockObject $em;
+    private AbstractHydrator&MockObject $hydrator;
 
     protected function setUp(): void
     {
diff --git a/tests/Doctrine/Tests/ORM/UnitOfWorkTest.php b/tests/Doctrine/Tests/ORM/UnitOfWorkTest.php
@@ -52,18 +52,15 @@ class UnitOfWorkTest extends OrmTestCase
 
     /**
      * Provides a sequence mock to the UnitOfWork
-     *
-     * @var Connection&MockObject
      */
-    private $connection;
+    private Connection $connection;
 
     /**
      * The EntityManager mock that provides the mock persisters
      */
     private EntityManagerMock $_emMock;
 
-    /** @var EventManager&MockObject */
-    private $eventManager;
+    private EventManager&MockObject $eventManager;
 
     protected function setUp(): void
     {

Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,7 @@`
`19`	`19`	`class CacheLoggerChainTest extends DoctrineTestCase`
`20`	`20`	`{`
`21`	`21`	`private CacheLoggerChain $logger;`
`22`		`-`
`23`		`- /** @var CacheLogger&MockObject */`
`24`		`- private CacheLogger $mock;`
	`22`	`+ private CacheLogger&MockObject $mock;`
`25`	`23`
`26`	`24`	`protected function setUp(): void`
`27`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,12 +22,8 @@`
`22`	`22`	`*/`
`23`	`23`	`abstract class CollectionPersisterTestCase extends OrmTestCase`
`24`	`24`	`{`
`25`		`- /** @var Region&MockObject */`
`26`		`- protected Region $region;`
`27`		`-`
`28`		`- /** @var CollectionPersister&MockObject */`
`29`		`- protected CollectionPersister $collectionPersister;`
`30`		`-`
	`25`	`+ protected Region&MockObject $region;`
	`26`	`+ protected CollectionPersister&MockObject $collectionPersister;`
`31`	`27`	`protected EntityManagerMock $em;`
`32`	`28`
`33`	`29`	`abstract protected function createPersister(EntityManagerInterface $em, CollectionPersister $persister, Region $region, array $mapping): AbstractCollectionPersister;`
`@@ -43,10 +39,7 @@ protected function setUp(): void`
`43`	`39`	`$this->collectionPersister = $this->createMock(CollectionPersister::class);`
`44`	`40`	`}`
`45`	`41`
`46`		`- /**`
`47`		`- * @return Region&MockObject`
`48`		`- */`
`49`		`- protected function createRegion(): Region`
	`42`	`+ protected function createRegion(): Region&MockObject`
`50`	`43`	`{`
`51`	`44`	`return $this->createMock(Region::class);`
`52`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,10 +26,7 @@ protected function createPersister(EntityManagerInterface $em, CollectionPersist`
`26`	`26`	`return new ReadWriteCachedCollectionPersister($persister, $region, $em, $mapping);`
`27`	`27`	`}`
`28`	`28`
`29`		`- /**`
`30`		`- * @return ConcurrentRegion&MockObject`
`31`		`- */`
`32`		`- protected function createRegion(): ConcurrentRegion`
	`29`	`+ protected function createRegion(): ConcurrentRegion&MockObject`
`33`	`30`	`{`
`34`	`31`	`return $this->createMock(ConcurrentRegion::class);`
`35`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,12 +25,8 @@`
`25`	`25`	`*/`
`26`	`26`	`abstract class EntityPersisterTestCase extends OrmTestCase`
`27`	`27`	`{`
`28`		`- /** @var Region&MockObject */`
`29`		`- protected Region $region;`
`30`		`-`
`31`		`- /** @var EntityPersister&MockObject */`
`32`		`- protected EntityPersister $entityPersister;`
`33`		`-`
	`28`	`+ protected Region&MockObject $region;`
	`29`	`+ protected EntityPersister&MockObject $entityPersister;`
`34`	`30`	`protected EntityManagerMock $em;`
`35`	`31`
`36`	`32`	`abstract protected function createPersister(EntityManagerInterface $em, EntityPersister $persister, Region $region, ClassMetadata $metadata): AbstractEntityPersister;`
`@@ -46,10 +42,7 @@ protected function setUp(): void`
`46`	`42`	`$this->entityPersister = $this->createMock(EntityPersister::class);`
`47`	`43`	`}`
`48`	`44`
`49`		`- /**`
`50`		`- * @return Region&MockObject`
`51`		`- */`
`52`		`- protected function createRegion(): Region`
	`45`	`+ protected function createRegion(): Region&MockObject`
`53`	`46`	`{`
`54`	`47`	`return $this->createMock(Region::class);`
`55`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`use Doctrine\ORM\Mapping\ClassMetadata;`
`15`	`15`	`use Doctrine\ORM\Persisters\Entity\EntityPersister;`
`16`	`16`	`use Doctrine\Tests\Models\Cache\Country;`
	`17`	`+use PHPUnit\Framework\MockObject\MockObject;`
`17`	`18`	`use ReflectionProperty;`
`18`	`19`
`19`	`20`	`/**`
`@@ -26,7 +27,7 @@ protected function createPersister(EntityManagerInterface $em, EntityPersister $`
`26`	`27`	`return new ReadWriteCachedEntityPersister($persister, $region, $em, $metadata);`
`27`	`28`	`}`
`28`	`29`
`29`		`- protected function createRegion(): Region`
	`30`	`+ protected function createRegion(): ConcurrentRegion&MockObject`
`30`	`31`	`{`
`31`	`32`	`return $this->createMock(ConcurrentRegion::class);`
`32`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -204,10 +204,7 @@ private function configureFilters(EntityManagerInterface $em): void`
`204`	`204`	`$config->addFilter('soft_delete', '\Doctrine\Tests\ORM\Functional\MySoftDeleteFilter');`
`205`	`205`	`}`
`206`	`206`
`207`		`- /**`
`208`		`- * @return Connection&MockObject`
`209`		`- */`
`210`		`- private function getMockConnection(): Connection`
	`207`	`+ private function getMockConnection(): Connection&MockObject`
`211`	`208`	`{`
`212`	`209`	`$connection = $this->createMock(Connection::class);`
`213`	`210`	`$connection->method('getEventManager')`
`@@ -216,20 +213,12 @@ private function getMockConnection(): Connection`
`216`	`213`	`return $connection;`
`217`	`214`	`}`
`218`	`215`
`219`		`- /**`
`220`		`- * @return EntityManagerInterface&MockObject`
`221`		`- */`
`222`		`- private function getMockEntityManager(): EntityManagerInterface`
	`216`	`+ private function getMockEntityManager(): EntityManagerInterface&MockObject`
`223`	`217`	`{`
`224`	`218`	`return $this->createMock(EntityManagerInterface::class);`
`225`	`219`	`}`
`226`	`220`
`227`		`- /**`
`228`		`- * @psalm-param EntityManagerInterface&MockObject $em`
`229`		`- *`
`230`		`- * @return FilterCollection&MockObject`
`231`		`- */`
`232`		`- private function addMockFilterCollection(EntityManagerInterface $em): FilterCollection`
	`221`	`+ private function addMockFilterCollection(EntityManagerInterface&MockObject $em): FilterCollection&MockObject`
`233`	`222`	`{`
`234`	`223`	`$filterCollection = $this->createMock(FilterCollection::class);`
`235`	`224`