bug #50637 [FrameworkBundle] Fixed parsing new JSON output of debug:config not possible (Toflar)

fabpot · fabpot · commit a95cbb35edd1 · 2023-06-24T11:59:31.000+02:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [FrameworkBundle] Fixed parsing new JSON output of debug:config not possible | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | | License | MIT | Doc PR | See my comment to the original PR which introduced `debug:config --format=json`: symfony/symfony#48457 (comment) Currently, it's not possible to parse the JSON output (neither is the YAML) which makes `--format=json` kind of pointless. The argument against this - I guess - is that the JSON format was introduced to make the command independent from the YAML component but still, why is `--format` an option then? So I guess by delivering an additional option, we can fix this issue and make it parsable. (Maybe instead of having `--no-tilte` we should call it `parsable` in the first place so that if in the future there's something on top of the title, the option would still be valid?) Commits ------- a3e8560631 [FrameworkBundle] Fixed parsing new JSON output of debug:config not possible
diff --git a/Command/ConfigDebugCommand.php b/Command/ConfigDebugCommand.php
@@ -49,7 +49,7 @@ protected function configure(): void
                 new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'),
                 new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
                 new InputOption('resolve-env', null, InputOption::VALUE_NONE, 'Display resolved environment variable values instead of placeholders'),
-                new InputOption('format', null, InputOption::VALUE_REQUIRED, sprintf('The output format ("%s")', implode('", "', $this->getAvailableFormatOptions())), class_exists(Yaml::class) ? 'yaml' : 'json'),
+                new InputOption('format', null, InputOption::VALUE_REQUIRED, sprintf('The output format ("%s")', implode('", "', $this->getAvailableFormatOptions())), class_exists(Yaml::class) ? 'txt' : 'json'),
             ])
             ->setHelp(<<<EOF
 The <info>%command.name%</info> command dumps the current configuration for an
@@ -97,16 +97,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $format = $input->getOption('format');
 
-        if ('yaml' === $format && !class_exists(Yaml::class)) {
-            $errorIo->error('Setting the "format" option to "yaml" requires the Symfony Yaml component. Try running "composer install symfony/yaml" or use "--format=json" instead.');
+        if (\in_array($format, ['txt', 'yml'], true) && !class_exists(Yaml::class)) {
+            $errorIo->error('Setting the "format" option to "txt" or "yaml" requires the Symfony Yaml component. Try running "composer install symfony/yaml" or use "--format=json" instead.');
 
             return 1;
         }
 
         if (null === $path = $input->getArgument('path')) {
-            $io->title(
-                sprintf('Current configuration for %s', $name === $extensionAlias ? sprintf('extension with alias "%s"', $extensionAlias) : sprintf('"%s"', $name))
-            );
+            if ('txt' === $input->getOption('format')) {
+                $io->title(
+                    sprintf('Current configuration for %s', $name === $extensionAlias ? sprintf('extension with alias "%s"', $extensionAlias) : sprintf('"%s"', $name))
+                );
+            }
 
             $io->writeln($this->convertToFormat([$extensionAlias => $config], $format));
 
@@ -131,7 +133,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     private function convertToFormat(mixed $config, string $format): string
     {
         return match ($format) {
-            'yaml' => Yaml::dump($config, 10),
+            'txt', 'yaml' => Yaml::dump($config, 10),
             'json' => json_encode($config, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE),
             default => throw new InvalidArgumentException(sprintf('Supported formats are "%s".', implode('", "', $this->getAvailableFormatOptions()))),
         };
@@ -268,6 +270,6 @@ private static function buildPathsCompletion(array $paths, string $prefix = ''):
 
     private function getAvailableFormatOptions(): array
     {
-        return ['yaml', 'json'];
+        return ['txt', 'yaml', 'json'];
     }
 }
diff --git a/Tests/Functional/ConfigDebugCommandTest.php b/Tests/Functional/ConfigDebugCommandTest.php
@@ -84,6 +84,19 @@ public function testDumpBundleOption(bool $debug)
         $this->assertStringContainsString('foo', $tester->getDisplay());
     }
 
+    /**
+     * @testWith [true]
+     *           [false]
+     */
+    public function testDumpWithoutTitleIsValidJson(bool $debug)
+    {
+        $tester = $this->createCommandTester($debug);
+        $ret = $tester->execute(['name' => 'TestBundle', '--format' => 'json']);
+
+        $this->assertSame(0, $ret, 'Returns 0 in case of success');
+        $this->assertJson($tester->getDisplay());
+    }
+
     /**
      * @testWith [true]
      *           [false]
@@ -93,7 +106,7 @@ public function testDumpWithUnsupportedFormat(bool $debug)
         $tester = $this->createCommandTester($debug);
 
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Supported formats are "yaml", "json"');
+        $this->expectExceptionMessage('Supported formats are "txt", "yaml", "json"');
 
         $tester->execute([
             'name' => 'test',
