Fixed bug that exit code of Command is incorrect when throwing an exception. (#4068)

Co-authored-by: 李铭昕 <715557344@qq.com>

Author: upper1027

src/Command.php

@@ -92,6 +92,13 @@ abstract class Command extends SymfonyCommand
             'normal' => OutputInterface::VERBOSITY_NORMAL,
         ];
 
+    /**
+     * The exit code of the command.
+     *
+     * @var int
+     */
+    protected $exitCode = 0;
+
     public function __construct(string $name = null)
     {
         if (! $name && $this->name) {
@@ -438,15 +445,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 $this->eventDispatcher && $this->eventDispatcher->dispatch(new Event\AfterHandle($this));
             } catch (\Throwable $exception) {
                 if (class_exists(ExitException::class) && $exception instanceof ExitException) {
-                    return 0;
+                    return $this->exitCode = (int) $exception->getStatus();
                 }
 
                 if (! $this->eventDispatcher) {
                     throw $exception;
                 }
 
                 $this->eventDispatcher->dispatch(new Event\FailToHandle($this, $exception));
-                return $exception->getCode();
+                return $this->exitCode = $exception->getCode();
             } finally {
                 $this->eventDispatcher && $this->eventDispatcher->dispatch(new Event\AfterExecute($this));
             }
@@ -456,7 +463,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         if ($this->coroutine && ! Coroutine::inCoroutine()) {
             run($callback, $this->hookFlags);
-            return 0;
+            return $this->exitCode;
         }
 
         return $callback();

tests/Command/FooCommand.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace HyperfTest\Command\Command;
+
+use Hyperf\Command\Command;
+
+class FooCommand extends Command
+{
+    public function handle()
+    {
+    }
+}

tests/Command/FooExceptionCommand.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace HyperfTest\Command\Command;
+
+use Hyperf\Command\Command;
+use Hyperf\Event\EventDispatcher;
+use Hyperf\Event\ListenerProvider;
+
+class FooExceptionCommand extends Command
+{
+    public function __construct(string $name = null)
+    {
+        parent::__construct($name);
+
+        $this->eventDispatcher = new EventDispatcher(
+            new ListenerProvider()
+        );
+    }
+
+    public function handle()
+    {
+        throw new \RuntimeException('xxx', 99);
+    }
+}

tests/Command/FooExitCommand.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+namespace HyperfTest\Command\Command;
+
+use Hyperf\Command\Command;
+use Hyperf\Event\EventDispatcher;
+use Hyperf\Event\ListenerProvider;
+
+class FooExitCommand extends Command
+{
+    public function __construct(string $name = null)
+    {
+        parent::__construct($name);
+
+        $this->eventDispatcher = new EventDispatcher(
+            new ListenerProvider()
+        );
+    }
+
+    public function handle()
+    {
+        exit('11xxx');
+    }
+}

tests/CommandTest.php

@@ -11,16 +11,28 @@
  */
 namespace HyperfTest\Command;
 
+use Hyperf\Utils\Reflection\ClassInvoker;
 use HyperfTest\Command\Command\DefaultSwooleFlagsCommand;
+use HyperfTest\Command\Command\FooCommand;
+use HyperfTest\Command\Command\FooExceptionCommand;
+use HyperfTest\Command\Command\FooExitCommand;
 use HyperfTest\Command\Command\SwooleFlagsCommand;
+use Mockery;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
 
 /**
  * @internal
  * @coversNothing
  */
 class CommandTest extends TestCase
 {
+    protected function tearDown(): void
+    {
+        Mockery::close();
+    }
+
     public function testHookFlags()
     {
         $command = new DefaultSwooleFlagsCommand('test:demo');
@@ -29,4 +41,32 @@ public function testHookFlags()
         $command = new SwooleFlagsCommand('test:demo2');
         $this->assertSame(SWOOLE_HOOK_ALL | SWOOLE_HOOK_CURL, $command->getHookFlags());
     }
+
+    /**
+     * @group NonCoroutine
+     */
+    public function testExitCodeWhenThrowException()
+    {
+        /** @var FooExceptionCommand $command */
+        $command = new ClassInvoker(new FooExceptionCommand());
+        $input = Mockery::mock(InputInterface::class);
+        $input->shouldReceive('getOption')->andReturnFalse();
+        $exitCode = $command->execute($input, Mockery::mock(OutputInterface::class));
+        $this->assertSame(99, $exitCode);
+
+        /** @var FooExitCommand $command */
+        $command = new ClassInvoker(new FooExitCommand());
+        $exitCode = $command->execute($input, Mockery::mock(OutputInterface::class));
+        $this->assertSame(11, $exitCode);
+
+        /** @var FooCommand $command */
+        $command = new ClassInvoker(new FooCommand());
+        $exitCode = $command->execute($input, Mockery::mock(OutputInterface::class));
+        $this->assertSame(0, $exitCode);
+    }
+
+    public function testExitCodeWhenThrowExceptionInCoroutine()
+    {
+        $this->testExitCodeWhenThrowException();
+    }
 }