コンソールテスト

はじめに

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);
}

また、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);
}

確認期待

"yes" または "no" の回答として確認を期待するコマンドを書く場合、expectsConfirmation メソッドを利用できます:

    $this->artisan('module:import')
        ->expectsConfirmation('Do you really wish to run this command?', 'no')
        ->assertExitCode(1);

テーブル期待

Artisan の table メソッドを使用して情報のテーブルを表示するコマンドの場合、テーブル全体の出力期待を書くのは手間がかかることがあります。代わりに、expectsTable メソッドを使用できます。このメソッドは、テーブルのヘッダーを最初の引数として、テーブルのデータを2番目の引数として受け取ります:

    $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 トレイトをクラスに追加することで、特定のテストクラスでこれらのイベントを有効にすることができます:

<?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;

    // ...
}