bug #21841 [Console] Do not squash input changes made from console.command event (chalasr)

fabpot · fabpot · commit b8b677463451 · 2017-03-05T12:03:23.000-08:00
This PR was merged into the 2.8 branch. Discussion ---------- [Console] Do not squash input changes made from console.command event | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #19441 | License | MIT | Doc PR | n/a Setting arguments/options from the `console.command` event is expected to work since #15938 Commits ------- c8d364b [Console] Do not squash input changes made from console.command event
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -859,6 +859,10 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI
             // ignore invalid options/arguments for now, to allow the event listeners to customize the InputDefinition
         }
 
+        // don't bind the input again as it would override any input argument/option set from the command event in
+        // addition to being useless
+        $command->setInputBound(true);
+
         $event = new ConsoleCommandEvent($command, $input, $output);
         $this->dispatcher->dispatch(ConsoleEvents::COMMAND, $event);
 
diff --git a/src/Symfony/Component/Console/Command/Command.php b/src/Symfony/Component/Console/Command/Command.php
@@ -42,6 +42,7 @@ class Command
     private $ignoreValidationErrors = false;
     private $applicationDefinitionMerged = false;
     private $applicationDefinitionMergedWithArgs = false;
+    private $inputBound = false;
     private $code;
     private $synopsis = array();
     private $usages = array();
@@ -218,11 +219,13 @@ public function run(InputInterface $input, OutputInterface $output)
         $this->mergeApplicationDefinition();
 
         // bind the input against the command specific arguments/options
-        try {
-            $input->bind($this->definition);
-        } catch (ExceptionInterface $e) {
-            if (!$this->ignoreValidationErrors) {
-                throw $e;
+        if (!$this->inputBound) {
+            try {
+                $input->bind($this->definition);
+            } catch (ExceptionInterface $e) {
+                if (!$this->ignoreValidationErrors) {
+                    throw $e;
+                }
             }
         }
 
@@ -678,6 +681,14 @@ public function asXml($asDom = false)
         return $output->fetch();
     }
 
+    /**
+     * @internal
+     */
+    public function setInputBound($inputBound)
+    {
+        $this->inputBound = $inputBound;
+    }
+
     /**
      * Validates a command name.
      *
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -1113,6 +1113,31 @@ public function testRunWithDispatcherAddingInputOptions()
         $this->assertEquals('some test value', $extraValue);
     }
 
+    public function testUpdateInputFromConsoleCommandEvent()
+    {
+        $dispatcher = $this->getDispatcher();
+        $dispatcher->addListener('console.command', function (ConsoleCommandEvent $event) {
+            $event->getInput()->setOption('extra', 'overriden');
+        });
+
+        $application = new Application();
+        $application->setDispatcher($dispatcher);
+        $application->setAutoExit(false);
+
+        $application
+            ->register('foo')
+            ->addOption('extra', null, InputOption::VALUE_REQUIRED)
+            ->setCode(function (InputInterface $input, OutputInterface $output) {
+                $output->write('foo.');
+            })
+        ;
+
+        $tester = new ApplicationTester($application);
+        $tester->run(array('command' => 'foo', '--extra' => 'original'));
+
+        $this->assertEquals('overriden', $tester->getInput()->getOption('extra'));
+    }
+
     public function testTerminalDimensions()
     {
         $application = new Application();

Original file line number	Diff line number	Diff line change
`@@ -859,6 +859,10 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI`
`859`	`859`	`// ignore invalid options/arguments for now, to allow the event listeners to customize the InputDefinition`
`860`	`860`	`}`
`861`	`861`
	`862`	`+ // don't bind the input again as it would override any input argument/option set from the command event in`
	`863`	`+ // addition to being useless`
	`864`	`+ $command->setInputBound(true);`
	`865`	`+`
`862`	`866`	`$event = new ConsoleCommandEvent($command, $input, $output);`
`863`	`867`	`$this->dispatcher->dispatch(ConsoleEvents::COMMAND, $event);`
`864`	`868`