laravel
9. 测试
控制台测试

介绍

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

成功/失败预期

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

test('控制台命令', 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('您叫什么名字？');

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

    $this->line('您的名字是 '.$name.' 并且您更喜欢 '.$language.'.');
});

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

test('控制台命令', function () {
    $this->artisan('question')
         ->expectsQuestion('您叫什么名字？', 'Taylor Otwell')
         ->expectsQuestion('您更喜欢哪种语言？', 'PHP')
         ->expectsOutput('您的名字是 Taylor Otwell 并且您更喜欢 PHP.')
         ->doesntExpectOutput('您的名字是 Taylor Otwell 并且您更喜欢 Ruby.')
         ->assertExitCode(0);
});
/**
 * 测试控制台命令。
 */
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 断言来模拟用户的输入、搜索结果和选择：

test('控制台命令', function () {
    $this->artisan('example')
         ->expectsSearch('您叫什么名字？', search: 'Tay', answers: [
            'Taylor Otwell',
            'Taylor Swift',
            'Darian Taylor'
         ], answer: 'Taylor Otwell')
         ->assertExitCode(0);
});
/**
 * 测试控制台命令。
 */
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 方法断言控制台命令不会生成任何输出：

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

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

test('控制台命令', 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('您真的希望运行此命令吗？', '否')
    ->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 特征添加到测试类中，为给定的测试类启用这些事件：

<?php
 
use Illuminate\Foundation\Testing\WithConsoleEvents;
 
uses(WithConsoleEvents::class);
 
//...
<?php
 
namespace Tests\Feature;
 
use Illuminate\Foundation\Testing\WithConsoleEvents;
use Tests\TestCase;
 
class ConsoleEventTest extends TestCase
{
    use WithConsoleEvents;
 
    //...
}
HTTP 测试Laravel Dusk