Merge remote-tracking branch 'falcon/MAGETWO-62655' into MAGETWO-62964

Author: oshmyheliuk

bin/magento

@@ -28,5 +28,5 @@ try {
         echo "\n\n";
         $e = $e->getPrevious();
     }
-    exit(Cli::RETURN_FAILURE);
+    exit(Magento\Framework\Console\Cli::RETURN_FAILURE);
 }

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

@@ -5,102 +5,105 @@
  */
 namespace Magento\Framework\Console;
 
+use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\App\State;
+use Magento\Framework\Code\Generator\Io;
 use Magento\Framework\Composer\ComposerJsonFinder;
-use Symfony\Component\Console\Input\InputInterface;
-use Symfony\Component\Console\Output\OutputInterface;
-use Symfony\Component\Console\Output\ConsoleOutput;
-use Symfony\Component\Console\Input\ArgvInput;
-use Symfony\Component\Console\Application as SymfonyApplication;
+use Magento\Framework\Exception\FileSystemException;
+use Magento\Setup\Model\ObjectManagerProvider;
+use Symfony\Component\Console;
 use Magento\Framework\App\Bootstrap;
 use Magento\Framework\Filesystem\Driver\File;
 use Magento\Framework\Shell\ComplexParameter;
 use Magento\Setup\Console\CompilerPreparation;
-use \Magento\Framework\App\ProductMetadata;
+use Magento\Framework\App\ProductMetadata;
+use Magento\Framework\ObjectManagerInterface;
+use Zend\ServiceManager\ServiceManager;
 
 /**
- * Magento 2 CLI Application. This is the hood for all command line tools supported by Magento
+ * Magento 2 CLI Application.
+ * This is the hood for all command line tools supported by Magento.
  *
  * {@inheritdoc}
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class Cli extends SymfonyApplication
+class Cli extends Console\Application
 {
     /**
-     * Name of input option
+     * Name of input option.
      */
     const INPUT_KEY_BOOTSTRAP = 'bootstrap';
 
-    /**
-     * Cli exit codes
+    /**#@+
+     * Cli exit codes.
      */
     const RETURN_SUCCESS = 0;
     const RETURN_FAILURE = 1;
+    /**#@-*/
 
-    /** @var \Zend\ServiceManager\ServiceManager */
+    /**
+     * Service Manager.
+     *
+     * @var ServiceManager
+     */
     private $serviceManager;
 
     /**
-     * Initialization exception
+     * Initialization exception.
      *
      * @var \Exception
      */
     private $initException;
 
     /**
-     * @param string $name  application name
-     * @param string $version application version
-     * @SuppressWarnings(PHPMD.ExitExpression)
+     * Object Manager.
+     *
+     * @var ObjectManagerInterface
+     */
+    private $objectManager;
+
+    /**
+     * @param string $name the application name
+     * @param string $version the application version
      */
     public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN')
     {
         $this->serviceManager = \Zend\Mvc\Application::init(require BP . '/setup/config/application.config.php')
             ->getServiceManager();
-        $generationDirectoryAccess = new GenerationDirectoryAccess($this->serviceManager);
-        if (!$generationDirectoryAccess->check()) {
-            $output = new ConsoleOutput();
-            $output->writeln(
-                '<error>Command line user does not have read and write permissions on var/generation directory.  Please'
-                . ' address this issue before using Magento command line.</error>'
-            );
-            exit(0);
-        }
-        /**
-         * Temporary workaround until the compiler is able to clear the generation directory
-         * @todo remove after MAGETWO-44493 resolved
-         */
-        if (class_exists(CompilerPreparation::class)) {
-            $compilerPreparation = new CompilerPreparation($this->serviceManager, new ArgvInput(), new File());
-            $compilerPreparation->handleCompilerEnvironment();
-        }
+
+        $this->assertCompilerPreparation();
+        $this->initObjectManager();
+        $this->assertGenerationPermissions();
 
         if ($version == 'UNKNOWN') {
-            $directoryList      = new DirectoryList(BP);
+            $directoryList = new DirectoryList(BP);
             $composerJsonFinder = new ComposerJsonFinder($directoryList);
-            $productMetadata    = new ProductMetadata($composerJsonFinder);
+            $productMetadata = new ProductMetadata($composerJsonFinder);
             $version = $productMetadata->getVersion();
         }
+
         parent::__construct($name, $version);
     }
 
     /**
-     * Process an error happened during initialization of commands, if any
+     * {@inheritdoc}
      *
-     * @param InputInterface $input
-     * @param OutputInterface $output
-     * @return int
-     * @throws \Exception
+     * @throws \Exception the exception in case of unexpected error
      */
-    public function doRun(InputInterface $input, OutputInterface $output)
+    public function doRun(Console\Input\InputInterface $input, Console\Output\OutputInterface $output)
     {
         $exitCode = parent::doRun($input, $output);
+
         if ($this->initException) {
             $output->writeln(
                 "<error>We're sorry, an error occurred. Try clearing the cache and code generation directories. "
                 . "By default, they are: var/cache, var/di, var/generation, and var/page_cache.</error>"
             );
+
             throw $this->initException;
         }
+
         return $exitCode;
     }
 
@@ -113,46 +116,141 @@ protected function getDefaultCommands()
     }
 
     /**
-     * Gets application commands
+     * Gets application commands.
      *
-     * @return array
+     * @return array a list of available application commands
      */
     protected function getApplicationCommands()
     {
         $commands = [];
         try {
-            $bootstrapParam = new ComplexParameter(self::INPUT_KEY_BOOTSTRAP);
-            $params = $bootstrapParam->mergeFromArgv($_SERVER, $_SERVER);
-            $params[Bootstrap::PARAM_REQUIRE_MAINTENANCE] = null;
-            $bootstrap = Bootstrap::create(BP, $params);
-            $objectManager = $bootstrap->getObjectManager();
-            /** @var \Magento\Setup\Model\ObjectManagerProvider $omProvider */
-            $omProvider = $this->serviceManager->get(\Magento\Setup\Model\ObjectManagerProvider::class);
-            $omProvider->setObjectManager($objectManager);
-
             if (class_exists(\Magento\Setup\Console\CommandList::class)) {
                 $setupCommandList = new \Magento\Setup\Console\CommandList($this->serviceManager);
                 $commands = array_merge($commands, $setupCommandList->getCommands());
             }
 
-            if ($objectManager->get(\Magento\Framework\App\DeploymentConfig::class)->isAvailable()) {
-                /** @var \Magento\Framework\Console\CommandListInterface */
-                $commandList = $objectManager->create(\Magento\Framework\Console\CommandListInterface::class);
+            if ($this->objectManager->get(DeploymentConfig::class)->isAvailable()) {
+                /** @var CommandListInterface */
+                $commandList = $this->objectManager->create(CommandListInterface::class);
                 $commands = array_merge($commands, $commandList->getCommands());
             }
 
-            $commands = array_merge($commands, $this->getVendorCommands($objectManager));
+            $commands = array_merge(
+                $commands,
+                $this->getVendorCommands($this->objectManager)
+            );
         } catch (\Exception $e) {
             $this->initException = $e;
         }
+
         return $commands;
     }
 
     /**
-     * Gets vendor commands
+     * Object Manager initialization.
+     *
+     * @return void
+     * @SuppressWarnings(PHPMD.ExitExpression)
+     */
+    private function initObjectManager()
+    {
+        try {
+            $params = (new ComplexParameter(self::INPUT_KEY_BOOTSTRAP))->mergeFromArgv($_SERVER, $_SERVER);
+            $params[Bootstrap::PARAM_REQUIRE_MAINTENANCE] = null;
+
+            $this->objectManager = Bootstrap::create(BP, $params)->getObjectManager();
+
+            /** @var ObjectManagerProvider $omProvider */
+            $omProvider = $this->serviceManager->get(ObjectManagerProvider::class);
+            $omProvider->setObjectManager($this->objectManager);
+        } catch (FileSystemException $exception) {
+            $this->writeGenerationDirectoryReadError();
+
+            exit(static::RETURN_FAILURE);
+        }
+    }
+
+    /**
+     * Checks whether generation directory is read-only.
+     * Depends on the current mode:
+     *      production - application will proceed
+     *      default - application will be terminated
+     *      developer - application will be terminated
+     *
+     * @return void
+     * @SuppressWarnings(PHPMD.ExitExpression)
+     */
+    private function assertGenerationPermissions()
+    {
+        /** @var GenerationDirectoryAccess $generationDirectoryAccess */
+        $generationDirectoryAccess = $this->objectManager->create(
+            GenerationDirectoryAccess::class,
+            ['serviceManager' => $this->serviceManager]
+        );
+        /** @var State $state */
+        $state = $this->objectManager->get(State::class);
+
+        if (
+            $state->getMode() !== State::MODE_PRODUCTION
+            && !$generationDirectoryAccess->check()
+        ) {
+            $this->writeGenerationDirectoryReadError();
+
+            exit(static::RETURN_FAILURE);
+        }
+    }
+
+    /**
+     * Checks whether compiler is being prepared.
+     *
+     * @return void
+     * @SuppressWarnings(PHPMD.ExitExpression)
+     */
+    private function assertCompilerPreparation()
+    {
+        /**
+         * Temporary workaround until the compiler is able to clear the generation directory
+         * @todo remove after MAGETWO-44493 resolved
+         */
+        if (class_exists(CompilerPreparation::class)) {
+            $compilerPreparation = new CompilerPreparation(
+                $this->serviceManager,
+                new Console\Input\ArgvInput(),
+                new File()
+            );
+
+            try {
+                $compilerPreparation->handleCompilerEnvironment();
+            } catch (FileSystemException $e) {
+                $this->writeGenerationDirectoryReadError();
+
+                exit(static::RETURN_FAILURE);
+            }
+        }
+    }
+
+    /**
+     * Writes read error to console.
      *
-     * @param \Magento\Framework\ObjectManagerInterface $objectManager
-     * @return array
+     * @return void
+     */
+    private function writeGenerationDirectoryReadError()
+    {
+        $output = new Console\Output\ConsoleOutput();
+        $output->writeln(
+            '<error>'
+            . 'Command line user does not have read and write permissions on ' . Io::DEFAULT_DIRECTORY . ' directory. '
+            . 'Please address this issue before using Magento command line.'
+            . '</error>'
+        );
+    }
+
+    /**
+     * Retrieves vendor commands.
+     *
+     * @param ObjectManagerInterface $objectManager the object manager
+     *
+     * @return array an array with external commands
      */
     protected function getVendorCommands($objectManager)
     {
@@ -165,6 +263,7 @@ protected function getVendorCommands($objectManager)
                 );
             }
         }
+
         return $commands;
     }
 }