Tests: fail on deprecation notices #265
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This (small) change needs a little explaining.... First of all, the `setup-php` action, by default uses a "production"-type ini file. This means that `error_reporting` is set to `E_ALL & ~E_DEPRECATED & ~E_STRICT` and `display_errors` is set to `Off`. For the purposes of CI, I'd recommend running with `-1` (always include all error levels on all PHP versions) and `display_errors=On` to ensure **all** PHP notices are shown. This is now fixed by adding the `ini-values` setting to `setup-php`. I've also made minor other tweaks to the `setup-php` config: * `tools: composer` is not needed as Composer is installed by default. * `extension: xdebug` is not the correct way to enable `xdebug` for code coverage. `coverage: xdebug` is (and is Xdebug cross-version compatible for Xdebug 2 and 3). Second of all, a change was made in PHPUnit 8.5.21 and 9.5.10, which changes the default value of the PHPUnit `convertDeprecationsToExceptions` attribute from `true` to `false`, meaning that tests would no longer fail on deprecation notices. Not great for open source packages which generally need to handle deprecations in a timely matter so as not to block other packages. So adding the `convertDeprecationsToExceptions` attribute and explicitly setting the value to `true` brings back the old behaviour and will allow for failing the tests on deprecation notices.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This (small) change needs a little explaining....
First of all, the
setup-phpaction, by default uses a "production"-type ini file. This means thaterror_reportingis set toE_ALL & ~E_DEPRECATED & ~E_STRICTanddisplay_errorsis set toOff.For the purposes of CI, I'd recommend running with
-1(always include all error levels on all PHP versions) anddisplay_errors=Onto ensure all PHP notices are shown.This is now fixed by adding the
ini-valuessetting tosetup-php.I've also made minor other tweaks to the
setup-phpconfig:tools: composeris not needed as Composer is installed by default.extension: xdebugis not the correct way to enablexdebugfor code coverage.coverage: xdebugis (and is Xdebug cross-version compatible for Xdebug 2 and 3).Second of all, a change was made in PHPUnit 8.5.21 and 9.5.10, which changes the default value of the PHPUnit
convertDeprecationsToExceptionsattribute fromtruetofalse, meaning that tests would no longer fail on deprecation notices.Not great for open source packages which generally need to handle deprecations in a timely matter so as not to block other packages.
So adding the
convertDeprecationsToExceptionsattribute and explicitly setting the value totruebrings back the old behaviour and will allow for failing the tests on deprecation notices.