Merge pull request #10 from kbond/expect-exception

Add `TestCommand::expectException()`

Author: kbond

.scrutinizer.yml

@@ -1,7 +1,6 @@
 # zenstruck/console-test
 
 [![CI Status](https://github.com/zenstruck/console-test/workflows/CI/badge.svg)](https://github.com/zenstruck/console-test/actions?query=workflow%3ACI)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/zenstruck/console-test/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/zenstruck/console-test/?branch=1.x)
 [![codecov](https://codecov.io/gh/zenstruck/console-test/branch/1.x/graph/badge.svg?token=KPQNKYGYRR)](https://codecov.io/gh/zenstruck/console-test)
 
 Alternative, opinionated helper for testing Symfony console commands. This package is an alternative to
@@ -71,6 +70,13 @@ class CreateUserCommandTest extends KernelTestCase
             ->assertOutputContains('Creating regular user "kbond"')
         ;
 
+        // test command throws exception
+        $this->consoleCommand(CreateUserCommand::class)
+            ->expectException(\RuntimeException::class, 'Username required!')
+            ->assertStatusCode(1)
+            ->assertOutputContains('Could not create user!') // can still make assertions on output before exception was thrown
+        ;
+
         // access result
         $result = $this->executeConsoleCommand('create:user');
 
@@ -130,6 +136,13 @@ class CreateUserCommandTest extends TestCase
             ->assertOutputContains('Creating regular user "kbond"')
         ;
 
+        // test command throws exception
+        TestCommand::for(new CreateUserCommand(/** args... */))
+            ->expectException(\RuntimeException::class, 'Username required!')
+            ->assertStatusCode(1)
+            ->assertOutputContains('Could not create user!') // can still make assertions on output before exception was thrown
+        ;
+
         // access result
         $result = TestCommand::for(new CreateUserCommand(/** args... */))->execute();
 

README.md

@@ -4,6 +4,7 @@
 
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;
+use Zenstruck\Assert;
 
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
@@ -15,6 +16,10 @@ final class TestCommand
 
     /** @var string[] */
     private array $inputs = [];
+
+    /** @var callable|class-string|null */
+    private $expectedException;
+    private ?string $expectedExceptionMessage = null;
     private bool $splitOutputStreams = false;
 
     private function __construct(Command $command, string $cli)
@@ -96,6 +101,25 @@ public function withInput(array $inputs): self
         return $this;
     }
 
+    /**
+     * Expect executing the command will throw this exception. Fails if not thrown.
+     *
+     * @param class-string|callable $expectedException string: class name of the expected exception
+     *                                                 callable: uses the first argument's type-hint
+     *                                                 to determine the expected exception class. When
+     *                                                 exception is caught, callable is invoked with
+     *                                                 the caught exception
+     * @param string|null           $expectedMessage   Assert the caught exception message "contains"
+     *                                                 this string
+     */
+    public function expectException($expectedException, ?string $expectedMessage = null): self
+    {
+        $this->expectedException = $expectedException;
+        $this->expectedExceptionMessage = $expectedMessage;
+
+        return $this;
+    }
+
     public function execute(?string $cli = null): CommandResult
     {
         $autoExit = $this->application->isAutoExitEnabled();
@@ -105,7 +129,7 @@ public function execute(?string $cli = null): CommandResult
         $this->application->setAutoExit(false);
         $this->application->setCatchExceptions(false);
 
-        $status = $this->application->run(
+        $status = $this->doRun(
             $input = new TestInput($cli, $this->inputs),
             $output = new TestOutput($this->splitOutputStreams, $input)
         );
@@ -115,4 +139,17 @@ public function execute(?string $cli = null): CommandResult
 
         return new CommandResult($cli, $status, $output);
     }
+
+    private function doRun(TestInput $input, TestOutput $output): int
+    {
+        $fn = fn() => $this->application->run($input, $output);
+
+        if (!$this->expectedException) {
+            return $fn();
+        }
+
+        Assert::that($fn)->throws($this->expectedException, $this->expectedExceptionMessage);
+
+        return 1;
+    }
 }

src/TestCommand.php

@@ -2,8 +2,10 @@
 
 namespace Zenstruck\Console\Test\Tests;
 
+use PHPUnit\Framework\AssertionFailedError;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
 use Symfony\Component\Console\Exception\CommandNotFoundException;
+use Zenstruck\Assert;
 use Zenstruck\Console\Test\InteractsWithConsole;
 use Zenstruck\Console\Test\Tests\Fixture\FixtureCommand;
 
@@ -136,6 +138,58 @@ public function exceptions_from_commands_are_thrown(): void
         $this->consoleCommand('fixture:command --throw')->execute();
     }
 
+    /**
+     * @test
+     */
+    public function can_expect_exception(): void
+    {
+        $this->consoleCommand('fixture:command --throw')
+            ->expectException(\RuntimeException::class)
+            ->execute()
+            ->assertStatusCode(1)
+            ->assertOutputContains('Executing command...')
+            ->assertOutputContains('Error output.')
+        ;
+
+        $this->consoleCommand('fixture:command --throw')
+            ->expectException(\RuntimeException::class, 'Exception thrown!')
+            ->execute()
+            ->assertStatusCode(1)
+            ->assertOutputContains('Executing command...')
+            ->assertOutputContains('Error output.')
+        ;
+
+        $this->consoleCommand('fixture:command --throw')
+            ->expectException(function(\RuntimeException $e) {
+                $this->assertSame('Exception thrown!', $e->getMessage());
+            })
+            ->execute()
+            ->assertStatusCode(1)
+            ->assertOutputContains('Executing command...')
+            ->assertOutputContains('Error output.')
+        ;
+    }
+
+    /**
+     * @test
+     */
+    public function if_expected_exception_not_thrown_fail(): void
+    {
+        Assert::that(function() {
+            $this->consoleCommand('fixture:command')
+                ->expectException(\RuntimeException::class)
+                ->execute()
+            ;
+        })->throws(AssertionFailedError::class, 'No exception thrown. Expected "RuntimeException".');
+
+        Assert::that(function() {
+            $this->consoleCommand('fixture:command --throw')
+                ->expectException(\LogicException::class)
+                ->execute()
+            ;
+        })->throws(AssertionFailedError::class, 'Expected "LogicException" to be thrown but got "RuntimeException".');
+    }
+
     /**
      * @test
      */