tests: add test permutation with multiple migration configuration files

nikophil · nikophil · commit 9e8d26dc9995 · 2025-10-04T08:15:59.000+02:00
diff --git a/.env b/.env
@@ -11,3 +11,11 @@ USE_DAMA_DOCTRINE_TEST_BUNDLE="0"
 USE_FOUNDRY_PHPUNIT_EXTENSION="0"
 USE_PHP_84_LAZY_OBJECTS="0"
 PHPUNIT_VERSION="12" # allowed values: 9, 10, 11, 12
+
+# Only relevant for "reset-database" testsuite
+DATABASE_RESET_MODE="schema" # allowed values: schema, migrate
+
+# Only relevant for "reset-database" testsuite with DATABASE_RESET_MODE="migrate"
+MIGRATION_CONFIGURATION_FILES=[]
+#MIGRATION_CONFIGURATION_FILES=["tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php"]
+#MIGRATION_CONFIGURATION_FILES=["tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php", "tests/Fixture/ResetDatabase/migration-configs/migration-dummy.php"]
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -120,19 +120,25 @@ jobs:
         database: [ mysql, pgsql, sqlite, mysql|mongo ]
         use-dama: [ 0, 1 ]
         reset-database-mode: [ schema, migrate ]
-        migration-configuration-file: ['no']
+        migration-configuration-file: ['[]']
         deps: [ highest, lowest ]
         include:
-          - { database: mongo, migration-configuration-file: 'no', use-dama: 0, reset-database-mode: schema }
-          - { database: pgsql, migration-configuration-file: 'migration-configuration', use-dama: 0, reset-database-mode: migration }
-          - { database: pgsql, migration-configuration-file: 'migration-configuration-transactional', use-dama: 0, reset-database-mode: migration }
+          - { database: mongo, migration-configuration-file: '[]', use-dama: 0, reset-database-mode: schema }
+          - { database: pgsql, migration-configuration-file: '["tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php"]', use-dama: 0, reset-database-mode: migrate }
+          - { database: pgsql, migration-configuration-file: '["tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php"]', use-dama: 0, reset-database-mode: migrate }
+          -
+            database: pgsql
+            use-dama: 0
+            reset-database-mode: migrate
+            migration-configuration-file: '["tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php", "tests/Fixture/ResetDatabase/migration-configs/migration-dummy.php"]'
+            deps: highest
     env:
       DATABASE_URL: ${{ contains(matrix.database, 'mysql') && 'mysql://root:root@localhost:3306/foundry?serverVersion=5.7.42' || contains(matrix.database, 'pgsql') && 'postgresql://root:root@localhost:5432/foundry?serverVersion=15' || 'sqlite:///%kernel.project_dir%/var/data.db' }}
       MONGO_URL: ${{ contains(matrix.database, 'mongo') && 'mongodb://127.0.0.1:27017/dbName?compressors=disabled&amp;gssapiServiceName=mongodb' || '' }}
       USE_DAMA_DOCTRINE_TEST_BUNDLE: ${{ matrix.use-dama == 1 && 1 || 0 }}
-      DATABASE_RESET_MODE: ${{ matrix.reset-database-mode == 1 && 1 || 0 }}
-      MIGRATION_CONFIGURATION_FILE: ${{ matrix.migration-configuration-file == 'no' && '' || format('tests/Fixture/MigrationTests/configs/{0}.php', matrix.migration-configuration-file) }}
-      PHPUNIT_VERSION: 11
+      DATABASE_RESET_MODE: ${{ matrix.reset-database-mode }}
+      MIGRATION_CONFIGURATION_FILES: ${{ matrix.migration-configuration-file }}
+      PHPUNIT_VERSION: 12
     services:
       postgres:
         image: ${{ contains(matrix.database, 'pgsql') && 'postgres:15' || '' }}
@@ -180,7 +186,7 @@ jobs:
 
           # We should be able to run the tests twice in order to check if the second run also starts from a fresh db
           # some bugs could be detected this way
-          ./phpunit --testsuite reset-database --bootstrap tests/bootstrap-reset-database.php
+          DATABASE_GENERATE_MIGRATIONS=0 ./phpunit --testsuite reset-database --bootstrap tests/bootstrap-reset-database.php
         shell: bash
 
   test-no-framework:
@@ -293,7 +299,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.2
+          php-version: 8.4
           coverage: xdebug
           ini-values: xdebug.mode=coverage
 
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ $ composer update
 $ ./phpunit
 
 # run "migrate" testsuite (with "migrate" reset database strategy)
-$ ./phpunit --testsuite reset-database
+$ ./phpunit --testsuite reset-database --bootstrap tests/bootstrap-reset-database.php
 ```
 
 ### Overriding the default configuration
@@ -73,7 +73,7 @@ PHPUNIT_VERSION="11" # possible values: 9, 10, 11, 11.4
 
 # test reset database with migrations,
 # only relevant for "reset-database" testsuite
-MIGRATION_CONFIGURATION_FILE="tests/Fixture/MigrationTests/configs/migration-configuration.php"
+MIGRATION_CONFIGURATION_FILES="[\"tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php\"]"
 
 # run test suite with postgreSQL
 $ vendor/bin/phpunit
diff --git a/composer.json b/composer.json
@@ -33,6 +33,7 @@
         "doctrine/common": "^3.2.2",
         "doctrine/doctrine-bundle": "^2.10",
         "doctrine/doctrine-migrations-bundle": "^2.2|^3.0",
+        "doctrine/migrations": "dev-feat/unfroze-dependencies-after-command as 3.9.5",
         "doctrine/mongodb-odm": "^2.4",
         "doctrine/mongodb-odm-bundle": "^4.6|^5.0",
         "doctrine/orm": "^2.16|^3.0",
@@ -64,6 +65,12 @@
             "src/symfony_console.php"
         ]
     },
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/nikophil/migrations"
+        }
+    ],
     "autoload-dev": {
         "psr-4": {
             "Zenstruck\\Foundry\\Tests\\": ["tests/"],
diff --git a/tests/Fixture/DoctrineCascadeRelationship/DoctrineCascadeRelationshipMetadata.php b/tests/Fixture/DoctrineCascadeRelationship/DoctrineCascadeRelationshipMetadata.php
@@ -56,7 +56,7 @@ public static function allCombinations(array $relationshipFields): iterable
         if (!\getenv('USE_DAMA_DOCTRINE_TEST_BUNDLE')) {
             $metadata = self::fromArray($relationshipFields[0]);
 
-            yield "{$metadata}\n" => [$metadata];
+            yield "{$metadata}" => [$metadata];
 
             return;
         }
diff --git a/tests/Fixture/FoundryTestKernel.php b/tests/Fixture/FoundryTestKernel.php
@@ -60,11 +60,6 @@ public static function hasMongo(): bool
         return (bool) \getenv('MONGO_URL');
     }
 
-    public static function usesMigrations(): bool
-    {
-        return 'migrate' === \getenv('DATABASE_RESET_MODE');
-    }
-
     public static function usesDamaDoctrineTestBundle(): bool
     {
         return (bool) \getenv('USE_DAMA_DOCTRINE_TEST_BUNDLE');
diff --git a/tests/Fixture/ResetDatabase/DummyMigration.php b/tests/Fixture/ResetDatabase/DummyMigration.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace Zenstruck\Foundry\Tests\Fixture\ResetDatabase;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+final class DummyMigration extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return 'Dummy migration to test migration reset with multiple configuration files.';
+    }
+
+    public function up(Schema $schema): void
+    {
+        $this->addSql('INSERT INTO address (city) VALUES (\'city\')');
+    }
+}
diff --git a/tests/Fixture/ResetDatabase/ResetDatabaseTestKernel.php b/tests/Fixture/ResetDatabase/ResetDatabaseTestKernel.php
@@ -28,7 +28,7 @@ public function registerBundles(): iterable
     {
         yield from parent::registerBundles();
 
-        if (FoundryTestKernel::usesMigrations()) {
+        if (self::usesMigrations()) {
             yield new DoctrineMigrationsBundle();
         }
     }
@@ -38,23 +38,25 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
         parent::configureContainer($c, $loader);
 
         $c->loadFromExtension('zenstruck_foundry', [
+            'persistence' => ['flush_once' => true],
+            'enable_auto_refresh_with_lazy_objects' => self::usePHP84LazyObjects(),
             'global_state' => [
                 GlobalStory::class,
                 GlobalInvokableService::class,
             ],
             'orm' => [
-                'reset' => FoundryTestKernel::usesMigrations()
+                'reset' => self::usesMigrations()
                         ? [
                             'mode' => ResetDatabaseMode::MIGRATE,
                             'migrations' => [
-                                'configurations' => ($configFile = \getenv('MIGRATION_CONFIGURATION_FILE')) ? [$configFile] : [],
+                                'configurations' => ($configFile = self::migrationFiles()) ? $configFile : [],
                             ],
                         ]
                         : ['mode' => ResetDatabaseMode::SCHEMA],
             ],
         ]);
 
-        if (FoundryTestKernel::usesMigrations() && !\getenv('MIGRATION_CONFIGURATION_FILE')) {
+        if (self::usesMigrations() && self::migrationFiles() === []) {
             // if no configuration file was given in Foundry's config, let's use the main one as default.
             $c->loadFromExtension(
                 'doctrine_migrations',
@@ -76,4 +78,34 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
             $c->register(MongoResetterDecorator::class)->setAutowired(true)->setAutoconfigured(true);
         }
     }
+
+    public static function usesMigrations(): bool
+    {
+        return 'migrate' === \getenv('DATABASE_RESET_MODE');
+    }
+
+    public static function shouldGenerateMigrations(): bool
+    {
+        return '0' !== \getenv('DATABASE_GENERATE_MIGRATIONS');
+    }
+
+    /**
+     * @return list<string>
+     */
+    public static function migrationFiles(): array
+    {
+        $files = json_decode(\getenv('MIGRATION_CONFIGURATION_FILES')?: '[]', flags: JSON_THROW_ON_ERROR);
+
+        if (!\is_array($files)) {
+            throw new \InvalidArgumentException('MIGRATION_CONFIGURATION_FILES must be a JSON array.');
+        }
+
+        foreach ($files as $file) {
+            if (!\file_exists($file)) {
+                throw new \InvalidArgumentException(\sprintf('Migration configuration file "%s" does not exist.', $file));
+            }
+        }
+
+        return $files; // @phpstan-ignore return.type
+    }
 }
diff --git a/tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php b/tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php
@@ -11,7 +11,7 @@
 
 return [
     'migrations_paths' => [
-        'Zenstruck\\Foundry\\Tests\\Fixture\\ResetDatabase\\Migrations' => \dirname(__DIR__, 4).'/var/cache/Migrations',
+        'Zenstruck\\Foundry\\Tests\\Fixture\\ResetDatabase\\Migrations' => \dirname(__DIR__, 4).'/var/Migrations',
     ],
     'transactional' => true,
 ];
diff --git a/tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php b/tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php
@@ -11,7 +11,7 @@
 
 return [
     'migrations_paths' => [
-        'Zenstruck\\Foundry\\Tests\\Fixture\\ResetDatabase\\Migrations' => \dirname(__DIR__, 4).'/var/cache/Migrations',
+        'Zenstruck\\Foundry\\Tests\\Fixture\\ResetDatabase\\Migrations' => \dirname(__DIR__, 4).'/var/Migrations',
     ],
     'transactional' => false,
 ];
diff --git a/tests/Fixture/ResetDatabase/migration-configs/migration-dummy.php b/tests/Fixture/ResetDatabase/migration-configs/migration-dummy.php
@@ -0,0 +1,17 @@
+<?php
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <kevinbond@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+return [
+    'migrations_paths' => [
+        'Zenstruck\\Foundry\\Tests\\Fixture\\ResetDatabase' => \dirname(__DIR__),
+    ],
+    'transactional' => false,
+];
diff --git a/tests/Integration/ResetDatabase/ResetDatabaseTest.php b/tests/Integration/ResetDatabase/ResetDatabaseTest.php
@@ -26,6 +26,8 @@
 use Zenstruck\Foundry\Tests\Fixture\ResetDatabase\MongoResetterDecorator;
 use Zenstruck\Foundry\Tests\Fixture\ResetDatabase\OrmResetterDecorator;
 
+use Zenstruck\Foundry\Tests\Fixture\ResetDatabase\ResetDatabaseTestKernel;
+
 use function Zenstruck\Foundry\Persistence\persist;
 use function Zenstruck\Foundry\Persistence\repository;
 
@@ -48,15 +50,7 @@ public function it_generates_valid_schema(): void
             $output = new BufferedOutput()
         );
 
-        if (FoundryTestKernel::usesMigrations()) {
-            // The command actually fails, because of a bug in doctrine ORM 3!
-            // https://github.com/doctrine/migrations/issues/1406
-            self::assertSame(2, $exit, \sprintf('Schema is not valid: %s', $commandOutput = $output->fetch()));
-            self::assertStringContainsString('1 schema diff(s) detected', $commandOutput);
-            self::assertStringContainsString('DROP TABLE doctrine_migration_versions', $commandOutput);
-        } else {
-            self::assertSame(0, $exit, \sprintf('Schema is not valid: %s', $output->fetch()));
-        }
+        self::assertSame(0, $exit, \sprintf('Schema is not valid: %s', $output->fetch()));
     }
 
     /**
diff --git a/tests/bootstrap-reset-database.php b/tests/bootstrap-reset-database.php
@@ -11,7 +11,6 @@
 
 use Symfony\Component\Dotenv\Dotenv;
 use Symfony\Component\Filesystem\Filesystem;
-use Zenstruck\Foundry\Tests\Fixture\FoundryTestKernel;
 use Zenstruck\Foundry\Tests\Fixture\ResetDatabase\ResetDatabaseTestKernel;
 
 use function Zenstruck\Foundry\application;
@@ -25,8 +24,9 @@
 
 (new Dotenv())->usePutenv()->loadEnv(__DIR__.'/../.env');
 
-if (FoundryTestKernel::usesMigrations()) {
-    $fs->mkdir(__DIR__.'/../var/cache/Migrations');
+if (ResetDatabaseTestKernel::usesMigrations() && ResetDatabaseTestKernel::shouldGenerateMigrations()) {
+    $fs->remove(__DIR__.'/../var/Migrations');
+    $fs->mkdir(__DIR__.'/../var/Migrations');
 
     $kernel = new ResetDatabaseTestKernel('test', true);
     $kernel->boot();
@@ -36,11 +36,17 @@
     runCommand($application, 'doctrine:database:drop --if-exists --force', canFail: true);
     runCommand($application, 'doctrine:database:create', canFail: true);
 
-    $configuration = '';
-    if (\getenv('MIGRATION_CONFIGURATION_FILE')) {
-        $configuration = '--configuration '.\getcwd().'/'.\getenv('MIGRATION_CONFIGURATION_FILE');
+    $configurationFiles = ResetDatabaseTestKernel::migrationFiles();
+
+    if (!$configurationFiles) {
+        runCommand($application, "doctrine:migrations:diff");
+    } else {
+        foreach ($configurationFiles as $configurationFile) {
+            $configuration = '--configuration '.\getcwd()."/{$configurationFile}";
+            runCommand($application, "doctrine:migrations:diff {$configuration}");
+        }
     }
-    runCommand($application, "doctrine:migrations:diff {$configuration}");
+
     runCommand($application, 'doctrine:database:drop --force', canFail: true);
 
     $kernel->shutdown();

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public static function allCombinations(array $relationshipFields): iterable`
`56`	`56`	`if (!\getenv('USE_DAMA_DOCTRINE_TEST_BUNDLE')) {`
`57`	`57`	`$metadata = self::fromArray($relationshipFields[0]);`
`58`	`58`
`59`		`- yield "{$metadata}\n" => [$metadata];`
	`59`	`+ yield "{$metadata}" => [$metadata];`
`60`	`60`
`61`	`61`	`return;`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,11 +60,6 @@ public static function hasMongo(): bool`
`60`	`60`	`return (bool) \getenv('MONGO_URL');`
`61`	`61`	`}`
`62`	`62`
`63`		`- public static function usesMigrations(): bool`
`64`		`- {`
`65`		`- return 'migrate' === \getenv('DATABASE_RESET_MODE');`
`66`		`- }`
`67`		`-`
`68`	`63`	`public static function usesDamaDoctrineTestBundle(): bool`
`69`	`64`	`{`
`70`	`65`	`return (bool) \getenv('USE_DAMA_DOCTRINE_TEST_BUNDLE');`