Add PendingCommand testing macros trait

[BinaryKitten]

Description

This new trait adds output testing against the PendingCommand from the core framework.

Adding this trait to your userland tests (Pest or PHPUnit) will allow calls through to the test methods on the PendingCommand (see examples/usage below)

Notes

So far this only works for regular output data and the other downside is that it can only check for a full table match

Usage

with this example command:

<?php

namespace App\Console\Commands;

use Illuminate\Console\Command;
use function Laravel\Prompts\info;
use function Laravel\Prompts\alert;
use function Laravel\Prompts\error;
use function Laravel\Prompts\outro;
use function Laravel\Prompts\table;
use function Laravel\Prompts\warning;

class PromptTest extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @inheritdoc
     */
    protected $signature = 'app:prompt-test';

    /**
     * The console command description.
     *
     * @inheritdoc
     */
    protected $description = 'test prompt';

    /**
     * Execute the console command.
     */
    public function handle(): void
    {
        outro('Test Prompt - outro');

        info('Test Prompt - information');

        alert('Test Prompt - information ALERT!');

        table(
            headers: ['ABC', 'DEF', 'GHI'],
            rows: [
                ['123', '456', '789'],
                ['234', '567', '890'],
            ]
        );

        warning('Test Prompt - warning');

        error('Test Prompt - error');

        outro('Test Prompt - outro');
    }
}

for PHPUnit:

<?php

namespace Tests\Unit;

use Tests\TestCase;
use Laravel\Prompts\Testing\InteractsWithPrompts;

class MyCommandTest extends TestCase
{
    use InteractsWithPrompts;

    public function testCommand(): void
    {
        $this->artisan('app:prompt-test')
            ->expectsPromptIntro('Test Prompt - intro')
            ->expectsPromptTable(
                headers: ['ABC', 'DEF', 'GHI'],
                rows: [
                    ['123', '456', '789'],
                    ['234', '567', '890'],
                ]
            )
            ->assertExitCode(0);
    }
}

for Pest (MyCommandTest.php)

<?php

use Tests\Traits\InteractsWithPrompts;

use function Pest\Laravel\artisan;

uses()->use(InteractsWithPrompts::class);

test('command prompts', function () {
    artisan('app:prompt-test')
        ->expectsPromptOutro('Test Prompt - outro')
        ->expectsPromptInfo('Test Prompt - information')
        ->expectsPromptTable(
            headers: ['ABC', 'DEF', 'GHI'],
            rows: [
                ['123', '456', '789'],
                ['234', '567', '890'],
            ]
        )
        ->assertExitCode(0);
});

[taylorotwell]

I kinda think it would be better to just bake this straight into the framework's pending command class so you get intellisense on it in your IDE vs. this macro approach.

Thanks!

[BinaryKitten]

I thought about it in the framework but that then put a hard tie on always being used, which I didn't feel was best approach for a new contribution.

I'd be happy to see these functions in the framework proper, would it be OK to pr that? Or should I leave it for the team?

[macocci7]

I'd be happy to see these functions in the framework proper, would it be OK to pr that? Or should I leave it for the team?

@BinaryKitten You'd better open a new pr by yourself. Laravel team members will welcome it, I think.👍