除了简化 HTTP 测试外,Laravel 还提供了一个简单的 API,用于测试你的应用程序的 自定义控制台命令。
首先,让我们探讨如何对 Artisan 命令的退出码进行断言。为此,我们将使用 artisan 方法从我们的测试中调用一个 Artisan 命令。然后,我们将使用 assertExitCode 方法来断言该命令已给定的退出码完成:
test('console command', function () {
$this->artisan('inspire')->assertExitCode(0);
});/**
* Test a console command.
*/
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);
});/**
* Test a console command.
*/
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);
});/**
* Test a console command.
*/
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);
});/**
* Test a console command.
*/
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);
});/**
* Test a console command.
*/
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, 'taylor@example.com'],
[2, 'abigail@example.com'],
]);默认情况下,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;
// ...
}