123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Console\Tests\Helper;
- use Symfony\Component\Console\Formatter\OutputFormatter;
- use Symfony\Component\Console\Helper\FormatterHelper;
- use Symfony\Component\Console\Helper\HelperSet;
- use Symfony\Component\Console\Helper\QuestionHelper;
- use Symfony\Component\Console\Output\StreamOutput;
- use Symfony\Component\Console\Question\ChoiceQuestion;
- use Symfony\Component\Console\Question\ConfirmationQuestion;
- use Symfony\Component\Console\Question\Question;
- /**
- * @group tty
- */
- class QuestionHelperTest extends AbstractQuestionHelperTest
- {
- public function testAskChoice()
- {
- $questionHelper = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $questionHelper->setHelperSet($helperSet);
- $heroes = ['Superman', 'Batman', 'Spiderman'];
- $inputStream = $this->getInputStream("\n1\n 1 \nFabien\n1\nFabien\n1\n0,2\n 0 , 2 \n\n\n");
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '2');
- $question->setMaxAttempts(1);
- // first answer is an empty answer, we're supposed to receive the default value
- $this->assertEquals('Spiderman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes);
- $question->setMaxAttempts(1);
- $this->assertEquals('Batman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('Batman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes);
- $question->setErrorMessage('Input "%s" is not a superhero!');
- $question->setMaxAttempts(2);
- $this->assertEquals('Batman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question));
- rewind($output->getStream());
- $stream = stream_get_contents($output->getStream());
- $this->assertContains('Input "Fabien" is not a superhero!', $stream);
- try {
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '1');
- $question->setMaxAttempts(1);
- $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question);
- $this->fail();
- } catch (\InvalidArgumentException $e) {
- $this->assertEquals('Value "Fabien" is invalid', $e->getMessage());
- }
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, null);
- $question->setMaxAttempts(1);
- $question->setMultiselect(true);
- $this->assertEquals(['Batman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals(['Superman', 'Spiderman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals(['Superman', 'Spiderman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '0,1');
- $question->setMaxAttempts(1);
- $question->setMultiselect(true);
- $this->assertEquals(['Superman', 'Batman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, ' 0 , 1 ');
- $question->setMaxAttempts(1);
- $question->setMultiselect(true);
- $this->assertEquals(['Superman', 'Batman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, 0);
- // We are supposed to get the default value since we are not in interactive mode
- $this->assertEquals('Superman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, true), $this->createOutputInterface(), $question));
- }
- public function testAskChoiceNonInteractive()
- {
- $questionHelper = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $questionHelper->setHelperSet($helperSet);
- $inputStream = $this->getInputStream("\n1\n 1 \nFabien\n1\nFabien\n1\n0,2\n 0 , 2 \n\n\n");
- $heroes = ['Superman', 'Batman', 'Spiderman'];
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '0');
- $this->assertSame('Superman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, 'Batman');
- $this->assertSame('Batman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, null);
- $this->assertNull($questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, '0');
- $question->setValidator(null);
- $this->assertSame('Superman', $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- try {
- $question = new ChoiceQuestion('What is your favorite superhero?', $heroes, null);
- $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question);
- } catch (\InvalidArgumentException $e) {
- $this->assertSame('Value "" is invalid', $e->getMessage());
- }
- $question = new ChoiceQuestion('Who are your favorite superheros?', $heroes, '0, 1');
- $question->setMultiselect(true);
- $this->assertSame(['Superman', 'Batman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('Who are your favorite superheros?', $heroes, '0, 1');
- $question->setMultiselect(true);
- $question->setValidator(null);
- $this->assertSame(['Superman', 'Batman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('Who are your favorite superheros?', $heroes, '0, Batman');
- $question->setMultiselect(true);
- $this->assertSame(['Superman', 'Batman'], $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('Who are your favorite superheros?', $heroes, null);
- $question->setMultiselect(true);
- $this->assertNull($questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question));
- $question = new ChoiceQuestion('Who are your favorite superheros?', ['a' => 'Batman', 'b' => 'Superman'], 'a');
- $this->assertSame('a', $questionHelper->ask($this->createStreamableInputInterfaceMock('', false), $this->createOutputInterface(), $question), 'ChoiceQuestion validator returns the key if it\'s a string');
- try {
- $question = new ChoiceQuestion('Who are your favorite superheros?', $heroes, '');
- $question->setMultiselect(true);
- $questionHelper->ask($this->createStreamableInputInterfaceMock($inputStream, false), $this->createOutputInterface(), $question);
- } catch (\InvalidArgumentException $e) {
- $this->assertSame('Value "" is invalid', $e->getMessage());
- }
- }
- public function testAsk()
- {
- $dialog = new QuestionHelper();
- $inputStream = $this->getInputStream("\n8AM\n");
- $question = new Question('What time is it?', '2PM');
- $this->assertEquals('2PM', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $question = new Question('What time is it?', '2PM');
- $this->assertEquals('8AM', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $output = $this->createOutputInterface(), $question));
- rewind($output->getStream());
- $this->assertEquals('What time is it?', stream_get_contents($output->getStream()));
- }
- public function testAskWithAutocomplete()
- {
- if (!$this->hasSttyAvailable()) {
- $this->markTestSkipped('`stty` is required to test autocomplete functionality');
- }
- // Acm<NEWLINE>
- // Ac<BACKSPACE><BACKSPACE>s<TAB>Test<NEWLINE>
- // <NEWLINE>
- // <UP ARROW><UP ARROW><NEWLINE>
- // <UP ARROW><UP ARROW><UP ARROW><UP ARROW><UP ARROW><TAB>Test<NEWLINE>
- // <DOWN ARROW><NEWLINE>
- // S<BACKSPACE><BACKSPACE><DOWN ARROW><DOWN ARROW><NEWLINE>
- // F00<BACKSPACE><BACKSPACE>oo<TAB><NEWLINE>
- $inputStream = $this->getInputStream("Acm\nAc\177\177s\tTest\n\n\033[A\033[A\n\033[A\033[A\033[A\033[A\033[A\tTest\n\033[B\nS\177\177\033[B\033[B\nF00\177\177oo\t\n");
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new Question('Please select a bundle', 'FrameworkBundle');
- $question->setAutocompleterValues(['AcmeDemoBundle', 'AsseticBundle', 'SecurityBundle', 'FooBundle']);
- $this->assertEquals('AcmeDemoBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('AsseticBundleTest', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('FrameworkBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('SecurityBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('FooBundleTest', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('AcmeDemoBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('AsseticBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('FooBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- public function testAskWithAutocompleteCallback()
- {
- if (!$this->hasSttyAvailable()) {
- $this->markTestSkipped('`stty` is required to test autocomplete functionality');
- }
- // Po<TAB>Cr<TAB>P<DOWN ARROW><DOWN ARROW><NEWLINE>
- $inputStream = $this->getInputStream("Pa\177\177o\tCr\tP\033[A\033[A\n");
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new Question('What\'s for dinner?');
- // A simple test callback - return an array containing the words the
- // user has already completed, suffixed with all known words.
- //
- // Eg: If the user inputs "Potato C", the return will be:
- //
- // ["Potato Carrot ", "Potato Creme ", "Potato Curry ", ...]
- //
- // No effort is made to avoid irrelevant suggestions, as this is handled
- // by the autocomplete function.
- $callback = function ($input) {
- $knownWords = ['Carrot', 'Creme', 'Curry', 'Parsnip', 'Pie', 'Potato', 'Tart'];
- $inputWords = explode(' ', $input);
- array_pop($inputWords);
- $suggestionBase = $inputWords ? implode(' ', $inputWords).' ' : '';
- return array_map(
- function ($word) use ($suggestionBase) {
- return $suggestionBase.$word.' ';
- },
- $knownWords
- );
- };
- $question->setAutocompleterCallback($callback);
- $this->assertSame('Potato Creme Pie', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- public function testAskWithAutocompleteWithNonSequentialKeys()
- {
- if (!$this->hasSttyAvailable()) {
- $this->markTestSkipped('`stty` is required to test autocomplete functionality');
- }
- // <UP ARROW><UP ARROW><NEWLINE><DOWN ARROW><DOWN ARROW><NEWLINE>
- $inputStream = $this->getInputStream("\033[A\033[A\n\033[B\033[B\n");
- $dialog = new QuestionHelper();
- $dialog->setHelperSet(new HelperSet([new FormatterHelper()]));
- $question = new ChoiceQuestion('Please select a bundle', [1 => 'AcmeDemoBundle', 4 => 'AsseticBundle']);
- $question->setMaxAttempts(1);
- $this->assertEquals('AcmeDemoBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('AsseticBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- public function testAskWithAutocompleteWithExactMatch()
- {
- if (!$this->hasSttyAvailable()) {
- $this->markTestSkipped('`stty` is required to test autocomplete functionality');
- }
- $inputStream = $this->getInputStream("b\n");
- $possibleChoices = [
- 'a' => 'berlin',
- 'b' => 'copenhagen',
- 'c' => 'amsterdam',
- ];
- $dialog = new QuestionHelper();
- $dialog->setHelperSet(new HelperSet([new FormatterHelper()]));
- $question = new ChoiceQuestion('Please select a city', $possibleChoices);
- $question->setMaxAttempts(1);
- $this->assertSame('b', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- public function getInputs()
- {
- return [
- ['$'], // 1 byte character
- ['¢'], // 2 bytes character
- ['€'], // 3 bytes character
- ['𐍈'], // 4 bytes character
- ];
- }
- /**
- * @dataProvider getInputs
- */
- public function testAskWithAutocompleteWithMultiByteCharacter($character)
- {
- if (!$this->hasSttyAvailable()) {
- $this->markTestSkipped('`stty` is required to test autocomplete functionality');
- }
- $inputStream = $this->getInputStream("$character\n");
- $possibleChoices = [
- '$' => '1 byte character',
- '¢' => '2 bytes character',
- '€' => '3 bytes character',
- '𐍈' => '4 bytes character',
- ];
- $dialog = new QuestionHelper();
- $dialog->setHelperSet(new HelperSet([new FormatterHelper()]));
- $question = new ChoiceQuestion('Please select a character', $possibleChoices);
- $question->setMaxAttempts(1);
- $this->assertSame($character, $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- public function testAutocompleteWithTrailingBackslash()
- {
- if (!$this->hasSttyAvailable()) {
- $this->markTestSkipped('`stty` is required to test autocomplete functionality');
- }
- $inputStream = $this->getInputStream('E');
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new Question('');
- $expectedCompletion = 'ExampleNamespace\\';
- $question->setAutocompleterValues([$expectedCompletion]);
- $output = $this->createOutputInterface();
- $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $output, $question);
- $outputStream = $output->getStream();
- rewind($outputStream);
- $actualOutput = stream_get_contents($outputStream);
- // Shell control (esc) sequences are not so important: we only care that
- // <hl> tag is interpreted correctly and replaced
- $irrelevantEscSequences = [
- "\0337" => '', // Save cursor position
- "\0338" => '', // Restore cursor position
- "\033[K" => '', // Clear line from cursor till the end
- ];
- $importantActualOutput = strtr($actualOutput, $irrelevantEscSequences);
- // Remove colors (e.g. "\033[30m", "\033[31;41m")
- $importantActualOutput = preg_replace('/\033\[\d+(;\d+)?m/', '', $importantActualOutput);
- $this->assertEquals($expectedCompletion, $importantActualOutput);
- }
- public function testAskHiddenResponse()
- {
- if ('\\' === \DIRECTORY_SEPARATOR) {
- $this->markTestSkipped('This test is not supported on Windows');
- }
- $dialog = new QuestionHelper();
- $question = new Question('What time is it?');
- $question->setHidden(true);
- $this->assertEquals('8AM', $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream("8AM\n")), $this->createOutputInterface(), $question));
- }
- /**
- * @dataProvider getAskConfirmationData
- */
- public function testAskConfirmation($question, $expected, $default = true)
- {
- $dialog = new QuestionHelper();
- $inputStream = $this->getInputStream($question."\n");
- $question = new ConfirmationQuestion('Do you like French fries?', $default);
- $this->assertEquals($expected, $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question), 'confirmation question should '.($expected ? 'pass' : 'cancel'));
- }
- public function getAskConfirmationData()
- {
- return [
- ['', true],
- ['', false, false],
- ['y', true],
- ['yes', true],
- ['n', false],
- ['no', false],
- ];
- }
- public function testAskConfirmationWithCustomTrueAnswer()
- {
- $dialog = new QuestionHelper();
- $inputStream = $this->getInputStream("j\ny\n");
- $question = new ConfirmationQuestion('Do you like French fries?', false, '/^(j|y)/i');
- $this->assertTrue($dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $question = new ConfirmationQuestion('Do you like French fries?', false, '/^(j|y)/i');
- $this->assertTrue($dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- public function testAskAndValidate()
- {
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $error = 'This is not a color!';
- $validator = function ($color) use ($error) {
- if (!\in_array($color, ['white', 'black'])) {
- throw new \InvalidArgumentException($error);
- }
- return $color;
- };
- $question = new Question('What color was the white horse of Henry IV?', 'white');
- $question->setValidator($validator);
- $question->setMaxAttempts(2);
- $inputStream = $this->getInputStream("\nblack\n");
- $this->assertEquals('white', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('black', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- try {
- $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream("green\nyellow\norange\n")), $this->createOutputInterface(), $question);
- $this->fail();
- } catch (\InvalidArgumentException $e) {
- $this->assertEquals($error, $e->getMessage());
- }
- }
- /**
- * @dataProvider simpleAnswerProvider
- */
- public function testSelectChoiceFromSimpleChoices($providedAnswer, $expectedValue)
- {
- $possibleChoices = [
- 'My environment 1',
- 'My environment 2',
- 'My environment 3',
- ];
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new ChoiceQuestion('Please select the environment to load', $possibleChoices);
- $question->setMaxAttempts(1);
- $answer = $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream($providedAnswer."\n")), $this->createOutputInterface(), $question);
- $this->assertSame($expectedValue, $answer);
- }
- public function simpleAnswerProvider()
- {
- return [
- [0, 'My environment 1'],
- [1, 'My environment 2'],
- [2, 'My environment 3'],
- ['My environment 1', 'My environment 1'],
- ['My environment 2', 'My environment 2'],
- ['My environment 3', 'My environment 3'],
- ];
- }
- /**
- * @dataProvider specialCharacterInMultipleChoice
- */
- public function testSpecialCharacterChoiceFromMultipleChoiceList($providedAnswer, $expectedValue)
- {
- $possibleChoices = [
- '.',
- 'src',
- ];
- $dialog = new QuestionHelper();
- $inputStream = $this->getInputStream($providedAnswer."\n");
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new ChoiceQuestion('Please select the directory', $possibleChoices);
- $question->setMaxAttempts(1);
- $question->setMultiselect(true);
- $answer = $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question);
- $this->assertSame($expectedValue, $answer);
- }
- public function specialCharacterInMultipleChoice()
- {
- return [
- ['.', ['.']],
- ['., src', ['.', 'src']],
- ];
- }
- /**
- * @dataProvider mixedKeysChoiceListAnswerProvider
- */
- public function testChoiceFromChoicelistWithMixedKeys($providedAnswer, $expectedValue)
- {
- $possibleChoices = [
- '0' => 'No environment',
- '1' => 'My environment 1',
- 'env_2' => 'My environment 2',
- 3 => 'My environment 3',
- ];
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new ChoiceQuestion('Please select the environment to load', $possibleChoices);
- $question->setMaxAttempts(1);
- $answer = $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream($providedAnswer."\n")), $this->createOutputInterface(), $question);
- $this->assertSame($expectedValue, $answer);
- }
- public function mixedKeysChoiceListAnswerProvider()
- {
- return [
- ['0', '0'],
- ['No environment', '0'],
- ['1', '1'],
- ['env_2', 'env_2'],
- [3, '3'],
- ['My environment 1', '1'],
- ];
- }
- /**
- * @dataProvider answerProvider
- */
- public function testSelectChoiceFromChoiceList($providedAnswer, $expectedValue)
- {
- $possibleChoices = [
- 'env_1' => 'My environment 1',
- 'env_2' => 'My environment',
- 'env_3' => 'My environment',
- ];
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new ChoiceQuestion('Please select the environment to load', $possibleChoices);
- $question->setMaxAttempts(1);
- $answer = $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream($providedAnswer."\n")), $this->createOutputInterface(), $question);
- $this->assertSame($expectedValue, $answer);
- }
- /**
- * @expectedException \InvalidArgumentException
- * @expectedExceptionMessage The provided answer is ambiguous. Value should be one of env_2 or env_3.
- */
- public function testAmbiguousChoiceFromChoicelist()
- {
- $possibleChoices = [
- 'env_1' => 'My first environment',
- 'env_2' => 'My environment',
- 'env_3' => 'My environment',
- ];
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new ChoiceQuestion('Please select the environment to load', $possibleChoices);
- $question->setMaxAttempts(1);
- $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream("My environment\n")), $this->createOutputInterface(), $question);
- }
- public function answerProvider()
- {
- return [
- ['env_1', 'env_1'],
- ['env_2', 'env_2'],
- ['env_3', 'env_3'],
- ['My environment 1', 'env_1'],
- ];
- }
- public function testNoInteraction()
- {
- $dialog = new QuestionHelper();
- $question = new Question('Do you have a job?', 'not yet');
- $this->assertEquals('not yet', $dialog->ask($this->createStreamableInputInterfaceMock(null, false), $this->createOutputInterface(), $question));
- }
- /**
- * @requires function mb_strwidth
- */
- public function testChoiceOutputFormattingQuestionForUtf8Keys()
- {
- $question = 'Lorem ipsum?';
- $possibleChoices = [
- 'foo' => 'foo',
- 'żółw' => 'bar',
- 'łabądź' => 'baz',
- ];
- $outputShown = [
- $question,
- ' [<info>foo </info>] foo',
- ' [<info>żółw </info>] bar',
- ' [<info>łabądź</info>] baz',
- ];
- $output = $this->getMockBuilder('\Symfony\Component\Console\Output\OutputInterface')->getMock();
- $output->method('getFormatter')->willReturn(new OutputFormatter());
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $output->expects($this->once())->method('writeln')->with($this->equalTo($outputShown));
- $question = new ChoiceQuestion($question, $possibleChoices, 'foo');
- $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream("\n")), $output, $question);
- }
- /**
- * @expectedException \Symfony\Component\Console\Exception\RuntimeException
- * @expectedExceptionMessage Aborted.
- */
- public function testAskThrowsExceptionOnMissingInput()
- {
- $dialog = new QuestionHelper();
- $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream('')), $this->createOutputInterface(), new Question('What\'s your name?'));
- }
- /**
- * @expectedException \Symfony\Component\Console\Exception\RuntimeException
- * @expectedExceptionMessage Aborted.
- */
- public function testAskThrowsExceptionOnMissingInputForChoiceQuestion()
- {
- $dialog = new QuestionHelper();
- $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream('')), $this->createOutputInterface(), new ChoiceQuestion('Choice', ['a', 'b']));
- }
- /**
- * @expectedException \Symfony\Component\Console\Exception\RuntimeException
- * @expectedExceptionMessage Aborted.
- */
- public function testAskThrowsExceptionOnMissingInputWithValidator()
- {
- $dialog = new QuestionHelper();
- $question = new Question('What\'s your name?');
- $question->setValidator(function () {
- if (!$value) {
- throw new \Exception('A value is required.');
- }
- });
- $dialog->ask($this->createStreamableInputInterfaceMock($this->getInputStream('')), $this->createOutputInterface(), $question);
- }
- /**
- * @expectedException \LogicException
- * @expectedExceptionMessage Choice question must have at least 1 choice available.
- */
- public function testEmptyChoices()
- {
- new ChoiceQuestion('Question', [], 'irrelevant');
- }
- public function testTraversableAutocomplete()
- {
- if (!$this->hasSttyAvailable()) {
- $this->markTestSkipped('`stty` is required to test autocomplete functionality');
- }
- // Acm<NEWLINE>
- // Ac<BACKSPACE><BACKSPACE>s<TAB>Test<NEWLINE>
- // <NEWLINE>
- // <UP ARROW><UP ARROW><NEWLINE>
- // <UP ARROW><UP ARROW><UP ARROW><UP ARROW><UP ARROW><TAB>Test<NEWLINE>
- // <DOWN ARROW><NEWLINE>
- // S<BACKSPACE><BACKSPACE><DOWN ARROW><DOWN ARROW><NEWLINE>
- // F00<BACKSPACE><BACKSPACE>oo<TAB><NEWLINE>
- $inputStream = $this->getInputStream("Acm\nAc\177\177s\tTest\n\n\033[A\033[A\n\033[A\033[A\033[A\033[A\033[A\tTest\n\033[B\nS\177\177\033[B\033[B\nF00\177\177oo\t\n");
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new Question('Please select a bundle', 'FrameworkBundle');
- $question->setAutocompleterValues(new AutocompleteValues(['irrelevant' => 'AcmeDemoBundle', 'AsseticBundle', 'SecurityBundle', 'FooBundle']));
- $this->assertEquals('AcmeDemoBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('AsseticBundleTest', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('FrameworkBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('SecurityBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('FooBundleTest', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('AcmeDemoBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('AsseticBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals('FooBundle', $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- public function testTraversableMultiselectAutocomplete()
- {
- // <NEWLINE>
- // F<TAB><NEWLINE>
- // A<3x UP ARROW><TAB>,F<TAB><NEWLINE>
- // F00<BACKSPACE><BACKSPACE>o<TAB>,A<DOWN ARROW>,<SPACE>SecurityBundle<NEWLINE>
- // Acme<TAB>,<SPACE>As<TAB><29x BACKSPACE>S<TAB><NEWLINE>
- // Ac<TAB>,As<TAB><3x BACKSPACE>d<TAB><NEWLINE>
- $inputStream = $this->getInputStream("\nF\t\nA\033[A\033[A\033[A\t,F\t\nF00\177\177o\t,A\033[B\t, SecurityBundle\nSecurityBundle\nAcme\t, As\t\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177\177S\t\nAc\t,As\t\177\177\177d\t\n");
- $dialog = new QuestionHelper();
- $helperSet = new HelperSet([new FormatterHelper()]);
- $dialog->setHelperSet($helperSet);
- $question = new ChoiceQuestion(
- 'Please select a bundle (defaults to AcmeDemoBundle and AsseticBundle)',
- ['AcmeDemoBundle', 'AsseticBundle', 'SecurityBundle', 'FooBundle'],
- '0,1'
- );
- // This tests that autocomplete works for all multiselect choices entered by the user
- $question->setMultiselect(true);
- $this->assertEquals(['AcmeDemoBundle', 'AsseticBundle'], $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals(['FooBundle'], $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals(['AsseticBundle', 'FooBundle'], $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals(['FooBundle', 'AsseticBundle', 'SecurityBundle'], $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals(['SecurityBundle'], $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- $this->assertEquals(['AcmeDemoBundle', 'AsseticBundle'], $dialog->ask($this->createStreamableInputInterfaceMock($inputStream), $this->createOutputInterface(), $question));
- }
- protected function getInputStream($input)
- {
- $stream = fopen('php://memory', 'r+', false);
- fwrite($stream, $input);
- rewind($stream);
- return $stream;
- }
- protected function createOutputInterface()
- {
- return new StreamOutput(fopen('php://memory', 'r+', false));
- }
- protected function createInputInterfaceMock($interactive = true)
- {
- $mock = $this->getMockBuilder('Symfony\Component\Console\Input\InputInterface')->getMock();
- $mock->expects($this->any())
- ->method('isInteractive')
- ->willReturn($interactive);
- return $mock;
- }
- private function hasSttyAvailable()
- {
- exec('stty 2>&1', $output, $exitcode);
- return 0 === $exitcode;
- }
- }
- class AutocompleteValues implements \IteratorAggregate
- {
- private $values;
- public function __construct(array $values)
- {
- $this->values = $values;
- }
- public function getIterator()
- {
- return new \ArrayIterator($this->values);
- }
- }
|