Add Hyperf\Command\Concerns\Prohibitable (#7265)

Author: huangdijia

src/Concerns/Prohibitable.php

@@ -0,0 +1,51 @@
+<?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 Hyperf\Command\Concerns;
+
+trait Prohibitable
+{
+    /**
+     * Indicates if the command should be prohibited from running.
+     *
+     * @var bool
+     */
+    protected static $prohibitedFromRunning = false;
+
+    /**
+     * Indicate whether the command should be prohibited from running.
+     *
+     * @param bool $prohibit
+     */
+    public static function prohibit($prohibit = true)
+    {
+        static::$prohibitedFromRunning = $prohibit;
+    }
+
+    /**
+     * Determine if the command is prohibited from running and display a warning if so.
+     *
+     * @return bool
+     */
+    protected function isProhibited(bool $quiet = false)
+    {
+        if (! static::$prohibitedFromRunning) {
+            return false;
+        }
+
+        if (! $quiet) {
+            $this->output->warn('This command is prohibited from running in this environment.');
+        }
+
+        return true;
+    }
+}

tests/Command/FooProhibitableCommand.php

@@ -0,0 +1,30 @@
+<?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\Command\Concerns\Prohibitable;
+
+class FooProhibitableCommand extends Command
+{
+    use Prohibitable;
+
+    public function handle()
+    {
+        if ($this->isProhibited()) {
+            return self::FAILURE;
+        }
+
+        return self::SUCCESS;
+    }
+}

tests/CommandTest.php

@@ -18,6 +18,7 @@
 use HyperfTest\Command\Command\FooCommand;
 use HyperfTest\Command\Command\FooExceptionCommand;
 use HyperfTest\Command\Command\FooExitCommand;
+use HyperfTest\Command\Command\FooProhibitableCommand;
 use HyperfTest\Command\Command\FooTraitCommand;
 use HyperfTest\Command\Command\SwooleFlagsCommand;
 use HyperfTest\Command\Command\Traits\Foo;
@@ -101,4 +102,31 @@ public function testExitCodeWhenThrowExceptionInCoroutine()
     {
         $this->testExitCodeWhenThrowException();
     }
+
+    public function testProhibitableCommand()
+    {
+        $application = Mockery::mock(ConsoleApplication::class);
+        $application->shouldReceive('getHelperSet');
+
+        $output = Mockery::mock(OutputInterface::class);
+        $command = new ClassInvoker(new FooProhibitableCommand());
+        $command->setApplication($application);
+        $command->setOutput($output);
+        $input = Mockery::mock(InputInterface::class);
+        $input->shouldReceive('getOption')->andReturnFalse();
+        $result = $command->execute($input, $output);
+        $this->assertSame(FooProhibitableCommand::SUCCESS, $result);
+
+        FooProhibitableCommand::prohibit(true);
+
+        $output = Mockery::mock(OutputInterface::class);
+        $output->shouldReceive('warn')->andReturn();
+        $command = new ClassInvoker(new FooProhibitableCommand());
+        $command->setApplication($application);
+        $command->setOutput($output);
+        $input = Mockery::mock(InputInterface::class);
+        $input->shouldReceive('getOption')->andReturnFalse();
+        $result = $command->execute($input, $output);
+        $this->assertSame(FooProhibitableCommand::FAILURE, $result);
+    }
 }