Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4c39bc8

Browse files
chalasrchalasr
committed
[Console] Set user inputs from CommandTester
Long array syntax CS improving Remove useless count check Improve tests Fix wrong phpdoc Fabbot fixes Remove useless assertion, avoid double quoted \n for PHP_EOL Remove useless getter, Change userInputs to inputs Describe in setInputs docblock Move QuestionHelper::setInputStream logic in CommandTester::execute(), CS Fixes Rebase on PR 18999 (Input::stream) Fabbot fixes Add a test with SymfonyStyle and no HelperSet
1 parent 362e03d commit 4c39bc8

File tree

2 files changed

+149
-40
lines changed

2 files changed

+149
-40
lines changed

‎src/Symfony/Component/Console/Tester/CommandTester.php

Lines changed: 71 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@
2121
* Eases the testing of console commands.
2222
*
2323
* @author Fabien Potencier <[email protected]>
24+
* @author Robin Chalas <[email protected]>
2425
*/
2526
class CommandTester
2627
{
2728
private $command;
2829
private $input;
2930
private $output;
31+
private $inputs = array();
3032
private $statusCode;
3133

3234
/**
@@ -39,46 +41,50 @@ public function __construct(Command $command)
3941
$this->command = $command;
4042
}
4143

42-
/**
43-
* Executes the command.
44-
*
45-
* Available execution options:
46-
*
47-
* * interactive: Sets the input interactive flag
48-
* * decorated: Sets the output decorated flag
49-
* * verbosity: Sets the output verbosity flag
50-
*
51-
* @param array $input An array of command arguments and options
52-
* @param array $options An array of execution options
53-
*
54-
* @return int The command exit code
55-
*/
56-
public function execute(array $input, array $options = array())
57-
{
58-
// set the command name automatically if the application requires
59-
// this argument and no command name was passed
60-
if (!isset($input['command'])
61-
&& (null !== $application = $this->command->getApplication())
62-
&& $application->getDefinition()->hasArgument('command')
63-
) {
64-
$input = array_merge(array('command' => $this->command->getName()), $input);
65-
}
66-
67-
$this->input = new ArrayInput($input);
68-
if (isset($options['interactive'])) {
69-
$this->input->setInteractive($options['interactive']);
70-
}
71-
72-
$this->output = new StreamOutput(fopen('php://memory', 'w', false));
73-
if (isset($options['decorated'])) {
74-
$this->output->setDecorated($options['decorated']);
75-
}
76-
if (isset($options['verbosity'])) {
77-
$this->output->setVerbosity($options['verbosity']);
78-
}
79-
80-
return $this->statusCode = $this->command->run($this->input, $this->output);
81-
}
44+
/**
45+
* Executes the command.
46+
*
47+
* Available execution options:
48+
*
49+
* * interactive: Sets the input interactive flag
50+
* * decorated: Sets the output decorated flag
51+
* * verbosity: Sets the output verbosity flag
52+
*
53+
* @param array $input An array of command arguments and options
54+
* @param array $options An array of execution options
55+
*
56+
* @return int The command exit code
57+
*/
58+
public function execute(array $input, array $options = array())
59+
{
60+
// set the command name automatically if the application requires
61+
// this argument and no command name was passed
62+
if (!isset($input['command'])
63+
&& (null !== $application = $this->command->getApplication())
64+
&& $application->getDefinition()->hasArgument('command')
65+
) {
66+
$input = array_merge(array('command' => $this->command->getName()), $input);
67+
}
68+
69+
$this->input = new ArrayInput($input);
70+
if ($this->inputs) {
71+
$this->input->setStream($this->getInputStream());
72+
}
73+
74+
if (isset($options['interactive'])) {
75+
$this->input->setInteractive($options['interactive']);
76+
}
77+
78+
$this->output = new StreamOutput(fopen('php://memory', 'w', false));
79+
if (isset($options['decorated'])) {
80+
$this->output->setDecorated($options['decorated']);
81+
}
82+
if (isset($options['verbosity'])) {
83+
$this->output->setVerbosity($options['verbosity']);
84+
}
85+
86+
return $this->statusCode = $this->command->run($this->input, $this->output);
87+
}
8288

8389
/**
8490
* Gets the display returned by the last execution of the command.
@@ -129,4 +135,29 @@ public function getStatusCode()
129135
{
130136
return $this->statusCode;
131137
}
138+
139+
/**
140+
* Sets the user inputs.
141+
*
142+
* @param array An array of strings representing each input
143+
* passed to the command input stream.
144+
*
145+
* @return CommandTester
146+
*/
147+
public function setInputs(array $inputs)
148+
{
149+
$this->inputs = $inputs;
150+
151+
return $this;
152+
}
153+
154+
private function getInputStream()
155+
{
156+
$stream = fopen('php://memory', 'r+', false);
157+
158+
fputs($stream, implode(PHP_EOL, $this->inputs));
159+
rewind($stream);
160+
161+
return $stream;
162+
}
132163
}

‎src/Symfony/Component/Console/Tests/Tester/CommandTesterTest.php

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@
1515
use Symfony\Component\Console\Command\Command;
1616
use Symfony\Component\Console\Output\Output;
1717
use Symfony\Component\Console\Tester\CommandTester;
18+
use Symfony\Component\Console\Question\Question;
19+
use Symfony\Component\Console\Helper\HelperSet;
20+
use Symfony\Component\Console\Helper\QuestionHelper;
21+
use Symfony\Component\Console\Style\SymfonyStyle;
1822

1923
class CommandTesterTest extends \PHPUnit_Framework_TestCase
2024
{
@@ -81,4 +85,78 @@ public function testCommandFromApplication()
8185
// check that there is no need to pass the command name here
8286
$this->assertEquals(0, $tester->execute(array()));
8387
}
88+
89+
public function testCommandWithInputs()
90+
{
91+
$questions = array(
92+
'What\'s your name?',
93+
'How are you?',
94+
'Where do you come from?',
95+
);
96+
97+
$command = new Command('foo');
98+
$command->setHelperSet(new HelperSet(array(new QuestionHelper())));
99+
$command->setCode(function ($input, $output) use ($questions, $command) {
100+
$helper = $command->getHelper('question');
101+
$helper->ask($input, $output, new Question($questions[0]));
102+
$helper->ask($input, $output, new Question($questions[1]));
103+
$helper->ask($input, $output, new Question($questions[2]));
104+
});
105+
106+
$tester = new CommandTester($command);
107+
$tester->setInputs(array('Bobby', 'Fine', 'France'));
108+
$tester->execute(array());
109+
110+
$this->assertEquals(0, $tester->getStatusCode());
111+
$this->assertEquals(implode('', $questions), $tester->getDisplay(true));
112+
}
113+
114+
/**
115+
* @expectedException \RuntimeException
116+
* @expectedMessage Aborted
117+
*/
118+
public function testCommandWithWrongInputsNumber()
119+
{
120+
$questions = array(
121+
'What\'s your name?',
122+
'How are you?',
123+
'Where do you come from?',
124+
);
125+
126+
$command = new Command('foo');
127+
$command->setHelperSet(new HelperSet(array(new QuestionHelper())));
128+
$command->setCode(function ($input, $output) use ($questions, $command) {
129+
$helper = $command->getHelper('question');
130+
$helper->ask($input, $output, new Question($questions[0]));
131+
$helper->ask($input, $output, new Question($questions[1]));
132+
$helper->ask($input, $output, new Question($questions[2]));
133+
});
134+
135+
$tester = new CommandTester($command);
136+
$tester->setInputs(array('Bobby', 'Fine'));
137+
$tester->execute(array());
138+
}
139+
140+
public function testSymfonyStyleCommandWithInputs()
141+
{
142+
$questions = array(
143+
'What\'s your name?',
144+
'How are you?',
145+
'Where do you come from?',
146+
);
147+
148+
$command = new Command('foo');
149+
$command->setCode(function ($input, $output) use ($questions, $command) {
150+
$io = new SymfonyStyle($input, $output);
151+
$io->ask($questions[0]); // Take its input stream from the inherited QuestionHelper::ask()
152+
$io->ask($questions[1]);
153+
$io->ask($questions[2]);
154+
});
155+
156+
$tester = new CommandTester($command);
157+
$tester->setInputs(array('Bobby', 'Fine', 'France'));
158+
$tester->execute(array());
159+
160+
$this->assertEquals(0, $tester->getStatusCode());
161+
}
84162
}

0 commit comments

Comments
 (0)