跳至內容
Laravel

主控台測試

簡介

除了簡化 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, '[email protected]'],
        [2, '[email protected]'],
    ]);

主控台事件

預設情況下，在執行應用程式的測試時，不會分派 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;
 
    // ...
}