Merge pull request #287 from dotkernel/issue-286

Implemented doctrine data fixtures

Author: arhimede

README.md

@@ -141,15 +141,7 @@ Note: you need to whitelist `localhost` in the reCAPTCHA settings page during de
 
 ## Migrations
 
-Run the migrations and seeds with these commands:
-
-```bash
-php vendor/bin/phinx migrate --configuration="config/migrations.php"
-php vendor/bin/phinx seed:run --configuration="config/migrations.php"
-```
-
-### Migration alternative with Doctrine
-Out of the box, we use Phinx like detailed above to populate the database. Doctrine is an alternative that is also ready to use for new migrations. An example file is included in `/data/doctrine/migrations`, but it's empty, so it won't run any queries. It can be edited freely. To generate a new migration file, use this command 
+Out of the box, we use Doctrine Migrations like detailed below to populate the database. An example file is included in `/data/doctrine/migrations`. To generate a new migration file, use this command:
 
 ```bash
 php vendor/bin/doctrine-migrations migrations:generate
@@ -192,6 +184,20 @@ php vendor/bin/doctrine-migrations migrations:execute --down 20220606131835
 This will also remove the log for that migration in the database, allowing the migration to run again with `php vendor/bin/doctrine-migrations migrate`. 
 Note the `20220606131835` is taken from the migration filename, e.g. `Version20220606131835.php`
 
+## Seeding the database (Fixtures)
+Seeding the database is done with the help of our custom package ``dotkernel/dot-data-fixtures`` built on top of doctrine/data-fixtures. See below on how to use our CLI command for listing and executing Doctrine data fixtures.
+
+An example of a fixtures class is ``data/doctrine/fixtures/RoleLoader.php``
+
+Running ``php bin/doctrine fixtures:list`` will list all the available fixtures, by order of execution.
+
+To execute all fixtures run : ``php bin/doctrine fixtures:execute``.
+
+To execute a specific fixtures run : ``php bin/doctrine fixtures:execute --class=RoleLoader``
+
+Fixtures can and should be ordered to ensure database consistency, more on ordering fixtures can be found here :
+https://www.doctrine-project.org/projects/doctrine-data-fixtures/en/latest/how-to/fixture-ordering.html#fixture-ordering
+
 ## Development mode
 
 - If you use `composer create-project`, the project will go into development mode automatically after installing. The development mode status can be checked and toggled by using these composer commands

bin/doctrine

@@ -0,0 +1,20 @@
+<?php
+
+use Doctrine\ORM\Tools\Console\ConsoleRunner;
+use Doctrine\ORM\Tools\Console\EntityManagerProvider\SingleManagerProvider;
+
+require_once 'vendor/autoload.php';
+
+$container = require getcwd() . '/config/container.php' ;
+
+$entityManager = $container->get(\Doctrine\ORM\EntityManager::class);
+
+$commands = [
+    $container->get(Dot\DataFixtures\Command\ExecuteFixturesCommand::class),
+    $container->get(Dot\DataFixtures\Command\ListFixturesCommand::class),
+];
+
+ConsoleRunner::run(
+    new SingleManagerProvider($entityManager),
+    $commands
+);

composer.json

@@ -56,6 +56,7 @@
         "dotkernel/dot-response-header": "^3.1.0",
         "dotkernel/dot-session": "^4.3.0",
         "dotkernel/dot-twigrenderer": "^3.2.1",
+        "dotkernel/dot-data-fixtures": "^1.0",
         "laminas/laminas-component-installer": "^2.8.0",
         "laminas/laminas-config-aggregator": "^1.8.0",
         "laminas/laminas-i18n": "^2.17.0",

config/autoload/doctrine.global.php

@@ -56,7 +56,8 @@
                 'class' => \Doctrine\Common\Cache\PhpFileCache::class,
                 'directory' => getcwd() . '/data/cache/doctrine'
             ]
-        ]
+        ],
+        'fixtures' => getcwd() . '/data/doctrine/fixtures',
     ],
     'resultCacheLifetime' => 600
 ];

config/config.php

@@ -41,6 +41,7 @@ class_exists(\Mezzio\Swoole\ConfigProvider::class)
     \Dot\Rbac\ConfigProvider::class,
     \Dot\Rbac\Guard\ConfigProvider::class,
     \Dot\ResponseHeader\ConfigProvider::class,
+    \Dot\DataFixtures\ConfigProvider::class,
 
     // Default App module config
     \Frontend\App\ConfigProvider::class,

data/doctrine/fixtures/RoleLoader.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Frontend\Fixtures;
+
+use Doctrine\Common\DataFixtures\FixtureInterface;
+use Doctrine\Persistence\ObjectManager;
+use Frontend\User\Entity\UserRole;
+
+/**
+ * Class RoleLoader
+ * @package Frontend\Fixtures
+ */
+class RoleLoader implements FixtureInterface
+{
+    public function load(ObjectManager $manager): void
+    {
+        $adminRole = new UserRole();
+        $adminRole->setName('admin');
+
+        $userRole = new UserRole();
+        $userRole->setName('user');
+
+        $guestRole = new UserRole();
+        $guestRole->setName('guest');
+
+        $manager->persist($adminRole);
+        $manager->persist($userRole);
+        $manager->persist($guestRole);
+
+        $manager->flush();
+    }
+}
+

data/doctrine/migrations/Version20220817121035.php

@@ -57,25 +57,5 @@ public function down(Schema $schema): void
         $this->addSql('DROP TABLE user_reset_password');
         $this->addSql('DROP TABLE user_role');
     }
-
-    public function postUp(Schema $schema): void
-    {
-        $this->connection->insert('user_role', [
-            'uuid' => UuidOrderedTimeGenerator::generateUuid()->getBytes(),
-            'name' => UserRole::ROLE_ADMIN,
-            'created' => (new DateTimeImmutable())->format('Y-m-d H:i:s'),
-        ]);
-
-        $this->connection->insert('user_role', [
-            'uuid' => UuidOrderedTimeGenerator::generateUuid()->getBytes(),
-            'name' => UserRole::ROLE_USER,
-            'created' => (new DateTimeImmutable())->format('Y-m-d H:i:s'),
-        ]);
-
-        $this->connection->insert('user_role', [
-            'uuid' => UuidOrderedTimeGenerator::generateUuid()->getBytes(),
-            'name' => UserRole::ROLE_GUEST,
-            'created' => (new DateTimeImmutable())->format('Y-m-d H:i:s'),
-        ]);
-    }
 }
+