[POC] add ResetDatabase trait for resetting database between tests

Test/DatabaseResetter.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Doctrine\Bundle\DoctrineBundle\Test;
+
+use Doctrine\Persistence\ManagerRegistry;
+use RuntimeException;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\HttpKernel\KernelInterface;
+
+use function array_merge;
+use function explode;
+use function sprintf;
+
+final class DatabaseResetter
+{
+    /** @var bool */
+    private static $hasBeenReset = false;
+
+    public static function hasBeenReset(): bool
+    {
+        return self::$hasBeenReset;
+    }
+
+    public static function resetDatabase(KernelInterface $kernel): void
+    {
+        $application = self::createApplication($kernel);
+        $registry    = $kernel->getContainer()->get('doctrine');
+
+        foreach (self::connectionsToReset($registry) as $connection) {
+            $dropParams = ['--connection' => $connection, '--force' => true];
+
+            if ($registry->getConnection($connection)->getDatabasePlatform()->getName() !== 'sqlite') {
+                // sqlite does not support "--if-exists" (ref: https://github.com/doctrine/dbal/pull/2402)
+                $dropParams['--if-exists'] = true;
+            }
+
+            self::runCommand($application, 'doctrine:database:drop', $dropParams);
+
+            self::runCommand($application, 'doctrine:database:create', ['--connection' => $connection]);
+        }
+
+        self::createSchema($application, $registry);
+
+        self::$hasBeenReset = true;
+    }
+
+    public static function resetSchema(KernelInterface $kernel): void
+    {
+        $application = self::createApplication($kernel);
+        $registry    = $kernel->getContainer()->get('doctrine');
+
+        self::dropSchema($application, $registry);
+        self::createSchema($application, $registry);
+    }
+
+    private static function createSchema(Application $application, ManagerRegistry $registry): void
+    {
+        foreach (self::objectManagersToReset($registry) as $manager) {
+            self::runCommand($application, 'doctrine:schema:create', ['--em' => $manager]);
+        }
+    }
+
+    private static function dropSchema(Application $application, ManagerRegistry $registry): void
+    {
+        foreach (self::objectManagersToReset($registry) as $manager) {
+            self::runCommand($application, 'doctrine:schema:drop', [
+                '--em' => $manager,
+                '--force' => true,
+            ]);
+        }
+    }
+
+    /**
+     * @param array<string, mixed> $parameters
+     */
+    private static function runCommand(Application $application, string $command, array $parameters = []): void
+    {
+        $exit       = $application->run(
+            new ArrayInput(array_merge(['command' => $command], $parameters)),
+            $output = new BufferedOutput()
+        );
+
+        if ($exit !== 0) {
+            throw new RuntimeException(sprintf('Error running "%s": %s', $command, $output->fetch()));
+        }
+    }
+
+    private static function createApplication(KernelInterface $kernel): Application
+    {
+        $application = new Application($kernel);
+        $application->setAutoExit(false);
+
+        return $application;
+    }
+
+    /**
+     * @return string[]
+     */
+    private static function connectionsToReset(ManagerRegistry $registry): array
+    {
+        if (isset($_SERVER['DOCTRINE_RESET_CONNECTIONS'])) {
+            return explode(',', $_SERVER['DOCTRINE_RESET_CONNECTIONS']);
+        }
+
+        return [$registry->getDefaultConnectionName()];
+    }
+
+    /**
+     * @return string[]
+     */
+    private static function objectManagersToReset(ManagerRegistry $registry): array
+    {
+        if (isset($_SERVER['DOCTRINE_RESET_OBJECT_MANAGERS'])) {
+            return explode(',', $_SERVER['DOCTRINE_RESET_OBJECT_MANAGERS']);
+        }
+
+        return [$registry->getDefaultManagerName()];
+    }
+}

Test/ResetDatabase.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Doctrine\Bundle\DoctrineBundle\Test;
+
+use RuntimeException;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+
+use function is_a;
+use function sprintf;
+
+trait ResetDatabase
+{
+    /** @var bool */
+    private static $hasDatabaseBeenReset = false;
+
+    /**
+     * @internal
+     *
+     * @beforeClass
+     */
+    public static function resetDatabase(): void
+    {
+        if (DatabaseResetter::hasBeenReset()) {
+            // only reset before first test
+            return;
+        }
+
+        if (! is_a(static::class, KernelTestCase::class, true)) {
+            throw new RuntimeException(sprintf('The "%s" trait can only be used on TestCases that extend "%s".', __TRAIT__, KernelTestCase::class));
+        }
+
+        $kernel = static::createKernel();
+        $kernel->boot();
+
+        DatabaseResetter::resetDatabase($kernel);
+
+        $kernel->shutdown();
+    }
+
+    /**
+     * @internal
+     *
+     * @before
+     */
+    public static function resetSchema(): void
+    {
+        $kernel = static::createKernel();
+        $kernel->boot();
+
+        DatabaseResetter::resetSchema($kernel);
+
+        $kernel->shutdown();
+    }
+}