[FrameworkBundle] fix BC-breaking property in WebTestAssertionsTrait

nicolas-grekas · nicolas-grekas · commit 835280b81e55 · 2019-06-05T18:24:41.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/WebTestAssertionsTrait.php b/src/Symfony/Bundle/FrameworkBundle/Test/WebTestAssertionsTrait.php
@@ -15,6 +15,7 @@
 use PHPUnit\Framework\Constraint\LogicalNot;
 use Symfony\Bundle\FrameworkBundle\KernelBrowser;
 use Symfony\Component\BrowserKit\Test\Constraint as BrowserKitConstraint;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\DomCrawler\Test\Constraint as DomCrawlerConstraint;
 use Symfony\Component\HttpFoundation\Request;
@@ -28,6 +29,32 @@
  */
 trait WebTestAssertionsTrait
 {
+    /**
+     * Creates a KernelBrowser.
+     *
+     * @param array $options An array of options to pass to the createKernel method
+     * @param array $server  An array of server parameters
+     *
+     * @return KernelBrowser A KernelBrowser instance
+     */
+    protected static function createClient(array $options = [], array $server = [])
+    {
+        $kernel = static::bootKernel($options);
+
+        try {
+            $client = $kernel->getContainer()->get('test.client');
+        } catch (ServiceNotFoundException $e) {
+            if (class_exists(KernelBrowser::class)) {
+                throw new \LogicException('You cannot create the client used in functional tests if the "framework.test" config is not set to true.');
+            }
+            throw new \LogicException('You cannot create the client used in functional tests if the BrowserKit component is not available. Try running "composer require symfony/browser-kit"');
+        }
+
+        $client->setServerParameters($server);
+
+        return self::getClient($client);
+    }
+
     public static function assertResponseIsSuccessful(string $message = ''): void
     {
         self::assertThat(static::getResponse(), new ResponseConstraint\ResponseIsSuccessful(), $message);
@@ -186,13 +213,19 @@ public static function assertRouteSame($expectedRoute, array $parameters = [], s
         self::assertThat(static::getRequest(), $constraint, $message);
     }
 
-    private static function getClient(): KernelBrowser
+    private static function getClient(KernelBrowser $newClient = null): ?KernelBrowser
     {
-        if (!static::$client instanceof KernelBrowser) {
+        static $client;
+
+        if (0 < \func_num_args()) {
+            return $client = $newClient;
+        }
+
+        if (!$client instanceof KernelBrowser) {
             static::fail(\sprintf('A client must be set to make assertions on it. Did you forget to call "%s::createClient"?', __CLASS__));
         }
 
-        return static::$client;
+        return $client;
     }
 
     private static function getCrawler(): Crawler
diff --git a/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Test/WebTestCase.php
@@ -11,9 +11,6 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Test;
 
-use Symfony\Bundle\FrameworkBundle\KernelBrowser;
-use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
-
 /**
  * WebTestCase is the base class for functional tests.
  *
@@ -23,39 +20,9 @@ abstract class WebTestCase extends KernelTestCase
 {
     use WebTestAssertionsTrait;
 
-    /** @var KernelBrowser|null */
-    protected static $client;
-
     protected function doTearDown(): void
     {
         parent::doTearDown();
-
-        static::$client = null;
-    }
-
-    /**
-     * Creates a KernelBrowser.
-     *
-     * @param array $options An array of options to pass to the createKernel method
-     * @param array $server  An array of server parameters
-     *
-     * @return KernelBrowser A KernelBrowser instance
-     */
-    protected static function createClient(array $options = [], array $server = [])
-    {
-        $kernel = static::bootKernel($options);
-
-        try {
-            $client = $kernel->getContainer()->get('test.client');
-        } catch (ServiceNotFoundException $e) {
-            if (class_exists(KernelBrowser::class)) {
-                throw new \LogicException('You cannot create the client used in functional tests if the "framework.test" config is not set to true.');
-            }
-            throw new \LogicException('You cannot create the client used in functional tests if the BrowserKit component is not available. Try running "composer require symfony/browser-kit"');
-        }
-
-        $client->setServerParameters($server);
-
-        return static::$client = $client;
+        self::getClient(null);
     }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Test/WebTestCaseTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Test/WebTestCaseTest.php
@@ -277,11 +277,9 @@ private function getTester(KernelBrowser $client): WebTestCase
         return new class($client) extends WebTestCase {
             use WebTestAssertionsTrait;
 
-            protected static $client;
-
             public function __construct(KernelBrowser $client)
             {
-                static::$client = $client;
+                self::getClient($client);
             }
         };
     }

Original file line number	Diff line number	Diff line change
`@@ -277,11 +277,9 @@ private function getTester(KernelBrowser $client): WebTestCase`
`277`	`277`	`return new class($client) extends WebTestCase {`
`278`	`278`	`use WebTestAssertionsTrait;`
`279`	`279`
`280`		`- protected static $client;`
`281`		`-`
`282`	`280`	`public function __construct(KernelBrowser $client)`
`283`	`281`	`{`
`284`		`- static::$client = $client;`
	`282`	`+ self::getClient($client);`
`285`	`283`	`}`
`286`	`284`	`};`
`287`	`285`	`}`