bug #34078 [FrameworkBundle] Don't reset the test container but the real one instead (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit bfd308ff4ada · 2019-10-23T11:00:45.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [FrameworkBundle] Don't reset the test container but the real one instead | Q | A | ------------- | --- | Branch? | 4.4 for features / 3.4 or 4.3 for bug fixes  | Bug fix? | yes/no | New feature? | yes/no  | Deprecations? | yes/no  | Tickets | Fix #...  | License | MIT | Doc PR | - After #31202 and #32056, the tearDown method keeps throwing deprecation notices about "Getting the container from a non-booted kernel". The reason is that resetting the test-container calls `$kernel->getContainer()` while the kernel has been shut down. This fixes it and a few other glitches found meanwhile. Commits ------- 8e16143 [FrameworkBundle] Dont reset the test container but the real one instead
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -93,7 +93,7 @@ Form
 FrameworkBundle
 ---------------
 
- * Deprecated booting the kernel before running `WebTestCase::createClient()`.
+ * Deprecated calling `WebTestCase::createClient()` while a kernel has been booted, ensure the kernel is shut down before calling the method
  * Deprecated support for `templating` engine in `TemplateController`, use Twig instead
  * The `$parser` argument of `ControllerResolver::__construct()` and `DelegatingLoader::__construct()`
    has been deprecated.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -222,8 +222,7 @@ Form
 FrameworkBundle
 ---------------
 
- * Dropped support for booting the kernel before running `WebTestCase::createClient()`. `createClient()` will throw an
-   exception if the kernel was already booted before.
+ * Calling `WebTestCase::createClient()` while a kernel has been booted now throws an exception, ensure the kernel is shut down before calling the method
  * Removed the `framework.templating` option, configure the Twig bundle instead.
  * The project dir argument of the constructor of `AssetsInstallCommand` is required.
  * Removed support for `bundle:controller:action` syntax to reference controllers. Use `serviceOrFqcn::method`
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -10,7 +10,7 @@ CHANGELOG
  * Deprecated the `controller_name_converter` and `resolve_controller_name_subscriber` services
  * The `ControllerResolver` and `DelegatingLoader` classes have been marked as `final`
  * Added support for configuring chained cache pools
- * Deprecated booting the kernel before running `WebTestCase::createClient()`
+ * Deprecated calling `WebTestCase::createClient()` while a kernel has been booted, ensure the kernel is shut down before calling the method
  * Deprecated `routing.loader.service`, use `routing.loader.container` instead.
  * Not tagging service route loaders with `routing.route_loader` has been deprecated.
  * Overriding the methods `KernelTestCase::tearDown()` and `WebTestCase::tearDown()` without the `void` return-type is deprecated.
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
@@ -37,7 +37,9 @@ abstract class KernelTestCase extends TestCase
      */
     protected static $container;
 
-    protected static $booted;
+    protected static $booted = false;
+
+    private static $kernelContainer;
 
     private function doTearDown()
     {
@@ -76,7 +78,7 @@ protected static function bootKernel(array $options = [])
         static::$kernel->boot();
         static::$booted = true;
 
-        $container = static::$kernel->getContainer();
+        self::$kernelContainer = $container = static::$kernel->getContainer();
         static::$container = $container->has('test.service_container') ? $container->get('test.service_container') : $container;
 
         return static::$kernel;
@@ -127,17 +129,14 @@ protected static function createKernel(array $options = [])
     protected static function ensureKernelShutdown()
     {
         if (null !== static::$kernel) {
-            $isBooted = (new \ReflectionClass(static::$kernel))->getProperty('booted');
-            $isBooted->setAccessible(true);
-            if ($isBooted->getValue(static::$kernel)) {
-                $container = static::$kernel->getContainer();
-                static::$kernel->shutdown();
-                static::$booted = false;
-                if ($container instanceof ResetInterface) {
-                    $container->reset();
-                }
-            }
+            static::$kernel->shutdown();
+            static::$booted = false;
+        }
+
+        if (self::$kernelContainer instanceof ResetInterface) {
+            self::$kernelContainer->reset();
         }
-        static::$container = null;
+
+        static::$container = self::$kernelContainer = null;
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/TestContainer.php b/src/Symfony/Bundle/FrameworkBundle/Test/TestContainer.php
@@ -119,7 +119,7 @@ public function initialized($id): bool
      */
     public function reset()
     {
-        $this->getPublicContainer()->reset();
+        // ignore the call
     }
 
     /**
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php
@@ -41,8 +41,8 @@ private function doTearDown()
      */
     protected static function createClient(array $options = [], array $server = [])
     {
-        if (true === static::$booted) {
-            @trigger_error(sprintf('Booting the kernel before calling %s() is deprecated and will throw in Symfony 5.0, the kernel should only be booted once.', __METHOD__), E_USER_DEPRECATED);
+        if (static::$booted) {
+            @trigger_error(sprintf('Calling "%s()" while a kernel has been booted is deprecated since Symfony 4.4 and will throw in 5.0, ensure the kernel is shut down before calling the method.', __METHOD__), E_USER_DEPRECATED);
         }
 
         $kernel = static::bootKernel($options);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php
@@ -100,7 +100,7 @@ protected function getKernelParameters(): array
 
     public function getContainer(): ContainerInterface
     {
-        if (!$this->booted) {
+        if (!$this->container) {
             throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');
         }
 
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AppKernel.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AppKernel.php
@@ -102,7 +102,7 @@ protected function getKernelParameters(): array
 
     public function getContainer(): ContainerInterface
     {
-        if (!$this->booted) {
+        if (!$this->container) {
             throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');
         }
 
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -380,7 +380,7 @@ public function getProjectDir()
      */
     public function getContainer()
     {
-        if (!$this->booted) {
+        if (!$this->container) {
             @trigger_error('Getting the container from a non-booted kernel is deprecated since Symfony 4.4.', E_USER_DEPRECATED);
         }
 

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ public function initialized($id): bool`
`119`	`119`	`*/`
`120`	`120`	`public function reset()`
`121`	`121`	`{`
`122`		`- $this->getPublicContainer()->reset();`
	`122`	`+ // ignore the call`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,8 @@ private function doTearDown()`
`41`	`41`	`*/`
`42`	`42`	`protected static function createClient(array $options = [], array $server = [])`
`43`	`43`	`{`
`44`		`- if (true === static::$booted) {`
`45`		`- @trigger_error(sprintf('Booting the kernel before calling %s() is deprecated and will throw in Symfony 5.0, the kernel should only be booted once.', __METHOD__), E_USER_DEPRECATED);`
	`44`	`+ if (static::$booted) {`
	`45`	`+ @trigger_error(sprintf('Calling "%s()" while a kernel has been booted is deprecated since Symfony 4.4 and will throw in 5.0, ensure the kernel is shut down before calling the method.', __METHOD__), E_USER_DEPRECATED);`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`$kernel = static::bootKernel($options);`
Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ protected function getKernelParameters(): array`
`100`	`100`
`101`	`101`	`public function getContainer(): ContainerInterface`
`102`	`102`	`{`
`103`		`- if (!$this->booted) {`
	`103`	`+ if (!$this->container) {`
`104`	`104`	`throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');`
`105`	`105`	`}`
`106`	`106`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ protected function getKernelParameters(): array`
`102`	`102`
`103`	`103`	`public function getContainer(): ContainerInterface`
`104`	`104`	`{`
`105`		`- if (!$this->booted) {`
	`105`	`+ if (!$this->container) {`
`106`	`106`	`throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');`
`107`	`107`	`}`
`108`	`108`
Original file line number	Diff line number	Diff line change
`@@ -380,7 +380,7 @@ public function getProjectDir()`
`380`	`380`	`*/`
`381`	`381`	`public function getContainer()`
`382`	`382`	`{`
`383`		`- if (!$this->booted) {`
	`383`	`+ if (!$this->container) {`
`384`	`384`	`@trigger_error('Getting the container from a non-booted kernel is deprecated since Symfony 4.4.', E_USER_DEPRECATED);`
`385`	`385`	`}`
`386`	`386`