콘솔 테스트 (Console Tests)

• 소개
• 성공 / 실패 결과 예측
• 입력 / 출력 예측
• 콘솔 이벤트

소개 (Introduction)

HTTP 테스트를 단순화하는 것 외에도, Laravel은 애플리케이션에서 작성한 사용자 정의 콘솔 명령어를 테스트할 수 있도록 간단한 API를 제공합니다.

성공 / 실패 결과 예측 (Success / Failure Expectations)

먼저, Artisan 명령어의 종료 코드(exit code)에 대한 검증(assertion)을 어떻게 작성하는지 살펴보겠습니다. 이를 위해 테스트 내에서 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 상태 코드로 종료되고, 실패하면 0이 아닌 종료 코드로 종료됩니다. 이에 따라, 더 간편하게 사용할 수 있도록 assertSuccessful과 assertFailed 메서드를 사용하여 명령어가 성공적으로 또는 실패로 종료되었음을 검증할 수 있습니다:

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

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

입력 / 출력 예측 (Input / Output Expectations)

Laravel에서는 콘솔 명령어에서 사용자 입력을 쉽게 "모킹(mock)"할 수 있도록 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);
}

확인(Confirmation) 예측

"예/아니오" 형태의 확인 답변을 기대하는 명령어를 작성할 때는 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]'],
    ]);

콘솔 이벤트 (Console Events)

기본적으로, 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;

    // ...
}