Overview

Namespaces

  • Evenement
  • None
  • Peridot
    • Console
    • Core
    • Reporter
    • Runner
    • Scope
    • Test
  • Symfony
    • Component
      • Console
        • Command
        • Descriptor
        • Event
        • Exception
        • Formatter
        • Helper
        • Input
        • Logger
        • Output
        • Question
        • Style
        • Tester
        • Tests
          • Command
          • Descriptor
          • Fixtures
          • Formatter
          • Helper
          • Input
          • Logger
          • Output
          • Style
          • Tester

Classes

  • BarBucCommand
  • Evenement\EventEmitter
  • Foo1Command
  • Foo2Command
  • Foo3Command
  • Foo4Command
  • Foo5Command
  • Foo6Command
  • FoobarCommand
  • FooCommand
  • FooSubnamespaced1Command
  • FooSubnamespaced2Command
  • Peridot\Configuration
  • Peridot\Console\Application
  • Peridot\Console\CliOptionParser
  • Peridot\Console\Command
  • Peridot\Console\ConfigurationReader
  • Peridot\Console\Environment
  • Peridot\Console\InputDefinition
  • Peridot\Console\Version
  • Peridot\Core\AbstractTest
  • Peridot\Core\Scope
  • Peridot\Core\Suite
  • Peridot\Core\Test
  • Peridot\Core\TestResult
  • Peridot\Reporter\AbstractBaseReporter
  • Peridot\Reporter\AnonymousReporter
  • Peridot\Reporter\CompositeReporter
  • Peridot\Reporter\ReporterFactory
  • Peridot\Reporter\SpecReporter
  • Peridot\Runner\Context
  • Peridot\Runner\Runner
  • Peridot\Runner\SuiteLoader
  • Peridot\Scope\Scope
  • Peridot\Test\ItWasRun
  • Symfony\Component\Console\Application
  • Symfony\Component\Console\Command\Command
  • Symfony\Component\Console\Command\HelpCommand
  • Symfony\Component\Console\Command\ListCommand
  • Symfony\Component\Console\ConsoleEvents
  • Symfony\Component\Console\Event\ConsoleCommandEvent
  • Symfony\Component\Console\Event\ConsoleEvent
  • Symfony\Component\Console\Event\ConsoleExceptionEvent
  • Symfony\Component\Console\Event\ConsoleTerminateEvent
  • Symfony\Component\Console\Formatter\OutputFormatter
  • Symfony\Component\Console\Formatter\OutputFormatterStyle
  • Symfony\Component\Console\Formatter\OutputFormatterStyleStack
  • Symfony\Component\Console\Helper\DebugFormatterHelper
  • Symfony\Component\Console\Helper\DescriptorHelper
  • Symfony\Component\Console\Helper\DialogHelper
  • Symfony\Component\Console\Helper\FormatterHelper
  • Symfony\Component\Console\Helper\Helper
  • Symfony\Component\Console\Helper\HelperSet
  • Symfony\Component\Console\Helper\InputAwareHelper
  • Symfony\Component\Console\Helper\ProcessHelper
  • Symfony\Component\Console\Helper\ProgressBar
  • Symfony\Component\Console\Helper\ProgressHelper
  • Symfony\Component\Console\Helper\ProgressIndicator
  • Symfony\Component\Console\Helper\QuestionHelper
  • Symfony\Component\Console\Helper\SymfonyQuestionHelper
  • Symfony\Component\Console\Helper\Table
  • Symfony\Component\Console\Helper\TableCell
  • Symfony\Component\Console\Helper\TableHelper
  • Symfony\Component\Console\Helper\TableSeparator
  • Symfony\Component\Console\Helper\TableStyle
  • Symfony\Component\Console\Input\ArgvInput
  • Symfony\Component\Console\Input\ArrayInput
  • Symfony\Component\Console\Input\Input
  • Symfony\Component\Console\Input\InputArgument
  • Symfony\Component\Console\Input\InputDefinition
  • Symfony\Component\Console\Input\InputOption
  • Symfony\Component\Console\Input\StringInput
  • Symfony\Component\Console\Logger\ConsoleLogger
  • Symfony\Component\Console\Output\BufferedOutput
  • Symfony\Component\Console\Output\ConsoleOutput
  • Symfony\Component\Console\Output\NullOutput
  • Symfony\Component\Console\Output\Output
  • Symfony\Component\Console\Output\StreamOutput
  • Symfony\Component\Console\Question\ChoiceQuestion
  • Symfony\Component\Console\Question\ConfirmationQuestion
  • Symfony\Component\Console\Question\Question
  • Symfony\Component\Console\Shell
  • Symfony\Component\Console\Style\OutputStyle
  • Symfony\Component\Console\Style\SymfonyStyle
  • Symfony\Component\Console\Tester\ApplicationTester
  • Symfony\Component\Console\Tester\CommandTester
  • Symfony\Component\Console\Tests\ApplicationTest
  • Symfony\Component\Console\Tests\Command\CommandTest
  • Symfony\Component\Console\Tests\Command\HelpCommandTest
  • Symfony\Component\Console\Tests\Command\ListCommandTest
  • Symfony\Component\Console\Tests\CustomApplication
  • Symfony\Component\Console\Tests\CustomDefaultCommandApplication
  • Symfony\Component\Console\Tests\Descriptor\AbstractDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\JsonDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\MarkdownDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\ObjectsProvider
  • Symfony\Component\Console\Tests\Descriptor\TextDescriptorTest
  • Symfony\Component\Console\Tests\Descriptor\XmlDescriptorTest
  • Symfony\Component\Console\Tests\Fixtures\DescriptorApplication1
  • Symfony\Component\Console\Tests\Fixtures\DescriptorApplication2
  • Symfony\Component\Console\Tests\Fixtures\DescriptorCommand1
  • Symfony\Component\Console\Tests\Fixtures\DescriptorCommand2
  • Symfony\Component\Console\Tests\Fixtures\DummyOutput
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterStyleStackTest
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterStyleTest
  • Symfony\Component\Console\Tests\Formatter\OutputFormatterTest
  • Symfony\Component\Console\Tests\Formatter\TableCell
  • Symfony\Component\Console\Tests\Helper\FormatterHelperTest
  • Symfony\Component\Console\Tests\Helper\HelperSetTest
  • Symfony\Component\Console\Tests\Helper\HelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyDialogHelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyProgressHelperTest
  • Symfony\Component\Console\Tests\Helper\LegacyTableHelperTest
  • Symfony\Component\Console\Tests\Helper\ProcessHelperTest
  • Symfony\Component\Console\Tests\Helper\ProgressBarTest
  • Symfony\Component\Console\Tests\Helper\ProgressIndicatorTest
  • Symfony\Component\Console\Tests\Helper\QuestionHelperTest
  • Symfony\Component\Console\Tests\Helper\SymfonyQuestionHelperTest
  • Symfony\Component\Console\Tests\Helper\TableStyleTest
  • Symfony\Component\Console\Tests\Helper\TableTest
  • Symfony\Component\Console\Tests\Input\ArgvInputTest
  • Symfony\Component\Console\Tests\Input\ArrayInputTest
  • Symfony\Component\Console\Tests\Input\InputArgumentTest
  • Symfony\Component\Console\Tests\Input\InputDefinitionTest
  • Symfony\Component\Console\Tests\Input\InputOptionTest
  • Symfony\Component\Console\Tests\Input\InputTest
  • Symfony\Component\Console\Tests\Input\StringInputTest
  • Symfony\Component\Console\Tests\Logger\ConsoleLoggerTest
  • Symfony\Component\Console\Tests\Output\ConsoleOutputTest
  • Symfony\Component\Console\Tests\Output\NullOutputTest
  • Symfony\Component\Console\Tests\Output\OutputTest
  • Symfony\Component\Console\Tests\Output\StreamOutputTest
  • Symfony\Component\Console\Tests\Output\TestOutput
  • Symfony\Component\Console\Tests\Style\SymfonyStyleTest
  • Symfony\Component\Console\Tests\Style\SymfonyStyleWithForcedLineLength
  • Symfony\Component\Console\Tests\Tester\ApplicationTesterTest
  • Symfony\Component\Console\Tests\Tester\CommandTesterTest
  • TestCommand

Interfaces

  • Evenement\EventEmitterInterface
  • Peridot\Core\TestInterface
  • Peridot\Reporter\ReporterInterface
  • Peridot\Runner\RunnerInterface
  • Peridot\Runner\SuiteLoaderInterface
  • Symfony\Component\Console\Descriptor\DescriptorInterface
  • Symfony\Component\Console\Exception\ExceptionInterface
  • Symfony\Component\Console\Formatter\OutputFormatterInterface
  • Symfony\Component\Console\Formatter\OutputFormatterStyleInterface
  • Symfony\Component\Console\Helper\HelperInterface
  • Symfony\Component\Console\Input\InputAwareInterface
  • Symfony\Component\Console\Input\InputInterface
  • Symfony\Component\Console\Output\ConsoleOutputInterface
  • Symfony\Component\Console\Output\OutputInterface
  • Symfony\Component\Console\Style\StyleInterface

Traits

  • Evenement\EventEmitterTrait
  • Peridot\Core\HasEventEmitterTrait
  • Peridot\Scope\ScopeTrait

Exceptions

  • Peridot\AssertException
  • Symfony\Component\Console\Exception\CommandNotFoundException
  • Symfony\Component\Console\Exception\InvalidArgumentException
  • Symfony\Component\Console\Exception\InvalidOptionException
  • Symfony\Component\Console\Exception\LogicException
  • Symfony\Component\Console\Exception\RuntimeException

Functions

  • afterEach
  • beforeEach
  • context
  • describe
  • fcontext
  • fdescribe
  • fit
  • it
  • Symfony\Component\Console\Tests\Command\createClosure
  • xcontext
  • xdescribe
  • xit
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 
<?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\Input\ArrayInput;
use Symfony\Component\Console\Helper\DialogHelper;
use Symfony\Component\Console\Helper\HelperSet;
use Symfony\Component\Console\Helper\FormatterHelper;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\StreamOutput;
use Symfony\Component\Console\Exception\InvalidArgumentException;

/**
 * @group legacy
 */
class LegacyDialogHelperTest extends \PHPUnit_Framework_TestCase
{
    public function testSelect()
    {
        $dialog = new DialogHelper();

        $helperSet = new HelperSet(array(new FormatterHelper()));
        $dialog->setHelperSet($helperSet);

        $heroes = array('Superman', 'Batman', 'Spiderman');

        $dialog->setInputStream($this->getInputStream("\n1\n  1  \nFabien\n1\nFabien\n1\n0,2\n 0 , 2  \n\n\n"));
        $this->assertEquals('2', $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes, '2'));
        $this->assertEquals('1', $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes));
        $this->assertEquals('1', $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes));
        $this->assertEquals('1', $dialog->select($output = $this->getOutputStream(), 'What is your favorite superhero?', $heroes, null, false, 'Input "%s" is not a superhero!', false));

        rewind($output->getStream());
        $this->assertContains('Input "Fabien" is not a superhero!', stream_get_contents($output->getStream()));

        try {
            $this->assertEquals('1', $dialog->select($output = $this->getOutputStream(), 'What is your favorite superhero?', $heroes, null, 1));
            $this->fail();
        } catch (\InvalidArgumentException $e) {
            $this->assertEquals('Value "Fabien" is invalid', $e->getMessage());
        }

        $this->assertEquals(array('1'), $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes, null, false, 'Input "%s" is not a superhero!', true));
        $this->assertEquals(array('0', '2'), $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes, null, false, 'Input "%s" is not a superhero!', true));
        $this->assertEquals(array('0', '2'), $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes, null, false, 'Input "%s" is not a superhero!', true));
        $this->assertEquals(array('0', '1'), $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes, '0,1', false, 'Input "%s" is not a superhero!', true));
        $this->assertEquals(array('0', '1'), $dialog->select($this->getOutputStream(), 'What is your favorite superhero?', $heroes, ' 0 , 1 ', false, 'Input "%s" is not a superhero!', true));
    }

    public function testSelectOnErrorOutput()
    {
        $dialog = new DialogHelper();

        $helperSet = new HelperSet(array(new FormatterHelper()));
        $dialog->setHelperSet($helperSet);

        $heroes = array('Superman', 'Batman', 'Spiderman');

        $dialog->setInputStream($this->getInputStream("Stdout\n1\n"));
        $this->assertEquals('1', $dialog->select($output = $this->getConsoleOutput($this->getOutputStream()), 'What is your favorite superhero?', $heroes, null, false, 'Input "%s" is not a superhero!', false));

        rewind($output->getErrorOutput()->getStream());
        $this->assertContains('Input "Stdout" is not a superhero!', stream_get_contents($output->getErrorOutput()->getStream()));
    }

    public function testAsk()
    {
        $dialog = new DialogHelper();

        $dialog->setInputStream($this->getInputStream("\n8AM\n"));

        $this->assertEquals('2PM', $dialog->ask($this->getOutputStream(), 'What time is it?', '2PM'));
        $this->assertEquals('8AM', $dialog->ask($output = $this->getOutputStream(), 'What time is it?', '2PM'));

        rewind($output->getStream());
        $this->assertEquals('What time is it?', stream_get_contents($output->getStream()));
    }

    public function testAskOnErrorOutput()
    {
        if (!$this->hasSttyAvailable()) {
            $this->markTestSkipped('`stderr` is required to test stderr output functionality');
        }

        $dialog = new DialogHelper();

        $dialog->setInputStream($this->getInputStream("not stdout\n"));

        $this->assertEquals('not stdout', $dialog->ask($output = $this->getConsoleOutput($this->getOutputStream()), 'Where should output go?', 'stderr'));

        rewind($output->getErrorOutput()->getStream());
        $this->assertEquals('Where should output go?', stream_get_contents($output->getErrorOutput()->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 DialogHelper();
        $dialog->setInputStream($inputStream);

        $bundles = array('AcmeDemoBundle', 'AsseticBundle', 'SecurityBundle', 'FooBundle');

        $this->assertEquals('AcmeDemoBundle', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
        $this->assertEquals('AsseticBundleTest', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
        $this->assertEquals('FrameworkBundle', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
        $this->assertEquals('SecurityBundle', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
        $this->assertEquals('FooBundleTest', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
        $this->assertEquals('AcmeDemoBundle', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
        $this->assertEquals('AsseticBundle', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
        $this->assertEquals('FooBundle', $dialog->ask($this->getOutputStream(), 'Please select a bundle', 'FrameworkBundle', $bundles));
    }

    /**
     * @group tty
     */
    public function testAskHiddenResponse()
    {
        if ('\\' === DIRECTORY_SEPARATOR) {
            $this->markTestSkipped('This test is not supported on Windows');
        }

        $dialog = new DialogHelper();

        $dialog->setInputStream($this->getInputStream("8AM\n"));

        $this->assertEquals('8AM', $dialog->askHiddenResponse($this->getOutputStream(), 'What time is it?'));
    }

    /**
     * @group tty
     */
    public function testAskHiddenResponseOnErrorOutput()
    {
        if ('\\' === DIRECTORY_SEPARATOR) {
            $this->markTestSkipped('This test is not supported on Windows');
        }

        $dialog = new DialogHelper();

        $dialog->setInputStream($this->getInputStream("8AM\n"));

        $this->assertEquals('8AM', $dialog->askHiddenResponse($output = $this->getConsoleOutput($this->getOutputStream()), 'What time is it?'));

        rewind($output->getErrorOutput()->getStream());
        $this->assertContains('What time is it?', stream_get_contents($output->getErrorOutput()->getStream()));
    }

    public function testAskConfirmation()
    {
        $dialog = new DialogHelper();

        $dialog->setInputStream($this->getInputStream("\n\n"));
        $this->assertTrue($dialog->askConfirmation($this->getOutputStream(), 'Do you like French fries?'));
        $this->assertFalse($dialog->askConfirmation($this->getOutputStream(), 'Do you like French fries?', false));

        $dialog->setInputStream($this->getInputStream("y\nyes\n"));
        $this->assertTrue($dialog->askConfirmation($this->getOutputStream(), 'Do you like French fries?', false));
        $this->assertTrue($dialog->askConfirmation($this->getOutputStream(), 'Do you like French fries?', false));

        $dialog->setInputStream($this->getInputStream("n\nno\n"));
        $this->assertFalse($dialog->askConfirmation($this->getOutputStream(), 'Do you like French fries?', true));
        $this->assertFalse($dialog->askConfirmation($this->getOutputStream(), 'Do you like French fries?', true));
    }

    public function testAskAndValidate()
    {
        $dialog = new DialogHelper();
        $helperSet = new HelperSet(array(new FormatterHelper()));
        $dialog->setHelperSet($helperSet);

        $question = 'What color was the white horse of Henry IV?';
        $error = 'This is not a color!';
        $validator = function ($color) use ($error) {
            if (!in_array($color, array('white', 'black'))) {
                throw new InvalidArgumentException($error);
            }

            return $color;
        };

        $dialog->setInputStream($this->getInputStream("\nblack\n"));
        $this->assertEquals('white', $dialog->askAndValidate($this->getOutputStream(), $question, $validator, 2, 'white'));
        $this->assertEquals('black', $dialog->askAndValidate($this->getOutputStream(), $question, $validator, 2, 'white'));

        $dialog->setInputStream($this->getInputStream("green\nyellow\norange\n"));
        try {
            $this->assertEquals('white', $dialog->askAndValidate($output = $this->getConsoleOutput($this->getOutputStream()), $question, $validator, 2, 'white'));
            $this->fail();
        } catch (\InvalidArgumentException $e) {
            $this->assertEquals($error, $e->getMessage());
            rewind($output->getErrorOutput()->getStream());
            $this->assertContains('What color was the white horse of Henry IV?', stream_get_contents($output->getErrorOutput()->getStream()));
        }
    }

    public function testNoInteraction()
    {
        $dialog = new DialogHelper();

        $input = new ArrayInput(array());
        $input->setInteractive(false);

        $dialog->setInput($input);

        $this->assertEquals('not yet', $dialog->ask($this->getOutputStream(), 'Do you have a job?', 'not yet'));
    }

    protected function getInputStream($input)
    {
        $stream = fopen('php://memory', 'r+', false);
        fwrite($stream, $input);
        rewind($stream);

        return $stream;
    }

    protected function getOutputStream()
    {
        return new StreamOutput(fopen('php://memory', 'r+', false));
    }

    protected function getConsoleOutput($stderr)
    {
        $output = new ConsoleOutput();
        $output->setErrorOutput($stderr);

        return $output;
    }

    private function hasSttyAvailable()
    {
        exec('stty 2>&1', $output, $exitcode);

        return $exitcode === 0;
    }
}
Peridot API documentation generated by ApiGen