PHPUnit Bridge

Provides utilities for PHPUnit, especially user deprecation notices management.

It comes with the following features:

* enforce a consistent C locale; * auto-register class_exists to load Doctrine annotations; * print a user deprecation notices summary at the end of the test suite; * display the stack trace of a deprecation on-demand.

By default any non-legacy-tagged or any non-@-silenced deprecation notices will make tests fail. This can be changed by setting the SYMFONY_DEPRECATIONS_HELPER environment variable to the maximum number of deprecations that are allowed to be triggered before making the test suite fail. Alternatively, setting it to weak will make the bridge ignore any deprecation notices and is useful to projects that must use deprecated interfaces for backward compatibility reasons.

A summary of deprecation notices is displayed at the end of the test suite:

Unsilenced* reports deprecation notices that were triggered without the recommended @-silencing operator; Legacy* deprecation notices denote tests that explicitly test some legacy interfaces. There are four ways to mark a test as legacy:

- make its class start with the `Legacy` prefix;
- make its method start with `testLegacy`;
- make its data provider start with `provideLegacy` or `getLegacy`;
- add the `@group legacy` annotation to its class or method.

Remaining/Other* deprecation notices are all other (non-legacy) notices, grouped by message, test class and method.

Usage

Add this bridge to the require-dev section of your composer.json file (not in require) with e.g. composer require --dev "symfony/phpunit-bridge".

When running phpunit, you will see a summary of deprecation notices at the end of the test suite.

Deprecation notices in the Unsilenced section should just be @-silenced: @trigger_error('...', E_USER_DEPRECATED);. Without the @-silencing operator, users would need to opt-out from deprecation notices. Silencing by default swaps this behavior and allows users to opt-in when they are ready to cope with them (by adding a custom error handler like the one provided by this bridge.)

Deprecation notices in the Remaining/Other section need some thought. You have to decide either to:

* update your code to not use deprecated interfaces anymore, thus gaining better forward compatibility; or move them to theLegacy* section (by using one of the above way).

In case you need to inspect the stack trace of a particular deprecation triggered by your unit tests, you can set the SYMFONY_DEPRECATIONS_HELPER env var to a regular expression that matches this deprecation's message, encapsed between /. For example, SYMFONY_DEPRECATIONS_HELPER=/foobar/ phpunit will stop your test suite once a deprecation notice is triggered whose message contains the "foobar" string.