Introduction

HTTP テストを簡素化するだけでなく、Laravel はアプリケーションの カスタムコンソールコマンド をテストするためのシンプルな API を提供します。

Success / Failure Expectations

始めるにあたり、Artisan コマンドの終了コードに関するアサーションの作成方法を探ってみましょう。これを達成するために、artisan メソッドを使用してテストから Artisan コマンドを呼び出します。その後、assertExitCode メソッドを使用して、コマンドが指定された終了コードで完了したことをアサートします: 

  1. test('console command', function () {
  2.    $this->artisan('inspire')->assertExitCode(0);
  3. });
  1. /**
  2.  * Test a console command.
  3.  */
  4. public function test_console_command(): void
  5. {
  6.    $this->artisan('inspire')->assertExitCode(0);
  7. }

assertNotExitCode メソッドを使用して、コマンドが指定された終了コードで終了しなかったことをアサートすることもできます: 

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

もちろん、すべてのターミナルコマンドは通常、成功した場合は 0 のステータスコードで終了し、成功しなかった場合は非ゼロの終了コードで終了します。したがって、便利のために、assertSuccessful および assertFailed アサーションを利用して、指定されたコマンドが成功した終了コードで終了したかどうかをアサートできます: 

  1. $this->artisan('inspire')->assertSuccessful();
  3. $this->artisan('inspire')->assertFailed();

Input / Output Expectations

Laravel は、expectsQuestion メソッドを使用してコンソールコマンドのユーザー入力を簡単に「モック」することを可能にします。さらに、assertExitCode および expectsOutput メソッドを使用して、コンソールコマンドから出力されることを期待する終了コードとテキストを指定できます。たとえば、次のコンソールコマンドを考えてみましょう: 

  1. Artisan::command('question', function () {
  2.    $name = $this->ask('What is your name?');
  4.    $language = $this->choice('Which language do you prefer?', [
  5.    'PHP',
  6.    'Ruby',
  7.    'Python',
  8.    ]);
  10.    $this->line('Your name is '.$name.' and you prefer '.$language.'.');
  11. });

このコマンドを次のテストでテストできます: 

  1. test('console command', function () {
  2.    $this->artisan('question')
  3.    ->expectsQuestion('What is your name?', 'Taylor Otwell')
  4.    ->expectsQuestion('Which language do you prefer?', 'PHP')
  5.    ->expectsOutput('Your name is Taylor Otwell and you prefer PHP.')
  6.    ->doesntExpectOutput('Your name is Taylor Otwell and you prefer Ruby.')
  7.    ->assertExitCode(0);
  8. });
  1. /**
  2.  * Test a console command.
  3.  */
  4. public function test_console_command(): void
  5. {
  6.    $this->artisan('question')
  7.    ->expectsQuestion('What is your name?', 'Taylor Otwell')
  8.    ->expectsQuestion('Which language do you prefer?', 'PHP')
  9.    ->expectsOutput('Your name is Taylor Otwell and you prefer PHP.')
  10.    ->doesntExpectOutput('Your name is Taylor Otwell and you prefer Ruby.')
  11.    ->assertExitCode(0);
  12. }

Laravel Prompts によって提供される search または multisearch 関数を利用している場合、expectsSearch アサーションを使用してユーザーの入力、検索結果、および選択をモックできます: 

  1. test('console command', function () {
  2.    $this->artisan('example')
  3.    ->expectsSearch('What is your name?', search: 'Tay', answers: [
  4.    'Taylor Otwell',
  5.    'Taylor Swift',
  6.    'Darian Taylor'
  7.    ], answer: 'Taylor Otwell')
  8.    ->assertExitCode(0);
  9. });
  1. /**
  2.  * Test a console command.
  3.  */
  4. public function test_console_command(): void
  5. {
  6.    $this->artisan('example')
  7.    ->expectsSearch('What is your name?', search: 'Tay', answers: [
  8.    'Taylor Otwell',
  9.    'Taylor Swift',
  10.    'Darian Taylor'
  11.    ], answer: 'Taylor Otwell')
  12.    ->assertExitCode(0);
  13. }

doesntExpectOutput メソッドを使用して、コンソールコマンドが出力を生成しないことをアサートすることもできます: 

  1. test('console command', function () {
  2.    $this->artisan('example')
  3.    ->doesntExpectOutput()
  4.    ->assertExitCode(0);
  5. });
  1. /**
  2.  * Test a console command.
  3.  */
  4. public function test_console_command(): void
  5. {
  6.    $this->artisan('example')
  7.    ->doesntExpectOutput()
  8.    ->assertExitCode(0);
  9. }

expectsOutputToContain および doesntExpectOutputToContain メソッドを使用して出力の一部に対してアサーションを行うことができます: 

  1. test('console command', function () {
  2.    $this->artisan('example')
  3.    ->expectsOutputToContain('Taylor')
  4.    ->assertExitCode(0);
  5. });
  1. /**
  2.  * Test a console command.
  3.  */
  4. public function test_console_command(): void
  5. {
  6.    $this->artisan('example')
  7.    ->expectsOutputToContain('Taylor')
  8.    ->assertExitCode(0);
  9. }

Confirmation Expectations

「はい」または「いいえ」の形で確認を期待するコマンドを書く場合、expectsConfirmation メソッドを利用できます: 

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

Table Expectations

コマンドが Artisan の table メソッドを使用して情報のテーブルを表示する場合、テーブル全体の出力期待を記述するのは面倒です。代わりに、expectsTable メソッドを使用できます。このメソッドは、テーブルのヘッダーを最初の引数として、テーブルのデータを第二の引数として受け取ります: 

  1. $this->artisan('users:all')
  2.    ->expectsTable([
  3.    'ID',
  4.    'Email',
  5.    ], [
  6.    [1, ''],
  7.    [2, ''],
  8.    ]);

Console Events

デフォルトでは、Illuminate\Console\Events\CommandStarting および Illuminate\Console\Events\CommandFinished イベントは、アプリケーションのテストを実行している間は発生しません。ただし、Illuminate\Foundation\Testing\WithConsoleEvents トレイトをクラスに追加することで、特定のテストクラスに対してこれらのイベントを有効にできます: 

  1. <?php
  3. use Illuminate\Foundation\Testing\WithConsoleEvents;
  5. uses(WithConsoleEvents::class);
  7. // ...
  1. <?php
  3. namespace Tests\Feature;
  5. use Illuminate\Foundation\Testing\WithConsoleEvents;
  6. use Tests\TestCase;
  8. class ConsoleEventTest extends TestCase
  9. {
  10.    use WithConsoleEvents;
  12.    // ...
  13. }