Deprecated DoctrineBridge internal test helpers for outside use

wouterj · wouterj · commit f0e48a0a0e4a · 2021-01-03T13:46:28.000+01:00
diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.3.0
+-----
+
+ * deprecated `DoctrineTestHelper` and `TestRepositoryFactory`
+
 5.2.0
 -----
 
diff --git a/src/Symfony/Bridge/Doctrine/Test/DoctrineTestHelper.php b/src/Symfony/Bridge/Doctrine/Test/DoctrineTestHelper.php
@@ -25,6 +25,8 @@
  * Provides utility functions needed in tests.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated in 5.3, will be removed in 6.0.
  */
 class DoctrineTestHelper
 {
@@ -33,14 +35,18 @@ class DoctrineTestHelper
      *
      * @return EntityManager
      */
-    public static function createTestEntityManager(Configuration $config = null)
+    public static function createTestEntityManager(Configuration $config = null/*, bool $deprecate = true*/)
     {
         if (!\extension_loaded('pdo_sqlite')) {
             TestCase::markTestSkipped('Extension pdo_sqlite is required.');
         }
 
+        if (func_num_args() <= 1 || func_get_arg(1)) {
+            trigger_deprecation('symfony/doctrine-bridge', '5.3', '"%s" is deprecated and will be removed in 6.0.', __CLASS__);
+        }
+
         if (null === $config) {
-            $config = self::createTestConfiguration();
+            $config = self::createTestConfiguration(false);
         }
 
         $params = [
@@ -54,8 +60,12 @@ public static function createTestEntityManager(Configuration $config = null)
     /**
      * @return Configuration
      */
-    public static function createTestConfiguration()
+    public static function createTestConfiguration(/*bool $deprecate = true*/)
     {
+        if (func_num_args() === 0 || func_get_arg(0)) {
+            trigger_deprecation('symfony/doctrine-bridge', '5.3', '"%s" is deprecated and will be removed in 6.0.', __CLASS__);
+        }
+
         $config = new Configuration();
         $config->setEntityNamespaces(['SymfonyTestsDoctrine' => 'Symfony\Bridge\Doctrine\Tests\Fixtures']);
         $config->setAutoGenerateProxyClasses(true);
@@ -71,9 +81,13 @@ public static function createTestConfiguration()
     /**
      * @return Configuration
      */
-    public static function createTestConfigurationWithXmlLoader()
+    public static function createTestConfigurationWithXmlLoader(/*bool $deprecate = true*/)
     {
-        $config = static::createTestConfiguration();
+        if (func_num_args() === 0 || func_get_arg(0)) {
+            trigger_deprecation('symfony/doctrine-bridge', '5.3', '"%s" is deprecated and will be removed in 6.0.', __CLASS__);
+        }
+
+        $config = static::createTestConfiguration(false);
 
         $driverChain = new MappingDriverChain();
         $driverChain->addDriver(
diff --git a/src/Symfony/Bridge/Doctrine/Test/TestRepositoryFactory.php b/src/Symfony/Bridge/Doctrine/Test/TestRepositoryFactory.php
@@ -18,8 +18,10 @@
 
 /**
  * @author Andreas Braun <alcaeus@alcaeus.org>
+ *
+ * @deprecated in 5.3, will be removed in 6.0.
  */
-final class TestRepositoryFactory implements RepositoryFactory
+class TestRepositoryFactory implements RepositoryFactory
 {
     /**
      * @var ObjectRepository[]
@@ -31,8 +33,12 @@ final class TestRepositoryFactory implements RepositoryFactory
      *
      * @return ObjectRepository
      */
-    public function getRepository(EntityManagerInterface $entityManager, $entityName)
+    public function getRepository(EntityManagerInterface $entityManager, $entityName, bool $deprecate = true)
     {
+        if ($deprecate) {
+            trigger_deprecation('symfony/doctrine-bridge', '5.3', '"%s" is deprecated and will be removed in 6.0.', __CLASS__);
+        }
+
         $repositoryHash = $this->getRepositoryHash($entityManager, $entityName);
 
         if (isset($this->repositoryList[$repositoryHash])) {
@@ -42,8 +48,12 @@ public function getRepository(EntityManagerInterface $entityManager, $entityName
         return $this->repositoryList[$repositoryHash] = $this->createRepository($entityManager, $entityName);
     }
 
-    public function setRepository(EntityManagerInterface $entityManager, string $entityName, ObjectRepository $repository)
+    public function setRepository(EntityManagerInterface $entityManager, string $entityName, ObjectRepository $repository, bool $deprecate = true)
     {
+        if ($deprecate) {
+            trigger_deprecation('symfony/doctrine-bridge', '5.3', '"%s" is deprecated and will be removed in 6.0.', __CLASS__);
+        }
+
         $repositoryHash = $this->getRepositoryHash($entityManager, $entityName);
 
         $this->repositoryList[$repositoryHash] = $repository;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/DoctrineTestHelper.php b/src/Symfony/Bridge/Doctrine/Tests/DoctrineTestHelper.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Tests;
+
+use Doctrine\ORM\Configuration;
+use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper as TestDoctrineTestHelper;
+
+/**
+ * Provides utility functions needed in tests.
+ *
+ * @author Bernhard Schussek <bschussek@gmail.com>
+ */
+class DoctrineTestHelper extends TestDoctrineTestHelper
+{
+    public static function createTestEntityManager(Configuration $config = null)
+    {
+        return parent::createTestEntityManager($config, false);
+    }
+
+    public static function createTestConfiguration()
+    {
+        return parent::createTestConfiguration(false);
+    }
+
+    public static function createTestConfigurationWithXmlLoader()
+    {
+        return parent::createTestConfigurationWithXmlLoader(false);
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Form/ChoiceList/ORMQueryBuilderLoaderTest.php b/src/Symfony/Bridge/Doctrine/Tests/Form/ChoiceList/ORMQueryBuilderLoaderTest.php
@@ -17,7 +17,7 @@
 use Doctrine\ORM\Version;
 use PHPUnit\Framework\TestCase;
 use Symfony\Bridge\Doctrine\Form\ChoiceList\ORMQueryBuilderLoader;
-use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
+use Symfony\Bridge\Doctrine\Tests\DoctrineTestHelper;
 use Symfony\Bridge\Doctrine\Types\UlidType;
 use Symfony\Bridge\Doctrine\Types\UuidType;
 use Symfony\Component\Form\Exception\TransformationFailedException;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Form/Type/EntityTypePerformanceTest.php b/src/Symfony/Bridge/Doctrine/Tests/Form/Type/EntityTypePerformanceTest.php
@@ -14,7 +14,7 @@
 use Doctrine\ORM\Tools\SchemaTool;
 use Doctrine\Persistence\ManagerRegistry;
 use Symfony\Bridge\Doctrine\Form\DoctrineOrmExtension;
-use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
+use Symfony\Bridge\Doctrine\Tests\DoctrineTestHelper;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\SingleIntIdEntity;
 use Symfony\Component\Form\Extension\Core\CoreExtension;
 use Symfony\Component\Form\Test\FormPerformanceTestCase;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Form/Type/EntityTypeTest.php b/src/Symfony/Bridge/Doctrine/Tests/Form/Type/EntityTypeTest.php
@@ -20,7 +20,7 @@
 use Symfony\Bridge\Doctrine\Form\DoctrineOrmExtension;
 use Symfony\Bridge\Doctrine\Form\DoctrineOrmTypeGuesser;
 use Symfony\Bridge\Doctrine\Form\Type\EntityType;
-use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
+use Symfony\Bridge\Doctrine\Tests\DoctrineTestHelper;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\CompositeIntIdEntity;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\CompositeStringIdEntity;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\GroupableEntity;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php b/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php
@@ -18,7 +18,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bridge\Doctrine\Security\User\EntityUserProvider;
 use Symfony\Bridge\Doctrine\Security\User\UserLoaderInterface;
-use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
+use Symfony\Bridge\Doctrine\Tests\DoctrineTestHelper;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\User;
 use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
 
diff --git a/src/Symfony/Bridge/Doctrine/Tests/TestRepositoryFactory.php b/src/Symfony/Bridge/Doctrine/Tests/TestRepositoryFactory.php
@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Doctrine\Tests;
+
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\Persistence\ObjectRepository;
+use Symfony\Bridge\Doctrine\Test\TestRepositoryFactory as TestTestRepositoryFactory;
+
+/**
+ * @author Andreas Braun <alcaeus@alcaeus.org>
+ */
+final class TestRepositoryFactory extends TestTestRepositoryFactory
+{
+    public function getRepository(EntityManagerInterface $entityManager, $entityName, bool $deprecate = false)
+    {
+        return parent::getRepository($entityManager, $entityName, $deprecate);
+    }
+
+    public function setRepository(EntityManagerInterface $entityManager, string $entityName, ObjectRepository $repository, bool $deprecate = false)
+    {
+        return parent::setRepository($entityManager, $entityName, $repository, $deprecate);
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Validator/Constraints/UniqueEntityValidatorTest.php b/src/Symfony/Bridge/Doctrine/Tests/Validator/Constraints/UniqueEntityValidatorTest.php
@@ -18,8 +18,8 @@
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\ObjectManager;
 use Doctrine\Persistence\ObjectRepository;
-use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
-use Symfony\Bridge\Doctrine\Test\TestRepositoryFactory;
+use Symfony\Bridge\Doctrine\Tests\DoctrineTestHelper;
+use Symfony\Bridge\Doctrine\Tests\TestRepositoryFactory;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\AssociationEntity;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\AssociationEntity2;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\CompositeObjectNoToStringIdEntity;
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Validator/DoctrineLoaderTest.php b/src/Symfony/Bridge/Doctrine/Tests/Validator/DoctrineLoaderTest.php
@@ -12,7 +12,7 @@
 namespace Symfony\Bridge\Doctrine\Tests\Validator;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
+use Symfony\Bridge\Doctrine\Tests\DoctrineTestHelper;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\BaseUser;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\DoctrineLoaderEmbed;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\DoctrineLoaderEntity;
