运行命令代码

Testing Is Documentation

tests/Console/RunCommandTest.php运行命令代码 - 图1

有时候我们需要在非命令行调用命令，比如在控制器等地方直接运行命令行代码，系统对这种场景进行了简单封装。

Uses

  1. <?php
  3. use Leevel\Console\Application;
  4. use Leevel\Console\RunCommand;
  5. use Leevel\Di\Container;
  6. use Tests\Console\Command\CallOtherCommand;
  7. use Tests\Console\Load1\Test1;

运行命令代码基本使用方法

fixture 定义

Tests\Console\Load1\Test1

  1. namespace Tests\Console\Load1;
  3. use Leevel\Console\Command;
  5. class Test1 extends Command
  6. {
  7.     protected string $name = 'load1:test1';
  9.     protected string $description = 'load1 test1 for command';
  11.     public function handle(): int
  12.     {
  13.         $this->info('load1 test1');
  15.         return 0;
  16.     }
  17. }

Tests\Console\Command\CallOtherCommand

  1. namespace Tests\Console\Command;
  3. use Leevel\Console\Command;
  5. class CallOtherCommand extends Command
  6. {
  7.     protected string $name = 'call:other';
  9.     protected string $description = 'call other command for test.';
  11.     public function handle(): int
  12.     {
  13.         $this->info('call other command test.');
  15.         $this->info('argument is '.json_encode($this->getArgument()));
  17.         $this->info('option is '.json_encode($this->getOption()));
  19.         $this->table([
  20.             'Item',
  21.             'Value',
  22.         ], [
  23.             ['hello', 'world'],
  24.             ['foo', 'bar'],
  25.         ]);
  27.         $this->info($this->time('test time'));
  29.         $this->question('a question');
  31.         $this->error('a error message');
  33.         $this->error('a error message');
  35.         $this->call('load1:test1');
  37.         return 0;
  38.     }
  39. }
  1. public function testBaseUse(): void
  2. {
  3.     $application = new Application(new Container(), '1.0');
  4.     $runCommand = new RunCommand($application);
  6.     $runCommand->normalizeCommand(Test1::class);
  7.     $result = $runCommand->handle(new CallOtherCommand(), [
  8.         'command'     => 'call:other',
  9.     ]);
  11.     $result = $this->normalizeContent($result);
  13.     $this->assertStringContainsString($this->normalizeContent('call other command test.'), $result);
  14.     $this->assertStringContainsString($this->normalizeContent('load1 test1'), $result);
  16.     // argument and option
  17.     $this->assertStringContainsString($this->normalizeContent('argument is {"command":"call:other"}'), $result);
  18.     $this->assertStringContainsString($this->normalizeContent('option is {"help":false,"quiet":false,"verbose":false,"version":false,"ansi":false,"no-ansi":false,"no-interaction":false}'), $result);
  20.     // table
  21.     $this->assertStringContainsString($this->normalizeContent('| Item  | Value |'), $result);
  22.     $this->assertStringContainsString($this->normalizeContent('| hello | world |'), $result);
  23.     $this->assertStringContainsString($this->normalizeContent('| foo   | bar   |'), $result);
  25.     // time
  26.     $this->assertStringContainsString($this->normalizeContent(']test time'), $result);
  28.     // question
  29.     $this->assertStringContainsString($this->normalizeContent('a question'), $result);
  31.     // error
  32.     $this->assertStringContainsString($this->normalizeContent('a error message'), $result);
  33. }

TIP

normalizeCommand 格式化命令，主要用于一个命令可能会调用其它命令，需要预先加载。