feat(faker): Improve reproducibility with faker

bin/console

@@ -6,5 +6,13 @@ use Zenstruck\Foundry\Tests\Fixture\TestKernel;
 
 require_once __DIR__ . '/../tests/bootstrap.php';
 
-$application = new Application(new TestKernel('test', true));
+foreach ($argv ?? [] as $i => $arg) {
+    if (($arg === '--env' || $arg === '-e') && isset($argv[$i + 1])) {
+        $_ENV['APP_ENV'] = $argv[$i + 1];
+        break;
+    }
+}
+
+$application = new Application(new TestKernel($_ENV['APP_ENV'], true));
+
 $application->run();

config/services.php

@@ -33,6 +33,7 @@
             service('.zenstruck_foundry.story_registry'),
             service('.zenstruck_foundry.persistence_manager')->nullOnInvalid(),
             service('event_dispatcher'),
+            '%env(default:zenstruck_foundry.faker.seed:int:FOUNDRY_FAKER_SEED)%',
         ])
         ->public()
     ;

src/Configuration.php

@@ -43,6 +43,8 @@ final class Configuration
     /** @var \Closure():self|self|null */
     private static \Closure|self|null $instance = null;
 
+    private static int|null $fakerSeed = null;
+
     /**
      * @phpstan-param InstantiatorCallable $instantiator
      */
@@ -53,10 +55,23 @@ public function __construct(
         public readonly StoryRegistry $stories,
         private readonly ?PersistenceManager $persistence = null,
         private readonly ?EventDispatcherInterface $eventDispatcher = null,
+        int|null $forcedFakerSeed = null,
     ) {
+        $this->faker->seed(self::fakerSeed($forcedFakerSeed));
+
         $this->instantiator = $instantiator;
     }
 
+    public static function fakerSeed(int|null $forcedFakerSeed = null): int
+    {
+        return self::$fakerSeed ??= ($forcedFakerSeed ?? random_int(0, 1000000));
+    }
+
+    public static function resetFakerSeed(): void
+    {
+        self::$fakerSeed = null;
+    }
+
     /**
      * @throws PersistenceNotAvailable
      */

src/PHPUnit/DisplayFakerSeedOnTestSuiteFinished.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\PHPUnit;
+
+use PHPUnit\Event\TestRunner\Finished;
+use PHPUnit\Event\TestRunner\FinishedSubscriber;
+use Zenstruck\Foundry\Configuration;
+
+final class DisplayFakerSeedOnTestSuiteFinished implements FinishedSubscriber
+{
+    public function notify(Finished $event): void
+    {
+        echo "\n\nFaker seed: ". Configuration::fakerSeed(); // @phpstan-ignore ekinoBannedCode.expression
+    }
+}

src/PHPUnit/FoundryExtension.php

@@ -34,7 +34,7 @@ public function bootstrap(
             Configuration::shutdown();
         }
 
-        $subscribers = [new BuildStoryOnTestPrepared()];
+        $subscribers = [new BuildStoryOnTestPrepared(), new DisplayFakerSeedOnTestSuiteFinished()];
 
         if (ConstraintRequirement::from('>=11.4')->isSatisfiedBy(Runner\Version::id())) {
             // those deal with data provider events which can be useful only if PHPUnit >=11.4 is used

src/Test/UnitTestConfig.php

@@ -51,6 +51,7 @@ public static function build(): Configuration
             $faker,
             self::$instantiator ?? Instantiator::withConstructor(),
             new StoryRegistry([]),
+            forcedFakerSeed: $_SERVER['FOUNDRY_FAKER_SEED'] ?? $_ENV['FOUNDRY_FAKER_SEED'] ?? (getenv('FOUNDRY_FAKER_SEED') ?: null)
         );
     }
 }

src/ZenstruckFoundryBundle.php

@@ -61,6 +61,7 @@ public function configure(DefinitionConfigurator $definition): void
                             ->defaultNull()
                         ->end()
                         ->scalarNode('seed')
+                            ->setDeprecated('zenstruck/foundry', '2.4', 'The "faker.seed" configuration is deprecated and will be removed in 3.0. Use environment variable "FOUNDRY_FAKER_SEED" instead.')
                             ->info('Random number generator seed to produce the same fake values every run.')
                             ->example(1234)
                             ->defaultNull()
@@ -404,8 +405,6 @@ private function configureFaker(array $config, ContainerBuilder $container): voi
             $definition->addArgument($config['locale']);
         }
 
-        if ($config['seed']) {
-            $definition->addMethodCall('seed', [$config['seed']]);
-        }
+        $container->setParameter('zenstruck_foundry.faker.seed', $config['seed']);
     }
 }

tests/Fixture/config/faker_seed_env_var.yaml

@@ -0,0 +1,2 @@
+parameters:
+    env(FOUNDRY_FAKER_SEED): 1234

tests/Fixture/config/faker_seed_legacy_config.yaml

@@ -0,0 +1,3 @@
+zenstruck_foundry:
+    faker:
+        seed: 1234

tests/Integration/Faker/FakerSeedAutomaticallySetKernelTest.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Tests\Integration\Faker;
+
+use PHPUnit\Framework\Attributes\Depends;
+use PHPUnit\Framework\Attributes\RequiresPhpunit;
+use PHPUnit\Framework\Attributes\Test;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Test\Factories;
+use Zenstruck\Foundry\Test\ResetDatabase;
+
+/**
+ * @author Nicolas PHILIPPE <[email protected]>
+ * @requires PHPUnit >=11.0
+ */
+#[RequiresPhpunit('>=11.0')]
+final class FakerSeedAutomaticallySetKernelTest extends KernelTestCase
+{
+    use Factories, ResetDatabase, FakerTestTrait;
+
+    #[Test]
+    public function faker_seed_does_not_change(): void
+    {
+        self::$currentSeed = Configuration::fakerSeed();
+
+        self::assertSame(self::$currentSeed, Configuration::fakerSeed());
+    }
+
+    #[Test]
+    #[Depends('faker_seed_does_not_change')]
+    public function faker_seed_does_not_change_between_tests(): void
+    {
+        self::assertSame(self::$currentSeed, Configuration::fakerSeed());
+    }
+}

tests/Integration/Faker/FakerSeedAutomaticallySetUnitTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Tests\Integration\Faker;
+
+use PHPUnit\Framework\Attributes\Depends;
+use PHPUnit\Framework\Attributes\RequiresPhpunit;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Test\Factories;
+
+/**
+ * @author Nicolas PHILIPPE <[email protected]>
+ * @requires PHPUnit >=11.0
+ */
+#[RequiresPhpunit('>=11.0')]
+final class FakerSeedAutomaticallySetUnitTest extends TestCase
+{
+    use Factories, FakerTestTrait;
+
+    #[Test]
+    public function faker_seed_does_not_change(): void
+    {
+        self::$currentSeed = Configuration::fakerSeed();
+
+        self::assertSame(self::$currentSeed, Configuration::fakerSeed());
+    }
+
+    #[Test]
+    #[Depends('faker_seed_does_not_change')]
+    public function faker_seed_does_not_change_between_tests(): void
+    {
+        self::assertSame(self::$currentSeed, Configuration::fakerSeed());
+    }
+}

tests/Integration/Faker/FakerSeedSetFromEnvVarKernelTest.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Tests\Integration\Faker;
+
+use PHPUnit\Framework\Attributes\Depends;
+use PHPUnit\Framework\Attributes\RequiresPhpunit;
+use PHPUnit\Framework\Attributes\Test;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Test\Factories;
+use Zenstruck\Foundry\Test\ResetDatabase;
+use Zenstruck\Foundry\Tests\Fixture\Factories\Entity\Address\AddressFactory;
+
+/**
+ * @author Nicolas PHILIPPE <[email protected]>
+ * @requires PHPUnit >=11.0
+ */
+#[RequiresPhpunit('>=11.0')]
+final class FakerSeedSetFromEnvVarKernelTest extends KernelTestCase
+{
+    use Factories, ResetDatabase, FakerTestTrait;
+
+    #[Test]
+    public function faker_seed_can_be_set_by_environment_variable(): void
+    {
+        // let's fake, we're starting from a fresh kernel
+        $this->tearDown();
+        Configuration::shutdown();
+        Configuration::resetFakerSeed();
+
+        self::bootKernel(['environment' => 'faker_seed_env_var']);
+
+        self::assertSame(1234, Configuration::fakerSeed());
+    }
+
+    #[Test]
+    #[Depends('faker_seed_can_be_set_by_environment_variable')]
+    public function faker_seed_is_already_set(): void
+    {
+        self::assertSame(1234, Configuration::fakerSeed());
+    }
+}

tests/Integration/Faker/FakerSeedSetFromEnvVarUnitTest.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Tests\Integration\Faker;
+
+use PHPUnit\Framework\Attributes\AfterClass;
+use PHPUnit\Framework\Attributes\Before;
+use PHPUnit\Framework\Attributes\Depends;
+use PHPUnit\Framework\Attributes\RequiresPhpunit;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Test\Factories;
+
+/**
+ * @author Nicolas PHILIPPE <[email protected]>
+ * @requires PHPUnit >=11.0
+ */
+#[RequiresPhpunit('>=11.0')]
+final class FakerSeedSetFromEnvVarUnitTest extends TestCase
+{
+    use Factories, FakerTestTrait;
+
+    #[Before(10)]
+    public static function __setEnv(): void
+    {
+        $_ENV['FOUNDRY_FAKER_SEED'] = $_SERVER['FOUNDRY_FAKER_SEED'] = '1234';
+    }
+
+    #[Test]
+    public function faker_seed_is_set_from_env_var(): void
+    {
+        self::assertSame(1234, Configuration::fakerSeed());
+    }
+
+    #[Test]
+    #[Depends('faker_seed_is_set_from_env_var')]
+    public function faker_seed_does_not_change(): void
+    {
+        self::assertSame(1234, Configuration::fakerSeed());
+    }
+
+    #[AfterClass(-9)]
+    public static function __resetFakerSeedEnv(): void
+    {
+        unset($_ENV['FOUNDRY_FAKER_SEED'], $_SERVER['FOUNDRY_FAKER_SEED']);
+    }
+}

tests/Integration/Faker/FakerSeedSetFromLegacyConfigKernelTest.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Tests\Integration\Faker;
+
+use PHPUnit\Framework\Attributes\Depends;
+use PHPUnit\Framework\Attributes\IgnoreDeprecations;
+use PHPUnit\Framework\Attributes\RequiresPhpunit;
+use PHPUnit\Framework\Attributes\Test;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Test\Factories;
+use Zenstruck\Foundry\Test\ResetDatabase;
+use Zenstruck\Foundry\Tests\Fixture\Factories\Entity\Address\AddressFactory;
+
+/**
+ * @author Nicolas PHILIPPE <[email protected]>
+ * @requires PHPUnit >=11.0
+ */
+#[RequiresPhpunit('>=11.0')]
+final class FakerSeedSetFromLegacyConfigKernelTest extends KernelTestCase
+{
+    use Factories, ResetDatabase, FakerTestTrait;
+
+    #[Test]
+    #[IgnoreDeprecations]
+    public function test_faker_seed_by_configuration_is_deprecated(): void
+    {
+        // let's fake, we're starting from a fresh kernel
+        $this->tearDown();
+        Configuration::shutdown();
+        Configuration::resetFakerSeed();
+
+        self::bootKernel(['environment' => 'faker_seed_legacy_config']);
+
+        self::expectUserDeprecationMessageMatches(
+            '/The "faker.seed" configuration is deprecated and will be removed in 3.0/'
+        );
+
+        self::assertSame(1234, Configuration::fakerSeed());
+    }
+
+    #[Test]
+    #[Depends('test_faker_seed_by_configuration_is_deprecated')]
+    public function faker_seed_is_already_set(): void
+    {
+        self::assertSame(1234, Configuration::fakerSeed());
+    }
+}

tests/Integration/Faker/FakerTestTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Zenstruck\Foundry\Tests\Integration\Faker;
+
+use PHPUnit\Framework\Attributes\AfterClass;
+use PHPUnit\Framework\Attributes\BeforeClass;
+use Zenstruck\Foundry\Configuration;
+
+trait FakerTestTrait
+{
+    private static int|null $currentSeed = null;
+    private static int|null $savedSeed = null;
+
+    #[BeforeClass(10)]
+    public static function __saveAndResetFakerSeed(): void
+    {
+        self::$savedSeed = Configuration::fakerSeed();
+
+        self::$currentSeed = null;
+        Configuration::resetFakerSeed();
+    }
+
+    #[AfterClass(-10)]
+    public static function __restoreSeed(): void
+    {
+        Configuration::resetFakerSeed();
+        Configuration::fakerSeed(self::$savedSeed);
+    }
+}