class CommandTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 vendor/symfony/console/Tests/Command/CommandTest.php \Symfony\Component\Console\Tests\Command\CommandTest
Hierarchy
- class \Symfony\Component\Console\Tests\Command\CommandTest extends \Symfony\Component\Console\Tests\Command\PHPUnit_Framework_TestCase
Expanded class hierarchy of CommandTest
File
- vendor/
symfony/ console/ Tests/ Command/ CommandTest.php, line 26
Namespace
Symfony\Component\Console\Tests\CommandView source
class CommandTest extends \PHPUnit_Framework_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');
}
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 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) {
$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('description', $command
->getHelp(), '->getHelp() fallback 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%');
}
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 testGetSynopsis() {
$command = new \TestCommand();
$command
->addOption('foo');
$command
->addArgument('bar');
$this
->assertEquals('namespace:name [--foo] [--] [<bar>]', $command
->getSynopsis(), '->getSynopsis() returns the synopsis');
}
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');
}
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 \InvalidArgumentException
* @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
->getMock('TestCommand', array(
'execute',
));
$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 testRunReturnsAlwaysInteger() {
$command = new \TestCommand();
$this
->assertSame(0, $command
->run(new StringInput(''), new NullOutput()));
}
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 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());
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Invalid callable provided to Command::setCode.
*/
public function testSetCodeWithNonCallable() {
$command = new \TestCommand();
$command
->setCode(array(
$this,
'nonExistentMethod',
));
}
public function callableMethodCommand(InputInterface $input, OutputInterface $output) {
$output
->writeln('from the code...');
}
/**
* @group legacy
*/
public function testLegacyAsText() {
$command = new \TestCommand();
$command
->setApplication(new Application());
$tester = new CommandTester($command);
$tester
->execute(array(
'command' => $command
->getName(),
));
$this
->assertStringEqualsFile(self::$fixturesPath . '/command_astext.txt', $command
->asText(), '->asText() returns a text representation of the command');
}
/**
* @group legacy
*/
public function testLegacyAsXml() {
$command = new \TestCommand();
$command
->setApplication(new Application());
$tester = new CommandTester($command);
$tester
->execute(array(
'command' => $command
->getName(),
));
$this
->assertXmlStringEqualsXmlFile(self::$fixturesPath . '/command_asxml.txt', $command
->asXml(), '->asXml() returns an XML representation of the command');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CommandTest:: |
protected static | property | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public static | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | @expectedException \LogicException @expectedExceptionMessage The command defined in "Symfony\Component\Console\Command\Command" cannot have an empty name. | |
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | @expectedException \LogicException @expectedExceptionMessage You must override the execute() method in the concrete command class. | |
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | @dataProvider provideInvalidCommandNames | |
CommandTest:: |
public | function | @group legacy | |
CommandTest:: |
public | function | @group legacy | |
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | @expectedException \InvalidArgumentException @expectedExceptionMessage The "--bar" option does not exist. | |
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | ||
CommandTest:: |
public | function | @expectedException \InvalidArgumentException @expectedExceptionMessage Invalid callable provided to Command::setCode. | |
CommandTest:: |
public | function | ||
CommandTest:: |
public | function |