123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435 |
- <?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\Command;
- use PHPUnit\Framework\TestCase;
- use Symfony\Component\Console\Command\Command;
- use Symfony\Component\Console\Helper\FormatterHelper;
- use Symfony\Component\Console\Application;
- use Symfony\Component\Console\Input\InputDefinition;
- use Symfony\Component\Console\Input\InputArgument;
- use Symfony\Component\Console\Input\InputOption;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Input\StringInput;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\Console\Output\NullOutput;
- use Symfony\Component\Console\Tester\CommandTester;
- class CommandTest extends TestCase
- {
- protected static $fixturesPath;
- public static function setUpBeforeClass()
- {
- self::$fixturesPath = __DIR__.'/../Fixtures/';
- require_once self::$fixturesPath.'/TestCommand.php';
- }
- public function testConstructor()
- {
- $command = new Command('foo:bar');
- $this->assertEquals('foo:bar', $command->getName(), '__construct() takes the command name as its first argument');
- }
- /**
- * @expectedException \LogicException
- * @expectedExceptionMessage The command defined in "Symfony\Component\Console\Command\Command" cannot have an empty name.
- */
- public function testCommandNameCannotBeEmpty()
- {
- new Command();
- }
- public function testSetApplication()
- {
- $application = new Application();
- $command = new \TestCommand();
- $command->setApplication($application);
- $this->assertEquals($application, $command->getApplication(), '->setApplication() sets the current application');
- $this->assertEquals($application->getHelperSet(), $command->getHelperSet());
- }
- public function testSetApplicationNull()
- {
- $command = new \TestCommand();
- $command->setApplication(null);
- $this->assertNull($command->getHelperSet());
- }
- public function testSetGetDefinition()
- {
- $command = new \TestCommand();
- $ret = $command->setDefinition($definition = new InputDefinition());
- $this->assertEquals($command, $ret, '->setDefinition() implements a fluent interface');
- $this->assertEquals($definition, $command->getDefinition(), '->setDefinition() sets the current InputDefinition instance');
- $command->setDefinition(array(new InputArgument('foo'), new InputOption('bar')));
- $this->assertTrue($command->getDefinition()->hasArgument('foo'), '->setDefinition() also takes an array of InputArguments and InputOptions as an argument');
- $this->assertTrue($command->getDefinition()->hasOption('bar'), '->setDefinition() also takes an array of InputArguments and InputOptions as an argument');
- $command->setDefinition(new InputDefinition());
- }
- public function testAddArgument()
- {
- $command = new \TestCommand();
- $ret = $command->addArgument('foo');
- $this->assertEquals($command, $ret, '->addArgument() implements a fluent interface');
- $this->assertTrue($command->getDefinition()->hasArgument('foo'), '->addArgument() adds an argument to the command');
- }
- public function testAddOption()
- {
- $command = new \TestCommand();
- $ret = $command->addOption('foo');
- $this->assertEquals($command, $ret, '->addOption() implements a fluent interface');
- $this->assertTrue($command->getDefinition()->hasOption('foo'), '->addOption() adds an option to the command');
- }
- public function testSetHidden()
- {
- $command = new \TestCommand();
- $command->setHidden(true);
- $this->assertTrue($command->isHidden());
- }
- public function testGetNamespaceGetNameSetName()
- {
- $command = new \TestCommand();
- $this->assertEquals('namespace:name', $command->getName(), '->getName() returns the command name');
- $command->setName('foo');
- $this->assertEquals('foo', $command->getName(), '->setName() sets the command name');
- $ret = $command->setName('foobar:bar');
- $this->assertEquals($command, $ret, '->setName() implements a fluent interface');
- $this->assertEquals('foobar:bar', $command->getName(), '->setName() sets the command name');
- }
- /**
- * @dataProvider provideInvalidCommandNames
- */
- public function testInvalidCommandNames($name)
- {
- if (method_exists($this, 'expectException')) {
- $this->expectException('InvalidArgumentException');
- $this->expectExceptionMessage(sprintf('Command name "%s" is invalid.', $name));
- } else {
- $this->setExpectedException('InvalidArgumentException', sprintf('Command name "%s" is invalid.', $name));
- }
- $command = new \TestCommand();
- $command->setName($name);
- }
- public function provideInvalidCommandNames()
- {
- return array(
- array(''),
- array('foo:'),
- );
- }
- public function testGetSetDescription()
- {
- $command = new \TestCommand();
- $this->assertEquals('description', $command->getDescription(), '->getDescription() returns the description');
- $ret = $command->setDescription('description1');
- $this->assertEquals($command, $ret, '->setDescription() implements a fluent interface');
- $this->assertEquals('description1', $command->getDescription(), '->setDescription() sets the description');
- }
- public function testGetSetHelp()
- {
- $command = new \TestCommand();
- $this->assertEquals('help', $command->getHelp(), '->getHelp() returns the help');
- $ret = $command->setHelp('help1');
- $this->assertEquals($command, $ret, '->setHelp() implements a fluent interface');
- $this->assertEquals('help1', $command->getHelp(), '->setHelp() sets the help');
- $command->setHelp('');
- $this->assertEquals('', $command->getHelp(), '->getHelp() does not fall back to the description');
- }
- public function testGetProcessedHelp()
- {
- $command = new \TestCommand();
- $command->setHelp('The %command.name% command does... Example: php %command.full_name%.');
- $this->assertContains('The namespace:name command does...', $command->getProcessedHelp(), '->getProcessedHelp() replaces %command.name% correctly');
- $this->assertNotContains('%command.full_name%', $command->getProcessedHelp(), '->getProcessedHelp() replaces %command.full_name%');
- $command = new \TestCommand();
- $command->setHelp('');
- $this->assertContains('description', $command->getProcessedHelp(), '->getProcessedHelp() falls back to the description');
- }
- public function testGetSetAliases()
- {
- $command = new \TestCommand();
- $this->assertEquals(array('name'), $command->getAliases(), '->getAliases() returns the aliases');
- $ret = $command->setAliases(array('name1'));
- $this->assertEquals($command, $ret, '->setAliases() implements a fluent interface');
- $this->assertEquals(array('name1'), $command->getAliases(), '->setAliases() sets the aliases');
- }
- public function testSetAliasesNull()
- {
- $command = new \TestCommand();
- $this->{method_exists($this, $_ = 'expectException') ? $_ : 'setExpectedException'}('InvalidArgumentException');
- $command->setAliases(null);
- }
- public function testGetSynopsis()
- {
- $command = new \TestCommand();
- $command->addOption('foo');
- $command->addArgument('bar');
- $this->assertEquals('namespace:name [--foo] [--] [<bar>]', $command->getSynopsis(), '->getSynopsis() returns the synopsis');
- }
- public function testAddGetUsages()
- {
- $command = new \TestCommand();
- $command->addUsage('foo1');
- $command->addUsage('foo2');
- $this->assertContains('namespace:name foo1', $command->getUsages());
- $this->assertContains('namespace:name foo2', $command->getUsages());
- }
- public function testGetHelper()
- {
- $application = new Application();
- $command = new \TestCommand();
- $command->setApplication($application);
- $formatterHelper = new FormatterHelper();
- $this->assertEquals($formatterHelper->getName(), $command->getHelper('formatter')->getName(), '->getHelper() returns the correct helper');
- }
- /**
- * @expectedException \LogicException
- * @expectedExceptionMessage Cannot retrieve helper "formatter" because there is no HelperSet defined.
- */
- public function testGetHelperWithoutHelperSet()
- {
- $command = new \TestCommand();
- $command->getHelper('formatter');
- }
- public function testMergeApplicationDefinition()
- {
- $application1 = new Application();
- $application1->getDefinition()->addArguments(array(new InputArgument('foo')));
- $application1->getDefinition()->addOptions(array(new InputOption('bar')));
- $command = new \TestCommand();
- $command->setApplication($application1);
- $command->setDefinition($definition = new InputDefinition(array(new InputArgument('bar'), new InputOption('foo'))));
- $r = new \ReflectionObject($command);
- $m = $r->getMethod('mergeApplicationDefinition');
- $m->setAccessible(true);
- $m->invoke($command);
- $this->assertTrue($command->getDefinition()->hasArgument('foo'), '->mergeApplicationDefinition() merges the application arguments and the command arguments');
- $this->assertTrue($command->getDefinition()->hasArgument('bar'), '->mergeApplicationDefinition() merges the application arguments and the command arguments');
- $this->assertTrue($command->getDefinition()->hasOption('foo'), '->mergeApplicationDefinition() merges the application options and the command options');
- $this->assertTrue($command->getDefinition()->hasOption('bar'), '->mergeApplicationDefinition() merges the application options and the command options');
- $m->invoke($command);
- $this->assertEquals(3, $command->getDefinition()->getArgumentCount(), '->mergeApplicationDefinition() does not try to merge twice the application arguments and options');
- }
- public function testMergeApplicationDefinitionWithoutArgsThenWithArgsAddsArgs()
- {
- $application1 = new Application();
- $application1->getDefinition()->addArguments(array(new InputArgument('foo')));
- $application1->getDefinition()->addOptions(array(new InputOption('bar')));
- $command = new \TestCommand();
- $command->setApplication($application1);
- $command->setDefinition($definition = new InputDefinition(array()));
- $r = new \ReflectionObject($command);
- $m = $r->getMethod('mergeApplicationDefinition');
- $m->setAccessible(true);
- $m->invoke($command, false);
- $this->assertTrue($command->getDefinition()->hasOption('bar'), '->mergeApplicationDefinition(false) merges the application and the command options');
- $this->assertFalse($command->getDefinition()->hasArgument('foo'), '->mergeApplicationDefinition(false) does not merge the application arguments');
- $m->invoke($command, true);
- $this->assertTrue($command->getDefinition()->hasArgument('foo'), '->mergeApplicationDefinition(true) merges the application arguments and the command arguments');
- $m->invoke($command);
- $this->assertEquals(2, $command->getDefinition()->getArgumentCount(), '->mergeApplicationDefinition() does not try to merge twice the application arguments');
- }
- public function testRunInteractive()
- {
- $tester = new CommandTester(new \TestCommand());
- $tester->execute(array(), array('interactive' => true));
- $this->assertEquals('interact called'.PHP_EOL.'execute called'.PHP_EOL, $tester->getDisplay(), '->run() calls the interact() method if the input is interactive');
- }
- public function testRunNonInteractive()
- {
- $tester = new CommandTester(new \TestCommand());
- $tester->execute(array(), array('interactive' => false));
- $this->assertEquals('execute called'.PHP_EOL, $tester->getDisplay(), '->run() does not call the interact() method if the input is not interactive');
- }
- /**
- * @expectedException \LogicException
- * @expectedExceptionMessage You must override the execute() method in the concrete command class.
- */
- public function testExecuteMethodNeedsToBeOverridden()
- {
- $command = new Command('foo');
- $command->run(new StringInput(''), new NullOutput());
- }
- /**
- * @expectedException \Symfony\Component\Console\Exception\InvalidOptionException
- * @expectedExceptionMessage The "--bar" option does not exist.
- */
- public function testRunWithInvalidOption()
- {
- $command = new \TestCommand();
- $tester = new CommandTester($command);
- $tester->execute(array('--bar' => true));
- }
- public function testRunReturnsIntegerExitCode()
- {
- $command = new \TestCommand();
- $exitCode = $command->run(new StringInput(''), new NullOutput());
- $this->assertSame(0, $exitCode, '->run() returns integer exit code (treats null as 0)');
- $command = $this->getMockBuilder('TestCommand')->setMethods(array('execute'))->getMock();
- $command->expects($this->once())
- ->method('execute')
- ->will($this->returnValue('2.3'));
- $exitCode = $command->run(new StringInput(''), new NullOutput());
- $this->assertSame(2, $exitCode, '->run() returns integer exit code (casts numeric to int)');
- }
- public function testRunWithApplication()
- {
- $command = new \TestCommand();
- $command->setApplication(new Application());
- $exitCode = $command->run(new StringInput(''), new NullOutput());
- $this->assertSame(0, $exitCode, '->run() returns an integer exit code');
- }
- public function testRunReturnsAlwaysInteger()
- {
- $command = new \TestCommand();
- $this->assertSame(0, $command->run(new StringInput(''), new NullOutput()));
- }
- public function testRunWithProcessTitle()
- {
- $command = new \TestCommand();
- $command->setApplication(new Application());
- $command->setProcessTitle('foo');
- $this->assertSame(0, $command->run(new StringInput(''), new NullOutput()));
- if (function_exists('cli_set_process_title')) {
- if (null === @cli_get_process_title() && 'Darwin' === PHP_OS) {
- $this->markTestSkipped('Running "cli_get_process_title" as an unprivileged user is not supported on MacOS.');
- }
- $this->assertEquals('foo', cli_get_process_title());
- }
- }
- public function testSetCode()
- {
- $command = new \TestCommand();
- $ret = $command->setCode(function (InputInterface $input, OutputInterface $output) {
- $output->writeln('from the code...');
- });
- $this->assertEquals($command, $ret, '->setCode() implements a fluent interface');
- $tester = new CommandTester($command);
- $tester->execute(array());
- $this->assertEquals('interact called'.PHP_EOL.'from the code...'.PHP_EOL, $tester->getDisplay());
- }
- public function getSetCodeBindToClosureTests()
- {
- return array(
- array(true, 'not bound to the command'),
- array(false, 'bound to the command'),
- );
- }
- /**
- * @dataProvider getSetCodeBindToClosureTests
- */
- public function testSetCodeBindToClosure($previouslyBound, $expected)
- {
- $code = createClosure();
- if ($previouslyBound) {
- $code = $code->bindTo($this);
- }
- $command = new \TestCommand();
- $command->setCode($code);
- $tester = new CommandTester($command);
- $tester->execute(array());
- $this->assertEquals('interact called'.PHP_EOL.$expected.PHP_EOL, $tester->getDisplay());
- }
- public function testSetCodeWithStaticClosure()
- {
- $command = new \TestCommand();
- $command->setCode(self::createClosure());
- $tester = new CommandTester($command);
- $tester->execute(array());
- if (\PHP_VERSION_ID < 70000) {
- // Cannot bind static closures in PHP 5
- $this->assertEquals('interact called'.PHP_EOL.'not bound'.PHP_EOL, $tester->getDisplay());
- } else {
- // Can bind static closures in PHP 7
- $this->assertEquals('interact called'.PHP_EOL.'bound'.PHP_EOL, $tester->getDisplay());
- }
- }
- private static function createClosure()
- {
- return function (InputInterface $input, OutputInterface $output) {
- $output->writeln(isset($this) ? 'bound' : 'not bound');
- };
- }
- public function testSetCodeWithNonClosureCallable()
- {
- $command = new \TestCommand();
- $ret = $command->setCode(array($this, 'callableMethodCommand'));
- $this->assertEquals($command, $ret, '->setCode() implements a fluent interface');
- $tester = new CommandTester($command);
- $tester->execute(array());
- $this->assertEquals('interact called'.PHP_EOL.'from the code...'.PHP_EOL, $tester->getDisplay());
- }
- public function callableMethodCommand(InputInterface $input, OutputInterface $output)
- {
- $output->writeln('from the code...');
- }
- }
- // In order to get an unbound closure, we should create it outside a class
- // scope.
- function createClosure()
- {
- return function (InputInterface $input, OutputInterface $output) {
- $output->writeln($this instanceof Command ? 'bound to the command' : 'not bound to the command');
- };
- }
|