Merge pull request #296 from alexislefebvre/feat-support-doctrine-orm-3

feat: support doctrine/orm 3

.github/workflows/tests.yml

@@ -132,8 +132,7 @@ jobs:
         run: echo '127.0.0.1 mariadb postgres mongodb' | sudo tee -a /etc/hosts
 
       - name: Run tests
-        # In phpunit.xml.dist, tests annotated with "@group mysql" are excluded, revert this
         # Run tests twice to ensure that tests are idempotent even if database caching is enabled
         run: |
-          php ./vendor/bin/phpunit --testdox --exclude-group ""
-          php ./vendor/bin/phpunit --testdox --exclude-group ""
+          php ./vendor/bin/phpunit --testdox --process-isolation
+          php ./vendor/bin/phpunit --testdox --process-isolation

composer.json

@@ -32,7 +32,7 @@
         "doctrine/doctrine-fixtures-bundle": "^3.4.4 || ^4.0",
         "doctrine/mongodb-odm": "^2.2",
         "doctrine/mongodb-odm-bundle": "^4.2.1 || ^5.0",
-        "doctrine/orm": "^2.14",
+        "doctrine/orm": "^2.14 || ^3.0",
         "doctrine/phpcr-bundle": "^2.4.3 || ^3.0",
         "doctrine/phpcr-odm": "^1.7.2 || ^2.0",
         "jackalope/jackalope-doctrine-dbal": "^1.10.1 || ^2.0",
@@ -48,7 +48,7 @@
         "doctrine/annotations": "<1.13.1 || >=3.0",
         "doctrine/dbal": "<2.13.1 || ~3.0.0 || >=4.0",
         "doctrine/mongodb-odm": "<2.2 || >=3.0",
-        "doctrine/orm": "<2.14 || >=3.0"
+        "doctrine/orm": "<2.14 || >=4.0"
     },
     "suggest": {
         "doctrine/dbal": "Required when using the fixture loading functionality with an ORM and SQLite",

doc/contributing.md

@@ -18,8 +18,40 @@ Install the dependencies with composer:
 docker-compose exec php-fpm composer install
 ```
 
+Install the lowest dependencies with composer:
+
+```bash
+docker-compose exec php-fpm composer update --prefer-lowest
+```
+
 Now you can execute the tests with the following command:
 
 ```bash
-docker-compose exec php-fpm ./vendor/bin/phpunit --exclude-group ""
+docker-compose exec php-fpm ./vendor/bin/phpunit --process-isolation
+```
+
+If one test fails, run it without the `--process-isolation` option
+
+```bash
+docker-compose exec php-fpm ./vendor/bin/phpunit tests/Test/ConfigMongodbTest.php
+```
+
+You can also use the `--filter` option to run tests matching a class and name:
+
+```bash
+docker-compose exec php-fpm ./vendor/bin/phpunit --process-isolation --filter=ConfigSqliteTest::testAppendFixtures
+```
+
+You can also use the `--filter` option to run tests matching a name:
+
+```bash
+docker-compose exec php-fpm ./vendor/bin/phpunit --process-isolation --filter=testAppendFixtures
+```
+
+## Delete the cache
+
+If you change the version of PHP or dependencies, the caches may cause issues, they can be deleted:
+
+```bash
+docker-compose exec php-fpm bash -c "rm -rf tests/App*/var/cache/*"
 ```

phpunit.xml.dist

@@ -18,11 +18,4 @@
             <directory>tests/Test</directory>
         </testsuite>
     </testsuites>
-
-    <groups>
-        <exclude>
-            <group>mysql</group>
-            <group>pgsql</group>
-        </exclude>
-    </groups>
 </phpunit>

tests/App/DataFixtures/ORM/LoadDependentUserData.php

@@ -25,17 +25,18 @@ class LoadDependentUserData extends AbstractFixture implements DependentFixtureI
      */
     public function load(ObjectManager $manager): void
     {
-        /** @var User $user */
-        $user = clone $this->getReference('user');
-
+        $user = new User();
         $user->setId(3);
+        $user->setName('alice bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();
 
-        $user = clone $this->getReference('user');
-
+        $user = new User();
         $user->setId(4);
+        $user->setName('eve bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();

tests/App/DataFixtures/ORM/LoadDependentUserWithServiceData.php

@@ -34,18 +34,19 @@ public function __construct(DummyService $dummyService)
      */
     public function load(ObjectManager $manager): void
     {
-        /** @var User $user */
-        $user = clone $this->getReference('serviceUser');
-
+        $user = new User();
         $user->setId(3);
+        $user->setName('alice bar');
+        $user->setEmail('[email protected]');
         $user->setDummyText($this->dummyService->getText());
 
         $manager->persist($user);
         $manager->flush();
 
-        $user = clone $this->getReference('serviceUser');
-
+        $user = new User();
         $user->setId(4);
+        $user->setName('eve bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();

tests/App/DataFixtures/ORM/LoadSecondUserData.php

@@ -25,8 +25,9 @@ class LoadSecondUserData extends AbstractFixture
     public function load(ObjectManager $manager): void
     {
         $user = new User();
-        $user->setName('bar foo');
-        $user->setEmail('[email protected]');
+        $user->setId(3);
+        $user->setName('alice bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();

tests/App/DataFixtures/ORM/LoadUserData.php

@@ -34,9 +34,10 @@ public function load(ObjectManager $manager): void
 
         $this->addReference('user', $user);
 
-        $user = clone $this->getReference('user');
-
+        $user = new User();
         $user->setId(2);
+        $user->setName('bob bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();

tests/App/DataFixtures/ORM/LoadUserDataInGroup.php

@@ -36,18 +36,18 @@ public function load(ObjectManager $manager): void
         $manager->persist($user);
         $manager->flush();
 
-        $this->addReference('groupUser', $user);
-
-        $user = clone $this->getReference('groupUser');
-
+        $user = new User();
         $user->setId(2);
+        $user->setName('bob bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();
 
-        $user = clone $this->getReference('groupUser');
-
+        $user = new User();
         $user->setId(3);
+        $user->setName('alice bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();

tests/App/DataFixtures/ORM/LoadUserWithServiceData.php

@@ -45,11 +45,10 @@ public function load(ObjectManager $manager): void
         $manager->persist($user);
         $manager->flush();
 
-        $this->addReference('serviceUser', $user);
-
-        $user = clone $this->getReference('serviceUser');
-
+        $user = new User();
         $user->setId(2);
+        $user->setName('bob bar');
+        $user->setEmail('[email protected]');
 
         $manager->persist($user);
         $manager->flush();

tests/App/DataFixtures/ORM/user.yml

@@ -1,4 +1,5 @@
 Liip\Acme\Tests\App\Entity\User:
-    id{1..10}:
+    user_id_{1..10}:
+        id: <current()>
         name: <name()>
         email: <email()>

tests/App/DataFixtures/ORM/user_with_custom_provider.yml

@@ -1,4 +1,5 @@
 Liip\Acme\Tests\App\Entity\User:
-    id{1..10}:
+    custom_user_id_{11..20}:
+        id: <current()>
         name: <foo('a string')>
         email: <email()>

tests/Test/ConfigMysqlCacheDbTest.php

@@ -24,8 +24,7 @@
  * they are disabled by default (see phpunit.xml.dist).
  *
  * In order to run them, you have to set the MySQL connection
- * parameters in the Tests/AppConfigMysql/config.yml file and
- * add “--exclude-group ""” when running PHPUnit.
+ * parameters in the Tests/AppConfigMysql/config.yml file.
  *
  * Use Tests/AppConfigMysql/AppConfigMysqlKernelCacheDb.php instead of
  * Tests/App/AppKernel.php.

tests/Test/ConfigMysqlKeepDatabaseAndSchemaTest.php

@@ -23,8 +23,7 @@
  * they are disabled by default (see phpunit.xml.dist).
  *
  * In order to run them, you have to set the MySQL connection
- * parameters in the Tests/AppConfigMysql/config.yml file and
- * add “--exclude-group ""” when running PHPUnit.
+ * parameters in the Tests/AppConfigMysql/config.yml file.
  *
  * Use Tests/AppConfigMysqlKeepDatabaseAndSchema/AppConfigMysqlKernelKeepDatabaseAndSchema.php instead of
  * Tests/App/AppKernel.php.

tests/Test/ConfigMysqlTest.php

@@ -37,8 +37,7 @@ class_alias('\Doctrine\Persistence\ObjectManager', '\Doctrine\Common\Persistence
  * they are disabled by default (see phpunit.xml.dist).
  *
  * In order to run them, you have to set the MySQL connection
- * parameters in the Tests/AppConfigMysql/config.yml file and
- * add “--exclude-group ""” when running PHPUnit.
+ * parameters in the Tests/AppConfigMysql/config.yml file.
  *
  * Use Tests/AppConfigMysql/AppConfigMysqlKernel.php instead of
  * Tests/App/AppKernel.php.
@@ -95,7 +94,7 @@ public function testLoadEmptyFixtures(): void
     /**
      * @group mysql
      */
-    public function testLoadFixtures(int $firstUserId = 1): void
+    public function testLoadFixtures(): void
     {
         $fixtures = $this->databaseTool->loadFixtures([
             'Liip\Acme\Tests\App\DataFixtures\ORM\LoadUserData',
@@ -135,7 +134,7 @@ public function testLoadFixtures(int $firstUserId = 1): void
     /**
      * @group mysql
      */
-    public function testAppendFixtures(int $firstUserId = 1, int $thirdUserId = 3): void
+    public function testAppendFixtures(): void
     {
         $this->databaseTool->loadFixtures([
             'Liip\Acme\Tests\App\DataFixtures\ORM\LoadUserData',
@@ -169,17 +168,31 @@ public function testAppendFixtures(int $firstUserId = 1, int $thirdUserId = 3):
             $user1->getEmail()
         );
 
-        /** @var User $user */
+        /** @var User $user2 */
+        $user2 = $this->userRepository
+            ->findOneBy([
+                'email' => '[email protected]',
+            ])
+        ;
+
+        $this->assertNotNull($user2);
+
+        $this->assertSame(
+            '[email protected]',
+            $user2->getEmail()
+        );
+
+        /** @var User $user3 */
         $user3 = $this->userRepository
             ->findOneBy([
-                'email' => 'bar@foo.com',
+                'email' => 'alice@bar.com',
             ])
         ;
 
         $this->assertNotNull($user3);
 
         $this->assertSame(
-            'bar@foo.com',
+            'alice@bar.com',
             $user3->getEmail()
         );
     }
@@ -262,6 +275,8 @@ public function testLoadFixturesAndPurge(): void
             $users
         );
 
+        $this->getTestContainer()->get('doctrine')->getManager()->clear();
+
         // Reload fixtures
         $this->databaseTool->loadFixtures([
             'Liip\Acme\Tests\App\DataFixtures\ORM\LoadUserData',
@@ -331,6 +346,29 @@ public function testLoadFixturesFiles(): void
         $this->assertInstanceOf(User::class, $user);
     }
 
+    /**
+     * Load fixture which has a dependency.
+     */
+    public function testLoadDependentFixtures(): void
+    {
+        $fixtures = $this->databaseTool->loadFixtures([
+            'Liip\Acme\Tests\App\DataFixtures\ORM\LoadDependentUserData',
+        ]);
+
+        $this->assertInstanceOf(
+            'Doctrine\Common\DataFixtures\Executor\ORMExecutor',
+            $fixtures
+        );
+
+        $users = $this->userRepository->findAll();
+
+        // The two files with fixtures have been loaded, there are 4 users.
+        $this->assertCount(
+            4,
+            $users
+        );
+    }
+
     protected static function getKernelClass(): string
     {
         return AppConfigMysqlKernel::class;

tests/Test/ConfigMysqlUrlTest.php

@@ -22,8 +22,7 @@
  * they are disabled by default (see phpunit.xml.dist).
  *
  * In order to run them, you have to set the MySQL connection
- * parameters in the Tests/AppConfigMysql/config.yml file and
- * add “--exclude-group ""” when running PHPUnit.
+ * parameters in the Tests/AppConfigMysql/config.yml file.
  *
  * Use Tests/AppConfigMysql/AppConfigMysqlUrlKernel.php instead of
  * Tests/App/AppKernel.php.

tests/Test/ConfigPgsqlTest.php

@@ -23,8 +23,7 @@
  * they are disabled by default (see phpunit.xml.dist).
  *
  * In order to run them, you have to set the PostgreSQL connection
- * parameters in the Tests/AppConfigPgsql/config.yml file and
- * add “--exclude-group ""” when running PHPUnit.
+ * parameters in the Tests/AppConfigPgsql/config.yml file.
  *
  * Use Tests/AppConfigPgsql/AppConfigPgsqlKernel.php instead of
  * Tests/App/AppKernel.php.
@@ -38,6 +37,29 @@
  */
 class ConfigPgsqlTest extends ConfigMysqlTest
 {
+    /**
+     * Load fixture which has a dependency.
+     */
+    public function testLoadDependentFixtures(): void
+    {
+        $fixtures = $this->databaseTool->loadFixtures([
+            'Liip\Acme\Tests\App\DataFixtures\ORM\LoadDependentUserData',
+        ]);
+
+        $this->assertInstanceOf(
+            'Doctrine\Common\DataFixtures\Executor\ORMExecutor',
+            $fixtures
+        );
+
+        $users = $this->userRepository->findAll();
+
+        // The two files with fixtures have been loaded, there are 4 users.
+        $this->assertCount(
+            4,
+            $users
+        );
+    }
+
     public function testToolType(): void
     {
         $this->assertInstanceOf(ORMDatabaseTool::class, $this->databaseTool);