Skip to content

Commit

Permalink
bug #31261 [Console] Commands with an alias should not be recognized …
Browse files Browse the repository at this point in the history
…as ambiguous when using register (Simperfit)

This PR was merged into the 3.4 branch.

Discussion
----------

[Console] Commands with an alias should not be recognized as ambiguous when using register

| Q             | A
| ------------- | ---
| Branch?       | 2.8
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #25355
| License       | MIT
| Doc PR        |

I think when passing an alias, it should not be treated as a ambiguous command since it's configured to response to it.

I've [pushed a commit](Simperfit/symfony-reproducer@2f5209a) that reproduce the bug and with this patch it does work.

Commits
-------

ae7ee46 [Console] Commands with an alias should not be recognized as ambiguous
  • Loading branch information
nicolas-grekas committed May 9, 2019
2 parents 284c216 + ae7ee46 commit fb4d928
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 13 deletions.
9 changes: 9 additions & 0 deletions src/Symfony/Component/Console/Application.php
Expand Up @@ -596,6 +596,15 @@ public function find($name)
$this->init();

$aliases = [];

foreach ($this->commands as $command) {
foreach ($command->getAliases() as $alias) {
if (!$this->has($alias)) {
$this->commands[$alias] = $command;
}
}
}

$allCommands = $this->commandLoader ? array_merge($this->commandLoader->getNames(), array_keys($this->commands)) : array_keys($this->commands);
$expr = preg_replace_callback('{([^:]+|)}', function ($matches) { return preg_quote($matches[1]).'[^:]*'; }, $name);
$commands = preg_grep('{^'.$expr.'}', $allCommands);
Expand Down
31 changes: 26 additions & 5 deletions src/Symfony/Component/Console/Tests/ApplicationTest.php
Expand Up @@ -72,8 +72,8 @@ public static function setUpBeforeClass()
require_once self::$fixturesPath.'/BarBucCommand.php';
require_once self::$fixturesPath.'/FooSubnamespaced1Command.php';
require_once self::$fixturesPath.'/FooSubnamespaced2Command.php';
require_once self::$fixturesPath.'/TestTiti.php';
require_once self::$fixturesPath.'/TestToto.php';
require_once self::$fixturesPath.'/TestAmbiguousCommandRegistering.php';
require_once self::$fixturesPath.'/TestAmbiguousCommandRegistering2.php';
}

protected function normalizeLineBreaks($text)
Expand Down Expand Up @@ -164,6 +164,27 @@ public function testRegister()
$this->assertEquals('foo', $command->getName(), '->register() registers a new command');
}

public function testRegisterAmbiguous()
{
$code = function (InputInterface $input, OutputInterface $output) {
$output->writeln('It works!');
};

$application = new Application();
$application
->register('test-foo')
->setAliases(['test'])
->setCode($code);

$application
->register('test-bar')
->setCode($code);

$tester = new ApplicationTester($application);
$tester->run(['test']);
$this->assertContains('It works!', $tester->getDisplay(true));
}

public function testAdd()
{
$application = new Application();
Expand Down Expand Up @@ -303,9 +324,9 @@ public function testFindAmbiguousNamespace()
public function testFindNonAmbiguous()
{
$application = new Application();
$application->add(new \TestTiti());
$application->add(new \TestToto());
$this->assertEquals('test-toto', $application->find('test')->getName());
$application->add(new \TestAmbiguousCommandRegistering());
$application->add(new \TestAmbiguousCommandRegistering2());
$this->assertEquals('test-ambiguous', $application->find('test')->getName());
}

/**
Expand Down
Expand Up @@ -4,19 +4,19 @@
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class TestToto extends Command
class TestAmbiguousCommandRegistering extends Command
{
protected function configure()
{
$this
->setName('test-toto')
->setDescription('The test-toto command')
->setName('test-ambiguous')
->setDescription('The test-ambiguous command')
->setAliases(['test'])
;
}

protected function execute(InputInterface $input, OutputInterface $output)
{
$output->write('test-toto');
$output->write('test-ambiguous');
}
}
Expand Up @@ -4,18 +4,18 @@
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class TestTiti extends Command
class TestAmbiguousCommandRegistering2 extends Command
{
protected function configure()
{
$this
->setName('test-titi')
->setDescription('The test:titi command')
->setName('test-ambiguous2')
->setDescription('The test-ambiguous2 command')
;
}

protected function execute(InputInterface $input, OutputInterface $output)
{
$output->write('test-titi');
$output->write('test-ambiguous2');
}
}

0 comments on commit fb4d928

Please sign in to comment.