From 26fdbe05e409e542954610368b6428a7d9f1a0b8 Mon Sep 17 00:00:00 2001 From: Robin Chalas Date: Sat, 28 May 2016 09:43:00 +0200 Subject: [PATCH] [Console] Adapt doc for easier testing of commands needing user inputs Fix missing colon Change userInputs to inputs Try to fix platformsh build Re-add useful use statements Fixed typo, use FQCN::method Rollback not useful diff Formatting Add more examples, precise documentation typo 'would have type' => 'would have typed' removing an ending dot in comment for consistency --- components/console/helpers/questionhelper.rst | 34 ++++++++++--------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/components/console/helpers/questionhelper.rst b/components/console/helpers/questionhelper.rst index 6ea453beeb7..006787c1da6 100644 --- 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. pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy