fix: clean entity manager before loading fixtures

liip · Jul 3, 2024 · 437e674 · 437e674
1 parent d8b429d
commit 437e674
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 22 deletions.
diff --git a/src/Services/DatabaseTools/AbstractDatabaseTool.php b/src/Services/DatabaseTools/AbstractDatabaseTool.php
@@ -170,6 +170,9 @@ public function loadAliceFixture(array $paths = [], bool $append = false): array
 
         if (false === $append) {
             $this->cleanDatabase();
+
+            // Clear the entity manager to avoid the exception `EntityIdentityCollisionException`
+            $this->om->clear();
         }
 
         $files = $this->locateResources($paths);

diff --git a/src/Services/DatabaseTools/MongoDBDatabaseTool.php b/src/Services/DatabaseTools/MongoDBDatabaseTool.php
@@ -76,6 +76,9 @@ public function loadFixtures(array $classNames = [], bool $append = false): Abst
         $executor->setReferenceRepository($referenceRepository);
         if (false === $append) {
             $executor->purge();
+
+            // Clear the entity manager to avoid the exception `EntityIdentityCollisionException`
+            $this->om->clear();
         }
 
         $loader = $this->fixturesLoaderFactory->getFixtureLoader($classNames);

diff --git a/src/Services/DatabaseTools/ORMDatabaseTool.php b/src/Services/DatabaseTools/ORMDatabaseTool.php
@@ -116,6 +116,9 @@ public function loadFixtures(array $classNames = [], bool $append = false): Abst
             $this->disableForeignKeyChecksIfApplicable();
             $executor->purge();
             $this->enableForeignKeyChecksIfApplicable();
+
+            // Clear the entity manager to avoid the exception `EntityIdentityCollisionException`
+            $this->om->clear();
         }
 
         $loader = $this->fixturesLoaderFactory->getFixtureLoader($classNames);

diff --git a/src/Services/DatabaseTools/ORMSqliteDatabaseTool.php b/src/Services/DatabaseTools/ORMSqliteDatabaseTool.php
@@ -94,6 +94,9 @@ public function loadFixtures(array $classNames = [], bool $append = false): Abst
         $executor->setReferenceRepository($referenceRepository);
         if (false === $append) {
             $executor->purge();
+
+            // Clear the entity manager to avoid the exception `EntityIdentityCollisionException`
+            $this->om->clear();
         }
 
         $loader = $this->fixturesLoaderFactory->getFixtureLoader($classNames);

diff --git a/tests/Test/ConfigMysqlCacheDbTest.php b/tests/Test/ConfigMysqlCacheDbTest.php
@@ -35,6 +35,13 @@
 #[PreserveGlobalState(false)]
 class ConfigMysqlCacheDbTest extends ConfigMysqlTest
 {
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->assertTrue($this->databaseTool->isDatabaseCacheEnabled());
+    }
+
     public function testLoadFixturesAndCheckBackup(): void
     {
         $this->assertTrue($this->databaseTool->isDatabaseCacheEnabled());
@@ -107,7 +114,6 @@ public function testLoadFixturesAndCheckBackup(): void
 
     public function testLoadFixturesCheckReferences(): void
     {
-        $this->markTestSkipped('This test is broken right now.');
         $referenceRepository = $this->databaseTool->loadFixtures([
             'Liip\Acme\Tests\App\DataFixtures\ORM\LoadUserData',
         ])->getReferenceRepository();

diff --git a/tests/Test/ConfigMysqlTest.php b/tests/Test/ConfigMysqlTest.php
@@ -249,8 +249,6 @@ public function testLoadFixturesAndPurge(): void
             $users
         );
 
-        $this->getTestContainer()->get('doctrine')->getManager()->clear();
-
         // Reload fixtures
         $this->databaseTool->loadFixtures([
             'Liip\Acme\Tests\App\DataFixtures\ORM\LoadUserData',

diff --git a/tests/Test/ConfigTest.php b/tests/Test/ConfigTest.php
@@ -13,7 +13,6 @@
 
 namespace Liip\Acme\Tests\Test;
 
-use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\Persistence\ObjectRepository;
 use Liip\Acme\Tests\App\Entity\User;
 use Liip\Acme\Tests\AppConfig\AppConfigKernel;
@@ -45,7 +44,6 @@ class ConfigTest extends KernelTestCase
     private $userRepository;
     /** @var SqliteDatabaseBackup */
     private $sqliteDatabaseBackup;
-    private EntityManagerInterface $entityManager;
 
     protected function setUp(): void
     {
@@ -64,10 +62,6 @@ protected function setUp(): void
         $this->sqliteDatabaseBackup = $this->getTestContainer()->get(SqliteDatabaseBackup::class);
 
         $this->assertInstanceOf(SqliteDatabaseBackup::class, $this->sqliteDatabaseBackup);
-
-        $this->entityManager = $this->getTestContainer()->get(EntityManagerInterface::class);
-
-        $this->assertInstanceOf(EntityManagerInterface::class, $this->entityManager);
     }
 
     /**
@@ -101,8 +95,6 @@ public function testLoadFixturesFilesWithCustomProvider(): void
             $user1->getName()
         );
 
-        $this->getTestContainer()->get('doctrine')->getManager()->clear();
-
         // Load Data Fixtures with custom loader defined in configuration.
         $fixtures = $this->databaseTool->loadAliceFixture([
             '@AcmeBundle/DataFixtures/ORM/user_with_custom_provider.yml',
@@ -130,9 +122,12 @@ public function testCacheCanBeDisabled(): void
 
         $this->databaseTool->setDatabaseCacheEnabled(false);
 
+        // Cache is not up-to-date.
+        $this->assertFalse($this->databaseTool->isDatabaseCacheEnabled());
+
         $this->databaseTool->loadFixtures($fixtures);
 
-        // Load data from database
+        // Load data from database.
         /** @var User $user1 */
         $user1 = $this->userRepository->findOneBy(['id' => 1]);
 
@@ -141,19 +136,22 @@ public function testCacheCanBeDisabled(): void
 
         sleep(2);
 
-        $this->clearEntityManager();
+        // Cache is up-to-date, but it won't be used since its usage is disabled.
+        $this->assertTrue($this->sqliteDatabaseBackup->isBackupActual());
 
         // Reload the fixtures.
         $this->databaseTool->loadFixtures($fixtures);
 
         /** @var User $user1 */
         $user1 = $this->userRepository->findOneBy(['id' => 1]);
 
-        // The salt are not the same because cache were not used
+        // The salt are not the same because the cache was not used.
         $this->assertNotSame($user1Salt, $user1->getSalt());
 
         // Enable the cache again
         $this->databaseTool->setDatabaseCacheEnabled(true);
+
+        $this->assertTrue($this->databaseTool->isDatabaseCacheEnabled());
     }
 
     /**
@@ -191,7 +189,7 @@ public function testBackupIsRefreshed(): void
 
         sleep(2);
 
-        $this->clearEntityManager();
+        $this->assertTrue($this->sqliteDatabaseBackup->isBackupActual());
 
         // Reload the fixtures.
         $this->databaseTool->loadFixtures($fixtures);
@@ -217,11 +215,11 @@ public function testBackupIsRefreshed(): void
 
         sleep(2);
 
-        $this->clearEntityManager();
-
         // Update the filemtime of the fixture file used as a dependency.
         touch($dependentFixtureFilePath);
 
+        $this->assertFalse($this->sqliteDatabaseBackup->isBackupActual());
+
         $this->databaseTool->loadFixtures($fixtures);
 
         // The mtime of the fixture file has been updated.
@@ -249,11 +247,6 @@ protected static function getKernelClass(): string
         return AppConfigKernel::class;
     }
 
-    protected function clearEntityManager(): void
-    {
-        $this->entityManager->clear();
-    }
-
     protected function tearDown(): void
     {
         parent::tearDown();