[FrameworkBundle] WebTestCase KernelBrowser::getContainer null return type

Simperfit · Simperfit · commit 50eda4bcaef9 · 2019-08-09T13:47:57.000+02:00
diff --git a/UPGRADE-4.4.md b/UPGRADE-4.4.md
@@ -116,6 +116,7 @@ HttpKernel
  * Implementing the `BundleInterface` without implementing the `getPublicDir()` method is deprecated.
    This method will be added to the interface in 5.0.
  * The `DebugHandlersListener` class has been marked as `final`
+ * Getting the container from a non-booted kernel is deprecated.
 
 Lock
 ----
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -287,6 +287,7 @@ HttpFoundation
    use `Symfony\Component\Mime\FileinfoMimeTypeGuesser` instead.
  * `ApacheRequest` has been removed, use the `Request` class instead.
  * The third argument of the `HeaderBag::get()` method has been removed, use method `all()` instead.
+ * Getting the container from a non-booted kernel is not possible anymore.
 
 HttpKernel
 ----------
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
@@ -127,11 +127,15 @@ protected static function createKernel(array $options = [])
     protected static function ensureKernelShutdown()
     {
         if (null !== static::$kernel) {
-            $container = static::$kernel->getContainer();
-            static::$kernel->shutdown();
-            static::$booted = false;
-            if ($container instanceof ResetInterface) {
-                $container->reset();
+            $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::$container = null;
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/app/AppKernel.php
@@ -96,4 +96,13 @@ protected function getKernelParameters()
 
         return $parameters;
     }
+
+    public function getContainer()
+    {
+        if (false === $this->booted) {
+            throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');
+        }
+
+        return parent::getContainer();
+    }
 }
diff --git a/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AppKernel.php b/src/Symfony/Bundle/SecurityBundle/Tests/Functional/app/AppKernel.php
@@ -98,4 +98,13 @@ protected function getKernelParameters()
 
         return $parameters;
     }
+
+    public function getContainer()
+    {
+        if (false === $this->booted) {
+            throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');
+        }
+
+        return parent::getContainer();
+    }
 }
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Implementing the `BundleInterface` without implementing the `getPublicDir()` method is deprecated.
    This method will be added to the interface in 5.0.
  * The `DebugHandlersListener` class has been marked as `final`
+ * Getting the container from a non-booted kernel is deprecated.
 
 4.3.0
 -----
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -361,6 +361,10 @@ public function getProjectDir()
      */
     public function getContainer()
     {
+        if (null === $this->container) {
+            @trigger_error('Getting the container from a non-booted kernel is deprecated since Symfony 4.4.', E_USER_DEPRECATED);
+        }
+
         return $this->container;
     }
 
diff --git a/src/Symfony/Component/HttpKernel/KernelInterface.php b/src/Symfony/Component/HttpKernel/KernelInterface.php
@@ -133,7 +133,7 @@ public function getRootDir();
     /**
      * Gets the current container.
      *
-     * @return ContainerInterface|null A ContainerInterface instance or null when the Kernel is shutdown
+     * @return ContainerInterface A ContainerInterface instance
      */
     public function getContainer();
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/KernelTest.php b/src/Symfony/Component/HttpKernel/Tests/KernelTest.php
@@ -46,6 +46,17 @@ public function testConstructor()
         $this->assertEquals($debug, $kernel->isDebug());
         $this->assertFalse($kernel->isBooted());
         $this->assertLessThanOrEqual(microtime(true), $kernel->getStartTime());
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation Getting the container from a non-booted kernel is deprecated since Symfony 4.4.
+     */
+    public function testGetContainerForANonBootedKernel()
+    {
+        $kernel = new KernelForTest('test_env', true);
+
+        $this->assertFalse($kernel->isBooted());
         $this->assertNull($kernel->getContainer());
     }
 
@@ -61,7 +72,6 @@ public function testClone()
         $this->assertEquals($debug, $clone->isDebug());
         $this->assertFalse($clone->isBooted());
         $this->assertLessThanOrEqual(microtime(true), $clone->getStartTime());
-        $this->assertNull($clone->getContainer());
     }
 
     public function testClassNameValidityGetter()
@@ -474,6 +484,18 @@ public function testTerminateReturnsSilentlyIfKernelIsNotBooted()
         $kernel->terminate(Request::create('/'), new Response());
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Getting the container from a non-booted kernel is deprecated since Symfony 4.4.
+     */
+    public function testDeprecatedNullKernel()
+    {
+        $kernel = $this->getKernel();
+        $kernel->shutdown();
+
+        $this->assertNull($kernel->getContainer());
+    }
+
     public function testTerminateDelegatesTerminationOnlyForTerminableInterface()
     {
         // does not implement TerminableInterface

Original file line number	Diff line number	Diff line change
`@@ -96,4 +96,13 @@ protected function getKernelParameters()`
`96`	`96`
`97`	`97`	`return $parameters;`
`98`	`98`	`}`
	`99`	`+`
	`100`	`+ public function getContainer()`
	`101`	`+ {`
	`102`	`+ if (false === $this->booted) {`
	`103`	`+ throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');`
	`104`	`+ }`
	`105`	`+`
	`106`	`+ return parent::getContainer();`
	`107`	`+ }`
`99`	`108`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,4 +98,13 @@ protected function getKernelParameters()`
`98`	`98`
`99`	`99`	`return $parameters;`
`100`	`100`	`}`
	`101`	`+`
	`102`	`+ public function getContainer()`
	`103`	`+ {`
	`104`	`+ if (false === $this->booted) {`
	`105`	`+ throw new \LogicException('Cannot access the container on a non-booted kernel. Did you forget to boot it?');`
	`106`	`+ }`
	`107`	`+`
	`108`	`+ return parent::getContainer();`
	`109`	`+ }`
`101`	`110`	`}`
Original file line number	Diff line number	Diff line change
`@@ -361,6 +361,10 @@ public function getProjectDir()`
`361`	`361`	`*/`
`362`	`362`	`public function getContainer()`
`363`	`363`	`{`
	`364`	`+ if (null === $this->container) {`
	`365`	`+ @trigger_error('Getting the container from a non-booted kernel is deprecated since Symfony 4.4.', E_USER_DEPRECATED);`
	`366`	`+ }`
	`367`	`+`
`364`	`368`	`return $this->container;`
`365`	`369`	`}`
`366`	`370`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ public function getRootDir();`
`133`	`133`	`/**`
`134`	`134`	`* Gets the current container.`
`135`	`135`	`*`
`136`		`- * @return ContainerInterface\|null A ContainerInterface instance or null when the Kernel is shutdown`
	`136`	`+ * @return ContainerInterface A ContainerInterface instance`
`137`	`137`	`*/`
`138`	`138`	`public function getContainer();`
`139`	`139`