ENGCOM-6181: Outuput for Exception in db-declaration:generate-whitelist command #25302

Author: VladimirZaets

app/code/Magento/Developer/Console/Command/TablesWhitelistGenerateCommand.php

@@ -10,6 +10,7 @@
 use Magento\Developer\Model\Setup\Declaration\Schema\WhitelistGenerator;
 use Magento\Framework\Config\FileResolverByModule;
 use Magento\Framework\Exception\ConfigurationMismatchException;
+use Magento\Framework\Console\Cli;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -80,11 +81,12 @@ protected function execute(InputInterface $input, OutputInterface $output) : int
             $this->whitelistGenerator->generate($moduleName);
         } catch (ConfigurationMismatchException $e) {
             $output->writeln($e->getMessage());
-            return \Magento\Framework\Console\Cli::RETURN_FAILURE;
+            return Cli::RETURN_FAILURE;
         } catch (\Exception $e) {
-            return \Magento\Framework\Console\Cli::RETURN_FAILURE;
+            $output->writeln($e->getMessage());
+            return Cli::RETURN_FAILURE;
         }
 
-        return \Magento\Framework\Console\Cli::RETURN_SUCCESS;
+        return Cli::RETURN_SUCCESS;
     }
 }

app/code/Magento/Developer/Test/Unit/Console/Command/TablesWhitelistGenerateCommandTest.php

@@ -0,0 +1,158 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Developer\Test\Unit\Console\Command;
+
+use Magento\Developer\Console\Command\TablesWhitelistGenerateCommand as GenerateCommand;
+use Magento\Developer\Model\Setup\Declaration\Schema\WhitelistGenerator;
+use Magento\Framework\Console\Cli;
+use Magento\Framework\Exception\ConfigurationMismatchException as ConfigException;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Tester\CommandTester;
+
+/**
+ * Class TablesWhitelistGenerateCommandTest
+ *
+ * @package Magento\Developer\Test\Unit\Console\Command
+ */
+class TablesWhitelistGenerateCommandTest extends TestCase
+{
+    // Exception Messages!
+    const CONFIG_EXCEPTION_MESSAGE = 'Configuration Exception Message';
+    const EXCEPTION_MESSAGE = 'General Exception Message';
+
+    /** @var WhitelistGenerator|MockObject $whitelistGenerator */
+    private $whitelistGenerator;
+
+    /** @var GenerateCommand $instance */
+    private $instance;
+
+    protected function setUp()
+    {
+        $this->whitelistGenerator = $this->getMockBuilder(WhitelistGenerator::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->instance = new GenerateCommand($this->whitelistGenerator);
+    }
+
+    /**
+     * Test case for success scenario
+     *
+     * @param string $arguments
+     * @param string $expected
+     *
+     * @dataProvider successDataProvider
+     */
+    public function testCommandSuccess(string $arguments, string $expected)
+    {
+        $this->whitelistGenerator->expects($this->once())
+            ->method('generate')
+            ->with($arguments);
+
+        $commandTest = $this->execute($arguments);
+        $this->assertEquals($expected, $commandTest->getStatusCode());
+        $this->assertEquals('', $commandTest->getDisplay());
+    }
+
+    /**
+     * Test case for failure scenario
+     *
+     * @param string $arguments
+     * @param string $expected
+     * @param \Exception|ConfigException $exception
+     * @param string $output
+     *
+     * @dataProvider failureDataProvider
+     */
+    public function testCommandFailure(string $arguments, string $expected, $exception, string $output)
+    {
+        $this->whitelistGenerator->expects($this->once())
+            ->method('generate')
+            ->with($arguments)
+            ->willReturnCallback(
+                function () use ($exception) {
+                    throw $exception;
+                }
+            );
+
+        $commandTest = $this->execute($arguments);
+        $this->assertEquals($expected, $commandTest->getStatusCode());
+        $this->assertEquals($output . PHP_EOL, $commandTest->getDisplay());
+    }
+
+    /**
+     * Data provider for success test case
+     *
+     * @return array
+     */
+    public function successDataProvider()
+    {
+        return [
+            [
+                'all',
+                Cli::RETURN_SUCCESS,
+
+            ],
+            [
+                'Module_Name',
+                Cli::RETURN_SUCCESS
+            ]
+        ];
+    }
+
+    /**
+     * Data provider for failure test case
+     *
+     * @return array
+     */
+    public function failureDataProvider()
+    {
+        return [
+            [
+                'all',
+                Cli::RETURN_FAILURE,
+                new ConfigException(__('Configuration Exception Message')),
+                self::CONFIG_EXCEPTION_MESSAGE
+            ],
+            [
+                'Module_Name',
+                Cli::RETURN_FAILURE,
+                new ConfigException(__('Configuration Exception Message')),
+                self::CONFIG_EXCEPTION_MESSAGE
+            ],
+            [
+                'all',
+                Cli::RETURN_FAILURE,
+                new \Exception(self::EXCEPTION_MESSAGE),
+                self::EXCEPTION_MESSAGE
+            ],
+            [
+                'Module_Name',
+                Cli::RETURN_FAILURE,
+                new \Exception(self::EXCEPTION_MESSAGE),
+                self::EXCEPTION_MESSAGE
+            ]
+        ];
+    }
+
+    /**
+     * Execute command test class for symphony
+     *
+     * @param string $arguments
+     *
+     * @return CommandTester
+     */
+    private function execute(string $arguments)
+    {
+        $commandTest = new CommandTester($this->instance);
+        $commandTest->execute(['--' . GenerateCommand::MODULE_NAME_KEY => $arguments]);
+
+        return $commandTest;
+    }
+}