控制台测试

简介

除了简化 HTTP 测试之外，Laravel 还为测试应用的 自定义控制台命令 提供了简单的 API。

成功 / 失败预期

首先，我们来了解如何针对 Artisan 命令的退出码进行断言。为此，我们将使用 artisan 方法在测试中调用 Artisan 命令。然后，我们将使用 assertExitCode 方法断言该命令以给定的退出码完成：

test('console command', function () {
    $this->artisan('inspire')->assertExitCode(0);
});

/**
 * 测试控制台命令。
 */
public function test_console_command(): void
{
    $this->artisan('inspire')->assertExitCode(0);
}

您可以使用 assertNotExitCode 方法断言该命令未以给定的退出码退出：

$this->artisan('inspire')->assertNotExitCode(1);

当然，所有终端命令在成功时通常会以 0 状态码退出，失败时则以非零退出码退出。因此，为了方便起见，您可以使用 assertSuccessful 和 assertFailed 断言来判断给定命令是否以成功退出码退出：

$this->artisan('inspire')->assertSuccessful();

$this->artisan('inspire')->assertFailed();

输入 / 输出预期

Laravel 允许您使用 expectsQuestion 方法轻松为控制台命令“模拟”用户输入。此外，您可以使用 assertExitCode 和 expectsOutput 方法指定预期控制台命令输出的退出码和文本。例如，考虑以下控制台命令：

Artisan::command('question', function () {
    $name = $this->ask('What is your name?');

    $language = $this->choice('Which language do you prefer?', [
        'PHP',
        'Ruby',
        'Python',
    ]);

    $this->line('Your name is '.$name.' and you prefer '.$language.'.');
});

您可以使用以下测试对该命令进行测试：

test('console command', function () {
    $this->artisan('question')
        ->expectsQuestion('What is your name?', 'Taylor Otwell')
        ->expectsQuestion('Which language do you prefer?', 'PHP')
        ->expectsOutput('Your name is Taylor Otwell and you prefer PHP.')
        ->doesntExpectOutput('Your name is Taylor Otwell and you prefer Ruby.')
        ->assertExitCode(0);
});

/**
 * 测试控制台命令。
 */
public function test_console_command(): void
{
    $this->artisan('question')
        ->expectsQuestion('What is your name?', 'Taylor Otwell')
        ->expectsQuestion('Which language do you prefer?', 'PHP')
        ->expectsOutput('Your name is Taylor Otwell and you prefer PHP.')
        ->doesntExpectOutput('Your name is Taylor Otwell and you prefer Ruby.')
        ->assertExitCode(0);
}

如果您使用的是 Laravel Prompts 提供的 search 或 multisearch 功能，则可以使用 expectsSearch 断言来模拟用户输入、搜索结果和选择：

test('console command', function () {
    $this->artisan('example')
        ->expectsSearch('What is your name?', search: 'Tay', answers: [
            'Taylor Otwell',
            'Taylor Swift',
            'Darian Taylor'
        ], answer: 'Taylor Otwell')
        ->assertExitCode(0);
});

/**
 * 测试控制台命令。
 */
public function test_console_command(): void
{
    $this->artisan('example')
        ->expectsSearch('What is your name?', search: 'Tay', answers: [
            'Taylor Otwell',
            'Taylor Swift',
            'Darian Taylor'
        ], answer: 'Taylor Otwell')
        ->assertExitCode(0);
}

您也可以使用 doesntExpectOutput 方法断言控制台命令未生成任何输出：

test('console command', function () {
    $this->artisan('example')
        ->doesntExpectOutput()
        ->assertExitCode(0);
});

/**
 * 测试控制台命令。
 */
public function test_console_command(): void
{
    $this->artisan('example')
        ->doesntExpectOutput()
        ->assertExitCode(0);
}

可以使用 expectsOutputToContain 和 doesntExpectOutputToContain 方法对部分输出进行断言：

test('console command', function () {
    $this->artisan('example')
        ->expectsOutputToContain('Taylor')
        ->assertExitCode(0);
});

/**
 * 测试控制台命令。
 */
public function test_console_command(): void
{
    $this->artisan('example')
        ->expectsOutputToContain('Taylor')
        ->assertExitCode(0);
}

确认预期

当编写需要以“是”或“否”形式进行确认的命令时，可以使用 expectsConfirmation 方法：

$this->artisan('module:import')
    ->expectsConfirmation('Do you really wish to run this command?', 'no')
    ->assertExitCode(1);

表格预期

如果您的命令使用 Artisan 的 table 方法显示信息表格，那么为整个表格编写输出预期会非常繁琐。此时，您可以使用 expectsTable 方法。该方法的第一个参数为表格的表头，第二个参数为表格的数据：

$this->artisan('users:all')
    ->expectsTable([
        'ID',
        'Email',
    ], [
        [1, '[email protected]'],
        [2, '[email protected]'],
    ]);

控制台事件

默认情况下，在运行应用测试时，不会分发 Illuminate\Console\Events\CommandStarting 和 Illuminate\Console\Events\CommandFinished 事件。不过，您可以通过在测试类中添加 Illuminate\Foundation\Testing\WithConsoleEvents trait 来为给定的测试类启用这些事件：

<?php

use Illuminate\Foundation\Testing\WithConsoleEvents;

pest()->use(WithConsoleEvents::class);

// ...

<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\WithConsoleEvents;
use Tests\TestCase;

class ConsoleEventTest extends TestCase
{
    use WithConsoleEvents;

    // ...
}