feature #6623 [Console] Adapt doc for easier testing of commands needing user inputs (chalasr)

xabbuh · xabbuh · commit 173033b8dada · 2016-06-30T18:58:10.000+02:00
This PR was merged into the master branch. Discussion ---------- [Console] Adapt doc for easier testing of commands needing user inputs Doc-PR for symfony/symfony#18710. This one eases testing of commands needing user interactions by simulating them from the CommandTester directly, by creating a input stream from the ones set by the developer. Commits ------- 26fdbe0 [Console] Adapt doc for easier testing of commands needing user inputs
diff --git a/components/console/helpers/questionhelper.rst b/components/console/helpers/questionhelper.rst
@@ -277,7 +277,7 @@ Testing a Command that Expects Input
 ------------------------------------
 
 If you want to write a unit test for a command which expects some kind of input
-from the command line, you need to set the helper input stream::
+from the command line, you need to set the inputs that the command expects::
 
     use Symfony\Component\Console\Helper\QuestionHelper;
     use Symfony\Component\Console\Helper\HelperSet;
@@ -289,26 +289,28 @@ from the command line, you need to set the helper input stream::
         // ...
         $commandTester = new CommandTester($command);
 
-        $helper = $command->getHelper('question');
-        $helper->setInputStream($this->getInputStream("Test\n"));
         // Equals to a user inputting "Test" and hitting ENTER
-        // If you need to enter a confirmation, "yes\n" will work
+        $commandTester->setInputs(array('Test'));
+
+        // Equals to a user inputting "This", "That" and hitting ENTER
+        // This can be used for answering two separated questions for instance
+        $commandTester->setInputs(array('This', 'That'));
+
+        // For simulating a positive answer to a confirmation question, adding an
+        // additional input saying "yes" will work
+        $commandTester->setInputs(array('yes'));
 
         $commandTester->execute(array('command' => $command->getName()));
 
         // $this->assertRegExp('/.../', $commandTester->getDisplay());
     }
 
-    protected function getInputStream($input)
-    {
-        $stream = fopen('php://memory', 'r+', false);
-        fputs($stream, $input);
-        rewind($stream);
-
-        return $stream;
-    }
+By calling :method:`Symfony\\Component\\Console\\Tester\\CommandTester::setInputs`,
+you imitate what the console would do internally with all user input through the CLI.
+This method takes an array as only argument with, for each input that the command expects,
+a string representing what the user would have typed.
+This way you can test any user interaction (even complex ones) by passing the appropriate inputs.
 
-By setting the input stream of the ``QuestionHelper``, you imitate what the
-console would do internally with all user input through the CLI. This way
-you can test any user interaction (even complex ones) by passing an appropriate
-input stream.
+.. note::
+    The :class:`Symfony\\Component\\Console\\Tester\\CommandTester` automatically simulates a user
+    hitting ``ENTER`` after each input, no need for passing an additional input.
