Merge pull request symfony#219 from dunglas/multi-clients

dunglas · web-flow · commit f5f377fde535 · 2019-08-22T10:53:31.000+02:00
Mercure and WebSocket testing: allow to create several browser instances
diff --git a/src/Client.php b/src/Client.php
@@ -71,6 +71,11 @@ public function __construct(BrowserManagerInterface $browserManager, ?string $ba
         $this->baseUri = $baseUri;
     }
 
+    public function getBrowserManager(): BrowserManagerInterface
+    {
+        return $this->browserManager;
+    }
+
     public function __destruct()
     {
         $this->quit();
@@ -242,7 +247,7 @@ public function restart()
             $this->webDriver->manage()->deleteAllCookies();
         }
 
-        $this->quit();
+        $this->quit(false);
         $this->start();
     }
 
@@ -334,13 +339,16 @@ public function getWindowHandles()
         return $this->webDriver->getWindowHandles();
     }
 
-    public function quit()
+    public function quit(bool $quitBrowserManager = true)
     {
         if (null !== $this->webDriver) {
             $this->webDriver->quit();
             $this->webDriver = null;
         }
-        $this->browserManager->quit();
+
+        if ($quitBrowserManager) {
+            $this->browserManager->quit();
+        }
     }
 
     public function takeScreenshot($saveAs = null)
diff --git a/src/PantherTestCaseTrait.php b/src/PantherTestCaseTrait.php
@@ -52,10 +52,15 @@ trait PantherTestCaseTrait
     protected static $goutteClient;
 
     /**
-     * @var PantherClient|null
+     * @var PantherClient|null The primary Panther client instance created
      */
     protected static $pantherClient;
 
+    /**
+     * @var PantherClient[] All Panther clients, the first one is the primary one (aka self::$pantherClient)
+     */
+    protected static $pantherClients = [];
+
     /**
      * @var array
      */
@@ -83,8 +88,14 @@ public static function stopWebServer()
         }
 
         if (null !== self::$pantherClient) {
-            self::$pantherClient->quit();
+            foreach (self::$pantherClients as $i => $pantherClient) {
+                // Stop ChromeDriver only when all sessions are already closed
+                $pantherClient->quit(false);
+            }
+
+            self::$pantherClient->getBrowserManager()->quit();
             self::$pantherClient = null;
+            self::$pantherClients = [];
         }
 
         if (null !== self::$goutteClient) {
@@ -129,16 +140,20 @@ public static function isWebServerStarted()
     }
 
     /**
-     * @param array $options       see {@see $defaultOptions}
-     * @param array $kernelOptions
+     * Creates the primary browser.
+     *
+     * @param array $options see {@see $defaultOptions}
      */
     protected static function createPantherClient(array $options = [], array $kernelOptions = []): PantherClient
     {
-        self::startWebServer($options);
-        if (null === self::$pantherClient) {
-            self::$pantherClient = Client::createChromeClient(null, null, [], self::$baseUri);
+        if (null !== self::$pantherClient) {
+            return self::$pantherClient;
         }
 
+        self::startWebServer($options);
+
+        self::$pantherClients[0] = self::$pantherClient = Client::createChromeClient(null, null, [], self::$baseUri);
+
         if (\is_a(self::class, KernelTestCase::class, true)) {
             static::bootKernel($kernelOptions);
         }
@@ -150,6 +165,18 @@ protected static function createPantherClient(array $options = [], array $kernel
         return self::$pantherClient;
     }
 
+    /**
+     * Creates an additional browser. Convenient to test apps leveraging Mercure or WebSocket (e.g. a chat).
+     */
+    protected static function createAdditionalPantherClient(): PantherClient
+    {
+        if (null === self::$pantherClient) {
+            return self::createPantherClient();
+        }
+
+        return self::$pantherClients[] = self::$pantherClient = new PantherClient(self::$pantherClient->getBrowserManager(), self::$baseUri);
+    }
+
     /**
      * @param array $options       see {@see $defaultOptions}
      * @param array $kernelOptions
diff --git a/tests/ClientTest.php b/tests/ClientTest.php
@@ -265,7 +265,7 @@ public function testCookie(callable $clientFactory, string $type)
     public function testServerPort(callable $clientFactory): void
     {
         $expectedPort = $_SERVER['PANTHER_WEB_SERVER_PORT'] ?? '9080';
-        $client = $clientFactory();
+        $clientFactory();
         $this->assertEquals($expectedPort, \mb_substr(self::$baseUri, -4));
     }
 }
diff --git a/tests/MultiClientsTest.php b/tests/MultiClientsTest.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Panther project.
+ *
+ * (c) Kévin Dunglas <dunglas@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Symfony\Component\Panther\Tests;
+
+class MultiClientsTest extends TestCase
+{
+    public function testMultiClient(): void
+    {
+        $client = self::createPantherClient();
+        $client->request('GET', '/cookie.php');
+
+        $crawler = $client->request('GET', '/cookie.php');
+        $this->assertSame('1', $crawler->filter('#barcelona')->text());
+
+        $client2 = self::createAdditionalPantherClient();
+        $crawler2 = $client2->request('GET', '/cookie.php');
+        $this->assertSame('0', $crawler2->filter('#barcelona')->text());
+
+        // Check that the cookie in the other client hasn't changed
+        $this->assertSame('1', $crawler->filter('#barcelona')->text());
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -71,6 +71,11 @@ public function __construct(BrowserManagerInterface $browserManager, ?string $ba`
`71`	`71`	`$this->baseUri = $baseUri;`
`72`	`72`	`}`
`73`	`73`
	`74`	`+ public function getBrowserManager(): BrowserManagerInterface`
	`75`	`+ {`
	`76`	`+ return $this->browserManager;`
	`77`	`+ }`
	`78`	`+`
`74`	`79`	`public function __destruct()`
`75`	`80`	`{`
`76`	`81`	`$this->quit();`
`@@ -242,7 +247,7 @@ public function restart()`
`242`	`247`	`$this->webDriver->manage()->deleteAllCookies();`
`243`	`248`	`}`
`244`	`249`
`245`		`- $this->quit();`
	`250`	`+ $this->quit(false);`
`246`	`251`	`$this->start();`
`247`	`252`	`}`
`248`	`253`
`@@ -334,13 +339,16 @@ public function getWindowHandles()`
`334`	`339`	`return $this->webDriver->getWindowHandles();`
`335`	`340`	`}`
`336`	`341`
`337`		`- public function quit()`
	`342`	`+ public function quit(bool $quitBrowserManager = true)`
`338`	`343`	`{`
`339`	`344`	`if (null !== $this->webDriver) {`
`340`	`345`	`$this->webDriver->quit();`
`341`	`346`	`$this->webDriver = null;`
`342`	`347`	`}`
`343`		`- $this->browserManager->quit();`
	`348`	`+`
	`349`	`+ if ($quitBrowserManager) {`
	`350`	`+ $this->browserManager->quit();`
	`351`	`+ }`
`344`	`352`	`}`
`345`	`353`
`346`	`354`	`public function takeScreenshot($saveAs = null)`
Original file line number	Diff line number	Diff line change
`@@ -265,7 +265,7 @@ public function testCookie(callable $clientFactory, string $type)`
`265`	`265`	`public function testServerPort(callable $clientFactory): void`
`266`	`266`	`{`
`267`	`267`	`$expectedPort = $_SERVER['PANTHER_WEB_SERVER_PORT'] ?? '9080';`
`268`		`- $client = $clientFactory();`
	`268`	`+ $clientFactory();`
`269`	`269`	`$this->assertEquals($expectedPort, \mb_substr(self::$baseUri, -4));`
`270`	`270`	`}`
`271`	`271`	`}`