Add reset message queues before scenario with zentruck/messenger-test

Author: serhiidonii

README.md

@@ -29,6 +29,9 @@ You can use regular expressions to validate messages that contain dynamic or var
 ### Verify Message Count in a Transport
 Ensure that a specific number of messages exist in a given transport.
 
+### Auto clean queue messages before scenario
+Check details in [documentation](docs/MessengerContext/clear_transport_with_zentruck.md)
+
 * Documentation: [Count Messages in Transport](docs/MessengerContext/count_message_transport.md)
 
 [master Build Status]: https://github.com/macpaw/behat-messenger-context/actions?query=workflow%3ACI+branch%3Amaster

docs/MessengerContext/clear_transport_with_zentruck.md

@@ -0,0 +1,43 @@
+# Clear queues messages before scenario with zentruck
+
+## Installation
+
+1. Install the library:
+
+    ```bash
+    composer require --dev zenstruck/messenger-test
+    ```
+2. If not added automatically by Symfony Flex, add the bundle in `config/bundles.php`:
+
+    ```php
+    Zenstruck\Messenger\Test\ZenstruckMessengerTestBundle::class => ['test' => true],
+    ```
+
+3. Update `config/packages/messenger.yaml` and override your transport(s)
+   in your `test` environment with `test://`:
+
+    ```yaml
+    # config/packages/messenger.yaml
+
+    # ...
+
+    when@test:
+        framework:
+            messenger:
+                transports:
+                    async: test://
+    ```
+
+## Transport
+
+You can interact with the test transports in your tests by using the
+`InteractsWithMessenger` trait in your `KernelTestCase`/`WebTestCase` tests.
+You can assert the different steps of message processing by asserting on the queue
+and the different states of message processing like "acknowledged", "rejected" and so on.
+
+> **Note**: If you only need to know if a message has been dispatched you can
+> make assertions [on the bus itself](#bus).
+
+More details you can see in [origin package repository](https://github.com/zenstruck/messenger-test)
+
+Zentruck will be used automatically after installation.

src/Context/MessengerContext.php

@@ -6,12 +6,18 @@
 
 use Behat\Behat\Context\Context;
 use Behat\Gherkin\Node\PyStringNode;
+use Behat\Hook\AfterFeature;
+use Behat\Hook\AfterScenario;
+use Behat\Hook\BeforeFeature;
 use Behat\Hook\BeforeScenario;
 use Exception;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\Messenger\Transport\InMemory\InMemoryTransport;
 use Symfony\Component\Messenger\Transport\Sync\SyncTransport;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
+use Zenstruck\Messenger\Test\Bus\TestBus;
+use Zenstruck\Messenger\Test\InteractsWithMessenger;
+use Zenstruck\Messenger\Test\Transport\TestTransport;
 
 class MessengerContext implements Context
 {
@@ -29,14 +35,37 @@ public function __construct(
         $this->transportRetriever = $transportRetriever;
     }
 
+    #[BeforeFeature]
+    public static function startTrackMessages(): void
+    {
+        if (class_exists(TestTransport::class)) {
+            TestTransport::resetAll();
+            TestTransport::enableMessagesCollection();
+            TestTransport::disableResetOnKernelShutdown();
+            TestBus::enableMessagesCollection();
+        }
+    }
+
+    #[AfterFeature]
+    public static function stopTrackMessages(): void
+    {
+        if (class_exists(TestTransport::class)) {
+            TestTransport::resetAll();
+        }
+    }
+
     #[BeforeScenario]
     public function clearMessenger(): void
     {
-        $transports = $this->transportRetriever->getAllTransports();
-
-        foreach ($transports as $transport) {
-            if ($transport instanceof InMemoryTransport) {
-                $transport->reset();
+        if (class_exists(TestTransport::class)) {
+            TestTransport::resetAll();
+        } else {
+            $transports = $this->transportRetriever->getAllTransports();
+
+            foreach ($transports as $transport) {
+                if ($transport instanceof InMemoryTransport) {
+                    $transport->reset();
+                }
             }
         }
     }

src/Resources/config/messenger_context.xml

@@ -6,6 +6,7 @@
     <services>
         <service public="true" autowire="true" id="BehatMessengerContext\Context\MessengerContext" class="BehatMessengerContext\Context\MessengerContext">
             <argument key="$container" type="service" id="test.service_container"/>
+            <argument key="$transportRetriever" type="service" id="BehatMessengerContext\Context\TransportRetriever"/>
         </service>
         <service public="true" autowire="true" id="BehatMessengerContext\Context\TransportRetriever" class="BehatMessengerContext\Context\TransportRetriever">
             <argument key="$receiverLocator" type="service" id="messenger.receiver_locator"/>

tests/MessengerContextTest.php

@@ -47,31 +47,6 @@ protected function setUp(): void
         );
     }
 
-    public function testClearMessenger(): void
-    {
-        $serviceProvider = $this->createMock(ServiceProviderInterface::class);
-        $serviceProvider
-            ->expects($this->once())
-            ->method('getProvidedServices')
-            ->willReturn(['messenger.transport.test']);
-
-        $serviceProvider
-            ->expects(self::once())
-            ->method('get')
-            ->with('messenger.transport.test')
-            ->willReturn($this->inMemoryTransport);
-
-        $this->inMemoryTransport
-            ->expects($this->once())
-            ->method('reset');
-
-        (new MessengerContext(
-            $this->container,
-            $this->normalizer,
-            new TransportRetriever($serviceProvider),
-        ))->clearMessenger();
-    }
-
     public function testTransportShouldContainMessageWithJson(): void
     {
         $message = new \stdClass();