控制台测试

• 介绍
• 成功 / 失败预期
• 输入 / 输出预期

介绍

除了简化 HTTP 测试，Laravel 还提供了一个简单的 API 用于测试应用程序的自定义控制台命令。

成功 / 失败预期

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

/**
 * 测试一个控制台命令。
 *
 * @return void
 */
public function test_console_command()
{
    $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.'.');
});

您可以使用以下测试来测试此命令，该测试利用了 expectsQuestion、expectsOutput、doesntExpectOutput 和 assertExitCode 方法：

/**
 * 测试一个控制台命令。
 *
 * @return void
 */
public function test_console_command()
{
    $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);
}

确认预期

在编写需要确认的命令时，您可以使用 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, 'taylor@example.com'],
        [2, 'abigail@example.com'],
    ]);