[FrameworkBundle] Fix stale container after reboot in KernelTestCase

nicolas-grekas · nicolas-grekas · commit c94226ef7919 · 2026-03-04T23:11:56.000+01:00
diff --git a/Test/KernelTestCase.php b/Test/KernelTestCase.php
@@ -12,10 +12,12 @@
 namespace Symfony\Bundle\FrameworkBundle\Test;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Config\Resource\SelfCheckingResourceChecker;
 use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Contracts\Service\ResetInterface;
 
@@ -38,6 +40,8 @@ abstract class KernelTestCase extends TestCase
 
     protected static $booted = false;
 
+    private static bool $kernelHasBeenRebooted = false;
+
     protected function tearDown(): void
     {
         static::ensureKernelShutdown();
@@ -88,6 +92,7 @@ protected static function bootKernel(array $options = []): KernelInterface
         // reboot a fresh one.
         if ($kernel->getContainer()->initialized('cache_warmer')) {
             static::ensureKernelShutdown();
+            self::$kernelHasBeenRebooted = true;
 
             $kernel = static::createKernel($options);
             $kernel->boot();
@@ -161,6 +166,20 @@ protected static function ensureKernelShutdown()
             static::$kernel->shutdown();
             static::$booted = false;
 
+            if (self::$kernelHasBeenRebooted) {
+                self::$kernelHasBeenRebooted = false;
+                try {
+                    (new \ReflectionProperty(Kernel::class, 'freshCache'))->setValue(null, []);
+                } catch (\ReflectionException) {
+                    // ignore if the property doesn't exist
+                }
+                try {
+                    (new \ReflectionProperty(SelfCheckingResourceChecker::class, 'cache'))->setValue(null, []);
+                } catch (\ReflectionException) {
+                    // ignore if the property doesn't exist
+                }
+            }
+
             if ($container instanceof ResetInterface) {
                 $container->reset();
             }
diff --git a/Tests/Functional/KernelTestCaseFreshCacheTest.php b/Tests/Functional/KernelTestCaseFreshCacheTest.php
@@ -0,0 +1,82 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
+
+use Symfony\Component\HttpKernel\KernelInterface;
+
+class KernelTestCaseFreshCacheTest extends AbstractWebTestCase
+{
+    private static string $trackedFile;
+
+    public static function setUpBeforeClass(): void
+    {
+        parent::setUpBeforeClass();
+
+        self::$trackedFile = sys_get_temp_dir().'/'.static::getVarDir().'/tracked_file.yaml';
+    }
+
+    public static function tearDownAfterClass(): void
+    {
+        parent::tearDownAfterClass();
+
+        @unlink(self::$trackedFile);
+    }
+
+    public function testContainerIsRebuiltWhenTrackedFileAppears()
+    {
+        @unlink(self::$trackedFile);
+
+        // First boot: container is built tracking the file as non-existing
+        static::bootKernel(['test_case' => 'TestServiceContainer', 'debug' => true]);
+
+        $this->assertFalse(static::$kernel->getContainer()->getParameter('tracked_file_existed'));
+
+        static::ensureKernelShutdown();
+
+        // Create the tracked file between boots
+        @mkdir(\dirname(self::$trackedFile), 0777, true);
+        file_put_contents(self::$trackedFile, 'placeholder');
+
+        // Reboot: should detect the resource change and rebuild the container
+        static::bootKernel(['test_case' => 'TestServiceContainer', 'debug' => true]);
+
+        $this->assertTrue(static::$kernel->getContainer()->getParameter('tracked_file_existed'));
+    }
+
+    protected static function createKernel(array $options = []): KernelInterface
+    {
+        $kernel = parent::createKernel($options);
+
+        FileExistenceTrackingKernel::$trackedFile = self::$trackedFile;
+
+        return $kernel;
+    }
+
+    protected static function getKernelClass(): string
+    {
+        require_once __DIR__.'/app/AppKernel.php';
+
+        return FileExistenceTrackingKernel::class;
+    }
+}
+
+class FileExistenceTrackingKernel extends app\AppKernel
+{
+    public static string $trackedFile;
+
+    protected function build(\Symfony\Component\DependencyInjection\ContainerBuilder $container): void
+    {
+        parent::build($container);
+
+        $container->setParameter('tracked_file_existed', $container->fileExists(self::$trackedFile));
+    }
+}
