> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# Console Tests

> Learn how to test Artisan commands in Laravel with input/output expectations, exit code assertions, and console event testing.

# Console Tests

Laravel provides a fluent API for testing Artisan commands, including interactive prompts and command output.

<Info>
  This page follows Laravel's latest console testing APIs, including `expectsSearch` for Laravel Prompts search interactions.
</Info>

## Introduction

Use the test runner's `artisan` method to execute a command and chain expectations:

<Tabs>
  <Tab title="Pest">
    ```php theme={null}
    test('question 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);
    });
    ```
  </Tab>

  <Tab title="PHPUnit">
    ```php theme={null}
    public function test_question_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);
    }
    ```
  </Tab>
</Tabs>

```mermaid theme={null}
flowchart TD
    A[Run command with artisan] --> B[Provide expected input]
    B --> C[Assert output or table]
    C --> D[Assert exit status]
```

## Success / Failure Expectations

Use exit-status assertions to verify whether a command succeeded or failed:

```php theme={null}
$this->artisan('inspire')->assertExitCode(0);
$this->artisan('inspire')->assertSuccessful();
$this->artisan('inspire')->assertFailed();
```

## Input / Output Expectations

### Input expectations

You can mock user interactions with questions and searchable prompts:

```php theme={null}
$this->artisan('example')
    ->expectsQuestion('What is your name?', 'Taylor Otwell')
    ->expectsSearch('What is your name?', search: 'Tay', answers: [
        'Taylor Otwell',
        'Taylor Swift',
        'Darian Taylor',
    ], answer: 'Taylor Otwell')
    ->assertExitCode(0);
```

### Output expectations

Use output assertions to verify exact strings, partial strings, and table rendering:

```php theme={null}
$this->artisan('users:all')
    ->expectsOutput('The expected output')
    ->doesntExpectOutput('Unexpected output')
    ->expectsOutputToContain('expected')
    ->expectsTable([
        'ID',
        'Email',
    ], [
        [1, 'taylor@example.com'],
        [2, 'abigail@example.com'],
    ])
    ->assertExitCode(0);
```

## Confirmation Expectations

For yes/no prompts, use `expectsConfirmation`:

```php theme={null}
$this->artisan('module:import')
    ->expectsConfirmation('Do you really wish to run this command?', 'no')
    ->assertExitCode(1);
```

## Console Events

By default, `CommandStarting` and `CommandFinished` are not dispatched during tests.

Use `WithConsoleEvents` when you need to assert console event behavior:

```php theme={null}
<?php

namespace Tests\Feature;

use Illuminate\Foundation\Testing\WithConsoleEvents;
use Tests\TestCase;

class ConsoleEventTest extends TestCase
{
    use WithConsoleEvents;
}
```

<Tip>
  Use `WithConsoleEvents` only in tests that require event assertions, so normal tests stay faster.
</Tip>