[FrameworkBundle] WebTestCase KernelBrowser::getContainer null return type

Simperfit · Simperfit · commit a522f61ef7a9 · 2019-05-18T08:30:20.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/KernelTestCase.php
@@ -124,10 +124,14 @@ protected static function createKernel(array $options = [])
     protected static function ensureKernelShutdown()
     {
         if (null !== static::$kernel) {
-            $container = static::$kernel->getContainer();
-            static::$kernel->shutdown();
-            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();
+                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,12 @@ 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
@@ -25,6 +25,7 @@ CHANGELOG
  * renamed `PostResponseEvent` to `TerminateEvent`
  * added `HttpClientKernel` for handling requests with an `HttpClientInterface` instance
  * added `trace_header` and `trace_level` configuration options to `HttpCache`
+ * Getting the container from a non-booted kernel is deprecated.
 
 4.2.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.3 and will throw an exceptions in Symfony 5.0.', 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 or null when the Kernel is shutdown
      */
     public function getContainer();
 
diff --git a/src/Symfony/Component/HttpKernel/Tests/KernelTest.php b/src/Symfony/Component/HttpKernel/Tests/KernelTest.php
@@ -36,6 +36,10 @@ public static function tearDownAfterClass()
         $fs->remove(__DIR__.'/Fixtures/var');
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Getting the container from a non-booted kernel is deprecated since Symfony 4.3 and will throw an exceptions in Symfony 5.0.
+     */
     public function testConstructor()
     {
         $env = 'test_env';
@@ -49,6 +53,10 @@ public function testConstructor()
         $this->assertNull($kernel->getContainer());
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Getting the container from a non-booted kernel is deprecated since Symfony 4.3 and will throw an exceptions in Symfony 5.0.
+     */
     public function testClone()
     {
         $env = 'test_env';
@@ -486,6 +494,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.3 and will throw an exceptions in Symfony 5.0.
+     */
+    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
`@@ -124,10 +124,14 @@ protected static function createKernel(array $options = [])`
`124`	`124`	`protected static function ensureKernelShutdown()`
`125`	`125`	`{`
`126`	`126`	`if (null !== static::$kernel) {`
`127`		`- $container = static::$kernel->getContainer();`
`128`		`- static::$kernel->shutdown();`
`129`		`- if ($container instanceof ResetInterface) {`
`130`		`- $container->reset();`
	`127`	`+ $isBooted = (new \ReflectionClass(static::$kernel))->getProperty('booted');`
	`128`	`+ $isBooted->setAccessible(true);`
	`129`	`+ if ($isBooted->getValue(static::$kernel)) {`
	`130`	`+ $container = static::$kernel->getContainer();`
	`131`	`+ static::$kernel->shutdown();`
	`132`	`+ if ($container instanceof ResetInterface) {`
	`133`	`+ $container->reset();`
	`134`	`+ }`
`131`	`135`	`}`
`132`	`136`	`}`
`133`	`137`	`static::$container = null;`
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,12 @@ 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`	`+ return parent::getContainer();`
	`108`	`+ }`
`101`	`109`	`}`
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.3 and will throw an exceptions in Symfony 5.0.', 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 or null when the Kernel is shutdown`
`137`	`137`	`*/`
`138`	`138`	`public function getContainer();`
`139`	`139`