[Console] Add auto-completion to debug:event-dispatcher #43859
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| <?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\Bundle\FrameworkBundle\Tests\Command; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Bundle\FrameworkBundle\Command\EventDispatcherDebugCommand; | ||
| use Symfony\Bundle\FrameworkBundle\Console\Application; | ||
| use Symfony\Component\Console\Tester\CommandCompletionTester; | ||
| use Symfony\Component\DependencyInjection\Container; | ||
| use Symfony\Component\DependencyInjection\ContainerBuilder; | ||
| use Symfony\Component\EventDispatcher\EventDispatcher; | ||
| use Symfony\Component\HttpKernel\KernelInterface; | ||
|
|
||
| class EventDispatcherDebugCommandCompletionTest extends TestCase | ||
| { | ||
| /** | ||
| * @dataProvider provideCompletionSuggestions | ||
| */ | ||
| public function testComplete(array $input, array $expectedSuggestions) | ||
| { | ||
| $tester = $this->createCommandCompletionTester(); | ||
|
There was a problem hiding this comment. Did you think about only mocking the $dispatchers = $this->createMock(ContainerInterface::class);
$dispatchers->method('get')->willReturn($dispatcher);
$dispatchers->method('has')->willReturn(true);
// ...
$command = new EventDispatcherDebugCommand($dispatchers);
$tester = new CommandCompletionTester($command);There was a problem hiding this comment. Let me try this out There was a problem hiding this comment. But container interface don't have another method required |
||
|
|
||
| $suggestions = $tester->complete($input); | ||
|
|
||
| $this->assertSame($expectedSuggestions, $suggestions); | ||
| } | ||
|
|
||
| public function provideCompletionSuggestions() | ||
| { | ||
| yield 'event' => [[''], ['event', 'Listener']]; | ||
| yield 'event for other dispatcher' => [['--dispatcher=other_event_dispatcher', 'other'], ['other_event', 'OtherListener']]; | ||
| yield 'dispatcher' => [['--dispatcher='], ['event_dispatcher', 'other_event_dispatcher']]; | ||
| yield 'format' => [['--format='], ['txt', 'xml', 'json', 'md']]; | ||
| } | ||
|
|
||
| private function createCommandCompletionTester(): CommandCompletionTester | ||
| { | ||
| $kernel = $this->createMock(KernelInterface::class); | ||
|
|
||
| $kernel | ||
| ->expects($this->any()) | ||
| ->method('getBundle') | ||
| ->willReturnMap([]); | ||
|
|
||
| $kernel | ||
| ->expects($this->any()) | ||
| ->method('getBundles') | ||
| ->willReturn([]); | ||
|
|
||
| $container = new Container(); | ||
|
|
||
| $kernel | ||
| ->expects($this->any()) | ||
| ->method('getContainer') | ||
| ->willReturn($container); | ||
|
|
||
| $dispatcher = new EventDispatcher(); | ||
| $otherDispatcher = new EventDispatcher(); | ||
|
|
||
| $dispatcher->addListener('event', 'Listener'); | ||
| $otherDispatcher->addListener('other_event', 'OtherListener'); | ||
|
|
||
| $locator = $this->createLocator([ | ||
| 'event_dispatcher' => $dispatcher, | ||
| 'other_event_dispatcher' => $otherDispatcher, | ||
| ]); | ||
|
|
||
| $command = new EventDispatcherDebugCommand($locator); | ||
|
|
||
| $application = new Application($kernel); | ||
|
|
||
| $application->add($command); | ||
|
|
||
| return new CommandCompletionTester($application->find('debug:event-dispatcher')); | ||
| } | ||
|
|
||
| private function createLocator(array $linkers) | ||
| { | ||
| $locator = $this->createMock(ContainerBuilder::class); | ||
|
|
||
| $locator->expects($this->any()) | ||
| ->method('has') | ||
| ->willReturnCallback(function ($dispatcherServiceName) use ($linkers) { | ||
| return isset($linkers[$dispatcherServiceName]); | ||
| }); | ||
|
|
||
| $locator->expects($this->any()) | ||
| ->method('get') | ||
| ->willReturnCallback(function ($dispatcherServiceName) use ($linkers) { | ||
| return $linkers[$dispatcherServiceName]; | ||
| }); | ||
|
|
||
| $locator->expects($this->any()) | ||
| ->method('getServiceIds') | ||
| ->willReturnCallback(function () use ($linkers) { | ||
| return array_keys($linkers); | ||
| }); | ||
|
|
||
| $locator->expects($this->any()) | ||
| ->method('getAliases') | ||
| ->willReturnCallback(function () { | ||
| return []; | ||
| }); | ||
|
|
||
| return $locator; | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why listeners are added to the list of suggested event names? The argument get values like
kernel.responseorSymfony\Component\Mailer\Event\MessageEvent. I did some tests and listener names are not accepted (ex:Symfony\Component\HttpKernel\EventListener\ResponseListener::onKernelResponse)