[Console] Escape % in command name & description from getDefault*()

symfony · Jun 6, 2022 · b4a1d2d · b4a1d2d
1 parent cce7a9f
commit b4a1d2d
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 1 deletion.
diff --git a/DependencyInjection/AddConsoleCommandPass.php b/DependencyInjection/AddConsoleCommandPass.php
@@ -55,7 +55,7 @@ public function process(ContainerBuilder $container)
                 if (!$r->isSubclassOf(Command::class)) {
                     throw new InvalidArgumentException(sprintf('The service "%s" tagged "%s" must be a subclass of "%s".', $id, $this->commandTag, Command::class));
                 }
-                $commandName = $class::getDefaultName();
+                $commandName = $class::getDefaultName() !== null ? str_replace('%', '%%', $class::getDefaultName()) : null;
             }
 
             if (null === $commandName) {

diff --git a/Tests/DependencyInjection/AddConsoleCommandPassTest.php b/Tests/DependencyInjection/AddConsoleCommandPassTest.php
@@ -118,6 +118,30 @@ public function visibilityProvider()
         ];
     }
 
+    public function testEscapesDefaultFromPhp()
+    {
+        $container = new ContainerBuilder();
+        $container
+            ->register('to-escape', EscapedDefaultsFromPhpCommand::class)
+            ->addTag('console.command')
+        ;
+
+        $pass = new AddConsoleCommandPass();
+        $pass->process($container);
+
+        $commandLoader = $container->getDefinition('console.command_loader');
+        $commandLocator = $container->getDefinition((string) $commandLoader->getArgument(0));
+
+        $this->assertSame(ContainerCommandLoader::class, $commandLoader->getClass());
+        $this->assertSame(['%%cmd%%' => 'to-escape'], $commandLoader->getArgument(1));
+        $this->assertEquals([['to-escape' => new ServiceClosureArgument(new TypedReference('to-escape', EscapedDefaultsFromPhpCommand::class))]], $commandLocator->getArguments());
+        $this->assertSame([], $container->getParameter('console.command.ids'));
+
+        $command = $container->get('console.command_loader')->get('%%cmd%%');
+
+        $this->assertSame('%cmd%', $command->getName());
+    }
+
     public function testProcessThrowAnExceptionIfTheServiceIsAbstract()
     {
         $this->expectException(\InvalidArgumentException::class);
@@ -250,3 +274,8 @@ class NamedCommand extends Command
 {
     protected static $defaultName = 'default';
 }
+
+class EscapedDefaultsFromPhpCommand extends Command
+{
+    protected static $defaultName = '%cmd%';
+}