[FrameworkBundle] [Console] add a warning when command is not found

Amrouche Hamza · Amrouche Hamza · commit dcfa7349b7d4 · 2018-02-23T19:23:36.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Application.php b/src/Symfony/Bundle/FrameworkBundle/Console/Application.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Console;
 
+use Symfony\Component\Console\Exception\CommandNotFoundException;
+use Symfony\Component\Console\Exception\CommandNotRegisteredException;
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Debug\Exception\FatalThrowableError;
@@ -91,7 +93,18 @@ public function find($name)
     {
         $this->registerCommands();
 
-        return parent::find($name);
+        try {
+            return parent::find($name);
+        } catch (CommandNotFoundException $e) {
+            if ($this->registrationErrors) {
+                foreach ($this->registrationErrors as $error) {
+                    $errors[] = $error->getMessage();
+                }
+                throw new CommandNotRegisteredException(implode('
+            ', $errors), 0, $e);
+            }
+            throw $e;
+        }
     }
 
     /**
@@ -101,7 +114,18 @@ public function get($name)
     {
         $this->registerCommands();
 
-        $command = parent::get($name);
+        try {
+            $command = parent::get($name);
+        } catch (CommandNotFoundException $e) {
+            if ($this->registrationErrors) {
+                foreach ($this->registrationErrors as $error) {
+                    $errors[] = $error->getMessage();
+                }
+                throw new CommandNotRegisteredException(implode('
+            ', $errors));
+            }
+            throw $e;
+        }
 
         if ($command instanceof ContainerAwareInterface) {
             $command->setContainer($this->kernel->getContainer());
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Console/ApplicationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Console/ApplicationTest.php
@@ -165,6 +165,37 @@ public function testRunOnlyWarnsOnUnregistrableCommand()
         $this->assertContains('fine', $output);
     }
 
+    public function testRunOnlyWarnsOnNoName()
+    {
+        $container = new ContainerBuilder();
+        $container->register('event_dispatcher', EventDispatcher::class);
+        $container->register(ThrowingCommand::class, ThrowingCommand::class);
+        $container->setParameter('console.command.ids', array(ThrowingCommand::class => ThrowingCommand::class));
+
+        $kernel = $this->getMockBuilder(KernelInterface::class)->getMock();
+        $kernel
+            ->method('getBundles')
+            ->willReturn(array($this->createBundleMock(
+                array((new Command(null))->setCode(function (InputInterface $input, OutputInterface $output) { $output->write('fine'); }))
+            )));
+        $kernel
+            ->method('getContainer')
+            ->willReturn($container);
+
+        $application = new Application($kernel);
+        $application->setAutoExit(false);
+
+        $tester = new ApplicationTester($application);
+        $tester->run(array('command' => 'fine'));
+        $tester->getOutput();
+        $output = $tester->getDisplay();
+
+        $this->assertSame(1, $tester->getStatusCode());
+        $this->assertContains('Some commands could not be registered:', $output);
+        $this->assertContains('throwing', $output);
+        $this->assertContains('fine', $output);
+    }
+
     private function getKernel(array $bundles, $useDispatcher = false)
     {
         $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerInterface')->getMock();
diff --git a/src/Symfony/Component/Console/Exception/CommandNotRegisteredException.php b/src/Symfony/Component/Console/Exception/CommandNotRegisteredException.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Console\Exception;
+
+/**
+ * Represents a non-registered command.
+ *
+ * @author Hamza Amrouche <hamza.simperfit@gmail.com>
+ */
+class CommandNotRegisteredException extends CommandNotFoundException
+{
+    /**
+     * @param string     $message  Exception message to throw
+     * @param int        $code     Exception code
+     * @param \Exception $previous Previous exception used for the exception chaining
+     */
+    public function __construct($message, $code = 0, \Exception $previous = null)
+    {
+        $message = sprintf("[WARNING] Some commands could not be registered: \n %s", $message);
+        parent::__construct($message, $previous instanceof CommandNotFoundException ? $previous->getAlternatives() : array(), $code, $previous);
+    }
+}
