Add support for Invokable Commands in CommandTester

ruudk · ruudk · commit 74ca9203c1d2 · 2025-06-18T15:54:29.000+02:00
diff --git a/src/Symfony/Component/Console/Tester/CommandTester.php b/src/Symfony/Component/Console/Tester/CommandTester.php
@@ -11,7 +11,10 @@
 
 namespace Symfony\Component\Console\Tester;
 
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
+use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Console\Input\ArrayInput;
 
 /**
@@ -24,9 +27,31 @@ class CommandTester
 {
     use TesterTrait;
 
+    private Command $command;
+
     public function __construct(
-        private Command $command,
+        callable|Command $command,
     ) {
+        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);
+            }
+        }
+
+        $this->command = $command;
     }
 
     /**
diff --git a/src/Symfony/Component/Console/Tests/Command/CommandTest.php b/src/Symfony/Component/Console/Tests/Command/CommandTest.php
@@ -38,6 +38,7 @@ public static function setUpBeforeClass(): void
     {
         self::$fixturesPath = __DIR__.'/../Fixtures/';
         require_once self::$fixturesPath.'/TestCommand.php';
+        require_once self::$fixturesPath.'/InvokableTestCommand.php';
     }
 
     public function testConstructor()
@@ -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/InvokableTestCommand.php b/src/Symfony/Component/Console/Tests/Fixtures/InvokableTestCommand.php
@@ -0,0 +1,13 @@
+<?php
+
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+
+#[AsCommand('invokable:test')]
+class InvokableTestCommand
+{
+    public function __invoke(): int
+    {
+        return Command::SUCCESS;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ public static function setUpBeforeClass(): void`
`38`	`38`	`{`
`39`	`39`	`self::$fixturesPath = __DIR__.'/../Fixtures/';`
`40`	`40`	`require_once self::$fixturesPath.'/TestCommand.php';`
	`41`	`+ require_once self::$fixturesPath.'/InvokableTestCommand.php';`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`public function testConstructor()`
`@@ -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());`