Merge pull request #480 from tienvx/add-command-count-messages

Add command count messages

README.md

@@ -23,8 +23,8 @@ All you have to do:
 
 ## Requirements
 
-* PHP 7.3 / 7.4
-* Symfony 5.0
+* PHP 7.2 / 7.3 / 7.4
+* Symfony 4.4 / 5.0
 * See also the `require` section of [composer.json](composer.json)
 
 ## Installation

src/Command/MessagesCountCommand.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Tienvx\Bundle\MbtBundle\Command;
+
+use Psr\Container\ContainerInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Exception\RuntimeException;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Messenger\Transport\Receiver\MessageCountAwareInterface;
+
+class MessagesCountCommand extends Command
+{
+    protected static $defaultName = 'mbt:messages:count';
+
+    private $receiverLocator;
+
+    public function __construct(ContainerInterface $receiverLocator)
+    {
+        $this->receiverLocator = $receiverLocator;
+
+        parent::__construct();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function configure(): void
+    {
+        $this
+            ->setDefinition([
+                new InputArgument('receiver', InputArgument::REQUIRED, 'Name of the receiver/transport to count', null),
+            ])
+            ->setDescription('Consumes messages')
+            ->setHelp(<<<'EOF'
+The <info>%command.name%</info> command count messages of a transport.
+
+    <info>php %command.full_name% <receiver-name></info>
+EOF
+            )
+        ;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $receiverName = $input->getArgument('receiver');
+        if (!$this->receiverLocator->has($receiverName)) {
+            throw new RuntimeException(sprintf('The receiver "%s" does not exist.', $receiverName));
+        }
+
+        $receiver = $this->receiverLocator->get($receiverName);
+
+        if (!$receiver instanceof MessageCountAwareInterface) {
+            throw new RuntimeException(sprintf('The receiver "%s" does not support count messages.', $receiverName));
+        }
+
+        $output->write($receiver->getMessageCount());
+
+        return 0;
+    }
+}

src/Message/ApplyBugTransitionMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class ApplyBugTransitionMessage
+class ApplyBugTransitionMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/ApplyTaskTransitionMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class ApplyTaskTransitionMessage
+class ApplyTaskTransitionMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/CaptureScreenshotsMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class CaptureScreenshotsMessage
+class CaptureScreenshotsMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/CreateBugMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class CreateBugMessage
+class CreateBugMessage implements MessageInterface
 {
     /**
      * @var string

src/Message/ExecuteTaskMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class ExecuteTaskMessage
+class ExecuteTaskMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/FinishReduceBugMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class FinishReduceBugMessage
+class FinishReduceBugMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/FinishReduceStepsMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class FinishReduceStepsMessage
+class FinishReduceStepsMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/MessageInterface.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Tienvx\Bundle\MbtBundle\Message;
+
+interface MessageInterface
+{
+}

src/Message/ReduceBugMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class ReduceBugMessage
+class ReduceBugMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/ReduceStepsMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class ReduceStepsMessage
+class ReduceStepsMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/RemoveScreenshotsMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class RemoveScreenshotsMessage
+class RemoveScreenshotsMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/ReportBugMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class ReportBugMessage
+class ReportBugMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/TestBugMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class TestBugMessage
+class TestBugMessage implements MessageInterface
 {
     /**
      * @var int

src/Message/TestPredefinedCaseMessage.php

@@ -2,7 +2,7 @@
 
 namespace Tienvx\Bundle\MbtBundle\Message;
 
-class TestPredefinedCaseMessage
+class TestPredefinedCaseMessage implements MessageInterface
 {
     /**
      * @var string

src/Resources/config/services.xml

@@ -11,5 +11,10 @@
         <service id="Tienvx\Bundle\MbtBundle\EventListener\EntitySubscriber">
             <tag name="doctrine.event_subscriber"/>
         </service>
+
+        <service id="Tienvx\Bundle\MbtBundle\Command\MessagesCountCommand">
+            <argument type="service" id="messenger.receiver_locator" />
+            <tag name="console.command" command="mbt:messages:count" />
+        </service>
     </services>
 </container>

tests/Command/MessagesCountCommandTest.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Tienvx\Bundle\MbtBundle\Tests\Command;
+
+use App\Message\CountableMessage;
+use Exception;
+use Symfony\Component\Console\Tester\CommandTester;
+use Symfony\Component\Messenger\MessageBusInterface;
+
+class MessagesCountCommandTest extends CommandTestCase
+{
+    /**
+     * @throws Exception
+     */
+    public function testExecute()
+    {
+        $name = 'mbt:messages:count';
+        $input = [
+            'command' => $name,
+            'receiver' => 'doctrine',
+        ];
+
+        $command = $this->application->find($name);
+        $commandTester = new CommandTester($command);
+
+        $commandTester->execute($input);
+        $output = $commandTester->getDisplay();
+        $this->assertEquals(0, $output);
+
+        $messageBus = self::$container->get(MessageBusInterface::class);
+        $messageBus->dispatch(new CountableMessage());
+
+        $commandTester->execute($input);
+        $output = $commandTester->getDisplay();
+        $this->assertEquals(1, $output);
+    }
+}

tests/app/config/config.yaml

@@ -11,8 +11,10 @@ framework:
                     delay: 1000
                     multiplier: 2
                     max_delay: 0
+            doctrine: 'doctrine://default'
         routing:
-            '*': memory
+            'Tienvx\Bundle\MbtBundle\Message\MessageInterface': memory
+            'App\Message\CountableMessage': doctrine
     validation:
         auto_mapping:
             Tienvx\Bundle\MbtBundle\Entity\: []

tests/app/src/Message/CountableMessage.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace App\Message;
+
+class CountableMessage
+{
+}