Merge pull request symfony#104 from maidmaid/server-ext

Keep alive the webserver between test suites

Author: dunglas

README.md

@@ -166,23 +166,34 @@ Unlike testing and web scraping libraries you're used to, Panther:
 * supports custom [Selenium server](https://www.seleniumhq.org) installations
 * supports remote browser testing services including [SauceLabs](https://saucelabs.com/) and [BrowserStack](https://www.browserstack.com/)
 
-### Using the `ServerListener` to Always Have a Running Web Server
+### Improve Performances by Having a Persistent Web Server Running
 
-When you use the Panther client, the web server running in background will be started at runtime and stopped at test's
-teardown.
+When you use the Panther client, the web server running in background will be started on demand at the first call to
+`createPantherClient()`, `createGoutteClient()` or `startWebServer()` and it will be stopped at `tearDownAfterClass()`.
 
-If you want to improve performances and launch the server at PHPUnit startup, you can add the `ServerListener` to
-your PHPUnit configuration:
+If you want to improve performances, you can hook to PHPUnit in your `phpunit.xml.dist` configuration file with the
+Panther's server extension:
 
 ```xml
 <!-- phpunit.xml.dist -->
+    <extensions>
+        <extension class="Symfony\Component\Panther\ServerExtension" />
+    </extensions>
+```
+
+This extension will start the web server on demand like previously, but it will stop it after the very last test.
+
+It should be noted that the Panther's extension only works with PHPUnit `>= 7.3`. Nonetheless, if you are using an
+anterior PHPUnit version, you can also hook to PHPUnit with the Panther's server listener:
 
+```xml
+<!-- phpunit.xml.dist -->
     <listeners>
         <listener class="Symfony\Component\Panther\ServerListener" />
     </listeners>
 ```
 
-The listener will start the webserver when the test suite is started, and will stop it when all your tests are executed.
+This listener will start the web server on demand like previously, but it will stop it after each test suite.
 
 ## Documentation
 

src/PantherTestCaseTrait.php

@@ -58,7 +58,7 @@ trait PantherTestCaseTrait
 
     public static function tearDownAfterClass()
     {
-        if (true === self::$stopServerOnTeardown) {
+        if (self::$stopServerOnTeardown) {
             static::stopWebServer();
         }
     }

src/ServerExtension.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Panther project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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;
+
+use PHPUnit\Runner\AfterLastTestHook;
+use PHPUnit\Runner\BeforeFirstTestHook;
+
+/**
+ *  @author Dany Maillard <[email protected]>
+ */
+final class ServerExtension implements BeforeFirstTestHook, AfterLastTestHook
+{
+    use ServerTrait;
+
+    public function executeBeforeFirstTest(): void
+    {
+        $this->keepServerOnTeardown();
+    }
+
+    public function executeAfterLastTest(): void
+    {
+        $this->stopWebServer();
+    }
+}

src/ServerListener.php

@@ -20,17 +20,15 @@
 final class ServerListener implements TestListener
 {
     use TestListenerDefaultImplementation;
+    use ServerTrait;
 
     public function startTestSuite(TestSuite $suite): void
     {
-        echo "Starting Panther server for test suite {$suite->getName()}...\n";
-        PantherTestCaseTrait::$stopServerOnTeardown = true;
-        PantherTestCaseTrait::startWebServer();
+        $this->keepServerOnTeardown();
     }
 
     public function endTestSuite(TestSuite $suite): void
     {
-        echo "\nShutting down Panther server...\n";
-        PantherTestCaseTrait::stopWebServer();
+        $this->stopWebServer();
     }
 }

src/ServerTrait.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Panther project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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;
+
+/**
+ * @author Dany Maillard <[email protected]>
+ *
+ * @internal
+ */
+trait ServerTrait
+{
+    private function keepServerOnTeardown(): void
+    {
+        PantherTestCase::$stopServerOnTeardown = false;
+    }
+
+    private function stopWebServer(): void
+    {
+        PantherTestCase::stopWebServer();
+    }
+}

tests/ServerExtensionTest.php

@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Panther project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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;
+
+use Symfony\Component\Panther\PantherTestCase;
+use Symfony\Component\Panther\ServerExtension;
+
+class ServerExtensionTest extends TestCase
+{
+    public static function tearDownAfterClass()
+    {
+        PantherTestCase::$stopServerOnTeardown = true;
+    }
+
+    public function testStartAndStop(): void
+    {
+        $listener = new ServerExtension();
+
+        $listener->executeBeforeFirstTest();
+        static::assertFalse(PantherTestCase::$stopServerOnTeardown);
+
+        $listener->executeAfterLastTest();
+        static::assertNull(PantherTestCase::$webServerManager);
+    }
+}

tests/ServerListenerTest.php

@@ -14,46 +14,25 @@
 namespace Symfony\Component\Panther\Tests;
 
 use PHPUnit\Framework\TestSuite;
+use Symfony\Component\Panther\PantherTestCase;
 use Symfony\Component\Panther\ServerListener;
 
 class ServerListenerTest extends TestCase
 {
-    private function createTestSuite()
+    public static function tearDownAfterClass()
     {
-        $suite = $this->createMock(TestSuite::class);
-        $suite->expects($this->once())->method('getName')->willReturn('Dummy test suite');
-
-        return $suite;
+        PantherTestCase::$stopServerOnTeardown = true;
     }
 
     public function testStartAndStop(): void
     {
-        $this->expectOutputString("Starting Panther server for test suite Dummy test suite...\n\nShutting down Panther server...\n");
-
-        $_SERVER['PANTHER_WEB_SERVER_DIR'] = static::$webServerDir;
-
-        $streamContext = stream_context_create(['http' => [
-            'ignore_errors' => true,
-            'protocol_version' => '1.1',
-            'header' => ['Connection: close'],
-            'timeout' => 1,
-        ]]);
-
-        $healthCheck = function () use ($streamContext) {
-            return @file_get_contents('http://127.0.0.1:9000', false, $streamContext);
-        };
-
-        $testSuite = $this->createTestSuite();
-
+        $testSuite = new TestSuite();
         $listener = new ServerListener();
-        $listener->startTestSuite($testSuite);
 
-        // Means the server rendered a 404, so server is running.
-        static::assertContains('<title>404 Not Found</title>', $healthCheck());
+        $listener->startTestSuite($testSuite);
+        static::assertFalse(PantherTestCase::$stopServerOnTeardown);
 
         $listener->endTestSuite($testSuite);
-
-        // False means that ping failed.
-        static::assertFalse($healthCheck());
+        static::assertNull(PantherTestCase::$webServerManager);
     }
 }