Merge pull request symfony#113 from maidmaid/pauseonfail

dunglas · web-flow · commit bb5b0e50ec01 · 2018-11-16T11:56:35.000+01:00
Pause on fail
diff --git a/.travis.yml b/.travis.yml
@@ -29,6 +29,6 @@ install:
     fi
 
 script:
-  - phpunit
+  - vendor/bin/phpunit
   - if [[ $lint = '1' ]]; then php php-cs-fixer.phar fix --dry-run --diff --no-ansi; fi
   - if [[ $lint = '1' ]]; then php phpstan.phar analyse src tests --level=6; fi
diff --git a/README.md b/README.md
@@ -130,6 +130,20 @@ class E2eTest extends PantherTestCase
 }
 ```
 
+### Interactive Mode
+
+Panther can make a pause in your tests suites after a failure.
+It is a break time really appreciated for investigating the problem through the web browser.
+For enabling this mode, you need the `--debug` PHPUnit option without the headless mode:
+
+    $ export PANTHER_NO_HEADLESS=1
+    $ phpunit --debug
+    
+    Test 'App\AdminTest::testLogin' started
+    Error: something is wrong.
+    
+    Press enter to continue...
+
 ## Features
 
 Unlike testing and web scraping libraries you're used to, Panther:
diff --git a/composer.json b/composer.json
@@ -43,7 +43,7 @@
   "require-dev": {
     "guzzlehttp/guzzle": "^6.3",
     "fabpot/goutte": "^3.2.3",
-    "phpunit/phpunit": "^7.0",
+    "phpunit/phpunit": "^7.3",
     "symfony/css-selector": "^3.4 || ^4.0",
     "symfony/framework-bundle": "^3.4 || ^4.0"
   }
diff --git a/src/PantherTestCaseTrait.php b/src/PantherTestCaseTrait.php
@@ -121,6 +121,11 @@ public static function startWebServer(array $options = []): void
         self::$baseUri = sprintf('http://%s:%s', $options['hostname'], $options['port']);
     }
 
+    public static function isWebServerStarted()
+    {
+        return self::$webServerManager->isStarted();
+    }
+
     /**
      * @param array $options       see {@see $defaultOptions}
      * @param array $kernelOptions
diff --git a/src/ProcessManager/WebServerManager.php b/src/ProcessManager/WebServerManager.php
@@ -79,4 +79,9 @@ public function quit(): void
     {
         $this->process->stop();
     }
+
+    public function isStarted()
+    {
+        return $this->process->isStarted();
+    }
 }
diff --git a/src/ServerExtension.php b/src/ServerExtension.php
@@ -14,12 +14,14 @@
 namespace Symfony\Component\Panther;
 
 use PHPUnit\Runner\AfterLastTestHook;
+use PHPUnit\Runner\AfterTestErrorHook;
+use PHPUnit\Runner\AfterTestFailureHook;
 use PHPUnit\Runner\BeforeFirstTestHook;
 
 /**
  *  @author Dany Maillard <danymaillard93b@gmail.com>
  */
-final class ServerExtension implements BeforeFirstTestHook, AfterLastTestHook
+final class ServerExtension implements BeforeFirstTestHook, AfterLastTestHook, AfterTestErrorHook, AfterTestFailureHook
 {
     use ServerTrait;
 
@@ -32,4 +34,14 @@ public function executeAfterLastTest(): void
     {
         $this->stopWebServer();
     }
+
+    public function executeAfterTestError(string $test, string $message, float $time): void
+    {
+        $this->pause(sprintf('Error: %s', $message));
+    }
+
+    public function executeAfterTestFailure(string $test, string $message, float $time): void
+    {
+        $this->pause(sprintf('Failure: %s', $message));
+    }
 }
diff --git a/src/ServerListener.php b/src/ServerListener.php
@@ -13,6 +13,8 @@
 
 namespace Symfony\Component\Panther;
 
+use PHPUnit\Framework\AssertionFailedError;
+use PHPUnit\Framework\Test;
 use PHPUnit\Framework\TestListener;
 use PHPUnit\Framework\TestListenerDefaultImplementation;
 use PHPUnit\Framework\TestSuite;
@@ -31,4 +33,14 @@ public function endTestSuite(TestSuite $suite): void
     {
         $this->stopWebServer();
     }
+
+    public function addError(Test $test, \Throwable $t, float $time): void
+    {
+        $this->pause(sprintf('Error: %s', $t->getMessage()));
+    }
+
+    public function addFailure(Test $test, AssertionFailedError $e, float $time): void
+    {
+        $this->pause(sprintf('Failure: %s', $e->getMessage()));
+    }
 }
diff --git a/src/ServerTrait.php b/src/ServerTrait.php
@@ -20,6 +20,8 @@
  */
 trait ServerTrait
 {
+    public $testing = false;
+
     private function keepServerOnTeardown(): void
     {
         PantherTestCase::$stopServerOnTeardown = false;
@@ -29,4 +31,17 @@ private function stopWebServer(): void
     {
         PantherTestCase::stopWebServer();
     }
+
+    private function pause($message): void
+    {
+        if (PantherTestCase::isWebServerStarted()
+            && \in_array('--debug', $_SERVER['argv'], true)
+            && $_SERVER['PANTHER_NO_HEADLESS'] ?? false
+        ) {
+            echo "$message\n\nPress enter to continue...";
+            if (!$this->testing) {
+                fgets(STDIN);
+            }
+        }
+    }
 }
diff --git a/tests/ServerExtensionTest.php b/tests/ServerExtensionTest.php
@@ -25,12 +25,48 @@ public static function tearDownAfterClass()
 
     public function testStartAndStop(): void
     {
-        $listener = new ServerExtension();
+        $extension = new ServerExtension();
 
-        $listener->executeBeforeFirstTest();
+        $extension->executeBeforeFirstTest();
         static::assertFalse(PantherTestCase::$stopServerOnTeardown);
 
-        $listener->executeAfterLastTest();
+        $extension->executeAfterLastTest();
         static::assertNull(PantherTestCase::$webServerManager);
     }
+
+    /**
+     * @dataProvider provideTestPauseOnFailure
+     */
+    public function testPauseOnFailure(string $method, string $expected): void
+    {
+        $extension = new ServerExtension();
+        $extension->testing = true;
+
+        // stores current state
+        $argv = $_SERVER['argv'];
+        $noHeadless = $_SERVER['PANTHER_NO_HEADLESS'] ?? false;
+
+        self::startWebServer();
+        $_SERVER['argv'][] = '--debug';
+        $_SERVER['PANTHER_NO_HEADLESS'] = 1;
+
+        $extension->{$method}('test', 'message', 0);
+        $this->expectOutputString($expected);
+
+        // restores previous state
+        $_SERVER['argv'] = $argv;
+        if (false === $noHeadless) {
+            unset($_SERVER['PANTHER_NO_HEADLESS']);
+        } else {
+            $_SERVER['PANTHER_NO_HEADLESS'] = $noHeadless;
+        }
+    }
+
+    public function provideTestPauseOnFailure()
+    {
+        return [
+            ['executeAfterTestError', "Error: message\n\nPress enter to continue..."],
+            ['executeAfterTestFailure', "Failure: message\n\nPress enter to continue..."],
+        ];
+    }
 }
diff --git a/tests/ServerListenerTest.php b/tests/ServerListenerTest.php
@@ -13,6 +13,8 @@
 
 namespace Symfony\Component\Panther\Tests;
 
+use PHPUnit\Framework\AssertionFailedError;
+use PHPUnit\Framework\Test;
 use PHPUnit\Framework\TestSuite;
 use Symfony\Component\Panther\PantherTestCase;
 use Symfony\Component\Panther\ServerListener;
@@ -35,4 +37,40 @@ public function testStartAndStop(): void
         $listener->endTestSuite($testSuite);
         static::assertNull(PantherTestCase::$webServerManager);
     }
+
+    /**
+     * @dataProvider provideTestPauseOnFailure
+     */
+    public function testPauseOnFailure(string $method, string $expected): void
+    {
+        $listener = new ServerListener();
+        $listener->testing = true;
+
+        // stores current state
+        $argv = $_SERVER['argv'];
+        $noHeadless = $_SERVER['PANTHER_NO_HEADLESS'] ?? false;
+
+        self::startWebServer();
+        $_SERVER['argv'][] = '--debug';
+        $_SERVER['PANTHER_NO_HEADLESS'] = 1;
+
+        $listener->{$method}($this->getMockForAbstractClass(Test::class), new AssertionFailedError('message'), 0);
+        $this->expectOutputString($expected);
+
+        // restores previous state
+        $_SERVER['argv'] = $argv;
+        if (false === $noHeadless) {
+            unset($_SERVER['PANTHER_NO_HEADLESS']);
+        } else {
+            $_SERVER['PANTHER_NO_HEADLESS'] = $noHeadless;
+        }
+    }
+
+    public function provideTestPauseOnFailure()
+    {
+        return [
+            ['addError', "Error: message\n\nPress enter to continue..."],
+            ['addFailure', "Failure: message\n\nPress enter to continue..."],
+        ];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@`
`43`	`43`	`"require-dev": {`
`44`	`44`	`"guzzlehttp/guzzle": "^6.3",`
`45`	`45`	`"fabpot/goutte": "^3.2.3",`
`46`		`- "phpunit/phpunit": "^7.0",`
	`46`	`+ "phpunit/phpunit": "^7.3",`
`47`	`47`	`"symfony/css-selector": "^3.4 \|\| ^4.0",`
`48`	`48`	`"symfony/framework-bundle": "^3.4 \|\| ^4.0"`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,4 +79,9 @@ public function quit(): void`
`79`	`79`	`{`
`80`	`80`	`$this->process->stop();`
`81`	`81`	`}`
	`82`	`+`
	`83`	`+ public function isStarted()`
	`84`	`+ {`
	`85`	`+ return $this->process->isStarted();`
	`86`	`+ }`
`82`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@`
`20`	`20`	`*/`
`21`	`21`	`trait ServerTrait`
`22`	`22`	`{`
	`23`	`+ public $testing = false;`
	`24`	`+`
`23`	`25`	`private function keepServerOnTeardown(): void`
`24`	`26`	`{`
`25`	`27`	`PantherTestCase::$stopServerOnTeardown = false;`
`@@ -29,4 +31,17 @@ private function stopWebServer(): void`
`29`	`31`	`{`
`30`	`32`	`PantherTestCase::stopWebServer();`
`31`	`33`	`}`
	`34`	`+`
	`35`	`+ private function pause($message): void`
	`36`	`+ {`
	`37`	`+ if (PantherTestCase::isWebServerStarted()`
	`38`	`+ && \in_array('--debug', $_SERVER['argv'], true)`
	`39`	`+ && $_SERVER['PANTHER_NO_HEADLESS'] ?? false`
	`40`	`+ ) {`
	`41`	`+ echo "$message\n\nPress enter to continue...";`
	`42`	`+ if (!$this->testing) {`
	`43`	`+ fgets(STDIN);`
	`44`	`+ }`
	`45`	`+ }`
	`46`	`+ }`
`32`	`47`	`}`