mirror of
https://github.com/kamilwylegala/cakephp2-php8.git
synced 2024-11-15 19:38:26 +00:00
683 lines
No EOL
19 KiB
PHP
683 lines
No EOL
19 KiB
PHP
<?php
|
|
/**
|
|
* ConsoleOptionParserTest file
|
|
*
|
|
* PHP 5
|
|
*
|
|
* CakePHP(tm) Tests <http://book.cakephp.org/view/1196/Testing>
|
|
* Copyright 2005-2010, Cake Software Foundation, Inc.
|
|
*
|
|
* Licensed under The MIT License
|
|
* Redistributions of files must retain the above copyright notice
|
|
*
|
|
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc.
|
|
* @link http://book.cakephp.org/view/1196/Testing CakePHP(tm) Tests
|
|
* @package cake
|
|
* @subpackage cake.tests.cases.console
|
|
* @since CakePHP(tm) v 2.0
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
|
*/
|
|
|
|
require_once CAKE . 'console' . DS . 'console_option_parser.php';
|
|
|
|
class ConsoleOptionParserTest extends CakeTestCase {
|
|
|
|
/**
|
|
* test setting the console description
|
|
*
|
|
* @return void
|
|
*/
|
|
function testDescription() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$result = $parser->description('A test');
|
|
|
|
$this->assertEquals($parser, $result, 'Setting description is not chainable');
|
|
$this->assertEquals('A test', $parser->description(), 'getting value is wrong.');
|
|
|
|
$result = $parser->description(array('A test', 'something'));
|
|
$this->assertEquals("A test\nsomething", $parser->description(), 'getting value is wrong.');
|
|
}
|
|
|
|
/**
|
|
* test setting the console epliog
|
|
*
|
|
* @return void
|
|
*/
|
|
function testEpilog() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$result = $parser->epilog('A test');
|
|
|
|
$this->assertEquals($parser, $result, 'Setting epilog is not chainable');
|
|
$this->assertEquals('A test', $parser->epilog(), 'getting value is wrong.');
|
|
|
|
$result = $parser->epilog(array('A test', 'something'));
|
|
$this->assertEquals("A test\nsomething", $parser->epilog(), 'getting value is wrong.');
|
|
}
|
|
|
|
/**
|
|
* test adding an option returns self.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptionReturnSelf() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$result = $parser->addOption('test');
|
|
$this->assertEquals($parser, $result, 'Did not return $this from addOption');
|
|
}
|
|
|
|
/**
|
|
* test adding an option and using the long value for parsing.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptionLong() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test', array(
|
|
'short' => 't'
|
|
));
|
|
$result = $parser->parse(array('--test', 'value'));
|
|
$this->assertEquals(array('test' => 'value', 'help' => false), $result[0], 'Long parameter did not parse out');
|
|
}
|
|
|
|
/**
|
|
* test adding an option and using the long value for parsing.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptionLongEquals() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test', array(
|
|
'short' => 't'
|
|
));
|
|
$result = $parser->parse(array('--test=value'));
|
|
$this->assertEquals(array('test' => 'value', 'help' => false), $result[0], 'Long parameter did not parse out');
|
|
}
|
|
|
|
/**
|
|
* test adding an option and using the default.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptionDefault() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test', array(
|
|
'default' => 'default value',
|
|
));
|
|
$result = $parser->parse(array('--test'));
|
|
$this->assertEquals(array('test' => 'default value', 'help' => false), $result[0], 'Default value did not parse out');
|
|
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test', array(
|
|
'default' => 'default value',
|
|
));
|
|
$result = $parser->parse(array());
|
|
$this->assertEquals(array('test' => 'default value', 'help' => false), $result[0], 'Default value did not parse out');
|
|
}
|
|
|
|
/**
|
|
* test adding an option and using the short value for parsing.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptionShort() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test', array(
|
|
'short' => 't'
|
|
));
|
|
$result = $parser->parse(array('-t', 'value'));
|
|
$this->assertEquals(array('test' => 'value', 'help' => false), $result[0], 'Short parameter did not parse out');
|
|
}
|
|
|
|
/**
|
|
* test adding and using boolean options.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptionBoolean() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test', array(
|
|
'boolean' => true,
|
|
));
|
|
|
|
$result = $parser->parse(array('--test', 'value'));
|
|
$expected = array(array('test' => true, 'help' => false), array('value'));
|
|
$this->assertEquals($expected, $result);
|
|
|
|
$result = $parser->parse(array('value'));
|
|
$expected = array(array('test' => false, 'help' => false), array('value'));
|
|
$this->assertEquals($expected, $result);
|
|
}
|
|
|
|
/**
|
|
* test adding an multiple shorts.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptionMultipleShort() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test', array('short' => 't'))
|
|
->addOption('file', array('short' => 'f'))
|
|
->addOption('output', array('short' => 'o'));
|
|
|
|
$result = $parser->parse(array('-o', '-t', '-f'));
|
|
$expected = array('file' => true, 'test' => true, 'output' => true, 'help' => false);
|
|
$this->assertEquals($expected, $result[0], 'Short parameter did not parse out');
|
|
|
|
$result = $parser->parse(array('-otf'));
|
|
$this->assertEquals($expected, $result[0], 'Short parameter did not parse out');
|
|
}
|
|
|
|
/**
|
|
* test multiple options at once.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testMultipleOptions() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('test')
|
|
->addOption('connection')
|
|
->addOption('table', array('short' => 't'));
|
|
|
|
$result = $parser->parse(array('--test', 'value', '-t', '--connection', 'postgres'));
|
|
$expected = array('test' => 'value', 'table' => true, 'connection' => 'postgres', 'help' => false);
|
|
$this->assertEquals($expected, $result[0], 'multiple options did not parse');
|
|
}
|
|
|
|
/**
|
|
* Test adding multiple options.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddOptions() {
|
|
$parser = new ConsoleOptionParser('something', false);
|
|
$result = $parser->addOptions(array(
|
|
'name' => array('help' => 'The name'),
|
|
'other' => array('help' => 'The other arg')
|
|
));
|
|
$this->assertEquals($parser, $result, 'addOptions is not chainable.');
|
|
|
|
$result = $parser->options();
|
|
$this->assertEquals(3, count($result), 'Not enough options');
|
|
}
|
|
|
|
/**
|
|
* test that boolean options work
|
|
*
|
|
* @return void
|
|
*/
|
|
function testOptionWithBooleanParam() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('no-commit', array('boolean' => true))
|
|
->addOption('table', array('short' => 't'));
|
|
|
|
$result = $parser->parse(array('--table', 'posts', '--no-commit', 'arg1', 'arg2'));
|
|
$expected = array(array('table' => 'posts', 'no-commit' => true, 'help' => false), array('arg1', 'arg2'));
|
|
$this->assertEquals($expected, $result, 'Boolean option did not parse correctly.');
|
|
}
|
|
|
|
/**
|
|
* test parsing options that do not exist.
|
|
*
|
|
* @expectedException InvalidArgumentException
|
|
*/
|
|
function testOptionThatDoesNotExist() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('no-commit', array('boolean' => true));
|
|
|
|
$result = $parser->parse(array('--fail', 'other'));
|
|
}
|
|
|
|
/**
|
|
* test that options with choices enforce them.
|
|
*
|
|
* @expectedException InvalidArgumentException
|
|
* @return void
|
|
*/
|
|
function testOptionWithChoices() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('name', array('choices' => array('mark', 'jose')));
|
|
|
|
$result = $parser->parse(array('--name', 'mark'));
|
|
$expected = array('name' => 'mark', 'help' => false);
|
|
$this->assertEquals($expected, $result[0], 'Got the correct value.');
|
|
|
|
$result = $parser->parse(array('--name', 'jimmy'));
|
|
}
|
|
|
|
/**
|
|
* test positional argument parsing.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testPositionalArgument() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$result = $parser->addArgument('name', array('help' => 'An argument'));
|
|
$this->assertEquals($parser, $result, 'Should returnn this');
|
|
}
|
|
|
|
/**
|
|
* test overwriting positional arguments.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testPositionalArgOverwrite() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addArgument('name', array('help' => 'An argument'))
|
|
->addArgument('other', array('index' => 0));
|
|
|
|
$result = $parser->arguments();
|
|
$this->assertEquals(1, count($result), 'Overwrite did not occur');
|
|
}
|
|
|
|
/**
|
|
* test parsing arguments.
|
|
*
|
|
* @expectedException InvalidArgumentException
|
|
* @return void
|
|
*/
|
|
function testParseArgumentTooMany() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addArgument('name', array('help' => 'An argument'))
|
|
->addArgument('other');
|
|
|
|
$expected = array('one', 'two');
|
|
$result = $parser->parse($expected);
|
|
$this->assertEquals($expected, $result[1], 'Arguments are not as expected');
|
|
|
|
$result = $parser->parse(array('one', 'two', 'three'));
|
|
}
|
|
|
|
/**
|
|
* test that when there are not enough arguments an exception is raised
|
|
*
|
|
* @expectedException RuntimeException
|
|
* @return void
|
|
*/
|
|
function testPositionalArgNotEnough() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addArgument('name', array('required' => true))
|
|
->addArgument('other', array('required' => true));
|
|
|
|
$parser->parse(array('one'));
|
|
}
|
|
|
|
/**
|
|
* test that arguments with choices enforce them.
|
|
*
|
|
* @expectedException InvalidArgumentException
|
|
* @return void
|
|
*/
|
|
function testPositionalArgWithChoices() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addArgument('name', array('choices' => array('mark', 'jose')))
|
|
->addArgument('alias', array('choices' => array('cowboy', 'samurai')))
|
|
->addArgument('weapon', array('choices' => array('gun', 'sword')));
|
|
|
|
$result = $parser->parse(array('mark', 'samurai', 'sword'));
|
|
$expected = array('mark', 'samurai', 'sword');
|
|
$this->assertEquals($expected, $result[1], 'Got the correct value.');
|
|
|
|
$result = $parser->parse(array('jose', 'coder'));
|
|
}
|
|
|
|
/**
|
|
* Test adding multiple arguments.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddArguments() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$result = $parser->addArguments(array(
|
|
'name' => array('help' => 'The name'),
|
|
'other' => array('help' => 'The other arg')
|
|
));
|
|
$this->assertEquals($parser, $result, 'addArguments is not chainable.');
|
|
|
|
$result = $parser->arguments();
|
|
$this->assertEquals(2, count($result), 'Not enough arguments');
|
|
}
|
|
|
|
/**
|
|
* test setting a subcommand up.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testSubcommand() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$result = $parser->addSubcommand('initdb', array(
|
|
'help' => 'Initialize the database'
|
|
));
|
|
$this->assertEquals($parser, $result, 'Adding a subcommand is not chainable');
|
|
}
|
|
|
|
/**
|
|
* test adding multiple subcommands
|
|
*
|
|
* @return void
|
|
*/
|
|
function testAddSubcommands() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$result = $parser->addSubcommands(array(
|
|
'initdb' => array('help' => 'Initialize the database'),
|
|
'create' => array('help' => 'Create something')
|
|
));
|
|
$this->assertEquals($parser, $result, 'Adding a subcommands is not chainable');
|
|
$result = $parser->subcommands();
|
|
$this->assertEquals(2, count($result), 'Not enough subcommands');
|
|
}
|
|
|
|
/**
|
|
* test getting help with defined options.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testHelpWithOptions() {
|
|
$parser = new ConsoleOptionParser('mycommand', false);
|
|
$parser->addOption('test', array('help' => 'A test option.'))
|
|
->addOption('connection', array(
|
|
'short' => 'c', 'help' => 'The connection to use.', 'default' => 'default'
|
|
));
|
|
|
|
$result = $parser->help();
|
|
$expected = <<<TEXT
|
|
<info>Usage:</info>
|
|
cake mycommand [-h] [--test] [-c default]
|
|
|
|
<info>Options:</info>
|
|
|
|
--help, -h Display this help.
|
|
--test A test option.
|
|
--connection, -c The connection to use. <comment>(default:
|
|
default)</comment>
|
|
|
|
TEXT;
|
|
$this->assertEquals($expected, $result, 'Help does not match');
|
|
}
|
|
|
|
/**
|
|
* test getting help with defined options.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testHelpWithOptionsAndArguments() {
|
|
$parser = new ConsoleOptionParser('mycommand', false);
|
|
$parser->addOption('test', array('help' => 'A test option.'))
|
|
->addArgument('model', array('help' => 'The model to make.', 'required' => true))
|
|
->addArgument('other_longer', array('help' => 'Another argument.'));
|
|
|
|
$result = $parser->help();
|
|
$expected = <<<TEXT
|
|
<info>Usage:</info>
|
|
cake mycommand [-h] [--test] <model> [<other_longer>]
|
|
|
|
<info>Options:</info>
|
|
|
|
--help, -h Display this help.
|
|
--test A test option.
|
|
|
|
<info>Arguments:</info>
|
|
|
|
model The model to make.
|
|
other_longer Another argument. <comment>(optional)</comment>
|
|
|
|
TEXT;
|
|
$this->assertEquals($expected, $result, 'Help does not match');
|
|
}
|
|
|
|
/**
|
|
* test that no exception is triggered when help is being generated
|
|
*
|
|
* @return void
|
|
*/
|
|
function testHelpNoExceptionWhenGettingHelp() {
|
|
$parser = new ConsoleOptionParser('mycommand', false);
|
|
$parser->addOption('test', array('help' => 'A test option.'))
|
|
->addArgument('model', array('help' => 'The model to make.', 'required' => true));
|
|
|
|
$result = $parser->parse(array('--help'));
|
|
$this->assertTrue($result[0]['help']);
|
|
}
|
|
|
|
/**
|
|
* test help() with options and arguments that have choices.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testHelpWithChoices() {
|
|
$parser = new ConsoleOptionParser('mycommand', false);
|
|
$parser->addOption('test', array('help' => 'A test option.', 'choices' => array('one', 'two')))
|
|
->addArgument('type', array(
|
|
'help' => 'Resource type.',
|
|
'choices' => array('aco', 'aro'),
|
|
'required' => true
|
|
))
|
|
->addArgument('other_longer', array('help' => 'Another argument.'));
|
|
|
|
$result = $parser->help();
|
|
$expected = <<<TEXT
|
|
<info>Usage:</info>
|
|
cake mycommand [-h] [--test one|two] <aco|aro> [<other_longer>]
|
|
|
|
<info>Options:</info>
|
|
|
|
--help, -h Display this help.
|
|
--test A test option. <comment>(choices: one|two)</comment>
|
|
|
|
<info>Arguments:</info>
|
|
|
|
type Resource type. <comment>(choices: aco|aro)</comment>
|
|
other_longer Another argument. <comment>(optional)</comment>
|
|
|
|
TEXT;
|
|
$this->assertEquals($expected, $result, 'Help does not match');
|
|
}
|
|
|
|
/**
|
|
* test description and epilog in the help
|
|
*
|
|
* @return void
|
|
*/
|
|
function testHelpDescriptionAndEpilog() {
|
|
$parser = new ConsoleOptionParser('mycommand', false);
|
|
$parser->description('Description text')
|
|
->epilog('epilog text')
|
|
->addOption('test', array('help' => 'A test option.'))
|
|
->addArgument('model', array('help' => 'The model to make.', 'required' => true));
|
|
|
|
$result = $parser->help();
|
|
$expected = <<<TEXT
|
|
Description text
|
|
|
|
<info>Usage:</info>
|
|
cake mycommand [-h] [--test] <model>
|
|
|
|
<info>Options:</info>
|
|
|
|
--help, -h Display this help.
|
|
--test A test option.
|
|
|
|
<info>Arguments:</info>
|
|
|
|
model The model to make.
|
|
|
|
epilog text
|
|
TEXT;
|
|
$this->assertEquals($expected, $result, 'Help is wrong.');
|
|
}
|
|
|
|
/**
|
|
* test that help() outputs subcommands.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testHelpSubcommand() {
|
|
$parser = new ConsoleOptionParser('mycommand', false);
|
|
$parser->addSubcommand('method', array('help' => 'This is another command'))
|
|
->addOption('test', array('help' => 'A test option.'));
|
|
|
|
$result = $parser->help();
|
|
$expected = <<<TEXT
|
|
<info>Usage:</info>
|
|
cake mycommand [subcommand] [-h] [--test]
|
|
|
|
<info>Subcommands:</info>
|
|
|
|
method This is another command
|
|
|
|
To see help on a subcommand use <info>`cake mycommand [subcommand] --help`</info>
|
|
|
|
<info>Options:</info>
|
|
|
|
--help, -h Display this help.
|
|
--test A test option.
|
|
|
|
TEXT;
|
|
$this->assertEquals($expected, $result, 'Help is not correct.');
|
|
}
|
|
|
|
/**
|
|
* test that help() with a command param shows the help for a subcommand
|
|
*
|
|
* @return void
|
|
*/
|
|
function testHelpSubcommandHelp() {
|
|
$subParser = new ConsoleOptionParser('method', false);
|
|
$subParser->addOption('connection', array('help' => 'Db connection.'));
|
|
|
|
$parser = new ConsoleOptionParser('mycommand', false);
|
|
$parser->addSubcommand('method', array(
|
|
'help' => 'This is another command',
|
|
'parser' => $subParser
|
|
))
|
|
->addOption('test', array('help' => 'A test option.'));
|
|
|
|
$result = $parser->help('method');
|
|
$expected = <<<TEXT
|
|
<info>Usage:</info>
|
|
cake mycommand method [-h] [--connection]
|
|
|
|
<info>Options:</info>
|
|
|
|
--help, -h Display this help.
|
|
--connection Db connection.
|
|
|
|
TEXT;
|
|
$this->assertEquals($expected, $result, 'Help is not correct.');
|
|
}
|
|
|
|
/**
|
|
* test building a parser from an array.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testBuildFromArray() {
|
|
$spec = array(
|
|
'command' => 'test',
|
|
'arguments' => array(
|
|
'name' => array('help' => 'The name'),
|
|
'other' => array('help' => 'The other arg')
|
|
),
|
|
'options' => array(
|
|
'name' => array('help' => 'The name'),
|
|
'other' => array('help' => 'The other arg')
|
|
),
|
|
'subcommands' => array(
|
|
'initdb' => array('help' => 'make database')
|
|
),
|
|
'description' => 'description text',
|
|
'epilog' => 'epilog text'
|
|
);
|
|
$parser = ConsoleOptionParser::buildFromArray($spec);
|
|
|
|
$this->assertEquals($spec['description'], $parser->description());
|
|
$this->assertEquals($spec['epilog'], $parser->epilog());
|
|
|
|
$options = $parser->options();
|
|
$this->assertTrue(isset($options['name']));
|
|
$this->assertTrue(isset($options['other']));
|
|
|
|
$args = $parser->arguments();
|
|
$this->assertEquals(2, count($args));
|
|
|
|
$commands = $parser->subcommands();
|
|
$this->assertEquals(1, count($commands));
|
|
}
|
|
|
|
/**
|
|
* test that parse() takes a subcommand argument, and that the subcommand parser
|
|
* is used.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testParsingWithSubParser() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->addOption('primary')
|
|
->addArgument('one', array('required' => true, 'choices' => array('a', 'b')))
|
|
->addArgument('two', array('required' => true))
|
|
->addSubcommand('sub', array(
|
|
'parser' => array(
|
|
'options' => array(
|
|
'secondary' => array('boolean' => true),
|
|
'fourth' => array('help' => 'fourth option')
|
|
),
|
|
'arguments' => array(
|
|
'sub_arg' => array('choices' => array('c', 'd'))
|
|
)
|
|
)
|
|
));
|
|
|
|
$result = $parser->parse(array('--secondary', '--fourth', '4', 'c'), 'sub');
|
|
$expected = array(array(
|
|
'secondary' => true,
|
|
'fourth' => '4',
|
|
'help' => false,
|
|
'verbose' => false,
|
|
'quiet' => false), array('c'));
|
|
$this->assertEquals($expected, $result, 'Sub parser did not parse request.');
|
|
}
|
|
|
|
/**
|
|
* test that the console max width is respected when generating help.
|
|
*
|
|
* @return void
|
|
*/
|
|
function testWidthFormatting() {
|
|
$parser = new ConsoleOptionParser('test', false);
|
|
$parser->description(__('This is 10 This is 10'))
|
|
->addOption('four', array('help' => 'more text'))
|
|
->addArgument('four', array('help' => 'more text'))
|
|
->addSubcommand('four', array('help' => 'more text'));
|
|
$result = $parser->help(null, 10);
|
|
$expected = <<<TEXT
|
|
This is 10
|
|
This is 10
|
|
|
|
<info>Usage:</info>
|
|
cake test [subcommand] [-h] [--four] [<four>]
|
|
|
|
<info>Subcommands:</info>
|
|
|
|
four more
|
|
text
|
|
|
|
To see help on a subcommand use <info>`cake test [subcommand] --help`</info>
|
|
|
|
<info>Options:</info>
|
|
|
|
--help, -h
|
|
Display
|
|
this help.
|
|
--four
|
|
more text
|
|
|
|
<info>Arguments:</info>
|
|
|
|
four more
|
|
text
|
|
<comment>(optional)</comment>
|
|
|
|
TEXT;
|
|
$this->assertEquals($expected, $result, 'Generated help is too wide');
|
|
}
|
|
|
|
} |