[Console] Allow Application to handle PHP 7 Errors

symfony · ogizanagi · Dec 7, 2016 · Dec 14, 2016 · Dec 13, 2016 · 64f9856a2fc3740bfcd17d3a3de17ac8400a42bd
commit 64f9856a2fc3740bfcd17d3a3de17ac8400a42bd
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -6,6 +6,10 @@ Console
 
  * Setting unknown style options is not supported anymore and throws an
    exception.
+
+ * The signature of `Application::renderException(\Exception $e, OutputInterface $output)` 
+   has changed for `Application::renderException(\Throwable $e, OutputInterface $output)`.
+   You must update your implementations.
 
 Debug
 -----

diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Console;
 
+use Symfony\Component\Console\Exception\ErrorException;
 use Symfony\Component\Console\Exception\ExceptionInterface;
 use Symfony\Component\Console\Helper\DebugFormatterHelper;
 use Symfony\Component\Console\Helper\ProcessHelper;
@@ -62,6 +63,7 @@ class Application
     private $name;
     private $version;
     private $catchExceptions = true;
+    private $catchErrors = false;
     private $autoExit = true;
     private $definition;
     private $helperSet;
@@ -100,8 +102,6 @@ public function setDispatcher(EventDispatcherInterface $dispatcher)
      * @param OutputInterface $output An Output instance
      *
      * @return int 0 if everything went fine, or an error code
-     *
-     * @throws \Exception When doRun returns Exception
      */
     public function run(InputInterface $input = null, OutputInterface $output = null)
     {
@@ -124,7 +124,14 @@ public function run(InputInterface $input = null, OutputInterface $output = null
             if (!$this->catchExceptions) {
                 throw $e;
             }
+        } catch (\Error $e) {
+            if (!$this->catchErrors) {
+                throw $e;
+            }
+            $e = new ErrorException($e);
+        }
 
+        if (isset($e)) {
             if ($output instanceof ConsoleOutputInterface) {
                 $this->renderException($e, $output->getErrorOutput());
             } else {
@@ -271,6 +278,22 @@ public function setCatchExceptions($boolean)
         $this->catchExceptions = (bool) $boolean;
     }
 
+    /**
+     * @return bool Whether errors are caught or not during commands execution
+     */
+    public function areErrorsCaught()
+    {
+        return $this->catchErrors;
+    }
+
+    /**
+     * @param bool $boolean Whether to catch errors or not during commands execution
+     */
+    public function setCatchErrors($boolean)
+    {
+        $this->catchErrors = (bool) $boolean;
+    }
+
     /**
      * Gets whether to automatically exit after a command execution or not.
      *
@@ -620,6 +643,10 @@ public static function getAbbreviations($names)
      */
     public function renderException(\Exception $e, OutputInterface $output)
     {
+        if ($e instanceof ErrorException) {
+            $e = $e->getError();
+        }
+
         $output->writeln('', OutputInterface::VERBOSITY_QUIET);
 
         do {
@@ -814,8 +841,6 @@ protected function configureIO(InputInterface $input, OutputInterface $output)
      * @param OutputInterface $output  An Output instance
      *
      * @return int 0 if everything went fine, or an error code
-     *
-     * @throws \Exception when the command being run threw an exception
      */
     protected function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
     {

diff --git a/src/Symfony/Component/Console/Exception/ErrorException.php b/src/Symfony/Component/Console/Exception/ErrorException.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Symfony\Component\Console\Exception;
+
+/**
+ * Wrap a PHP 7 Error into an exception.
+ *
+ * @internal This class is used internally by Application and should never be used in user-land
+ */
+final class ErrorException extends \Exception
+{
+    private $error;
+
+    public function __construct(\Error $error)
+    {
+        $this->error = $error;
+    }
+
+    /**
+     * @return \Error
+     */
+    public function getError()
+    {
+        return $this->error;
+    }
+}
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -1000,6 +1000,39 @@ public function testRunWithErrorFailingStatusCode()
         $this->assertSame(1, $tester->getStatusCode(), 'Status code should be 1');
     }
 
+    public function testErrorsAreNotCaughtByDefault()
+    {
+        $application = new Application();
+
+        $this->assertFalse($application->areErrorsCaught());
+    }
+
+    /**
+     * @requires PHP 7
+     */
+    public function testCatchesErrors()
+    {
+        $application = new Application();
+
+        $application->setCatchErrors(true);
+        $application->setAutoExit(false);
+
+        $this->assertTrue($application->areErrorsCaught());
+
+        $application->register('foo')->setCode(function () {
+            throw new \Error('This error should be catch by Application::run');
+        });
+
+        $tester = new ApplicationTester($application);
+        $tester->run(array('command' => 'foo'));
+        $this->assertSame(1, $tester->getStatusCode(), 'Status code should be 1');
+        $this->assertContains(<<<'EOTXT'
+  [Error]                                         
+  This error should be catch by Application::run
+EOTXT
+            , $tester->getDisplay(true), 'The PHP error should be caught when catchErrors is true.');
+    }
+
     public function testRunWithDispatcherSkippingCommand()
     {
         $application = new Application();