feature #43598 [Console] add suggestions for debug commands: firewall, form, messenger, router (IonBazan)

This PR was merged into the 5.4 branch.

Discussion
----------

[Console] add suggestions for debug commands: firewall, form, messenger, router

| Q             | A
| ------------- | ---
| Branch?       | 5.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | #43594
| License       | MIT
| Doc PR        | -

Adding Bash completion for following commands:

- `debug:firewall`
- `debug:form`
- `debug:messenger`
- `debug:router`

~Waiting for #43596 to be merged first as it adds testing utilities and `DescriptorHelper::getFormats()`.~

Commits
-------

eaf9461722 add suggestions for debug:firewall, debug:form, debug:messenger, debug:router

Author: fabpot

Command/RouterDebugCommand.php

@@ -13,6 +13,8 @@
 
 use Symfony\Bundle\FrameworkBundle\Console\Helper\DescriptorHelper;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Completion\CompletionInput;
+use Symfony\Component\Console\Completion\CompletionSuggestions;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -131,4 +133,18 @@ private function findRouteNameContaining(string $name, RouteCollection $routes):
 
         return $foundRoutesNames;
     }
+
+    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
+    {
+        if ($input->mustSuggestArgumentValuesFor('name')) {
+            $suggestions->suggestValues(array_keys($this->router->getRouteCollection()->all()));
+
+            return;
+        }
+
+        if ($input->mustSuggestOptionValuesFor('format')) {
+            $helper = new DescriptorHelper();
+            $suggestions->suggestValues($helper->getFormats());
+        }
+    }
 }

Tests/Functional/RouterDebugCommandTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
 
 use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Tester\CommandCompletionTester;
 use Symfony\Component\Console\Tester\CommandTester;
 
 /**
@@ -69,6 +70,37 @@ public function testSearchWithThrow()
         $tester->execute(['name' => 'gerard'], ['interactive' => true]);
     }
 
+    /**
+     * @dataProvider provideCompletionSuggestions
+     */
+    public function testComplete(array $input, array $expectedSuggestions)
+    {
+        if (!class_exists(CommandCompletionTester::class)) {
+            $this->markTestSkipped('Test command completion requires symfony/console 5.4+.');
+        }
+
+        $tester = new CommandCompletionTester($this->application->get('debug:router'));
+        $this->assertSame($expectedSuggestions, $tester->complete($input));
+    }
+
+    public function provideCompletionSuggestions()
+    {
+        yield 'option --format' => [
+            ['--format', ''],
+            ['txt', 'xml', 'json', 'md'],
+        ];
+
+        yield 'route_name' => [
+            [''],
+            [
+                'routerdebug_session_welcome',
+                'routerdebug_session_welcome_name',
+                'routerdebug_session_logout',
+                'routerdebug_test',
+            ],
+        ];
+    }
+
     private function createCommandTester(): CommandTester
     {
         $command = $this->application->get('debug:router');