feat: force PHPUnit extension usage

Author: nikophil

phpunit-deprecation-baseline.xml

@@ -4,6 +4,8 @@
         <line number="25" hash="c6af5d66288d0667e424978000f29571e4954b81">
             <issue><![CDATA[Since symfony/framework-bundle 6.4: Not setting the "framework.php_errors.log" config option is deprecated. It will default to "true" in 7.0.]]></issue>
             <issue><![CDATA[Since symfony/var-exporter 7.3: Generating lazy proxy for class "Zenstruck\Foundry\Tests\Integration\ForceFactoriesTraitUsage\SomeObject" is deprecated; leverage native lazy objects instead.]]></issue>
+            <issue><![CDATA[Since zenstruck/foundry 2.7: Trait Zenstruck\Foundry\Test\Factories is deprecated and will be removed in Foundry 3.]]></issue>
+            <issue><![CDATA[Since zenstruck/foundry 2.7: Not using Foundry's PHPUnit extension is deprecated and will throw an error in Foundry 3.]]></issue>
         </line>
     </file>
 </files>

src/Configuration.php

@@ -19,6 +19,8 @@
 use Zenstruck\Foundry\InMemory\CannotEnableInMemory;
 use Zenstruck\Foundry\InMemory\InMemoryRepositoryRegistry;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
+use Zenstruck\Foundry\PHPUnit\FoundryExtension;
+use Zenstruck\Foundry\Test\Factories;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
@@ -128,6 +130,10 @@ public static function isBooted(): bool
     public static function boot(\Closure|self $configuration): void
     {
         self::$instance = $configuration;
+
+        if (FoundryExtension::shouldBeEnabled()) {
+            trigger_deprecation('zenstruck/foundry', '2.7', 'Not using Foundry\'s PHPUnit extension is deprecated and will throw an error in Foundry 3.');
+        }
     }
 
     /** @param \Closure():self|self $configuration */

src/Exception/FoundryNotBooted.php

@@ -11,13 +11,20 @@
 
 namespace Zenstruck\Foundry\Exception;
 
+use PHPUnit\Metadata\Version\ConstraintRequirement;
+use PHPUnit\Runner;
+
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
 final class FoundryNotBooted extends \LogicException
 {
     public function __construct()
     {
-        parent::__construct('Foundry is not yet booted. Ensure ZenstruckFoundryBundle is enabled. If in a test, ensure your TestCase has the Factories trait.');
+        $message = ConstraintRequirement::from('>=10')->isSatisfiedBy(Runner\Version::id())
+            ? 'Foundry is not yet booted. Ensure ZenstruckFoundryBundle is enabled. If in a test, ensure Foundry\'s PHPUnit extension is enabled.'
+            : 'Foundry is not yet booted. Ensure ZenstruckFoundryBundle is enabled. If in a test, ensure your TestCase has the Factories trait.';
+
+        parent::__construct($message);
     }
 }

src/PHPUnit/BootFoundryOnDataProviderMethodCalled.php

@@ -14,8 +14,11 @@
 namespace Zenstruck\Foundry\PHPUnit;
 
 use PHPUnit\Event;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Zenstruck\Foundry\Configuration;
 use Zenstruck\Foundry\InMemory\AsInMemoryTest;
+use Zenstruck\Foundry\Test\UnitTestConfig;
 
 /**
  * @internal
@@ -25,14 +28,38 @@ final class BootFoundryOnDataProviderMethodCalled implements Event\Test\DataProv
 {
     public function notify(Event\Test\DataProviderMethodCalled $event): void
     {
-        if (\method_exists($event->testMethod()->className(), '_bootForDataProvider')) {
-            $event->testMethod()->className()::_bootForDataProvider();
-        }
+        $this->bootFoundryForDataProvider($event->testMethod()->className());
 
         $testMethod = $event->testMethod();
 
         if (AsInMemoryTest::shouldEnableInMemory($testMethod->className(), $testMethod->methodName())) {
             Configuration::instance()->enableInMemory();
         }
     }
+
+    /**
+     * @param class-string $className
+     */
+    private function bootFoundryForDataProvider(string $className): void
+    {
+        if (!\is_subclass_of($className, TestCase::class)) {
+            return;
+        }
+
+        // unit test
+        if (!\is_subclass_of($className, KernelTestCase::class)) {
+            Configuration::bootForDataProvider(UnitTestConfig::build());
+
+            return;
+        }
+
+        // integration test
+        Configuration::bootForDataProvider(static function(): Configuration {
+            if (!KernelTestCaseHelper::getContainer()->has('.zenstruck_foundry.configuration')) {
+                throw new \LogicException('ZenstruckFoundryBundle is not enabled. Ensure it is added to your config/bundles.php.');
+            }
+
+            return KernelTestCaseHelper::getContainer()->get('.zenstruck_foundry.configuration'); // @phpstan-ignore return.type
+        });
+    }
 }

src/PHPUnit/BootFoundryOnPreparationStarted.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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.
+ */
+
+namespace Zenstruck\Foundry\PHPUnit;
+
+use PHPUnit\Event;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Zenstruck\Foundry\Configuration;
+use Zenstruck\Foundry\Test\UnitTestConfig;
+
+/**
+ * @internal
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ */
+final class BootFoundryOnPreparationStarted implements Event\Test\PreparationStartedSubscriber
+{
+    public function notify(Event\Test\PreparationStarted $event): void
+    {
+        if (!$event->test()->isTestMethod()) {
+            return;
+        }
+
+        $this->bootFoundry($event->test()->className());
+    }
+
+    /**
+     * @param class-string $className
+     */
+    private function bootFoundry(string $className): void
+    {
+        if (!\is_subclass_of($className, TestCase::class)) {
+            return;
+        }
+
+        // unit test
+        if (!\is_subclass_of($className, KernelTestCase::class)) {
+            Configuration::boot(UnitTestConfig::build());
+
+            return;
+        }
+
+        // integration test
+        Configuration::boot(static function(): Configuration {
+            if (!KernelTestCaseHelper::getContainer()->has('.zenstruck_foundry.configuration')) {
+                throw new \LogicException('ZenstruckFoundryBundle is not enabled. Ensure it is added to your config/bundles.php.');
+            }
+
+            return KernelTestCaseHelper::getContainer()->get('.zenstruck_foundry.configuration'); // @phpstan-ignore return.type
+        });
+    }
+}

src/PHPUnit/FoundryExtension.php

@@ -24,6 +24,8 @@
  */
 final class FoundryExtension implements Runner\Extension\Extension
 {
+    private static bool $enabled = false;
+
     public function bootstrap(
         TextUI\Configuration\Configuration $configuration,
         Runner\Extension\Facade $facade,
@@ -38,6 +40,8 @@ public function bootstrap(
             new BuildStoryOnTestPrepared(),
             new EnableInMemoryBeforeTest(),
             new DisplayFakerSeedOnTestSuiteFinished(),
+            new BootFoundryOnPreparationStarted(),
+            new ShutdownFoundryOnTestFinished(),
         ];
 
         if (ConstraintRequirement::from('>=11.4')->isSatisfiedBy(Runner\Version::id())) {
@@ -47,5 +51,17 @@ public function bootstrap(
         }
 
         $facade->registerSubscribers(...$subscribers);
+
+        self::$enabled = true;
+    }
+
+    public static function shouldBeEnabled(): bool
+    {
+        return !self::isEnabled() && ConstraintRequirement::from('>=10')->isSatisfiedBy(Runner\Version::id());
+    }
+
+    public static function isEnabled(): bool
+    {
+        return self::$enabled;
     }
 }

src/PHPUnit/KernelTestCaseHelper.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Zenstruck\Foundry\PHPUnit;
+
+use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\DependencyInjection\Container;
+
+final class KernelTestCaseHelper extends KernelTestCase
+{
+    public static function getContainer(): Container
+    {
+        return parent::getContainer();
+    }
+}

src/PHPUnit/ShutdownFoundryOnDataProviderMethodFinished.php

@@ -14,6 +14,7 @@
 namespace Zenstruck\Foundry\PHPUnit;
 
 use PHPUnit\Event;
+use Zenstruck\Foundry\Configuration;
 
 /**
  * @internal
@@ -23,8 +24,8 @@ final class ShutdownFoundryOnDataProviderMethodFinished implements Event\Test\Da
 {
     public function notify(Event\Test\DataProviderMethodFinished $event): void
     {
-        if (\method_exists($event->testMethod()->className(), '_shutdownAfterDataProvider')) {
-            $event->testMethod()->className()::_shutdownAfterDataProvider();
-        }
+        KernelTestCaseHelper::tearDownAfterClass();
+
+        Configuration::shutdown();
     }
 }

src/PHPUnit/ShutdownFoundryOnTestFinished.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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.
+ */
+
+namespace Zenstruck\Foundry\PHPUnit;
+
+use PHPUnit\Event;
+use Zenstruck\Foundry\Configuration;
+
+/**
+ * @internal
+ * @author Nicolas PHILIPPE <nikophil@gmail.com>
+ */
+final class ShutdownFoundryOnTestFinished implements Event\Test\FinishedSubscriber
+{
+    public function notify(Event\Test\Finished $event): void
+    {
+        Configuration::shutdown();
+    }
+}

src/Test/Factories.php

@@ -16,6 +16,8 @@
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Zenstruck\Foundry\Configuration;
 
+use Zenstruck\Foundry\PHPUnit\FoundryExtension;
+
 use function Zenstruck\Foundry\Persistence\initialize_proxy_object;
 
 /**
@@ -27,58 +29,31 @@ trait Factories
      * @internal
      * @before
      */
-    #[Before]
+    #[Before(10)]
     public function _beforeHook(): void
     {
-        $this->_bootFoundry();
-        $this->_loadDataProvidedProxies();
-    }
+        $this->_loadDataProvidedProxies(); // todo remove
 
-    /**
-     * @internal
-     * @after
-     */
-    #[After]
-    public static function _shutdownFoundry(): void
-    {
-        Configuration::shutdown();
-    }
-
-    /**
-     * @see \Zenstruck\Foundry\PHPUnit\BootFoundryOnDataProviderMethodCalled
-     * @internal
-     */
-    public static function _bootForDataProvider(): void
-    {
-        if (!\is_subclass_of(static::class, KernelTestCase::class)) { // @phpstan-ignore function.impossibleType, function.alreadyNarrowedType
-            // unit test
-            Configuration::bootForDataProvider(UnitTestConfig::build());
+        if (FoundryExtension::isEnabled()) {
+            trigger_deprecation('zenstruck/foundry', '2.7', sprintf('Trait %s is deprecated and will be removed in Foundry 3.', Factories::class));
 
             return;
         }
 
-        // integration test
-        Configuration::bootForDataProvider(static function(): Configuration {
-            if (!static::getContainer()->has('.zenstruck_foundry.configuration')) { // @phpstan-ignore staticMethod.notFound
-                throw new \LogicException('ZenstruckFoundryBundle is not enabled. Ensure it is added to your config/bundles.php.');
-            }
-
-            return static::getContainer()->get('.zenstruck_foundry.configuration'); // @phpstan-ignore staticMethod.notFound, return.type
-        });
+        $this->_bootFoundry();
     }
 
     /**
      * @internal
-     * @see \Zenstruck\Foundry\PHPUnit\ShutdownFoundryOnDataProviderMethodFinished
+     * @after
      */
-    public static function _shutdownAfterDataProvider(): void
+    #[After(10)]
+    public static function _shutdownFoundry(): void
     {
-        if (\is_subclass_of(static::class, KernelTestCase::class)) { // @phpstan-ignore function.impossibleType, function.alreadyNarrowedType
-            self::ensureKernelShutdown(); // @phpstan-ignore staticMethod.notFound
-            static::$class = null; // @phpstan-ignore staticProperty.notFound
-            static::$kernel = null; // @phpstan-ignore staticProperty.notFound
-            static::$booted = false; // @phpstan-ignore staticProperty.notFound
+        if (FoundryExtension::isEnabled()) {
+            return;
         }
+
         Configuration::shutdown();
     }