Testing

To ease the process of testing your commands this package provides an implementation of Environment just for this case. This implementation has the same behaviour as the one provided provided when running your tool.

You can write such a test like this:

use Innmind\CLI\{
    Commands,
    Environment\InMemory,
};
use PHPUnit\Framework\TestCase;

class GreetTest extends TestCase
{
    public function testCommandGreetsTheUser()
    {
        $commands = Commands::of(new Greet);
        $environment = $commands(InMemory::of(
            [], // no chunks in STDIN
            false, // non interactive mode
            ['cli.php', 'greet', 'Bob'], // to simulate `php cli.php greet Bob`
            [], // environment variables
            '/tmp/', // working directory path
        ))->unwrap();

        // it asked to output "Hi Bob\n"
        $this->assertSame(["Hi Bob\n"], $environment->outputs());
        // it didn't write anything to STDERR
        $this->assertSame([], $environment->errors());
        // it didn't specify any exit code, meaning it will default to 0
        $this->assertFalse($environment->exitCode()->match(
            static fn() => true,
            static fn() => false,
        ));
    }
}