Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
php-versions: ['8.4', '8.5']
php-versions: ['8.3', '8.4', '8.5']
mode: ['high-deps', 'low-deps']
fail-fast: false
name: PHP ${{ matrix.php-versions }} tests with ${{ matrix.mode }}
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Changelog

All releases have their changelog published in the [Releases section](https://github.com/Yousign/zdd-message-bundle/releases).
All releases have their changelog published in the [Releases section](https://github.com/Youtrust/zdd-message-bundle/releases).
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Yousign
Copyright (c) 2023-2026 Youtrust

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
60 changes: 43 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,47 @@

A Symfony Bundle to use when you want to assert that messages used with Message brokers such like RabbitMQ are compliant with the Zero Downtime Deployment.

## Upgrading from `yousign/zdd-message-bundle`

This bundle was published as `yousign/zdd-message-bundle` up to v3.3.0, under the
`Yousign\ZddMessageBundle\` namespace. Following the company rename to Youtrust, v4.0.0 moves to
`youtrust/zdd-message-bundle` and the `Youtrust\ZddMessageBundle\` namespace. There is no functional
change between v3.3.0 and v4.0.0.

```
$ composer remove yousign/zdd-message-bundle
$ composer require youtrust/zdd-message-bundle:^4.0
```

Then replace every `Yousign\ZddMessageBundle\` prefix with `Youtrust\ZddMessageBundle\`. Beyond your PHP
code, three spots live in configuration and are easy to miss:

- the bundle class in `config/bundles.php`
- the serializer service in `messenger.yaml`, if you use `ZddMessageMessengerSerializer`
- your own implementations of `ZddMessageConfigInterface` and `CustomMessageGeneratorInterface`

The console commands are renamed to `youtrust:zdd-message:*`, with **no alias kept for the old names**.
They are typically invoked from CI pipelines rather than from PHP, so unlike the namespace change this one
fails at run time rather than at autoload time — update your pipelines as part of the upgrade.

`yousign/zdd-message-bundle` is abandoned and no longer maintained. It will receive no further release of
any kind, security fixes included.

## Requirements

- PHP 8.4 and above
- PHP 8.3 and above
- Symfony 7.4 or 8

## Getting started
### Installation
First, install the bundle with composer:
```
$ composer require yousign/zdd-message-bundle
$ composer require youtrust/zdd-message-bundle
```

Then, verify that the bundle has been registered in `config/bundles.php`:
```php
Yousign\ZddMessageBundle\ZddMessageBundle::class => ['all' => true],
Youtrust\ZddMessageBundle\ZddMessageBundle::class => ['all' => true],
```

### Configuration
Expand All @@ -27,8 +53,8 @@ Create a class to configure the messages to assert and how to create them:

namespace App\Message;

use Yousign\ZddMessageBundle\Config\CustomMessageGeneratorInterface;
use Yousign\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Youtrust\ZddMessageBundle\Config\CustomMessageGeneratorInterface;
use Youtrust\ZddMessageBundle\Config\ZddMessageConfigInterface;

class MessageConfig implements ZddMessageConfigInterface, CustomMessageGeneratorInterface
{
Expand Down Expand Up @@ -99,9 +125,9 @@ Finish by updating the configuration with this new service in `config/packages/z

Option to use different serializer.
Possible options:
- `Yousign\ZddMessageBundle\Serializer\ZddMessageMessengerSerializer` (default, already configured for messenger serialization in messenger.yaml)
- `Youtrust\ZddMessageBundle\Serializer\ZddMessageMessengerSerializer` (default, already configured for messenger serialization in messenger.yaml)
- Define your own serializer
- Create a service that implement `Yousign\ZddMessageBundle\Serializer\SerializerInterface`
- Create a service that implement `Youtrust\ZddMessageBundle\Serializer\SerializerInterface`
- Use it in the configuration
```yaml
# config/packages/zdd_message.yaml
Expand Down Expand Up @@ -138,37 +164,37 @@ zdd_message:
The bundle comes with commands to assert that your messages are compliant with the Zero Downtime Deployment:

```bash
$ bin/console yousign:zdd-message:generate # Generate serialized messages in files.
$ bin/console yousign:zdd-message:validate # Assert that the messages are compliant by deserializing them from files and call the properties.
$ bin/console yousign:zdd-message:debug # Output all tracked messages.
$ bin/console youtrust:zdd-message:generate # Generate serialized messages in files.
$ bin/console youtrust:zdd-message:validate # Assert that the messages are compliant by deserializing them from files and call the properties.
$ bin/console youtrust:zdd-message:debug # Output all tracked messages.
```

💡 You should run `bin/console yousign:zdd-message:generate` with the production version code and `bin/console yousign:zdd-message:validate` with the version code you want to merge.
💡 You should run `bin/console youtrust:zdd-message:generate` with the production version code and `bin/console youtrust:zdd-message:validate` with the version code you want to merge.

#### Example from the version you want to merge:
```bash
$ git checkout [production_version]
$ bin/console yousign:zdd-message:generate
$ bin/console youtrust:zdd-message:generate
$ git checkout - # Go back to the version you want to merge
$ bin/console yousign:zdd-message:validate
$ bin/console youtrust:zdd-message:validate
```

💡 Use verbose mode to see error details

```
$ bin/console yousign:zdd-message:validate -vv
$ bin/console youtrust:zdd-message:validate -vv
--- ------------------------------------------------------------------- ----------------
# Message ZDD Compliant?
--- ------------------------------------------------------------------- ----------------
1 Yousign\ZddMessageBundle\Tests\Fixtures\App\Messages\DummyMessage No ❌
1 Youtrust\ZddMessageBundle\Tests\Fixtures\App\Messages\DummyMessage No ❌
--- ------------------------------------------------------------------- ----------------

! [NOTE] 1 error(s) triggered.

------------------------------------------------------------------- --------------
Message Error
------------------------------------------------------------------- --------------
Yousign\ZddMessageBundle\Tests\Fixtures\App\Messages\DummyMessage Syntax error
Youtrust\ZddMessageBundle\Tests\Fixtures\App\Messages\DummyMessage Syntax error
------------------------------------------------------------------- --------------
```

Expand All @@ -187,7 +213,7 @@ $ make all

If you want to use your local fork to develop in your projects, you can use the link command to replace the vendor installation by your local version.
```bash
$ ./link /home/yousign/dev/my-project
$ ./link /home/youtrust/dev/my-project
```

## Authors
Expand Down
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"type": "library",
"name": "yousign/zdd-message-bundle",
"name": "youtrust/zdd-message-bundle",
"description": "Assert Zero Downtime Deployment compliance for messages",
"license": "MIT",
"keywords": ["dev", "zdd"],
"minimum-stability": "stable",
"prefer-stable": true,
"require": {
"php": "^8.4",
"php": "^8.3",
"symfony/console": "^7.4|^8.0"
},
"require-dev": {
Expand All @@ -21,12 +21,12 @@
},
"autoload": {
"psr-4": {
"Yousign\\ZddMessageBundle\\": "src/"
"Youtrust\\ZddMessageBundle\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Yousign\\ZddMessageBundle\\Tests\\": "tests/"
"Youtrust\\ZddMessageBundle\\Tests\\": "tests/"
}
}
}
10 changes: 5 additions & 5 deletions link
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ require __DIR__.'/vendor/autoload.php';
use Symfony\Component\Filesystem\Filesystem;

/**
* Links dependencies to components to a local clone of the Yousign/zdd-message-bundle GitHub repository.
* Links dependencies to components to a local clone of the Youtrust/zdd-message-bundle GitHub repository.
* Inspired by symfony/symfony and async-aws/aws
*/

$copy = false !== $k = array_search('--copy', $argv, true);
$copy && array_splice($argv, $k, 1);
$pathToProject = $argv[1] ?? getcwd();

if (!is_dir("$pathToProject/vendor/yousign/zdd-message-bundle")) {
echo 'Link (or copy) dependencies to components to a local clone of the main Yousign/zdd-message-bundle GitHub repository.'.PHP_EOL.PHP_EOL;
if (!is_dir("$pathToProject/vendor/youtrust/zdd-message-bundle")) {
echo 'Link (or copy) dependencies to components to a local clone of the main Youtrust/zdd-message-bundle GitHub repository.'.PHP_EOL.PHP_EOL;
echo "Usage: $argv[0] /path/to/the/project".PHP_EOL;
echo ' Use `--copy` to copy dependencies instead of symlink'.PHP_EOL.PHP_EOL;
echo "The directory \"$pathToProject\" does not exist or the dependencies are not installed, did you forget to run \"composer install\" in your project?".PHP_EOL;
Expand All @@ -31,9 +31,9 @@ $filesystem = new Filesystem();

$packages[json_decode(file_get_contents(__DIR__.'/composer.json'))->name] = __DIR__;

$dir = "$pathToProject/vendor/yousign/zdd-message-bundle";
$dir = "$pathToProject/vendor/youtrust/zdd-message-bundle";

$package = 'yousign/zdd-message-bundle';
$package = 'youtrust/zdd-message-bundle';
if (!$copy && is_link($dir)) {
echo "\"$package\" is already a symlink, skipping.".PHP_EOL;
exit;
Expand Down
2 changes: 1 addition & 1 deletion phpunit.xml.dist
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<ini name="error_reporting" value="-1"/>
<env name="SYMFONY_DEPRECATIONS_HELPER" value="max[direct]=0" />
<env name="APP_DEBUG" value="0"/>
<env name="KERNEL_CLASS" value="Yousign\ZddMessageBundle\Tests\Fixtures\App\AppKernel"/>
<env name="KERNEL_CLASS" value="Youtrust\ZddMessageBundle\Tests\Fixtures\App\AppKernel"/>
</php>

<testsuites>
Expand Down
10 changes: 5 additions & 5 deletions src/Assert/ZddMessageAsserter.php
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<?php

namespace Yousign\ZddMessageBundle\Assert;
namespace Youtrust\ZddMessageBundle\Assert;

use Yousign\ZddMessageBundle\Factory\Property;
use Yousign\ZddMessageBundle\Factory\PropertyList;
use Yousign\ZddMessageBundle\Serializer\SerializerInterface;
use Yousign\ZddMessageBundle\Serializer\UnableToDeserializeException;
use Youtrust\ZddMessageBundle\Factory\Property;
use Youtrust\ZddMessageBundle\Factory\PropertyList;
use Youtrust\ZddMessageBundle\Serializer\SerializerInterface;
use Youtrust\ZddMessageBundle\Serializer\UnableToDeserializeException;

/**
* @internal
Expand Down
12 changes: 6 additions & 6 deletions src/Command/GenerateZddMessageCommand.php
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<?php

namespace Yousign\ZddMessageBundle\Command;
namespace Youtrust\ZddMessageBundle\Command;

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Yousign\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Yousign\ZddMessageBundle\Factory\ZddMessageFactory;
use Yousign\ZddMessageBundle\Filesystem\ZddMessageFilesystem;
use Yousign\ZddMessageBundle\Serializer\SerializerInterface;
use Youtrust\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Youtrust\ZddMessageBundle\Factory\ZddMessageFactory;
use Youtrust\ZddMessageBundle\Filesystem\ZddMessageFilesystem;
use Youtrust\ZddMessageBundle\Serializer\SerializerInterface;

#[AsCommand(name: 'yousign:zdd-message:generate', description: 'Generate serialized version of managed messages to validate them afterwards.')]
#[AsCommand(name: 'youtrust:zdd-message:generate', description: 'Generate serialized version of managed messages to validate them afterwards.')]
final class GenerateZddMessageCommand extends Command
{
private ZddMessageFactory $zddMessageFactory;
Expand Down
6 changes: 3 additions & 3 deletions src/Command/ListZddMessageCommand.php
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<?php

namespace Yousign\ZddMessageBundle\Command;
namespace Youtrust\ZddMessageBundle\Command;

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Yousign\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Youtrust\ZddMessageBundle\Config\ZddMessageConfigInterface;

#[AsCommand(name: 'yousign:zdd-message:debug', description: 'List of managed messages to validate.')]
#[AsCommand(name: 'youtrust:zdd-message:debug', description: 'List of managed messages to validate.')]
final class ListZddMessageCommand extends Command
{
public function __construct(
Expand Down
14 changes: 7 additions & 7 deletions src/Command/ValidateZddMessageCommand.php
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
<?php

namespace Yousign\ZddMessageBundle\Command;
namespace Youtrust\ZddMessageBundle\Command;

use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Yousign\ZddMessageBundle\Assert\ZddMessageAsserter;
use Yousign\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Yousign\ZddMessageBundle\Factory\ZddMessageFactory;
use Yousign\ZddMessageBundle\Filesystem\ZddMessageFilesystem;
use Yousign\ZddMessageBundle\Serializer\SerializerInterface;
use Youtrust\ZddMessageBundle\Assert\ZddMessageAsserter;
use Youtrust\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Youtrust\ZddMessageBundle\Factory\ZddMessageFactory;
use Youtrust\ZddMessageBundle\Filesystem\ZddMessageFilesystem;
use Youtrust\ZddMessageBundle\Serializer\SerializerInterface;

#[AsCommand(name: 'yousign:zdd-message:validate', description: 'Validate the serialized version of managed messages with the current version.')]
#[AsCommand(name: 'youtrust:zdd-message:validate', description: 'Validate the serialized version of managed messages with the current version.')]
final class ValidateZddMessageCommand extends Command
{
private ZddMessageFactory $zddMessageFactory;
Expand Down
2 changes: 1 addition & 1 deletion src/Config/CustomMessageGeneratorInterface.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Yousign\ZddMessageBundle\Config;
namespace Youtrust\ZddMessageBundle\Config;

/**
* @experimental
Expand Down
2 changes: 1 addition & 1 deletion src/Config/ZddMessageConfigInterface.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Yousign\ZddMessageBundle\Config;
namespace Youtrust\ZddMessageBundle\Config;

interface ZddMessageConfigInterface
{
Expand Down
2 changes: 1 addition & 1 deletion src/Exceptions/InvalidTypeException.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Yousign\ZddMessageBundle\Exceptions;
namespace Youtrust\ZddMessageBundle\Exceptions;

class InvalidTypeException extends \Exception
{
Expand Down
4 changes: 2 additions & 2 deletions src/Exceptions/MissingValueForTypeException.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php

namespace Yousign\ZddMessageBundle\Exceptions;
namespace Youtrust\ZddMessageBundle\Exceptions;

use Yousign\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Youtrust\ZddMessageBundle\Config\ZddMessageConfigInterface;

class MissingValueForTypeException extends \Exception
{
Expand Down
8 changes: 4 additions & 4 deletions src/Factory/MessageGenerator.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

declare(strict_types=1);

namespace Yousign\ZddMessageBundle\Factory;
namespace Youtrust\ZddMessageBundle\Factory;

use Yousign\ZddMessageBundle\Config\CustomMessageGeneratorInterface;
use Yousign\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Yousign\ZddMessageBundle\Exceptions\MissingValueForTypeException;
use Youtrust\ZddMessageBundle\Config\CustomMessageGeneratorInterface;
use Youtrust\ZddMessageBundle\Config\ZddMessageConfigInterface;
use Youtrust\ZddMessageBundle\Exceptions\MissingValueForTypeException;

/**
* @internal
Expand Down
2 changes: 1 addition & 1 deletion src/Factory/Property.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Yousign\ZddMessageBundle\Factory;
namespace Youtrust\ZddMessageBundle\Factory;

final class Property
{
Expand Down
2 changes: 1 addition & 1 deletion src/Factory/PropertyList.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Yousign\ZddMessageBundle\Factory;
namespace Youtrust\ZddMessageBundle\Factory;

/**
* @internal
Expand Down
2 changes: 1 addition & 1 deletion src/Factory/ZddMessage.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php

namespace Yousign\ZddMessageBundle\Factory;
namespace Youtrust\ZddMessageBundle\Factory;

/**
* @internal
Expand Down
Loading
Loading