feature symfony#53632 [Console] Add silent verbosity suppressing all output, including errors (wouterj)

This PR was merged into the 7.2 branch.

Discussion
----------

[Console] Add silent verbosity suppressing all output, including errors

| Q             | A
| ------------- | ---
| Branch?       | 7.2
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | yes
| Issues        | Fix symfony#52777
| License       | MIT

<details>
<summary>Original PR description</summary>

Alternative to symfony#53126

In Symfony 2.8, we decided to still show exceptions/errors when running a command with `--quiet` or `SHELL_VERBOSITY=-1` (symfony#15680).

Since that time, we've introduced the ConsoleLogger and 12-factor app logic. In todays landscape, it's more common to run commands that only output computer-readable text (e.g. JSON), which is ingested and displayed by services like Datadog and Kibana.
Our decision from 2.8 breaks this, as the JSON is interrupted by human-readable exception output that users can't disable. At the same time, this information is duplicated as errors are always logged (and thus shown as JSON).

I think we should revert the 2.8 decision, rather than adding a new "extremely quiet" verbosity mode. As far as I'm aware, this is also more consistent with normal unix commands which also don't output anything when passing `--quiet`.
I don't think this warrants as a BC break, as the errors are human readable and we don't promise BC on human readable console output (afaik, we don't promise BC on any console output, but I think we should be careful when changing e.g. the JSON logging).

</details>

This updated PR adds a new `--silent` verbosity mode that suppresses all output, including exceptions caught by the Application.

I went back and forth between simply passing `NullOutput` to the command in silent mode or not ignoring everything written to silent mode in `Output`. In the end, I've decided for the last to avoid bug reports from people silently expecting a `ConsoleOutputInterface` in their commands (e.g. for sections) without properly guarding it.

The new `isSilent()` methods can be used by commands to e.g. write important messages to the logger instead of command output when running in silent mode.

Commits
-------

57fe0bd [Console] Add silent verbosity mode suppressing all output, including errors

Author: fabpot

UPGRADE-7.2.md

@@ -14,6 +14,13 @@ Cache
  * `igbinary_serialize()` is not used by default when the igbinary extension is installed
  * Deprecate making `cache.app` adapter taggable, use the `cache.app.taggable` adapter instead
 
+Console
+-------
+
+ * [BC BREAK] Add ``--silent`` global option to enable the silent verbosity mode (suppressing all output, including errors)
+   If a custom command defines the `silent` option, it must be renamed before upgrading.
+ * Add `isSilent()` method to `OutputInterface`
+
 DependencyInjection
 -------------------
 

src/Symfony/Component/Console/Application.php

@@ -913,6 +913,9 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
         }
 
         switch ($shellVerbosity = (int) getenv('SHELL_VERBOSITY')) {
+            case -2:
+                $output->setVerbosity(OutputInterface::VERBOSITY_SILENT);
+                break;
             case -1:
                 $output->setVerbosity(OutputInterface::VERBOSITY_QUIET);
                 break;
@@ -930,7 +933,10 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
                 break;
         }
 
-        if (true === $input->hasParameterOption(['--quiet', '-q'], true)) {
+        if (true === $input->hasParameterOption(['--silent'], true)) {
+            $output->setVerbosity(OutputInterface::VERBOSITY_SILENT);
+            $shellVerbosity = -2;
+        } elseif (true === $input->hasParameterOption(['--quiet', '-q'], true)) {
             $output->setVerbosity(OutputInterface::VERBOSITY_QUIET);
             $shellVerbosity = -1;
         } else {
@@ -946,7 +952,7 @@ protected function configureIO(InputInterface $input, OutputInterface $output):
             }
         }
 
-        if (-1 === $shellVerbosity) {
+        if (0 > $shellVerbosity) {
             $input->setInteractive(false);
         }
 
@@ -1082,7 +1088,8 @@ protected function getDefaultInputDefinition(): InputDefinition
         return new InputDefinition([
             new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'),
             new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display help for the given command. When no command is given display help for the <info>'.$this->defaultCommand.'</info> command'),
-            new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Do not output any message'),
+            new InputOption('--silent', null, InputOption::VALUE_NONE, 'Do not output any message'),
+            new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Only errors are displayed. All other output is suppressed'),
             new InputOption('--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug'),
             new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Display this application version'),
             new InputOption('--ansi', '', InputOption::VALUE_NEGATABLE, 'Force (or disable --no-ansi) ANSI output', null),

src/Symfony/Component/Console/CHANGELOG.md

@@ -6,6 +6,8 @@ CHANGELOG
 
  * Add support for `FORCE_COLOR` environment variable
  * Add `verbosity` argument to `mustRun` process helper method
+ * [BC BREAK] Add silent verbosity (`--silent`/`SHELL_VERBOSITY=-2`) to suppress all output, including errors
+ * Add `OutputInterface::isSilent()`, `Output::isSilent()`, `OutputStyle::isSilent()` methods
 
 7.1
 ---

src/Symfony/Component/Console/Descriptor/ReStructuredTextDescriptor.php

@@ -217,6 +217,7 @@ private function getNonDefaultOptions(InputDefinition $definition): array
     {
         $globalOptions = [
             'help',
+            'silent',
             'quiet',
             'verbose',
             'version',

src/Symfony/Component/Console/Output/NullOutput.php

@@ -54,14 +54,19 @@ public function setVerbosity(int $level): void
 
     public function getVerbosity(): int
     {
-        return self::VERBOSITY_QUIET;
+        return self::VERBOSITY_SILENT;
     }
 
-    public function isQuiet(): bool
+    public function isSilent(): bool
     {
         return true;
     }
 
+    public function isQuiet(): bool
+    {
+        return false;
+    }
+
     public function isVerbose(): bool
     {
         return false;

src/Symfony/Component/Console/Output/Output.php

@@ -17,13 +17,14 @@
 /**
  * Base class for output classes.
  *
- * There are five levels of verbosity:
+ * There are six levels of verbosity:
  *
  *  * normal: no option passed (normal output)
  *  * verbose: -v (more output)
  *  * very verbose: -vv (highly extended output)
  *  * debug: -vvv (all debug output)
- *  * quiet: -q (no output)
+ *  * quiet: -q (only output errors)
+ *  * silent: --silent (no output)
  *
  * @author Fabien Potencier <[email protected]>
  */
@@ -74,6 +75,11 @@ public function getVerbosity(): int
         return $this->verbosity;
     }
 
+    public function isSilent(): bool
+    {
+        return self::VERBOSITY_SILENT === $this->verbosity;
+    }
+
     public function isQuiet(): bool
     {
         return self::VERBOSITY_QUIET === $this->verbosity;

src/Symfony/Component/Console/Output/OutputInterface.php

@@ -17,9 +17,12 @@
  * OutputInterface is the interface implemented by all Output classes.
  *
  * @author Fabien Potencier <[email protected]>
+ *
+ * @method bool isSilent()
  */
 interface OutputInterface
 {
+    public const VERBOSITY_SILENT = 8;
     public const VERBOSITY_QUIET = 16;
     public const VERBOSITY_NORMAL = 32;
     public const VERBOSITY_VERBOSE = 64;

src/Symfony/Component/Console/Style/OutputStyle.php

@@ -78,6 +78,12 @@ public function getFormatter(): OutputFormatterInterface
         return $this->output->getFormatter();
     }
 
+    public function isSilent(): bool
+    {
+        // @deprecated since Symfony 7.2, change to $this->output->isSilent() in 8.0
+        return method_exists($this->output, 'isSilent') ? $this->output->isSilent() : self::VERBOSITY_SILENT === $this->output->getVerbosity();
+    }
+
     public function isQuiet(): bool
     {
         return $this->output->isQuiet();

src/Symfony/Component/Console/Tests/ApplicationTest.php

@@ -851,12 +851,15 @@ public function testRenderException()
         putenv('COLUMNS=120');
         $tester = new ApplicationTester($application);
 
-        $tester->run(['command' => 'foo'], ['decorated' => false, 'capture_stderr_separately' => true]);
+        $tester->run(['command' => 'foo'], ['decorated' => false, 'verbosity' => Output::VERBOSITY_QUIET, 'capture_stderr_separately' => true]);
         $this->assertStringEqualsFile(self::$fixturesPath.'/application_renderexception1.txt', $tester->getErrorOutput(true), '->renderException() renders a pretty exception');
 
         $tester->run(['command' => 'foo'], ['decorated' => false, 'verbosity' => Output::VERBOSITY_VERBOSE, 'capture_stderr_separately' => true]);
         $this->assertStringContainsString('Exception trace', $tester->getErrorOutput(), '->renderException() renders a pretty exception with a stack trace when verbosity is verbose');
 
+        $tester->run(['command' => 'foo'], ['decorated' => false, 'verbosity' => Output::VERBOSITY_SILENT, 'capture_stderr_separately' => true]);
+        $this->assertSame('', $tester->getErrorOutput(true), '->renderException() renders nothing in SILENT verbosity');
+
         $tester->run(['command' => 'list', '--foo' => true], ['decorated' => false, 'capture_stderr_separately' => true]);
         $this->assertStringEqualsFile(self::$fixturesPath.'/application_renderexception2.txt', $tester->getErrorOutput(true), '->renderException() renders the command synopsis when an exception occurs in the context of a command');
 

src/Symfony/Component/Console/Tests/Command/CompleteCommandTest.php

@@ -119,9 +119,9 @@ public function testCompleteCommandInputDefinition(array $input, array $suggesti
 
     public static function provideCompleteCommandInputDefinitionInputs()
     {
-        yield 'definition' => [['bin/console', 'hello', '-'], ['--help', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
+        yield 'definition' => [['bin/console', 'hello', '-'], ['--help', '--silent', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
         yield 'custom' => [['bin/console', 'hello'], ['Fabien', 'Robin', 'Wouter']];
-        yield 'definition-aliased' => [['bin/console', 'ahoy', '-'], ['--help', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
+        yield 'definition-aliased' => [['bin/console', 'ahoy', '-'], ['--help', '--silent', '--quiet', '--verbose', '--version', '--ansi', '--no-ansi', '--no-interaction']];
         yield 'custom-aliased' => [['bin/console', 'ahoy'], ['Fabien', 'Robin', 'Wouter']];
     }