#24043: Better exception handling during cli commands.

Author: p-bystritsky

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

@@ -19,6 +19,7 @@
 use Magento\Setup\Application;
 use Magento\Setup\Console\CompilerPreparation;
 use Magento\Setup\Model\ObjectManagerProvider;
+use Psr\Log\LoggerInterface;
 use Symfony\Component\Console;
 use Magento\Framework\Config\ConfigOptionsListConstants;
 
@@ -61,6 +62,11 @@ class Cli extends Console\Application
      */
     private $objectManager;
 
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * @param string $name the application name
      * @param string $version the application version
@@ -94,6 +100,7 @@ public function __construct($name = 'UNKNOWN', $version = 'UNKNOWN')
 
         parent::__construct($name, $version);
         $this->serviceManager->setService(\Symfony\Component\Console\Application::class, $this);
+        $this->logger = $this->objectManager->get(LoggerInterface::class);
     }
 
     /**
@@ -107,7 +114,9 @@ public function doRun(Console\Input\InputInterface $input, Console\Output\Output
         try {
             $exitCode = parent::doRun($input, $output);
         } catch (\Exception $e) {
-            $output->writeln($e->getTraceAsString());
+            $errorMessage = $e->getMessage() . PHP_EOL . $e->getTraceAsString();
+            $this->logger->error($errorMessage);
+            $this->initException = $e;
         }
 
         if ($this->initException) {

lib/internal/Magento/Framework/Console/Test/Unit/CliTest.php

@@ -0,0 +1,81 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\Console\Test\Unit;
+
+use Magento\Framework\Console\Cli;
+use PHPUnit\Framework\MockObject\MockObject;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ *  Test for Magento\Framework\Console\Cli class.
+ */
+class CliTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var Cli
+     */
+    private $cli;
+
+    /**
+     * @var InputInterface|MockObject
+     */
+    private $inputMock;
+
+    /**
+     * @var OutputInterface|MockObject
+     */
+    private $outputMock;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp()
+    {
+        $this->inputMock = $this->getMockBuilder(InputInterface::class)
+            ->getMockForAbstractClass();
+        $this->outputMock = $this->getMockBuilder(OutputInterface::class)
+            ->getMockForAbstractClass();
+        $this->cli = new Cli();
+    }
+
+    /**
+     * Make sure exception message is displayed and trace is logged.
+     *
+     * @expectedException \Exception
+     * @expectedExceptionMessage Test message
+     */
+    public function testDoRunExceptionLogging()
+    {
+        $e = new \Exception('Test message');
+        $this->inputMock->expects($this->once())->method('getFirstArgument')->willThrowException($e);
+        $loggerMock = $this->createMock(LoggerInterface::class);
+        $loggerMock->expects($this->once())
+            ->method('error')
+            ->with($e->getMessage() . PHP_EOL . $e->getTraceAsString());
+        $this->injectMock($loggerMock, 'logger');
+
+        $this->cli->doRun($this->inputMock, $this->outputMock);
+    }
+
+    /**
+     * Inject mock to Cli property.
+     *
+     * @param MockObject $mockObject
+     * @param string $propertyName
+     * @throws \ReflectionException
+     */
+    private function injectMock(MockObject $mockObject, string $propertyName): void
+    {
+        $reflection = new \ReflectionClass(Cli::class);
+        $reflectionProperty = $reflection->getProperty($propertyName);
+        $reflectionProperty->setAccessible(true);
+        $reflectionProperty->setValue($this->cli, $mockObject);
+    }
+}