控制台测试

• 介绍
• 成功/失败期望
• 输入/输出期望
• 控制台事件

介绍

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

成功/失败期望

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

Pest

test('控制台命令', function () {
    $this->artisan('inspire')->assertExitCode(0);
});

PHPUnit

/**
 * 测试控制台命令。
 */
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('你叫什么名字？');

    $language = $this->choice('你更喜欢哪种语言？', [
        'PHP',
        'Ruby',
        'Python',
    ]);

    $this->line('你的名字是 '.$name.'，你更喜欢 '.$language.'。');
});

您可以使用以下测试来测试此命令：

Pest

test('控制台命令', function () {
    $this->artisan('question')
         ->expectsQuestion('你叫什么名字？', 'Taylor Otwell')
         ->expectsQuestion('你更喜欢哪种语言？', 'PHP')
         ->expectsOutput('你的名字是 Taylor Otwell，您更喜欢 PHP。')
         ->doesntExpectOutput('你的名字是 Taylor Otwell，您更喜欢 Ruby。')
         ->assertExitCode(0);
});

PHPUnit

/**
 * 测试控制台命令。
 */
public function test_console_command(): void
{
    $this->artisan('question')
         ->expectsQuestion('你叫什么名字？', 'Taylor Otwell')
         ->expectsQuestion('你更喜欢哪种语言？', 'PHP')
         ->expectsOutput('你的名字是 Taylor Otwell，您更喜欢 PHP。')
         ->doesntExpectOutput('你的名字是 Taylor Otwell，您更喜欢 Ruby。')
         ->assertExitCode(0);
}

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

Pest

test('控制台命令', function () {
    $this->artisan('example')
         ->expectsSearch('你叫什么名字？', search: 'Tay', answers: [
            'Taylor Otwell',
            'Taylor Swift',
            'Darian Taylor'
         ], answer: 'Taylor Otwell')
         ->assertExitCode(0);
});

PHPUnit

/**
 * 测试控制台命令。
 */
public function test_console_command(): void
{
    $this->artisan('example')
         ->expectsSearch('你叫什么名字？', search: 'Tay', answers: [
            'Taylor Otwell',
            'Taylor Swift',
            'Darian Taylor'
         ], answer: 'Taylor Otwell')
         ->assertExitCode(0);
}

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

Pest

test('控制台命令', function () {
    $this->artisan('example')
         ->doesntExpectOutput()
         ->assertExitCode(0);
});

PHPUnit

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

expectsOutputToContain 和 doesntExpectOutputToContain 方法可用于对输出的一部分进行断言：

Pest

test('控制台命令', function () {
    $this->artisan('example')
         ->expectsOutputToContain('Taylor')
         ->assertExitCode(0);
});

PHPUnit

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

确认期望

当编写一个期望以“是”或“否”答案形式确认的命令时，您可以使用 expectsConfirmation 方法：

$this->artisan('module:import')
    ->expectsConfirmation('您真的希望运行此命令吗？', 'no')
    ->assertExitCode(1);

表格期望

如果您的命令使用 Artisan 的 table 方法显示信息表，编写整个表的输出期望可能会很麻烦。相反，您可以使用 expectsTable 方法。此方法接受表头作为第一个参数，表数据作为第二个参数：

$this->artisan('users:all')
    ->expectsTable([
        'ID',
        'Email',
    ], [
        [1, 'taylor@example.com'],
        [2, 'abigail@example.com'],
    ]);

控制台事件

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

Pest

<?php

use Illuminate\Foundation\Testing\WithConsoleEvents;

uses(WithConsoleEvents::class);

// ...

PHPUnit

<?php

namespace Tests\Feature;

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

class ConsoleEventTest extends TestCase
{
    use WithConsoleEvents;

    // ...
}