Skip to content

Commit 22fe4e9

Browse files
nikophilnikophil
committed
tests: add test permutation with multiple migration configuration files
1 parent 55f2689 commit 22fe4e9

20 files changed

+171
-87
lines changed

‎.env‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,11 @@ USE_DAMA_DOCTRINE_TEST_BUNDLE="0"
1111
USE_FOUNDRY_PHPUNIT_EXTENSION="0"
1212
USE_PHP_84_LAZY_OBJECTS="0"
1313
PHPUNIT_VERSION="12" # allowed values: 9, 10, 11, 12
14+
15+
# Only relevant for "reset-database" testsuite
16+
DATABASE_RESET_MODE="schema" # allowed values: schema, migrate
17+
18+
# Only relevant for "reset-database" testsuite with DATABASE_RESET_MODE="migrate"
19+
MIGRATION_CONFIGURATION_FILES=[]
20+
#MIGRATION_CONFIGURATION_FILES=["tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php"]
21+
#MIGRATION_CONFIGURATION_FILES=["tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php", "tests/Fixture/ResetDatabase/migration-configs/migration-dummy.php"]

‎.github/workflows/ci.yml‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -120,19 +120,25 @@ jobs:
120120
database: [ mysql, pgsql, sqlite, mysql|mongo ]
121121
use-dama: [ 0, 1 ]
122122
reset-database-mode: [ schema, migrate ]
123-
migration-configuration-file: ['no']
123+
migration-configuration-file: ['[]']
124124
deps: [ highest, lowest ]
125125
include:
126-
- { database: mongo, migration-configuration-file: 'no', use-dama: 0, reset-database-mode: schema }
127-
- { database: pgsql, migration-configuration-file: 'migration-configuration', use-dama: 0, reset-database-mode: migration }
128-
- { database: pgsql, migration-configuration-file: 'migration-configuration-transactional', use-dama: 0, reset-database-mode: migration }
126+
- { database: mongo, migration-configuration-file: '[]', use-dama: 0, reset-database-mode: schema }
127+
- { database: pgsql, migration-configuration-file: '["tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php"]', use-dama: 0, reset-database-mode: migrate }
128+
- { database: pgsql, migration-configuration-file: '["tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php"]', use-dama: 0, reset-database-mode: migrate }
129+
-
130+
database: pgsql
131+
use-dama: 0
132+
reset-database-mode: migrate
133+
migration-configuration-file: '["tests/Fixture/ResetDatabase/migration-configs/migration-configuration-transactional.php", "tests/Fixture/ResetDatabase/migration-configs/migration-dummy.php"]'
134+
deps: highest
129135
env:
130136
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' }}
131137
MONGO_URL: ${{ contains(matrix.database, 'mongo') && 'mongodb://127.0.0.1:27017/dbName?compressors=disabled&gssapiServiceName=mongodb' || '' }}
132138
USE_DAMA_DOCTRINE_TEST_BUNDLE: ${{ matrix.use-dama == 1 && 1 || 0 }}
133-
DATABASE_RESET_MODE: ${{ matrix.reset-database-mode == 1 && 1 || 0 }}
134-
MIGRATION_CONFIGURATION_FILE: ${{ matrix.migration-configuration-file == 'no' && '' || format('tests/Fixture/MigrationTests/configs/{0}.php', matrix.migration-configuration-file) }}
135-
PHPUNIT_VERSION: 11
139+
DATABASE_RESET_MODE: ${{ matrix.reset-database-mode }}
140+
MIGRATION_CONFIGURATION_FILES: ${{ matrix.migration-configuration-file }}
141+
PHPUNIT_VERSION: 12
136142
services:
137143
postgres:
138144
image: ${{ contains(matrix.database, 'pgsql') && 'postgres:15' || '' }}
@@ -176,11 +182,11 @@ jobs:
176182

177183
- name: Test
178184
run: |
179-
./phpunit --testsuite reset-database --bootstrap tests/bootstrap-reset-database.php
185+
./phpunit --testsuite reset-database
180186
181187
# We should be able to run the tests twice in order to check if the second run also starts from a fresh db
182188
# some bugs could be detected this way
183-
./phpunit --testsuite reset-database --bootstrap tests/bootstrap-reset-database.php
189+
DATABASE_GENERATE_MIGRATIONS=0 ./phpunit --testsuite reset-database
184190
shell: bash
185191

186192
test-no-framework:
@@ -267,7 +273,7 @@ jobs:
267273
MONGO_URL: mongodb://127.0.0.1:27017/dbName?compressors=disabled&gssapiServiceName=mongodb
268274
USE_DAMA_DOCTRINE_TEST_BUNDLE: 1
269275
USE_FOUNDRY_PHPUNIT_EXTENSION: 1
270-
PHPUNIT_VERSION: 11
276+
PHPUNIT_VERSION: 12
271277
services:
272278
mongo:
273279
image: mongo:4
@@ -293,7 +299,7 @@ jobs:
293299
- name: Setup PHP
294300
uses: shivammathur/setup-php@v2
295301
with:
296-
php-version: 8.2
302+
php-version: 8.4
297303
coverage: xdebug
298304
ini-values: xdebug.mode=coverage
299305

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ PHPUNIT_VERSION="11" # possible values: 9, 10, 11, 11.4
7373

7474
# test reset database with migrations,
7575
# only relevant for "reset-database" testsuite
76-
MIGRATION_CONFIGURATION_FILE="tests/Fixture/MigrationTests/configs/migration-configuration.php"
76+
MIGRATION_CONFIGURATION_FILES="[\"tests/Fixture/ResetDatabase/migration-configs/migration-configuration.php\"]"
7777

7878
# run test suite with postgreSQL
7979
$ vendor/bin/phpunit

‎composer.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
"doctrine/common": "^3.2.2",
3434
"doctrine/doctrine-bundle": "^2.10",
3535
"doctrine/doctrine-migrations-bundle": "^2.2|^3.0",
36+
"doctrine/migrations": "dev-feat/unfroze-dependencies-after-command as 3.9.5",
3637
"doctrine/mongodb-odm": "^2.4",
3738
"doctrine/mongodb-odm-bundle": "^4.6|^5.0",
3839
"doctrine/orm": "^2.16|^3.0",
@@ -64,6 +65,12 @@
6465
"src/symfony_console.php"
6566
]
6667
},
68+
"repositories": [
69+
{
70+
"type": "vcs",
71+
"url": "https://github.com/nikophil/migrations"
72+
}
73+
],
6774
"autoload-dev": {
6875
"psr-4": {
6976
"Zenstruck\\Foundry\\Tests\\": ["tests/"],

‎phpunit-10.xml.dist‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!-- https://phpunit.de/manual/current/en/appendixes.configuration.html -->
33
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4-
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd"
4+
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/12.3/phpunit.xsd"
55
bootstrap="tests/bootstrap.php"
66
colors="true"
77
failOnRisky="true"
@@ -16,11 +16,11 @@
1616
<env name="SYMFONY_DEPRECATIONS_HELPER" value="disabled"/>
1717
</php>
1818
<testsuites>
19-
<testsuite name="main">
19+
<testsuite name="main" bootstrap="tests/bootstrap.php">
2020
<directory>tests</directory>
2121
<exclude>tests/Integration/ResetDatabase</exclude>
2222
</testsuite>
23-
<testsuite name="reset-database">
23+
<testsuite name="reset-database" bootstrap="tests/bootstrap-reset-database.php">
2424
<directory>tests/Integration/ResetDatabase</directory>
2525
</testsuite>
2626
</testsuites>

‎tests/Fixture/DoctrineCascadeRelationship/ChangesEntityRelationshipCascadePersist.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ trait ChangesEntityRelationshipCascadePersist
3838
{
3939
use RequiresORM;
4040

41+
// Because we're handling the provided data manually in a #[Before] method,
42+
// PHPUnit triggers a warning, which we ignore with #[IgnorePhpunitWarnings]
43+
public const DATA_PROVIDER_WARNING_REGEX = 'Data set "(.)*" provided by Zenstruck(.)*::provideCascadeRelationshipsCombinations has more arguments \(\d\) than the test method accepts \(0\)';
44+
4145
private static string $methodName = '';
4246

4347
#[Before]

‎tests/Fixture/DoctrineCascadeRelationship/DoctrineCascadeRelationshipMetadata.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public static function allCombinations(array $relationshipFields): iterable
5656
if (!\getenv('USE_DAMA_DOCTRINE_TEST_BUNDLE')) {
5757
$metadata = self::fromArray($relationshipFields[0]);
5858

59-
yield "{$metadata}\n" => [$metadata];
59+
yield "{$metadata}" => [$metadata];
6060

6161
return;
6262
}

‎tests/Fixture/FoundryTestKernel.php‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,6 @@ public static function hasMongo(): bool
6060
return (bool) \getenv('MONGO_URL');
6161
}
6262

63-
public static function usesMigrations(): bool
64-
{
65-
return 'migrate' === \getenv('DATABASE_RESET_MODE');
66-
}
67-
6863
public static function usesDamaDoctrineTestBundle(): bool
6964
{
7065
return (bool) \getenv('USE_DAMA_DOCTRINE_TEST_BUNDLE');

‎tests/Fixture/ResetDatabase/DummyMigration.php‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?php
2+
3+
namespace Zenstruck\Foundry\Tests\Fixture\ResetDatabase;
4+
5+
use Doctrine\DBAL\Schema\Schema;
6+
use Doctrine\Migrations\AbstractMigration;
7+
8+
final class DummyMigration extends AbstractMigration
9+
{
10+
public function getDescription(): string
11+
{
12+
return 'Dummy migration to test migration reset with multiple configuration files.';
13+
}
14+
15+
public function up(Schema $schema): void
16+
{
17+
$this->addSql('INSERT INTO address (city) VALUES (\'city\')');
18+
}
19+
}

‎tests/Fixture/ResetDatabase/ResetDatabaseTestKernel.php‎

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public function registerBundles(): iterable
2828
{
2929
yield from parent::registerBundles();
3030

31-
if (FoundryTestKernel::usesMigrations()) {
31+
if (self::usesMigrations()) {
3232
yield new DoctrineMigrationsBundle();
3333
}
3434
}
@@ -38,23 +38,25 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
3838
parent::configureContainer($c, $loader);
3939

4040
$c->loadFromExtension('zenstruck_foundry', [
41+
'persistence' => ['flush_once' => true],
42+
'enable_auto_refresh_with_lazy_objects' => self::usePHP84LazyObjects(),
4143
'global_state' => [
4244
GlobalStory::class,
4345
GlobalInvokableService::class,
4446
],
4547
'orm' => [
46-
'reset' => FoundryTestKernel::usesMigrations()
48+
'reset' => self::usesMigrations()
4749
? [
4850
'mode' => ResetDatabaseMode::MIGRATE,
4951
'migrations' => [
50-
'configurations' => ($configFile = \getenv('MIGRATION_CONFIGURATION_FILE')) ? [$configFile] : [],
52+
'configurations' => ($configFile = self::migrationFiles()) ? $configFile : [],
5153
],
5254
]
5355
: ['mode' => ResetDatabaseMode::SCHEMA],
5456
],
5557
]);
5658

57-
if (FoundryTestKernel::usesMigrations() && !\getenv('MIGRATION_CONFIGURATION_FILE')) {
59+
if (self::usesMigrations() && self::migrationFiles() === []) {
5860
// if no configuration file was given in Foundry's config, let's use the main one as default.
5961
$c->loadFromExtension(
6062
'doctrine_migrations',
@@ -76,4 +78,34 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
7678
$c->register(MongoResetterDecorator::class)->setAutowired(true)->setAutoconfigured(true);
7779
}
7880
}
81+
82+
public static function usesMigrations(): bool
83+
{
84+
return 'migrate' === \getenv('DATABASE_RESET_MODE');
85+
}
86+
87+
public static function shouldGenerateMigrations(): bool
88+
{
89+
return '0' !== \getenv('DATABASE_GENERATE_MIGRATIONS');
90+
}
91+
92+
/**
93+
* @return list<string>
94+
*/
95+
public static function migrationFiles(): array
96+
{
97+
$files = json_decode(\getenv('MIGRATION_CONFIGURATION_FILES')?: '[]', flags: JSON_THROW_ON_ERROR);
98+
99+
if (!\is_array($files)) {
100+
throw new \InvalidArgumentException('MIGRATION_CONFIGURATION_FILES must be a JSON array.');
101+
}
102+
103+
foreach ($files as $file) {
104+
if (!\file_exists($file)) {
105+
throw new \InvalidArgumentException(\sprintf('Migration configuration file "%s" does not exist.', $file));
106+
}
107+
}
108+
109+
return $files; // @phpstan-ignore return.type
110+
}
79111
}

0 commit comments

Comments
 (0)