控制台测试

• 简介
• 成功/失败断言
• 输入/输出断言
• 控制台事件

简介

除了简化 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',
        '邮箱',
    ], [
        [1, 'taylor@example.com'],
        [2, 'abigail@example.com'],
    ]);

控制台事件

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

Pest

<?php

use Illuminate\Foundation\Testing\WithConsoleEvents;

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

// ...

PHPUnit

<?php

namespace Tests\Feature;

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

class ConsoleEventTest extends TestCase
{
    use WithConsoleEvents;

    // ...
}