Add support for Invokable Commands in CommandTester

ruudk · ruudk · commit a10ae7f443bf · 2025-06-20T09:25:10.000+02:00
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -552,22 +552,7 @@ public function addCommand(callable|Command $command): ?Command
         $this->init();
 
         if (!$command instanceof Command) {
-            if (!\is_object($command) || $command instanceof \Closure) {
-                throw new InvalidArgumentException(\sprintf('The command must be an instance of "%s" or an invokable object.', Command::class));
-            }
-
-            /** @var AsCommand $attribute */
-            $attribute = ((new \ReflectionObject($command))->getAttributes(AsCommand::class)[0] ?? null)?->newInstance()
-                ?? throw new LogicException(\sprintf('The command must use the "%s" attribute.', AsCommand::class));
-
-            $command = (new Command($attribute->name))
-                ->setDescription($attribute->description ?? '')
-                ->setHelp($attribute->help ?? '')
-                ->setCode($command);
-
-            foreach ($attribute->usages as $usage) {
-                $command->addUsage($usage);
-            }
+            $command = new Command(null, $command);
         }
 
         $command->setApplication($this);
diff --git a/src/Symfony/Component/Console/CHANGELOG.md b/src/Symfony/Component/Console/CHANGELOG.md
@@ -8,7 +8,8 @@ CHANGELOG
  * Introduce `Symfony\Component\Console\Application::addCommand()` to simplify using invokable commands when the component is used standalone
  * Deprecate `Symfony\Component\Console\Application::add()` in favor of `Symfony\Component\Console\Application::addCommand()`
  * Add `BackedEnum` support with `#[Argument]` and `#[Option]` inputs in invokable commands
- * Allow Usages to be specified via #[AsCommand] attribute.
+ * Allow Usages to be specified via `#[AsCommand]` attribute.
+ * Allow passing invokable commands to `Symfony\Component\Console\Tester\CommandTester`
 
 7.3
 ---
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -87,10 +87,31 @@ public static function getDefaultDescription(): ?string
      *
      * @throws LogicException When the command name is empty
      */
-    public function __construct(?string $name = null)
+    public function __construct(?string $name = null, ?callable $code = null)
     {
         $this->definition = new InputDefinition();
 
+        if ($code !== null) {
+            if (!\is_object($code) || $code instanceof \Closure) {
+                throw new InvalidArgumentException(\sprintf('The command must be an instance of "%s" or an invokable object.', Command::class));
+            }
+
+            /** @var AsCommand $attribute */
+            $attribute = ((new \ReflectionObject($code))->getAttributes(AsCommand::class)[0] ?? null)?->newInstance()
+                ?? throw new LogicException(\sprintf('The command must use the "%s" attribute.', AsCommand::class));
+
+            $this->setName($name ?? $attribute->name)
+                ->setDescription($attribute->description ?? '')
+                ->setHelp($attribute->help ?? '')
+                ->setCode($code);
+
+            foreach ($attribute->usages as $usage) {
+                $this->addUsage($usage);
+            }
+
+            return;
+        }
+
         $attribute = ((new \ReflectionClass(static::class))->getAttributes(AsCommand::class)[0] ?? null)?->newInstance();
 
         if (null === $name) {
diff --git a/src/Symfony/Component/Console/Tester/CommandTester.php b/src/Symfony/Component/Console/Tester/CommandTester.php
@@ -24,9 +24,12 @@ class CommandTester
 {
     use TesterTrait;
 
+    private Command $command;
+
     public function __construct(
-        private Command $command,
+        callable|Command $command,
     ) {
+        $this->command = $command instanceof Command ? $command : new Command(null, $command);
     }
 
     /**
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -48,6 +48,8 @@
 use Symfony\Component\Console\SignalRegistry\SignalRegistry;
 use Symfony\Component\Console\Terminal;
 use Symfony\Component\Console\Tester\ApplicationTester;
+use Symfony\Component\Console\Tests\Fixtures\InvokableExtendingCommandTestCommand;
+use Symfony\Component\Console\Tests\Fixtures\InvokableTestCommand;
 use Symfony\Component\Console\Tests\Fixtures\MockableAppliationWithTerminalWidth;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\EventDispatcher\EventDispatcher;
@@ -257,7 +259,7 @@ public function testAddCommandWithInvokableCommand()
         $application->addCommand($foo = new InvokableTestCommand());
         $commands = $application->all();
 
-        $this->assertInstanceOf(Command::class, $command = $commands['invokable']);
+        $this->assertInstanceOf(Command::class, $command = $commands['invokable:test']);
         $this->assertEquals(new InvokableCommand($command, $foo), (new \ReflectionObject($command))->getProperty('code')->getValue($command));
     }
 
@@ -2570,14 +2572,6 @@ public function isEnabled(): bool
     }
 }
 
-#[AsCommand(name: 'invokable')]
-class InvokableTestCommand
-{
-    public function __invoke(): int
-    {
-    }
-}
-
 #[AsCommand(name: 'invokable-extended')]
 class InvokableExtendedTestCommand extends Command
 {
diff --git a/src/Symfony/Component/Console/Tests/Command/CommandTest.php b/src/Symfony/Component/Console/Tests/Command/CommandTest.php
@@ -27,6 +27,7 @@
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\Console\Tests\Fixtures\InvokableTestCommand;
 
 class CommandTest extends TestCase
 {
@@ -304,6 +305,13 @@ public function testRunInteractive()
         $this->assertEquals('interact called'.\PHP_EOL.'execute called'.\PHP_EOL, $tester->getDisplay(), '->run() calls the interact() method if the input is interactive');
     }
 
+    public function testInvokableCommand()
+    {
+        $tester = new CommandTester(new InvokableTestCommand());
+
+        $this->assertSame(Command::SUCCESS, $tester->execute([]));
+    }
+
     public function testRunNonInteractive()
     {
         $tester = new CommandTester(new \TestCommand());
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/InvokableExtendingCommandTestCommand.php b/src/Symfony/Component/Console/Tests/Fixtures/InvokableExtendingCommandTestCommand.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Symfony\Component\Console\Tests\Fixtures;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+
+#[AsCommand('invokable:test')]
+class InvokableExtendingCommandTestCommand extends Command
+{
+    public function __invoke(): int
+    {
+        return Command::SUCCESS;
+    }
+}
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/InvokableTestCommand.php b/src/Symfony/Component/Console/Tests/Fixtures/InvokableTestCommand.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Symfony\Component\Console\Tests\Fixtures;
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+
+#[AsCommand('invokable:test')]
+class InvokableTestCommand
+{
+    public function __invoke(): int
+    {
+        return Command::SUCCESS;
+    }
+}
diff --git a/src/Symfony/Component/Console/Tests/Tester/CommandTesterTest.php b/src/Symfony/Component/Console/Tests/Tester/CommandTesterTest.php
@@ -23,6 +23,8 @@
 use Symfony\Component\Console\Question\Question;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\Console\Tests\Fixtures\InvokableExtendingCommandTestCommand;
+use Symfony\Component\Console\Tests\Fixtures\InvokableTestCommand;
 
 class CommandTesterTest extends TestCase
 {
@@ -267,4 +269,24 @@ public function testErrorOutput()
 
         $this->assertSame('foo', $tester->getErrorOutput());
     }
+
+    public function testAInvokableCommand()
+    {
+        $command = new InvokableTestCommand();
+
+        $tester = new CommandTester($command);
+        $tester->execute([]);
+
+        $tester->assertCommandIsSuccessful();
+    }
+
+    public function testAInvokableExtendedCommand()
+    {
+        $command = new InvokableExtendingCommandTestCommand();
+
+        $tester = new CommandTester($command);
+        $tester->execute([]);
+
+        $tester->assertCommandIsSuccessful();
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,12 @@ class CommandTester`
`24`	`24`	`{`
`25`	`25`	`use TesterTrait;`
`26`	`26`
	`27`	`+ private Command $command;`
	`28`	`+`
`27`	`29`	`public function __construct(`
`28`		`- private Command $command,`
	`30`	`+ callable\|Command $command,`
`29`	`31`	`) {`
	`32`	`+ $this->command = $command instanceof Command ? $command : new Command(null, $command);`
`30`	`33`	`}`
`31`	`34`
`32`	`35`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@`
`27`	`27`	`use Symfony\Component\Console\Output\NullOutput;`
`28`	`28`	`use Symfony\Component\Console\Output\OutputInterface;`
`29`	`29`	`use Symfony\Component\Console\Tester\CommandTester;`
	`30`	`+use Symfony\Component\Console\Tests\Fixtures\InvokableTestCommand;`
`30`	`31`
`31`	`32`	`class CommandTest extends TestCase`
`32`	`33`	`{`
`@@ -304,6 +305,13 @@ public function testRunInteractive()`
`304`	`305`	`$this->assertEquals('interact called'.\PHP_EOL.'execute called'.\PHP_EOL, $tester->getDisplay(), '->run() calls the interact() method if the input is interactive');`
`305`	`306`	`}`
`306`	`307`
	`308`	`+ public function testInvokableCommand()`
	`309`	`+ {`
	`310`	`+ $tester = new CommandTester(new InvokableTestCommand());`
	`311`	`+`
	`312`	`+ $this->assertSame(Command::SUCCESS, $tester->execute([]));`
	`313`	`+ }`
	`314`	`+`
`307`	`315`	`public function testRunNonInteractive()`
`308`	`316`	`{`
`309`	`317`	`$tester = new CommandTester(new \TestCommand());`