/
githubmirror
/
symfony
Обзор
Документация
Войти
/
githubmirror
/
symfony
Код
Запросы
0
Пакеты
0
Релизы
0
Аналитика
Безопасность
8.2
src/Symfony/Component/Console/Tests/Input/ArgvInputTest.php
862 строки
37 KB
Théo FIDRY
[Console] Expose the original input arguments and options and to unparse options
17 мар 2026, 19:55
17 мар 2026, 19:55
6475fab
Код
Авторство
О чём код?
<?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\Input; use PHPUnit\Framework\Attributes\DataProvider; use PHPUnit\Framework\TestCase; use Symfony\Component\Console\Input\ArgvInput; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputDefinition; use Symfony\Component\Console\Input\InputOption; class ArgvInputTest extends TestCase { public function testConstructor() { $_SERVER['argv'] = ['cli.php', 'foo']; $input = new ArgvInput(); $r = new \ReflectionObject($input); $p = $r->getProperty('tokens'); $this->assertSame(['foo'], $p->getValue($input), '__construct() automatically get its input from the argv server variable'); } public function testParseArguments() { $input = new ArgvInput(['cli.php', 'foo']); $input->bind(new InputDefinition([new InputArgument('name')])); $this->assertSame(['name' => 'foo'], $input->getArguments(), '->parse() parses required arguments'); $input->bind(new InputDefinition([new InputArgument('name')])); $this->assertSame(['name' => 'foo'], $input->getArguments(), '->parse() is stateless'); } #[DataProvider('provideOptions')] public function testParseOptions($input, $options, $expectedOptions, $message) { $input = new ArgvInput($input); $input->bind(new InputDefinition($options)); $this->assertSame($expectedOptions, $input->getOptions(), $message); } #[DataProvider('provideNegatableOptions')] public function testParseOptionsNegatable($input, $options, $expectedOptions, $message) { $input = new ArgvInput($input); $input->bind(new InputDefinition($options)); $this->assertSame($expectedOptions, $input->getOptions(), $message); } public static function provideOptions() { return [ [ ['cli.php', '--foo'], [new InputOption('foo')], ['foo' => true], '->parse() parses long options without a value', ], [ ['cli.php', '--foo=bar'], [new InputOption('foo', 'f', InputOption::VALUE_REQUIRED)], ['foo' => 'bar'], '->parse() parses long options with a required value (with a = separator)', ], [ ['cli.php', '--foo', 'bar'], [new InputOption('foo', 'f', InputOption::VALUE_REQUIRED)], ['foo' => 'bar'], '->parse() parses long options with a required value (with a space separator)', ], [ ['cli.php', '--foo='], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL)], ['foo' => ''], '->parse() parses long options with optional value which is empty (with a = separator) as empty string', ], [ ['cli.php', '--foo=', 'bar'], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('name', InputArgument::REQUIRED)], ['foo' => ''], '->parse() parses long options with optional value without value specified or an empty string (with a = separator) followed by an argument as empty string', ], [ ['cli.php', 'bar', '--foo'], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('name', InputArgument::REQUIRED)], ['foo' => null], '->parse() parses long options with optional value which is empty (with a = separator) preceded by an argument', ], [ ['cli.php', '--foo', '', 'bar'], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('name', InputArgument::REQUIRED)], ['foo' => ''], '->parse() parses long options with optional value which is empty as empty string even followed by an argument', ], [ ['cli.php', '--foo'], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL)], ['foo' => null], '->parse() parses long options with optional value specified with no separator and no value as null', ], [ ['cli.php', '-f'], [new InputOption('foo', 'f')], ['foo' => true], '->parse() parses short options without a value', ], [ ['cli.php', '-fbar'], [new InputOption('foo', 'f', InputOption::VALUE_REQUIRED)], ['foo' => 'bar'], '->parse() parses short options with a required value (with no separator)', ], [ ['cli.php', '-f', 'bar'], [new InputOption('foo', 'f', InputOption::VALUE_REQUIRED)], ['foo' => 'bar'], '->parse() parses short options with a required value (with a space separator)', ], [ ['cli.php', '-f', ''], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL)], ['foo' => ''], '->parse() parses short options with an optional empty value', ], [ ['cli.php', '-f', '', 'foo'], [new InputArgument('name'), new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL)], ['foo' => ''], '->parse() parses short options with an optional empty value followed by an argument', ], [ ['cli.php', '-f', '', '-b'], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputOption('bar', 'b')], ['foo' => '', 'bar' => true], '->parse() parses short options with an optional empty value followed by an option', ], [ ['cli.php', '-f', '-b', 'foo'], [new InputArgument('name'), new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputOption('bar', 'b')], ['foo' => null, 'bar' => true], '->parse() parses short options with an optional value which is not present', ], [ ['cli.php', '-fb'], [new InputOption('foo', 'f'), new InputOption('bar', 'b')], ['foo' => true, 'bar' => true], '->parse() parses short options when they are aggregated as a single one', ], [ ['cli.php', '-fb', 'bar'], [new InputOption('foo', 'f'), new InputOption('bar', 'b', InputOption::VALUE_REQUIRED)], ['foo' => true, 'bar' => 'bar'], '->parse() parses short options when they are aggregated as a single one and the last one has a required value', ], [ ['cli.php', '-fb', 'bar'], [new InputOption('foo', 'f'), new InputOption('bar', 'b', InputOption::VALUE_OPTIONAL)], ['foo' => true, 'bar' => 'bar'], '->parse() parses short options when they are aggregated as a single one and the last one has an optional value', ], [ ['cli.php', '-fbbar'], [new InputOption('foo', 'f'), new InputOption('bar', 'b', InputOption::VALUE_OPTIONAL)], ['foo' => true, 'bar' => 'bar'], '->parse() parses short options when they are aggregated as a single one and the last one has an optional value with no separator', ], [ ['cli.php', '-fbbar'], [new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputOption('bar', 'b', InputOption::VALUE_OPTIONAL)], ['foo' => 'bbar', 'bar' => null], '->parse() parses short options when they are aggregated as a single one and one of them takes a value', ], ]; } public static function provideNegatableOptions() { return [ [ ['cli.php', '--foo'], [new InputOption('foo', null, InputOption::VALUE_NEGATABLE)], ['foo' => true], '->parse() parses long options without a value', ], [ ['cli.php', '--foo'], [new InputOption('foo', null, InputOption::VALUE_NONE | InputOption::VALUE_NEGATABLE)], ['foo' => true], '->parse() parses long options without a value', ], [ ['cli.php', '--no-foo'], [new InputOption('foo', null, InputOption::VALUE_NEGATABLE)], ['foo' => false], '->parse() parses long options without a value', ], [ ['cli.php', '--no-foo'], [new InputOption('foo', null, InputOption::VALUE_NONE | InputOption::VALUE_NEGATABLE)], ['foo' => false], '->parse() parses long options without a value', ], [ ['cli.php'], [new InputOption('foo', null, InputOption::VALUE_NEGATABLE)], ['foo' => null], '->parse() parses long options without a value', ], [ ['cli.php'], [new InputOption('foo', null, InputOption::VALUE_NONE | InputOption::VALUE_NEGATABLE)], ['foo' => null], '->parse() parses long options without a value', ], [ ['cli.php'], [new InputOption('foo', null, InputOption::VALUE_NEGATABLE, '', false)], ['foo' => false], '->parse() parses long options without a value', ], [ ['cli.php'], [new InputOption('foo', null, InputOption::VALUE_NONE | InputOption::VALUE_NEGATABLE, '', false)], ['foo' => false], '->parse() parses long options without a value', ], ]; } #[DataProvider('provideInvalidInput')] public function testInvalidInput($argv, $definition, $expectedExceptionMessage) { $this->expectException(\RuntimeException::class); $this->expectExceptionMessage($expectedExceptionMessage); (new ArgvInput($argv))->bind($definition); } #[DataProvider('provideInvalidNegatableInput')] public function testInvalidInputNegatable($argv, $definition, $expectedExceptionMessage) { $this->expectException(\RuntimeException::class); $this->expectExceptionMessage($expectedExceptionMessage); (new ArgvInput($argv))->bind($definition); } public static function provideInvalidInput(): array { return [ [ ['cli.php', '--foo'], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_REQUIRED)]), 'The "--foo" option requires a value.', ], [ ['cli.php', '-f'], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_REQUIRED)]), 'The "--foo" option requires a value.', ], [ ['cli.php', '-ffoo'], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NONE)]), 'The "-o" option does not exist.', ], [ ['cli.php', '--foo=bar'], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NONE)]), 'The "--foo" option does not accept a value.', ], [ ['cli.php', 'foo', 'bar'], new InputDefinition(), 'No arguments expected, got "foo".', ], [ ['cli.php', 'foo', 'bar'], new InputDefinition([new InputArgument('number')]), 'Too many arguments, expected arguments "number".', ], [ ['cli.php', 'foo', 'bar', 'zzz'], new InputDefinition([new InputArgument('number'), new InputArgument('county')]), 'Too many arguments, expected arguments "number" "county".', ], [ ['cli.php', '--foo'], new InputDefinition(), 'The "--foo" option does not exist.', ], [ ['cli.php', '-f'], new InputDefinition(), 'The "-f" option does not exist.', ], [ ['cli.php', '-1'], new InputDefinition([new InputArgument('number')]), 'The "-1" option does not exist.', ], [ ['cli.php', '-fЩ'], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NONE)]), 'The "-Щ" option does not exist.', ], [ ['cli.php', 'acme:foo', 'bar'], new InputDefinition([new InputArgument('command', InputArgument::REQUIRED)]), 'No arguments expected for "acme:foo" command, got "bar"', ], [ ['cli.php', 'acme:foo', 'bar'], new InputDefinition([new InputArgument('name', InputArgument::REQUIRED)]), 'Too many arguments, expected arguments "name".', ], [ ['cli.php', ['array']], new InputDefinition(), 'Argument values expected to be all scalars, got "array".', ], ]; } public static function provideInvalidNegatableInput(): array { return [ [ ['cli.php', '--no-foo=bar'], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NEGATABLE)]), 'The "--no-foo" option does not accept a value.', ], [ ['cli.php', '--no-foo='], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NEGATABLE)]), 'The "--no-foo" option does not accept a value.', ], [ ['cli.php', '--no-foo=bar'], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NONE | InputOption::VALUE_NEGATABLE)]), 'The "--no-foo" option does not accept a value.', ], [ ['cli.php', '--no-foo='], new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_NONE | InputOption::VALUE_NEGATABLE)]), 'The "--no-foo" option does not accept a value.', ], ]; } public function testParseArrayArgument() { $input = new ArgvInput(['cli.php', 'foo', 'bar', 'baz', 'bat']); $input->bind(new InputDefinition([new InputArgument('name', InputArgument::IS_ARRAY)])); $this->assertSame(['name' => ['foo', 'bar', 'baz', 'bat']], $input->getArguments(), '->parse() parses array arguments'); } public function testParseArrayOption() { $input = new ArgvInput(['cli.php', '--name=foo', '--name=bar', '--name=baz']); $input->bind(new InputDefinition([new InputOption('name', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY)])); $this->assertSame(['name' => ['foo', 'bar', 'baz']], $input->getOptions(), '->parse() parses array options ("--option=value" syntax)'); $input = new ArgvInput(['cli.php', '--name', 'foo', '--name', 'bar', '--name', 'baz']); $input->bind(new InputDefinition([new InputOption('name', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY)])); $this->assertSame(['name' => ['foo', 'bar', 'baz']], $input->getOptions(), '->parse() parses array options ("--option value" syntax)'); $input = new ArgvInput(['cli.php', '--name=foo', '--name=bar', '--name=']); $input->bind(new InputDefinition([new InputOption('name', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY)])); $this->assertSame(['name' => ['foo', 'bar', '']], $input->getOptions(), '->parse() parses empty array options as null ("--option=value" syntax)'); $input = new ArgvInput(['cli.php', '--name', 'foo', '--name', 'bar', '--name', '--anotherOption']); $input->bind(new InputDefinition([ new InputOption('name', null, InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY), new InputOption('anotherOption', null, InputOption::VALUE_NONE), ])); $this->assertSame(['name' => ['foo', 'bar', null], 'anotherOption' => true], $input->getOptions(), '->parse() parses empty array options ("--option value" syntax)'); } public function testParseNegativeNumberAfterDoubleDash() { $input = new ArgvInput(['cli.php', '--', '-1']); $input->bind(new InputDefinition([new InputArgument('number')])); $this->assertSame(['number' => '-1'], $input->getArguments(), '->parse() parses arguments with leading dashes as arguments after having encountered a double-dash sequence'); $input = new ArgvInput(['cli.php', '-f', 'bar', '--', '-1']); $input->bind(new InputDefinition([new InputArgument('number'), new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL)])); $this->assertSame(['foo' => 'bar'], $input->getOptions(), '->parse() parses arguments with leading dashes as options before having encountered a double-dash sequence'); $this->assertSame(['number' => '-1'], $input->getArguments(), '->parse() parses arguments with leading dashes as arguments after having encountered a double-dash sequence'); } public function testParseEmptyStringArgument() { $input = new ArgvInput(['cli.php', '-f', 'bar', '']); $input->bind(new InputDefinition([new InputArgument('empty'), new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL)])); $this->assertSame(['empty' => ''], $input->getArguments(), '->parse() parses empty string arguments'); } public function testGetFirstArgument() { $input = new ArgvInput(['cli.php', '-fbbar']); $this->assertNull($input->getFirstArgument(), '->getFirstArgument() returns null when there is no arguments'); $input = new ArgvInput(['cli.php', '-fbbar', 'foo']); $this->assertSame('foo', $input->getFirstArgument(), '->getFirstArgument() returns the first argument from the raw input'); $input = new ArgvInput(['cli.php', '--foo', 'fooval', 'bar']); $input->bind(new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('arg')])); $this->assertSame('bar', $input->getFirstArgument()); $input = new ArgvInput(['cli.php', '-bf', 'fooval', 'argval']); $input->bind(new InputDefinition([new InputOption('bar', 'b', InputOption::VALUE_NONE), new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('arg')])); $this->assertSame('argval', $input->getFirstArgument()); } public function testHasParameterOption() { $input = new ArgvInput(['cli.php', '-f', 'foo']); $this->assertTrue($input->hasParameterOption('-f'), '->hasParameterOption() returns true if the given short option is in the raw input'); $input = new ArgvInput(['cli.php', '-etest']); $this->assertTrue($input->hasParameterOption('-e'), '->hasParameterOption() returns true if the given short option is in the raw input'); $this->assertFalse($input->hasParameterOption('-s'), '->hasParameterOption() returns true if the given short option is in the raw input'); $input = new ArgvInput(['cli.php', '--foo', 'foo']); $this->assertTrue($input->hasParameterOption('--foo'), '->hasParameterOption() returns true if the given short option is in the raw input'); $input = new ArgvInput(['cli.php', 'foo']); $this->assertFalse($input->hasParameterOption('--foo'), '->hasParameterOption() returns false if the given short option is not in the raw input'); $input = new ArgvInput(['cli.php', '--foo=bar']); $this->assertTrue($input->hasParameterOption('--foo'), '->hasParameterOption() returns true if the given option with provided value is in the raw input'); } public function testHasParameterOptionOnlyOptions() { $input = new ArgvInput(['cli.php', '-f', 'foo']); $this->assertTrue($input->hasParameterOption('-f', true), '->hasParameterOption() returns true if the given short option is in the raw input'); $input = new ArgvInput(['cli.php', '--foo', '--', 'foo']); $this->assertTrue($input->hasParameterOption('--foo', true), '->hasParameterOption() returns true if the given long option is in the raw input'); $input = new ArgvInput(['cli.php', '--foo=bar', 'foo']); $this->assertTrue($input->hasParameterOption('--foo', true), '->hasParameterOption() returns true if the given long option with provided value is in the raw input'); $input = new ArgvInput(['cli.php', '--', '--foo']); $this->assertFalse($input->hasParameterOption('--foo', true), '->hasParameterOption() returns false if the given option is in the raw input but after an end of options signal'); } public function testHasParameterOptionEdgeCasesAndLimitations() { $input = new ArgvInput(['cli.php', '-fh']); // hasParameterOption does not know if the previous short option, -f, // takes a value or not. If -f takes a value, then -fh does NOT include // -h; Otherwise it does. Since we do not know which short options take // values, hasParameterOption does not support this use-case. $this->assertFalse($input->hasParameterOption('-h'), '->hasParameterOption() returns true if the given short option is in the raw input'); // hasParameterOption does detect that `-fh` contains `-f`, since // `-f` is the first short option in the set. $this->assertTrue($input->hasParameterOption('-f'), '->hasParameterOption() returns true if the given short option is in the raw input'); // The test below happens to pass, although it might make more sense // to disallow it, and require the use of // $input->hasParameterOption('-f') && $input->hasParameterOption('-h') // instead. $this->assertTrue($input->hasParameterOption('-fh'), '->hasParameterOption() returns true if the given short option is in the raw input'); // In theory, if -fh is supported, then -hf should also work. // However, this is not supported. $this->assertFalse($input->hasParameterOption('-hf'), '->hasParameterOption() returns true if the given short option is in the raw input'); $input = new ArgvInput(['cli.php', '-f', '-h']); // If hasParameterOption('-fh') is supported for 'cli.php -fh', then // one might also expect that it should also be supported for // 'cli.php -f -h'. However, this is not supported. $this->assertFalse($input->hasParameterOption('-fh'), '->hasParameterOption() returns true if the given short option is in the raw input'); } public function testNoWarningOnInvalidParameterOption() { $input = new ArgvInput(['cli.php', '-edev']); $this->assertTrue($input->hasParameterOption(['-e', ''])); // No warning thrown $this->assertFalse($input->hasParameterOption(['-m', ''])); $this->assertSame('dev', $input->getParameterOption(['-e', ''])); // No warning thrown $this->assertFalse($input->getParameterOption(['-m', ''])); } public function testToString() { $input = new ArgvInput(['cli.php', '-f', 'foo']); $this->assertSame('-f foo', (string) $input); $input = new ArgvInput(['cli.php', '-f', '--bar=foo', 'a b c d', "A\nB'C"]); $this->assertSame('-f --bar=foo '.escapeshellarg('a b c d').' '.escapeshellarg("A\nB'C"), (string) $input); } #[DataProvider('provideGetParameterOptionValues')] public function testGetParameterOptionEqualSign($argv, $key, $default, $onlyParams, $expected) { $input = new ArgvInput($argv); $this->assertSame($expected, $input->getParameterOption($key, $default, $onlyParams), '->getParameterOption() returns the expected value'); } public static function provideGetParameterOptionValues() { return [ [['app/console', 'foo:bar'], '-e', 'default', false, 'default'], [['app/console', 'foo:bar', '-e', 'dev'], '-e', 'default', false, 'dev'], [['app/console', 'foo:bar', '--env=dev'], '--env', 'default', false, 'dev'], [['app/console', 'foo:bar', '-e', 'dev'], ['-e', '--env'], 'default', false, 'dev'], [['app/console', 'foo:bar', '--env=dev'], ['-e', '--env'], 'default', false, 'dev'], [['app/console', 'foo:bar', '--env=dev', '--en=1'], ['--en'], 'default', false, '1'], [['app/console', 'foo:bar', '--env=dev', '', '--en=1'], ['--en'], 'default', false, '1'], [['app/console', 'foo:bar', '--env', 'val'], '--env', 'default', false, 'val'], [['app/console', 'foo:bar', '--env', 'val', '--dummy'], '--env', 'default', false, 'val'], [['app/console', 'foo:bar', '--', '--env=dev'], '--env', 'default', false, 'dev'], [['app/console', 'foo:bar', '--', '--env=dev'], '--env', 'default', true, 'default'], ]; } public function testParseSingleDashAsArgument() { $input = new ArgvInput(['cli.php', '-']); $input->bind(new InputDefinition([new InputArgument('file')])); $this->assertSame(['file' => '-'], $input->getArguments(), '->parse() parses single dash as an argument'); } public function testParseOptionWithValueOptionalGivenEmptyAndRequiredArgument() { $input = new ArgvInput(['cli.php', '--foo=', 'bar']); $input->bind(new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('name', InputArgument::REQUIRED)])); $this->assertSame(['foo' => ''], $input->getOptions(), '->parse() parses optional options with empty value as null'); $this->assertSame(['name' => 'bar'], $input->getArguments(), '->parse() parses required arguments'); $input = new ArgvInput(['cli.php', '--foo=0', 'bar']); $input->bind(new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('name', InputArgument::REQUIRED)])); $this->assertSame(['foo' => '0'], $input->getOptions(), '->parse() parses optional options with empty value as null'); $this->assertSame(['name' => 'bar'], $input->getArguments(), '->parse() parses required arguments'); } public function testParseOptionWithValueOptionalGivenEmptyAndOptionalArgument() { $input = new ArgvInput(['cli.php', '--foo=', 'bar']); $input->bind(new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('name', InputArgument::OPTIONAL)])); $this->assertSame(['foo' => ''], $input->getOptions(), '->parse() parses optional options with empty value as null'); $this->assertSame(['name' => 'bar'], $input->getArguments(), '->parse() parses optional arguments'); $input = new ArgvInput(['cli.php', '--foo=0', 'bar']); $input->bind(new InputDefinition([new InputOption('foo', 'f', InputOption::VALUE_OPTIONAL), new InputArgument('name', InputArgument::OPTIONAL)])); $this->assertSame(['foo' => '0'], $input->getOptions(), '->parse() parses optional options with empty value as null'); $this->assertSame(['name' => 'bar'], $input->getArguments(), '->parse() parses optional arguments'); } public function testGetRawTokensFalse() { $input = new ArgvInput(['cli.php', '--foo', 'bar']); $this->assertSame(['--foo', 'bar'], $input->getRawTokens()); } #[DataProvider('provideGetRawTokensTrueTests')] public function testGetRawTokensTrue(array $argv, array $expected) { $input = new ArgvInput($argv); $this->assertSame($expected, $input->getRawTokens(true)); } public static function provideGetRawTokensTrueTests(): iterable { yield [['app/console', 'foo:bar'], []]; yield [['app/console', 'foo:bar', '--env=prod'], ['--env=prod']]; yield [['app/console', 'foo:bar', '--env', 'prod'], ['--env', 'prod']]; yield [['app/console', '--no-ansi', 'foo:bar', '--env', 'prod'], ['--env', 'prod']]; yield [['app/console', '--no-ansi', 'foo:bar', '--env', 'prod'], ['--env', 'prod']]; yield [['app/console', '--no-ansi', 'foo:bar', 'argument'], ['argument']]; yield [['app/console', '--no-ansi', 'foo:bar', 'foo:bar'], ['foo:bar']]; yield [['app/console', '--no-ansi', 'foo:bar', '--', 'argument'], ['--', 'argument']]; } #[DataProvider('unparseProvider')] public function testUnparse(?InputDefinition $inputDefinition, ArgvInput $input, ?array $parsedOptions, array $expected) { if (null !== $inputDefinition) { $input->bind($inputDefinition); } $actual = null === $parsedOptions ? $input->unparse() : $input->unparse($parsedOptions); self::assertSame($expected, $actual); } public static function unparseProvider(): iterable { yield 'empty input and empty definition' => [ new InputDefinition(), new ArgvInput([]), null, [], ]; yield 'empty input and definition with default values: ignore default values' => [ new InputDefinition([ new InputArgument( 'argWithDefaultValue', InputArgument::OPTIONAL, 'Argument with a default value', 'arg1DefaultValue', ), new InputOption( 'optWithDefaultValue', null, InputOption::VALUE_REQUIRED, 'Option with a default value', 'opt1DefaultValue', ), ]), new ArgvInput([]), null, [], ]; $completeInputDefinition = new InputDefinition([ new InputArgument( 'requiredArgWithoutDefaultValue', InputArgument::REQUIRED, 'Argument without a default value', ), new InputArgument( 'optionalArgWithDefaultValue', InputArgument::OPTIONAL, 'Argument with a default value', 'argDefaultValue', ), new InputOption( 'optWithoutDefaultValue', null, InputOption::VALUE_REQUIRED, 'Option without a default value', ), new InputOption( 'optWithDefaultValue', null, InputOption::VALUE_REQUIRED, 'Option with a default value', 'optDefaultValue', ), ]); yield 'arguments & options: returns all passed options but ignore default values' => [ $completeInputDefinition, new ArgvInput(['argValue', '--optWithoutDefaultValue=optValue']), null, ['--optWithoutDefaultValue=optValue'], ]; yield 'arguments & options; explicitly pass the default values: the default values are returned' => [ $completeInputDefinition, new ArgvInput(['argValue', 'argDefaultValue', '--optWithoutDefaultValue=optValue', '--optWithDefaultValue=optDefaultValue']), null, [ '--optWithoutDefaultValue=optValue', '--optWithDefaultValue=optDefaultValue', ], ]; yield 'arguments & options; no input definition: nothing returned' => [ null, new ArgvInput(['argValue', 'argDefaultValue', '--optWithoutDefaultValue=optValue', '--optWithDefaultValue=optDefaultValue']), null, [], ]; yield 'arguments & options; parsing an argument name instead of an option name: that option is ignored' => [ $completeInputDefinition, new ArgvInput(['argValue']), ['requiredArgWithoutDefaultValue'], [], ]; yield 'arguments & options; non passed option: it is ignored' => [ $completeInputDefinition, new ArgvInput(['argValue']), ['optWithDefaultValue'], [], ]; yield 'arguments & options; requesting a specific option' => [ $completeInputDefinition, new ArgvInput([ '--optWithoutDefaultValue=optValue1', '--optWithDefaultValue=optValue2', ]), ['optWithDefaultValue'], ['--optWithDefaultValue=optValue2'], ]; yield 'arguments & options; requesting no options' => [ $completeInputDefinition, new ArgvInput([ '--optWithoutDefaultValue=optValue1', '--optWithDefaultValue=optValue2', ]), [], [], ]; $createSingleOptionScenario = static fn ( InputOption $option, array $input, array $expected, ) => [ new InputDefinition([$option]), new ArgvInput(['appName', ...$input]), null, $expected, ]; yield 'option without value' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_NONE, ), ['--opt'], ['--opt'], ); yield 'option without value by shortcut' => $createSingleOptionScenario( new InputOption( 'opt', 'o', InputOption::VALUE_NONE, ), ['-o'], ['--opt'], ); yield 'option with value required' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_REQUIRED, ), ['--opt=foo'], ['--opt=foo'], ); yield 'option with non string value (bool)' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_REQUIRED, ), ['--opt=1'], ['--opt=1'], ); yield 'option with non string value (int)' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_REQUIRED, ), ['--opt=20'], ['--opt=20'], ); yield 'option with non string value (float)' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_REQUIRED, ), ['--opt=5.3'], ['--opt=5.3'], ); yield 'option with non string value (array of strings)' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, ), ['--opt=v1', '--opt=v2', '--opt=v3 --opt=v4'], ['--opt=v1', '--opt=v2', '--opt=v3 --opt=v4'], ); yield 'negatable option (positive)' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_NEGATABLE, ), ['--opt'], ['--opt'], ); yield 'negatable option (negative)' => $createSingleOptionScenario( new InputOption( 'opt', null, InputOption::VALUE_NEGATABLE, ), ['--no-opt'], ['--no-opt'], ); $createEscapeOptionTokenScenario = static fn ( string $optionValue, ?string $expected, ) => [ new InputDefinition([ new InputOption( 'opt', null, InputOption::VALUE_REQUIRED, ), ]), new ArgvInput(['appName', '--opt='.$optionValue]), null, ['--opt='.$expected], ]; yield 'escape token; string token' => $createEscapeOptionTokenScenario( 'foo', 'foo', ); yield 'escape token; escaped string token' => $createEscapeOptionTokenScenario( '"foo"', '"foo"', ); yield 'escape token; escaped string token with both types of quotes' => $createEscapeOptionTokenScenario( '"o_id in(\'20\')"', '"o_id in(\'20\')"', ); yield 'escape token; string token with spaces' => $createEscapeOptionTokenScenario( 'a b c d', 'a b c d', ); yield 'escape token; string token with line return' => $createEscapeOptionTokenScenario( "A\nB'C", "A\nB'C", ); } }