︙

Console Tests

Table of Contents

Introduction
Success / Failure Expectations
Input / Output Expectations
Console Events

Introduction

HTTPtesting を簡素化するだけでなく、Laravel はあなたの application のcustomconsolecommandの testing に対するシンプルな API を提供します。

Success / Failure Expectations

始めるために、 Artisan コマンドの終了 code についての主張をする方法を探しましょう。これを達成するために、私たちはテストから Artisan command を呼び出すためにartisan method を使用します。その後、assertExitCode method を使用して、 command が特定の終了 code で完了したことを assert します。

test('console command', function () {
    $this->artisan('inspire')->assertExitCode(0);
});

/**
 * Test a console command.
 */
public function test_console_command(): void
{
    $this->artisan('inspire')->assertExitCode(0);
}

特定の終了 code で終了しなかったことをassertNotExitCode method で assert するために使用できます。 command :

$this->artisan('inspire')->assertNotExitCode(1);

もちろん、全てのターミナルコマンドは通常、成功した場合には status code が0、失敗した場合には非ゼロの終了 code とともに終了します。したがって、便宜上、assertSuccessfulとassertFailedのアサーションを使用して、特定の command が成功した終了 code で終了したのかどうかを assert することができます：

$this->artisan('inspire')->assertSuccessful();

$this->artisan('inspire')->assertFailed();

Laravel は、expectsQuestion method を使用して consolecommands の user 入力を簡単に"mock"することができます。さらに、assertExitCodeおよびexpectsOutputメソッドを使用して、console command によって出力されると予想される終了コードとテキストを指定することもできます。例えば、以下の console command を考えてみてください：

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

次のテストを使用して、この command をテストすることができます：

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 method を使用して、console command が何も出力を生成しないことを主張することもできます：

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メソッドは、 output の一部に対するアサーションを行うために使用することができます。

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" の答えの形で確認を待つ command を書くとき、expectsConfirmation method を活用することができます。

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

テーブルの期待値

あなたの command が Artisan のtable method を使って情報のテーブルを表示する場合、テーブル全体の output の期待値を書くのは面倒です。代わりに、expectsTable method を使うことができます。この method は、最初の引数としてテーブルの headers を受け取り、2 番目の引数としてテーブルの data を受け取ります：

$this->artisan('users:all')
    ->expectsTable([
        'ID',
        'Email',
    ], [
        [1, 'taylor@example.com'],
        [2, 'abigail@example.com'],
    ]);

Console Events

default では、Illuminate\Console\Events\CommandStartingとIlluminate\Console\Events\CommandFinishedの events は、application の test を実行する間は dispatch されません。ただし、これらの events を特定の test class に対して有効にすることができます。その方法は、Illuminate\Foundation\Testing\WithConsoleEventsトレイトをその class に追加することです：

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

    // ...
}