bug #41386 [Console] Escape synopsis output (jschaedl)

nicolas-grekas · nicolas-grekas · commit d7524e6842f3 · 2021-06-03T13:51:23.000+02:00
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- [Console] Escape synopsis output | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Tickets | Fix #41315  | License | MIT | Doc PR | symfony/symfony-docs#...  Commits ------- 960cb52 [Console] Escape synopsis output
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -833,7 +833,7 @@ public function renderThrowable(\Throwable $e, OutputInterface $output): void
     private function finishRenderThrowableOrException(OutputInterface $output): void
     {
         if (null !== $this->runningCommand) {
-            $output->writeln(sprintf('<info>%s</info>', sprintf($this->runningCommand->getSynopsis(), $this->getName())), OutputInterface::VERBOSITY_QUIET);
+            $output->writeln(sprintf('<info>%s</info>', OutputFormatter::escape(sprintf($this->runningCommand->getSynopsis(), $this->getName()))), OutputInterface::VERBOSITY_QUIET);
             $output->writeln('', OutputInterface::VERBOSITY_QUIET);
         }
     }
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -940,6 +940,23 @@ public function testRenderExceptionStackTraceContainsRootException()
         $this->assertStringContainsString('Dummy type "class@anonymous" is invalid.', $tester->getDisplay(true));
     }
 
+    public function testRenderExceptionEscapesLinesOfSynopsis()
+    {
+        $application = new Application();
+        $application->setAutoExit(false);
+        $application
+            ->register('foo')
+            ->setCode(function () {
+                throw new \Exception('some exception');
+            })
+            ->addArgument('info')
+        ;
+        $tester = new ApplicationTester($application);
+
+        $tester->run(['command' => 'foo'], ['decorated' => false]);
+        $this->assertStringMatchesFormatFile(self::$fixturesPath.'/application_rendersynopsis_escapesline.txt', $tester->getDisplay(true), '->renderException() escapes lines containing formatting of synopsis');
+    }
+
     public function testRun()
     {
         $application = new Application();
diff --git a/src/Symfony/Component/Console/Tests/Command/CommandTest.php b/src/Symfony/Component/Console/Tests/Command/CommandTest.php
@@ -192,7 +192,8 @@ public function testGetSynopsis()
         $command = new \TestCommand();
         $command->addOption('foo');
         $command->addArgument('bar');
-        $this->assertEquals('namespace:name [--foo] [--] [<bar>]', $command->getSynopsis(), '->getSynopsis() returns the synopsis');
+        $command->addArgument('info');
+        $this->assertEquals('namespace:name [--foo] [--] [<bar> [<info>]]', $command->getSynopsis(), '->getSynopsis() returns the synopsis');
     }
 
     public function testAddGetUsages()
diff --git a/src/Symfony/Component/Console/Tests/Fixtures/application_rendersynopsis_escapesline.txt b/src/Symfony/Component/Console/Tests/Fixtures/application_rendersynopsis_escapesline.txt
@@ -0,0 +1,7 @@
+
+In ApplicationTest.php line %d:
+                  
+  some exception  
+                  
+
+foo [<info>]

Original file line number	Diff line number	Diff line change
`@@ -833,7 +833,7 @@ public function renderThrowable(\Throwable $e, OutputInterface $output): void`
`833`	`833`	`private function finishRenderThrowableOrException(OutputInterface $output): void`
`834`	`834`	`{`
`835`	`835`	`if (null !== $this->runningCommand) {`
`836`		`- $output->writeln(sprintf('<info>%s</info>', sprintf($this->runningCommand->getSynopsis(), $this->getName())), OutputInterface::VERBOSITY_QUIET);`
	`836`	`+ $output->writeln(sprintf('<info>%s</info>', OutputFormatter::escape(sprintf($this->runningCommand->getSynopsis(), $this->getName()))), OutputInterface::VERBOSITY_QUIET);`
`837`	`837`	`$output->writeln('', OutputInterface::VERBOSITY_QUIET);`
`838`	`838`	`}`
`839`	`839`	`}`
Original file line number	Diff line number	Diff line change
`@@ -192,7 +192,8 @@ public function testGetSynopsis()`
`192`	`192`	`$command = new \TestCommand();`
`193`	`193`	`$command->addOption('foo');`
`194`	`194`	`$command->addArgument('bar');`
`195`		`- $this->assertEquals('namespace:name [--foo] [--] [<bar>]', $command->getSynopsis(), '->getSynopsis() returns the synopsis');`
	`195`	`+ $command->addArgument('info');`
	`196`	`+ $this->assertEquals('namespace:name [--foo] [--] [<bar> [<info>]]', $command->getSynopsis(), '->getSynopsis() returns the synopsis');`
`196`	`197`	`}`
`197`	`198`
`198`	`199`	`public function testAddGetUsages()`