Merge pull request #42 from MacPaw/develop

Release

Author: serhiidonii

.github/workflows/ci.yaml

@@ -18,18 +18,19 @@ jobs:
                     - '6.3.*'
                     - '6.4.*'
                     - '7.0.*'
+                    - '7.1.*'
                 include:
                     - php: '8.2'
                       coverage: 'xdebug'
-                      symfony-versions: '7.0.*'
+                      symfony-versions: '7.1.*'
 
 
         name: PHP ${{ matrix.php }} Symfony ${{ matrix.symfony-versions }} ${{ matrix.description }}
         steps:
             - name: Checkout
               uses: actions/checkout@v2
 
-            - uses: actions/cache@v2
+            - uses: actions/cache@v4
               with:
                   path: ~/.composer/cache/files
                   key: ${{ matrix.php }}-${{ matrix.symfony-versions }}
@@ -48,7 +49,7 @@ jobs:
               run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
             - name: Cache composer
-              uses: actions/cache@v2.1.2
+              uses: actions/cache@v4
               with:
                   path: ${{ steps.composer-cache.outputs.dir }}
                   key: ${{ runner.os }}-${{ matrix.php }}-${{ matrix.symfony-versions }}-composer-${{ hashFiles('composer.json') }}
@@ -74,8 +75,9 @@ jobs:
               if: matrix.coverage == 'xdebug'
 
             - name: Run codecov
-              uses: codecov/codecov-action@v1
+              uses: codecov/codecov-action@v4.0.1
               if: matrix.coverage == 'xdebug'
               with:
-                  file: './coverage.xml'
-                  fail_ci_if_error: true
+                token: ${{ secrets.CODECOV_TOKEN }}
+                file: './coverage.xml'
+                fail_ci_if_error: true

.github/workflows/static-analysis.yaml

@@ -11,7 +11,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
@@ -27,7 +27,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
@@ -43,7 +43,7 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout
-              uses: actions/checkout@v2
+              uses: actions/checkout@v4
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2

.gitignore

@@ -5,3 +5,5 @@
 /node_modules/
 /.idea/
 /package-lock.json
+/reports
+/clover.xml

README.md

@@ -1,87 +1,48 @@
-Behat Messenger Context Bundle
-=================================
+# Behat Messenger Context Bundle
+[![Latest Stable Version](http://poser.pugx.org/macpaw/behat-messenger-context/v)](https://packagist.org/packages/macpaw/behat-messenger-context) 
+[![Total Downloads](http://poser.pugx.org/macpaw/behat-messenger-context/downloads)](https://packagist.org/packages/macpaw/behat-messenger-context)
+[![Latest Unstable Version](http://poser.pugx.org/macpaw/behat-messenger-context/v/unstable)](https://packagist.org/packages/macpaw/behat-messenger-context)
+[![License](http://poser.pugx.org/macpaw/behat-messenger-context/license)](https://packagist.org/packages/macpaw/behat-messenger-context)
+[![PHP Version Require](http://poser.pugx.org/macpaw/behat-messenger-context/require/php)](https://packagist.org/packages/macpaw/behat-messenger-context)
 
-| Version | Build Status | Code Coverage |
-|:---------:|:-------------:|:-----:|
-| `master`| [![CI][master Build Status Image]][master Build Status] | [![Coverage Status][master Code Coverage Image]][master Code Coverage] |
-| `develop`| [![CI][develop Build Status Image]][develop Build Status] | [![Coverage Status][develop Code Coverage Image]][develop Code Coverage] |
+| Version    | Build Status                                               | Coverage                                                                 |
+|------------|------------------------------------------------------------|--------------------------------------------------------------------------|
+| `master`   | [![CI][master Build Status Image]][master Build Status]    | [![Coverage Status][master Code Coverage Image]][master Code Coverage]   |
+| `develop`  | [![CI][develop Build Status Image]][develop Build Status]  | [![Coverage Status][develop Code Coverage Image]][develop Code Coverage] |
 
-Installation
-============
 
-Step 1: Download the Bundle
-----------------------------------
-Open a command console, enter your project directory and execute:
+This repository provides custom Behat step definitions for working with Symfony Messenger transports. It includes functionality for checking messages in transports, validating them against expected JSON structures, and working with variable fields.
 
-###  Applications that use Symfony Flex [in progress](https://github.com/MacPaw/BehatRedisContext/issues/2)
+## Installation
 
-```console
-$ composer require --dev macpaw/behat-messenger-context
-```
+To install the MessengerContext and integrate it with your Behat setup, follow the instructions provided in the [Installation Guide](docs/install.md).
 
-### Applications that don't use Symfony Flex
+## Available Features
 
-Open a command console, enter your project directory and execute the
-following command to download the latest stable version of this bundle:
+### Check a Specific Message in a Transport
+You can verify if a specific message exists in a given transport.
+* Documentation: [Check Transport Message](docs/MessengerContext/check_transport_message.md)
 
-```console
-$ composer require --dev macpaw/behat-messenger-context
-```
+### Check All Messages in a Transport
+Verify if all messages in a given transport match the expected JSON structure.
+* Documentation: [Check All Transport Messages](docs/MessengerContext/check_all_transport_message.md)
 
-This command requires you to have Composer installed globally, as explained
-in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
-of the Composer documentation.
+### Check Messages with Regular Expressions
+You can use regular expressions to validate messages that contain dynamic or variable data.
+* Documentation for specific message: [Check Transport Message with Regexp](docs/MessengerContext/check_transport_message_regexp.md)
+* Documentation for all messages: [Check All Transport Messages with Regexp](docs/MessengerContext/check_all_transport_message_regexp.md)
 
+### Check Every Messages with Mask Regular Expressions
+You can use regular expression to validate all messages messages that contain dynamic or variable data.
+* Documentation for all specific message: [Check Transport Messages with Regexp](docs/MessengerContext/check_transport_messages_regexp_mask.md)
 
-Then, enable the bundle by adding it to the list of registered bundles
-in the `app/AppKernel.php` file of your project:
+### Verify Message Count in a Transport
+Ensure that a specific number of messages exist in a given transport.
 
-```php
-<?php
-// app/AppKernel.php
+### Auto clean queue messages before scenario
+Check details in [documentation](docs/MessengerContext/clear_transport_with_zentruck.md)
 
-// ...
-class AppKernel extends Kernel
-{
-    public function registerBundles()
-    {
-        $bundles = array(
-            // ...
-            BehatMessengerContext\BehatMessengerContextBundle::class => ['test' => true],
-        );
-
-        // ...
-    }
-
-    // ...
-}
-```
-
-Step 2: Configure Messenger
-=============
-Copying `config/packages/dev/messenger.yaml` and pasting that into `config/packages/test/`. This gives us messenger configuration that will only be used in the test environment. Uncomment the code, and replace sync with in-memory. Do that for both of the transports.
-
-```yaml
-framework:
-    messenger:
-        transports:
-            async: 'in-memory://'
-            async_priority_high: 'in-memory://'
-            ...
-...
-```
-
-
-Step 3: Configure Behat
-=============
-Go to `behat.yml`
-
-```yaml
-...
-  contexts:
-    - BehatMessengerContext\Context\MessengerContext
-...
-```
+* 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
 [master Build Status Image]: https://github.com/macpaw/behat-messenger-context/workflows/CI/badge.svg?branch=master

composer.json

@@ -40,6 +40,9 @@
         "slevomat/coding-standard": "^7.0",
         "squizlabs/php_codesniffer": "^3.6"
     },
+    "suggest": {
+        "zenstruck/messenger-test": "To use Zentruck messages clearing"
+    },
     "autoload": {
         "psr-4": {
             "BehatMessengerContext\\": "src"

docs/MessengerContext/check_all_transport_message.md

@@ -0,0 +1,33 @@
+# Behat Custom Step: Verify All Messages in a Transport
+
+This documentation outlines the purpose and usage of the custom Behat step definition for verifying that all messages in a specific Symfony Messenger transport match a list of expected JSON structures.
+
+## Purpose
+
+This function is designed to validate that all messages in a specific transport (e.g., asynchronous queues) match a given set of expected JSON structures. It is useful in scenarios where you need to ensure that every message in the transport adheres to a specific structure or content format.
+
+## Function Overview
+
+### Signature:
+```gherkin
+Then all transport ":transportName" messages should be JSON:
+"""
+    [
+        {
+            "event": "status_updated",
+            "time": "123123123",
+            "payload": "dqwdwdwdw"
+        },
+        {
+            "event": "order_created",
+            "time": "456456456",
+            "payload": "otherPayload"
+        }
+    ]
+    """
+
+```
+
+### Parameters:
+- `transportName` (string): The name of the transport (e.g., 'async') where the message is expected to be found.
+- `expectedMessage` PyStringNode): A JSON array representing the expected content of all messages that should be present in the transport.

docs/MessengerContext/check_all_transport_message_regexp.md

@@ -0,0 +1,41 @@
+# Behat Custom Step: Verify All Messages in Transport with Variable Fields
+
+This documentation outlines the purpose and usage of the custom Behat step definition for verifying that all messages in a specific Symfony Messenger transport match a list of expected JSON structures, while allowing certain fields to vary across the messages.
+## Purpose
+
+This function is designed to validate that all messages in a specific transport (e.g., asynchronous queues) match a given set of expected JSON structures, while allowing certain fields (e.g., timestamps, unique IDs) to have variable values. This is useful in scenarios where specific fields in the messages may differ but the overall structure and format must remain consistent.## Function Overview
+
+### Signature:
+```php
+/**
+ * @Then all transport :transportName messages should be JSON with variable fields :variableFields:
+ */
+public function allTransportMessagesShouldBeJsonWithVariableFields(
+    string $transportName,
+    string $variableFields,
+    PyStringNode $expectedMessageList
+): void
+```
+
+### Parameters:
+- `transportName` (string): The name of the transport (e.g., 'webhook') where the message is expected to be found.
+- `variableFields` (string): A comma-separated list of fields where values may vary and should be compared using regular expressions.
+- `expectedMessage` (PyStringNode): The expected message content in JSON format, where fields marked with `~` in their values will be treated as regular expressions.
+
+```gherkin
+Then all transport ":transportName" messages should be JSON with variable fields ":variableFields":
+"""
+    [
+        {
+            "event": "status_updated",
+            "time": "~^\\d{13}$",
+            "payload": "dqwdwdwdw"
+        },
+        {
+            "event": "order_created",
+            "time": "~^\\d{13}$",
+            "payload": "otherPayload"
+        }
+    ]
+"""
+```

docs/MessengerContext/check_transport_message.md

@@ -0,0 +1,26 @@
+
+# Behat Custom Step: Transport JSON Message Assertion
+
+This documentation outlines the purpose and usage of the custom Behat step definition for verifying if a Symfony Messenger transport contains a message with a specific JSON structure.
+
+## Purpose
+
+This function is designed to check if a given transport (such as an asynchronous queue) contains a message that matches a particular JSON structure. It is useful in scenarios where you need to validate that a message was correctly dispatched with the expected content during Behat tests.
+
+## Function Overview
+
+### Signature:
+```gherkin
+Then transport ":transportName" should contain message with JSON:
+    """
+    {
+        "event": "status_updated",
+        "time": "123123123",
+        "payload": "dqwdwdwdw"
+    }
+    """
+```
+
+### Parameters:
+- `transportName` (string): The name of the transport (e.g., 'async') where the message is expected to be found.
+- `expectedMessage` (PyStringNode): The expected message content in JSON format that should be present in the transport.

docs/MessengerContext/check_transport_message_regexp.md

@@ -0,0 +1,37 @@
+
+# Behat Custom Step: Transport JSON Message Assertion with Regexp Fields
+
+This documentation outlines the purpose and usage of the custom Behat step definition for verifying if a Symfony Messenger transport contains a message with a specific JSON structure, using regular expressions to handle dynamic fields.
+
+## Purpose
+
+This function is designed to check if a given transport (such as an asynchronous queue) contains a message that matches a particular JSON structure, while allowing certain fields to be validated using regular expressions. It is particularly useful when testing messages with dynamic data, such as timestamps, unique identifiers, or payloads, where the exact value cannot be guaranteed.
+## Function Overview
+
+### Signature:
+```php
+/**
+ * @Then transport :transportName should contain message with JSON and variable fields :variableFields:
+ */
+public function transportShouldContainMessageWithJsonAndVariableFields(
+    string $transportName,
+    string $variableFields,
+    PyStringNode $expectedMessage
+): void
+```
+
+### Parameters:
+- `transportName` (string): The name of the transport (e.g., 'webhook') where the message is expected to be found.
+- `variableFields` (string): A comma-separated list of field names where values should be matched using regular expressions.
+- `expectedMessage` (PyStringNode): The expected message content in JSON format, where fields marked with `~` in their values will be treated as regular expressions.
+
+```gherkin
+And transport "webhook" should contain message with JSON and variable fields "time, payload":
+    """
+    {
+        "event": "customer_agreement_status_updated",
+        "time": "~^\\d{13}$",
+        "payload": "~^\\{.*\\}$"
+    }
+    """
+```

docs/MessengerContext/check_transport_messages_regexp_mask.md

@@ -0,0 +1,37 @@
+
+# Behat Custom Step: Transport JSON Message Assertion with Regexp Fields
+
+This documentation outlines the purpose and usage of the custom Behat step definition for verifying if a Symfony Messenger transport contains a message with a specific JSON mask for every message, using regular expressions to handle dynamic fields.
+
+## Purpose
+
+This function is designed to check if a given transport (such as an asynchronous queue) contains a message that matches a message with a specific JSON mask for every message, while allowing certain fields to be validated using regular expressions. It is particularly useful when testing messages with dynamic data, such as timestamps, unique identifiers, or payloads, where the exact value cannot be guaranteed.
+## Function Overview
+
+### Signature:
+```php
+/**
+ * @Then all transport :transportName messages have JSON by :fields with mask :mask:
+ */
+public function allTransportMessagesHaveJsonByFieldsWithMask(
+    string $transportName,
+    string $variableFields,
+    PyStringNode $expectedMessageList,
+): void {
+```
+
+### Parameters:
+- `transportName` (string): The name of the transport (e.g., 'webhook') where the message is expected to be found.
+- `variableFields` (string): A comma-separated list of field names where values should be matched using regular expressions.
+- `expectedMessage` (PyStringNode): The expected message content in JSON format, where fields marked with `~` in their values will be treated as regular expressions.
+
+```gherkin
+And all transport "webhook" messages should contain message with JSON and variable fields "time, payload" by mask:
+    """
+    {
+        "event": "customer_agreement_status_updated",
+        "time": "~^\\d{13}$",
+        "payload": "~^\\{.*\\}$"
+    }
+    """
+```