Add support for Invokable Commands in CommandTester

ruudk · ruudk · commit beea1964e91e · 2025-06-18T15:42:36.000+02:00
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -82,6 +82,26 @@ public static function getDefaultDescription(): ?string
         return null;
     }
 
+    /**
+     * Creates a Command from an object that uses #[AsCommand] attribute.
+     */
+    public static function createFromAttribute(object $command) : self
+    {
+        if ($command instanceof self) {
+            return $command;
+        }
+
+        if (!is_callable($command)) {
+            throw new \InvalidArgumentException(\sprintf('The command "%s" must be a callable.', $command::class));
+        }
+
+        if (!$attribute = (new \ReflectionClass($command))->getAttributes(AsCommand::class)) {
+            throw new \InvalidArgumentException(\sprintf('The command "%s" does not have the `#[%s]` attribute.', $command::class, AsCommand::class));
+        }
+
+        return (new self($attribute[0]->newInstance()->name))->setCode($command);
+    }
+
     /**
      * @param string|null $name The name of the command; passing null means it must be set in configure()
      *
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,
+        object $command,
     ) {
+        $this->command = Command::createFromAttribute($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
`@@ -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`	`+ object $command,`
`29`	`31`	`) {`
	`32`	`+ $this->command = Command::createFromAttribute($command);`
`30`	`33`	`}`
`31`	`34`
`32`	`35`	`/**`
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());`