Allow legacy configurations to improve interoperability with other do…

…ctrine cli tools
doctrine · Jun 15, 2020 · 5c80ae8 · 5c80ae8
1 parent da238fb
commit 5c80ae8
Show file tree

Hide file tree

Showing 7 changed files with 159 additions and 0 deletions.
diff --git a/lib/Doctrine/Migrations/Tools/Console/ConsoleRunner.php b/lib/Doctrine/Migrations/Tools/Console/ConsoleRunner.php
@@ -4,6 +4,10 @@
 
 namespace Doctrine\Migrations\Tools\Console;
 
+use Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper;
+use Doctrine\Migrations\Configuration\Connection\ExistingConnection;
+use Doctrine\Migrations\Configuration\EntityManager\ExistingEntityManager;
+use Doctrine\Migrations\Configuration\Migration\ConfigurationFileWithFallback;
 use Doctrine\Migrations\DependencyFactory;
 use Doctrine\Migrations\Tools\Console\Command\CurrentCommand;
 use Doctrine\Migrations\Tools\Console\Command\DiffCommand;
@@ -19,9 +23,11 @@
 use Doctrine\Migrations\Tools\Console\Command\SyncMetadataCommand;
 use Doctrine\Migrations\Tools\Console\Command\UpToDateCommand;
 use Doctrine\Migrations\Tools\Console\Command\VersionCommand;
+use Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper;
 use PackageVersions\Versions;
 use RuntimeException;
 use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Helper\HelperSet;
 use function file_exists;
 use function getcwd;
 use function is_readable;
@@ -67,6 +73,7 @@ public static function findDependencyFactory() : ?DependencyFactory
             }
 
             $dependencyFactory = require $configurationFile;
+            $dependencyFactory = self::checkLegacyConfiguration($dependencyFactory, $configurationFile);
         }
 
         if ($dependencyFactory !== null && ! ($dependencyFactory instanceof DependencyFactory)) {
@@ -121,4 +128,36 @@ public static function addCommands(Application $cli, ?DependencyFactory $depende
 
         $cli->add(new DiffCommand($dependencyFactory));
     }
+
+    /**
+     * @param mixed|HelperSet $dependencyFactory
+     *
+     * @return mixed|DependencyFactory
+     */
+    private static function checkLegacyConfiguration($dependencyFactory, string $configurationFile)
+    {
+        if (! ($dependencyFactory instanceof HelperSet)) {
+            return $dependencyFactory;
+        }
+
+        $configurations = new ConfigurationFileWithFallback();
+        if ($dependencyFactory->has('em') && $dependencyFactory->get('em') instanceof EntityManagerHelper) {
+            return DependencyFactory::fromEntityManager(
+                $configurations,
+                new ExistingEntityManager($dependencyFactory->get('em')->getEntityManager())
+            );
+        }
+
+        if ($dependencyFactory->has('db') && $dependencyFactory->get('db') instanceof ConnectionHelper) {
+            return DependencyFactory::fromConnection(
+                $configurations,
+                new ExistingConnection($dependencyFactory->get('db')->getConnection())
+            );
+        }
+
+        throw new RuntimeException(sprintf(
+            'Configuration HelperSet returned by "%s" does not have a valid "em" or the "db" helper.',
+            $configurationFile
+        ));
+    }
 }
diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/ConsoleRunnerTest.php b/tests/Doctrine/Migrations/Tests/Tools/Console/ConsoleRunnerTest.php
@@ -6,6 +6,7 @@
 
 use Doctrine\Migrations\DependencyFactory;
 use Doctrine\Migrations\Tools\Console\ConsoleRunner;
+use Doctrine\ORM\EntityManager;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 use Symfony\Component\Console\Application;
@@ -24,6 +25,66 @@ class ConsoleRunnerTest extends TestCase
     /** @var Application */
     private $application;
 
+    public function testCreateDependencyFactoryFromLegacyDbalHelper() : void
+    {
+        $dir = getcwd();
+        if ($dir === false) {
+            $dir = '.';
+        }
+
+        chdir(__DIR__ . '/legacy-config-dbal');
+
+        try {
+            $dependencyFactory = ConsoleRunnerStub::findDependencyFactory();
+            self::assertInstanceOf(DependencyFactory::class, $dependencyFactory);
+            self::assertSame('sqlite', $dependencyFactory->getConnection()->getDatabasePlatform()->getName());
+        } finally {
+            chdir($dir);
+        }
+    }
+
+    public function testCreateDependencyFactoryFromLegacyOrmHelper() : void
+    {
+        $dir = getcwd();
+        if ($dir === false) {
+            $dir = '.';
+        }
+
+        chdir(__DIR__ . '/legacy-config-orm');
+
+        try {
+            $dependencyFactory = ConsoleRunnerStub::findDependencyFactory();
+            self::assertInstanceOf(DependencyFactory::class, $dependencyFactory);
+            self::assertSame('sqlite', $dependencyFactory->getConnection()->getDatabasePlatform()->getName());
+            self::assertInstanceOf(EntityManager::class, $dependencyFactory->getEntityManager());
+        } finally {
+            chdir($dir);
+        }
+    }
+
+    public function testCreateDependencyFactoryFromWrongLegacyHelper() : void
+    {
+        $this->expectException(RuntimeException::class);
+
+        $dir = getcwd();
+        if ($dir === false) {
+            $dir = '.';
+        }
+
+        chdir(__DIR__ . '/legacy-config-wrong');
+
+        $this->expectExceptionMessage(sprintf(
+            'Configuration HelperSet returned by "%s" does not have a valid "em" or the "db" helper.',
+            realpath(__DIR__ . '/legacy-config-wrong/cli-config.php')
+        ));
+
+        try {
+            $dependencyFactory = ConsoleRunnerStub::findDependencyFactory();
+        } finally {
+            chdir($dir);
+        }
+    }
+
     /**
      * @dataProvider getDependencyFactoryTestDirectories
      */

diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-dbal/cli-config.php b/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-dbal/cli-config.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Doctrine\DBAL\DriverManager;
+use Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper;
+use Symfony\Component\Console\Helper\HelperSet;
+
+$conn = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'memory' => true]);
+
+return new HelperSet([
+    'db' => new ConnectionHelper($conn),
+]);
diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-dbal/migrations.php b/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-dbal/migrations.php
@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+return [];
diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-orm/cli-config.php b/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-orm/cli-config.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+use Doctrine\DBAL\DriverManager;
+use Doctrine\ORM\Configuration;
+use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Tools\Console\Helper\EntityManagerHelper;
+use Doctrine\Persistence\Mapping\Driver\PHPDriver;
+use Symfony\Component\Console\Helper\HelperSet;
+
+$conf = new Configuration();
+$conf->setProxyDir(__DIR__);
+$conf->setProxyNamespace('Foo');
+$conf->setMetadataDriverImpl(new PHPDriver(''));
+
+$conn = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'memory' => true]);
+
+$em = EntityManager::create($conn, $conf);
+
+return new HelperSet([
+    'em' => new EntityManagerHelper($em),
+]);
diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-orm/migrations.php b/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-orm/migrations.php
@@ -0,0 +1,5 @@
+<?php
+
+declare(strict_types=1);
+
+return [];
diff --git a/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-wrong/cli-config.php b/tests/Doctrine/Migrations/Tests/Tools/Console/legacy-config-wrong/cli-config.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+use Doctrine\DBAL\DriverManager;
+use Doctrine\DBAL\Tools\Console\Helper\ConnectionHelper;
+use Symfony\Component\Console\Helper\HelperSet;
+
+$conn = DriverManager::getConnection(['driver' => 'pdo_sqlite', 'memory' => true]);
+
+return new HelperSet([
+    'abc' => new ConnectionHelper($conn),
+]);