如何高效测试Symfony控制台命令？Zenstruck/Console-Test助你写出优雅的测试代码

<code class="bash">composer require --dev zenstruck/console-test</code>

<pre class="brush:php;toolbar:false;"><?php

namespace App\Tests;

use App\Command\CreateUserCommand;
use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use Zenstruck\Console\Test\InteractsWithConsole;

class CreateUserCommandTest extends KernelTestCase
{
    use InteractsWithConsole; // 引入这个 trait

    public function testCanCreateUser(): void
    {
        // 简单执行命令并断言
        $this->executeConsoleCommand('create:user kbond --admin --role=ROLE_EMPLOYEE --role=ROLE_MANAGER')
            ->assertSuccessful() // 断言命令成功执行 (退出码为 0)
            ->assertOutputContains('Creating admin user "kbond"') // 断言标准输出包含特定字符串
            ->assertOutputNotContains('regular user') // 断言标准输出不包含特定字符串
        ;

        // 更高级的用法：通过 consoleCommand() 方法链式调用
        $this->consoleCommand(CreateUserCommand::class) // 可以传入命令类名或命令名称
            ->splitOutputStreams() // 分离标准输出和错误输出
            ->addArgument('another_user')
            ->addOption('--admin')
            ->addOption('role', ['ROLE_EMPLOYEE', 'ROLE_MANAGER'])
            ->addOption('-vv') // 设置输出详细级别
            ->execute() // 执行命令
            ->assertStatusCode(0) // 断言退出码
            ->assertOutputContains('Creating admin user "another_user"')
            // ->assertErrorOutputContains('this is in stderr') // 假设你的命令会将某些信息输出到 stderr
            ->dump() // 打印命令状态码和输出，并继续执行
        ;

        // 测试交互式命令
        $this->consoleCommand('create:user')
            ->addInput('interactive_user') // 模拟用户输入
            ->execute()
            ->assertSuccessful()
            ->assertOutputContains('Creating regular user "interactive_user"')
        ;

        // 测试命令抛出异常
        $this->consoleCommand(CreateUserCommand::class)
            ->expectException(\RuntimeException::class, 'Username required!') // 期望抛出特定异常及消息
            ->assertStatusCode(1) // 异常通常对应非零退出码
            ->assertOutputContains('Could not create user!') // 异常前可能仍有输出
        ;
    }
}

<pre class="brush:php;toolbar:false;"><?php

namespace App\Tests\Unit;

use App\Command\MyStandaloneCommand; // 假设这是你的命令类
use PHPUnit\Framework\TestCase;
use Zenstruck\Console\Test\TestCommand;

class MyStandaloneCommandTest extends TestCase
{
    public function testCanExecuteCommand(): void
    {
        // 直接为命令实例创建 TestCommand
        TestCommand::for(new MyStandaloneCommand(/* 构造函数参数 */))
            ->execute('arg1 --option1=value')
            ->assertSuccessful()
            ->assertOutputContains('Command executed successfully!')
        ;
    }
}

<pre class="brush:php;toolbar:false;"><!-- phpunit.xml -->
<phpunit>
    <!-- ... -->
    <php>
        <env name="COLUMNS" value="120" />
    </php>
    <!-- ... -->
</phpunit>