ISSUE-337: fixture test fix

Author: tatevikg1

config/config.yml

@@ -52,7 +52,7 @@ doctrine:
         auto_mapping: true
         mappings:
             PhpList\Core\Domain\Model:
-                type: annotation
                 is_bundle: false
-                prefix: PhpList\Core\Domain\Model
+                type: attribute
                 dir: '%kernel.project_dir%/src/Domain/Model/'
+                prefix: 'PhpList\Core\Domain\Model\'

config/config_test.yml

@@ -7,3 +7,9 @@ framework:
         storage_id: session.storage.mock_file
     profiler:
         collect: false
+
+doctrine:
+    dbal:
+        driver: 'pdo_sqlite'
+        memory: true
+        charset: UTF8

src/Domain/Model/Identity/Administrator.php

@@ -114,4 +114,12 @@ public function setSuperUser(bool $superUser): void
     {
         $this->superUser = $superUser;
     }
+
+    #[ORM\PrePersist]
+    public function setCreationDate(): void
+    {
+        if ($this->creationDate === null) {
+            $this->creationDate = new DateTime();
+        }
+    }
 }

src/Domain/Model/Identity/AdministratorToken.php

@@ -103,7 +103,7 @@ public function generateKey(): void
         $this->setKey($key);
     }
 
-    public function getAdministrator(): ?Administrator
+    public function getAdministrator(): Administrator|Proxy|null
     {
         return $this->administrator;
     }

src/Domain/Model/Traits/IdentityTrait.php

@@ -20,7 +20,7 @@ trait IdentityTrait
     #[ORM\Column(type: "integer")]
     #[ORM\GeneratedValue]
     #[SerializedName("id")]
-    private int $id = 0;
+    private int $id;
 
     public function getId(): int
     {

src/TestingSupport/AbstractWebTest.php

@@ -1,40 +1,35 @@
 <?php
+
 declare(strict_types=1);
 
 namespace PhpList\Core\TestingSupport;
 
 use PhpList\Core\Core\Bootstrap;
 use PhpList\Core\Core\Environment;
-use Symfony\Bundle\FrameworkBundle\Client;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
 
 /**
  * Base class for integration tests for controllers.
  *
  * If you have your own setUp method, make sure to call $this->setUpWebTest() first thing in your setUp method.
- *
- * @author Oliver Klee <[email protected]>
  */
 abstract class AbstractWebTest extends WebTestCase
 {
-    /**
-     * @var Client
-     */
-    protected $client = null;
+    protected ?KernelBrowser $client = null;
 
-    protected function setUp()
+    protected function setUp(): void
     {
+        parent::setUp();
         $this->setUpWebTest();
     }
 
-    protected function setUpWebTest()
+    protected function setUpWebTest(): void
     {
-        // This makes sure that all DateTime instances use the same time zone, thus making the dates in the
-        // JSON provided by the REST API easier to test.
         date_default_timezone_set('UTC');
 
         Bootstrap::getInstance()->setEnvironment(Environment::TESTING)->configure();
 
-        $this->client = static::createClient(['environment' => Environment::TESTING]);
+        $this->client = static::createClient();
     }
 }

src/TestingSupport/Traits/ContainsInstanceAssertionTrait.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace PhpList\Core\TestingSupport\Traits;
@@ -17,11 +18,11 @@ trait ContainsInstanceAssertionTrait
      *
      * @return void
      */
-    public static function assertContainsInstanceOf(string $className, array $haystack, string $message = '')
+    public static function assertContainsInstanceOf(string $className, array $haystack, string $message = ''): void
     {
         $found = false;
         foreach ($haystack as $element) {
-            if (is_object($element) && $element instanceof $className) {
+            if ($element instanceof $className) {
                 $found = true;
                 break;
             }

src/TestingSupport/Traits/DatabaseTestTrait.php

@@ -4,176 +4,109 @@
 
 namespace PhpList\Core\TestingSupport\Traits;
 
+use Doctrine\Common\DataFixtures\Purger\ORMPurger;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\SchemaTool;
+use Doctrine\ORM\Tools\ToolsException;
+use InvalidArgumentException;
 use PhpList\Core\Core\Bootstrap;
 use PhpList\Core\Core\Environment;
-use PHPUnit\DbUnit\Database\Connection;
-use PHPUnit\DbUnit\DataSet\CsvDataSet;
-use PHPUnit\DbUnit\Operation\Factory;
-use PHPUnit\DbUnit\Operation\Operation;
-use PHPUnit\DbUnit\TestCaseTrait;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use RuntimeException;
 
 /**
- * This is a trait for integration tests that use database records.
- *
- * If you have your own setUp method, make sure to call $this->setUpDatabaseTest() first thing in your setUp method.
- *
- * And if you have your own tearDown method, call $this->tearDownDatabaseTest() first thing in your tearDown method.
- *
- * @author Oliver Klee <[email protected]>
+ * This trait provides support for integration tests involving database records.
  */
 trait DatabaseTestTrait
 {
-    use TestCaseTrait;
+    protected ?Bootstrap $bootstrap = null;
+    protected ?EntityManagerInterface $entityManager = null;
+    protected static $container;
 
     /**
-     * @var Connection
+     * Sets up the database test environment.
      */
-    private $databaseConnection = null;
-
-    /**
-     * @var \PDO
-     */
-    private static $pdo = null;
-
-    /**
-     * @var CsvDataSet
-     */
-    private $dataSet = null;
-
-    /**
-     * @var Bootstrap
-     */
-    protected $bootstrap = null;
-
-    /**
-     * @var EntityManagerInterface
-     */
-    protected $entityManager = null;
-
-    /**
-     * @var ContainerInterface
-     */
-    protected $container = null;
-
-    protected function setUp()
+    protected function setUpDatabaseTest(): void
     {
-        $this->setUpDatabaseTest();
-    }
-
-    protected function setUpDatabaseTest()
-    {
-        $this->initializeDatabaseTester();
-        $this->bootstrap = Bootstrap::getInstance()->setEnvironment(Environment::TESTING)->configure();
-        $this->container = $this->bootstrap->getContainer();
-        $this->entityManager = $this->bootstrap->getEntityManager();
-        static::assertTrue($this->entityManager->isOpen());
+        $this->initializeBootstrap();
+        $this->clearDatabase();
     }
 
     /**
-     * Initializes the CSV data set and the database tester.
-     *
-     * @return void
+     * Tears down the database test environment.
      */
-    protected function initializeDatabaseTester()
+    protected function tearDownDatabaseTest(): void
     {
-        $this->dataSet = new CsvDataSet();
-
-        unset($this->databaseTester);
-        $this->getDatabaseTester()->setSetUpOperation($this->getSetUpOperation());
-    }
-
-    protected function tearDown()
-    {
-        $this->tearDownDatabaseTest();
+        $this->entityManager?->clear();
+        $this->entityManager?->close();
+        $this->bootstrap = null;
+        $this->entityManager = null;
     }
 
-    protected function tearDownDatabaseTest()
+    /**
+     * Initializes the Bootstrap and Doctrine EntityManager.
+     */
+    private function initializeBootstrap(): void
     {
-        $this->entityManager->close();
-        $this->getDatabaseTester()->setTearDownOperation($this->getTearDownOperation());
-        $this->getDatabaseTester()->setDataSet($this->getDataSet());
-        $this->getDatabaseTester()->onTearDown();
+        $this->bootstrap = Bootstrap::getInstance()
+            ->setEnvironment(Environment::TESTING)
+            ->configure();
 
-        // Destroy the tester after the test is run to keep DB connections
-        // from piling up.
-        unset($this->databaseTester);
+        $this->entityManager = $this->bootstrap->getEntityManager();
 
-        Bootstrap::purgeInstance();
+        if (!$this->entityManager->isOpen()) {
+            throw new RuntimeException('The Doctrine EntityManager is not open.');
+        }
     }
 
     /**
-     * Returns the database operation executed in test cleanup.
-     *
-     * @return Operation
+     * Clears the database using ORMPurger.
      */
-    protected function getTearDownOperation(): Operation
+    private function clearDatabase(): void
     {
-        return Factory::TRUNCATE();
+        if (!$this->entityManager) {
+            throw new RuntimeException('EntityManager not initialized.');
+        }
+
+        $purger = new ORMPurger($this->entityManager);
+        $purger->purge();
     }
 
     /**
-     * Returns the test database connection.
+     * Loads data fixtures into the database.
      *
-     * @return Connection
+     * @param array $fixtures List of fixture classes to load
      */
-    protected function getConnection(): Connection
+    protected function loadFixtures(array $fixtures): void
     {
-        if ($this->databaseConnection === null) {
-            if (self::$pdo === null) {
-                $databaseHost = getenv('PHPLIST_DATABASE_HOST') ?: 'localhost';
-                $databasePort = getenv('PHPLIST_DATABASE_PORT') ?: '3306';
-                $databaseName = getenv('PHPLIST_DATABASE_NAME');
-                self::$pdo = new \PDO(
-                    'mysql:host='.$databaseHost.';port='.$databasePort.';dbname='.$databaseName,
-                    getenv('PHPLIST_DATABASE_USER'),
-                    getenv('PHPLIST_DATABASE_PASSWORD')
-                );
+        foreach ($fixtures as $fixture) {
+            $fixtureInstance = new $fixture();
+            if (!method_exists($fixtureInstance, 'load')) {
+                throw new InvalidArgumentException(sprintf('Fixture %s must have a load() method.', $fixture));
             }
-            $this->databaseConnection = $this->createDefaultDBConnection(self::$pdo);
+
+            $fixtureInstance->load($this->entityManager);
         }
 
-        return $this->databaseConnection;
+        $this->entityManager->flush();
     }
 
-    /**
-     * Returns the test data set.
-     *
-     * Add data to in the individual test by calling $this->getDataSet()->addTable.
-     *
-     * @return CsvDataSet
-     */
-    protected function getDataSet(): CsvDataSet
+    protected function loadSchema(): void
     {
-        return $this->dataSet;
-    }
+        $this->entityManager = self::getContainer()->get('doctrine.orm.entity_manager');
+        $schemaTool = new SchemaTool($this->entityManager);
+        $metadata = $this->entityManager->getMetadataFactory()->getAllMetadata();
 
-    /**
-     * Applies all database changes on $this->dataSet.
-     *
-     * This methods needs to be called after the last addTable call in each test.
-     *
-     * @return void
-     */
-    protected function applyDatabaseChanges()
-    {
-        $this->getDatabaseTester()->setDataSet($this->getDataSet());
-        $this->getDatabaseTester()->onSetUp();
-    }
+        $connection = $this->entityManager->getConnection();
+        $schemaManager = $connection->createSchemaManager();
 
-    /**
-     * Marks the table with the given name as "touched", i.e., it will be truncated in the tearDown method.
-     *
-     * This is useful if the table gets populated only by the tested code instead of by using the addTable
-     * and applyDatabaseChanges method.
-     *
-     * @param string $tableName
-     *
-     * @return void
-     */
-    protected function touchDatabaseTable(string $tableName)
-    {
-        $this->getDataSet()->addTable($tableName, __DIR__ . '/../Fixtures/TouchTable.csv');
+        foreach ($metadata as $classMetadata) {
+            $tableName = $classMetadata->getTableName();
+
+            if (!$schemaManager->tablesExist([$tableName])) {
+                try {
+                    $schemaTool->createSchema([$classMetadata]);
+                } catch (ToolsException $e){}
+            }
+        }
     }
 }