MAGETWO-35133: Search for Commands

- changes in readme according to CR
- throws exceprtion in case if command class does not exist and added testcase for that
- added docbloc descriptions for classes

Author: Ivan Gavryshko

dev/tools/Magento/Tools/Console/CommandList.php

@@ -6,8 +6,11 @@
 
 namespace Magento\Tools\Console;
 
-use Symfony\Component\Console\Command\Command;
-
+/**
+ * Class CommandList contains predefined list of command classes for Tools
+ *
+ * @package Magento\Tools\Console
+ */
 class CommandList
 {
     /**
@@ -24,17 +27,17 @@ protected function getCommandsClasses()
      * Gets list of command instances
      *
      * @return \Symfony\Component\Console\Command\Command[]
+     * @throws \Exception
      */
     public function getCommands()
     {
         $commands = [];
 
         foreach ($this->getCommandsClasses() as $class) {
             if (class_exists($class)) {
-                $command = new $class;
-                if ($command instanceof Command) {
-                    $commands[] = $command;
-                }
+                $commands[] = new $class;
+            } else {
+                throw new \Exception('Class ' . $class . ' does not exist');
             }
         }
 

lib/internal/Magento/Framework/App/Test/Unit/Console/CommandListTest.php

@@ -35,4 +35,17 @@ public function testGetCommands()
         $this->objectManager->expects($this->once())->method('get')->with('Symfony\Component\Console\Command\Command');
         $this->commandList->getCommands();
     }
+
+    /**
+     * @expectedException \Exception
+     * @expectedExceptionMessage Class Symfony\Component\Console\Command\WrongCommand does not exist
+     */
+    public function testGetCommandsException()
+    {
+        $wrongCommands =[
+            'Symfony\Component\Console\Command\WrongCommand'
+        ];
+        $commandList = new CommandList($this->objectManager, $wrongCommands);
+        $commandList->getCommands();
+    }
 }

lib/internal/Magento/Framework/Console/CommandList.php

@@ -7,8 +7,12 @@
 namespace Magento\Framework\Console;
 
 use Magento\Framework\ObjectManagerInterface;
-use Symfony\Component\Console\Command\Command;
 
+/**
+ * Class CommandList has a list of commands, which can be extended via DI configuration.
+ *
+ * @package Magento\Framework\Console
+ */
 class CommandList
 {
     /**
@@ -37,16 +41,16 @@ public function __construct(ObjectManagerInterface $objectManager, array $comman
      * Gets list of command instances
      *
      * @return \Symfony\Component\Console\Command\Command[]
+     * @throws \Exception
      */
     public function getCommands()
     {
         $commands = [];
         foreach ($this->commands as $class) {
             if (class_exists($class)) {
-                $command = $this->objectManager->get($class);
-                if ($command instanceof Command) {
-                    $commands[] = $command;
-                }
+                $commands[] = $this->objectManager->get($class);
+            } else {
+                throw new \Exception('Class ' . $class . ' does not exist');
             }
         }
 

lib/internal/Magento/Framework/Console/README.md

@@ -1,3 +1,16 @@
 # Console
 
-This component has a list of commands, which can be extended via DI configuration.
+This component contains Magento Cli and can be extended via DI configuration.
+
+For example we can introduce new command in module using di.xml:
+
+```
+<type name="Magento\Framework\Console\CommandList">
+    <arguments>
+        <argument name="commands" xsi:type="array">
+            <item name="session_cleaner" xsi:type="string">Magento\MyModule\Console\TestMeCommand</item>
+        </argument>
+    </arguments>
+</type>
+```
+

setup/src/Magento/Setup/Console/CommandList.php

@@ -7,8 +7,12 @@
 namespace Magento\Setup\Console;
 
 use Zend\ServiceManager\ServiceManager;
-use Symfony\Component\Console\Command\Command;
 
+/**
+ * Class CommandList contains predefined list of commands for Setup
+ *
+ * @package Magento\Setup\Console
+ */
 class CommandList
 {
     /**
@@ -44,17 +48,17 @@ protected function getCommandsClasses()
      * Gets list of command instances
      *
      * @return \Symfony\Component\Console\Command\Command[]
+     * @throws \Exception
      */
     public function getCommands()
     {
         $commands = [];
 
         foreach ($this->getCommandsClasses() as $class) {
             if (class_exists($class)) {
-                $command = $this->serviceManager->create($class);
-                if ($command instanceof Command) {
-                    $commands[] = $command;
-                }
+                $commands[] = $this->serviceManager->create($class);
+            } else {
+                throw new \Exception('Class ' . $class . ' does not exist');
             }
         }