[FEATURE] Make suppressed error levels for ErrorHandler configurable #5303
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
sbuerk
added a commit
to sbuerk/phpunit-documentation-english
that referenced
this pull request
Apr 8, 2023
This change adds the documentation for the recently added configuration options: * errorHandlerIgnoreSuppressedPhpDeprecations * errorHandlerIgnoreSuppressedPhpNotices * errorHandlerIgnoreSuppressedPhpWarnings * errorHandlerIgnoreSuppressedUserDeprecations * errorHandlerIgnoreSuppressedUserNotices * errorHandlerIgnoreSuppressedUserWarnings Related change sebastianbergmann/phpunit#5303
|
Prepared documentation part also in -> sebastianbergmann/phpunit-documentation-english#301 |
sbuerk
added a commit
to sbuerk/phpunit-documentation-english
that referenced
this pull request
Apr 9, 2023
This change adds the documentation for the recently added configuration options: * errorHandlerIgnoreSuppressedPhpDeprecations * errorHandlerIgnoreSuppressedPhpNotices * errorHandlerIgnoreSuppressedPhpWarnings * errorHandlerIgnoreSuppressedUserDeprecations * errorHandlerIgnoreSuppressedUserNotices * errorHandlerIgnoreSuppressedUserWarnings Related change sebastianbergmann/phpunit#5303
PHPUnit v10 changed how it handles notices, warnings, errors and deprecations. Therefore, converting them to exception has been removed in favour of display/fail options per type. Recently, the last missing piece for notices and deprecation has been added with: #5196: Optionally (fail|stop) on (notice|deprecation) events PHPUnit v9 (and possibly earlier versions) did not converted suppressed error levels to exceptions, if the corresponded old and removed option has been set. With PHPUnit v10, only native PHP error level (notices/strict,warnings,deprecated) are not handled if suppressed using the "@" suppress operator or by `error_reporting()` configuration. User error levels (notices,warnings,deprecation,error) are no longer suppressable. It's impossible to have only one defined set, which should be suppressable AND suppressed state regonized to suite all needs for framework, packages and applications using PHPUnit to test things. This **must** be configurable for users of the PHPUnit. This change adds configuration options to configure, which error levels are suppressable/suppressed state taking into account. Configuration is only provided through the PHPUnit configuration file. CLI options would not be really usefull, due "true" defauls - and therefore some options would be needed to be added "inverse". Having this only as XML options is more then suitable. Added xml configuration file options for: * (bool) errorHandlerIgnoreSuppressedPhpDeprecations [default: true] * (bool) errorHandlerIgnoreSuppressedPhpNotices [default: true] * (bool) errorHandlerIgnoreSuppressedPhpWarnings [default: true] * (bool) errorHandlerIgnoreSuppressedUserDeprecations [default: false] * (bool) errorHandlerIgnoreSuppressedUserNotices [default: false] * (bool) errorHandlerIgnoreSuppressedUserWarnings [default: false] **NOTE** ErrorLevels, which are configured to be ignored if suppressed, will not fail with corresponding `--fail-on-*` configuration/flag. On the other hand, this means that if suppressed ignore is configured, it will fail even if suppressed. E_USER_ERROR, e.g. triggered by using `trigger_error('', E_USER_ERROR)`, are not failing like php errors (E_ERROR). They always dispatches corresponding event. Additionally, there is no `--fail-on-error` flag which could control this for E_USER_ERROR. Therefore, E_USER_ERROR is left for now and should be targeted in a dedicated change. Furthermore, a couple of tests are added to cover the new options. Resolves #5302
Codecov Report
@@ Coverage Diff @@
## main #5303 +/- ##
============================================
+ Coverage 84.80% 84.88% +0.08%
- Complexity 6030 6050 +20
============================================
Files 650 650
Lines 19132 19210 +78
============================================
+ Hits 16224 16306 +82
+ Misses 2908 2904 -4
... and 1 file with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
sebastianbergmann
added
type/enhancement
|
Sorry for the delay - was full with work and needed time to test with the mentioned options. To be short, this pull-request does not make much sense IMO. So I would close it for now. |
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.
PHPUnit v10 changed how it handles notices, warnings, errors and deprecations. Therefore, converting them to exception has been removed in favour of display/fail options per type. Recently, the last missing piece for notices and deprecation has been added with:
#5196: Optionally (fail|stop) on (notice|deprecation) events
PHPUnit v9 (and possibly earlier versions) did not converted suppressed error levels to exceptions, if the corresponded old and removed option has been set. With PHPUnit v10, only native PHP error level (notices/strict,warnings,deprecated) are not handled if suppressed using the "@" suppress operator or by
error_reporting()configuration.User error levels (notices,warnings,deprecation,error) are no longer suppressable.
It's impossible to have only one defined set, which should be suppressable AND suppressed state regonized to suite all needs for framework, packages and applications using PHPUnit to test things. This must be configurable for users of the PHPUnit.
This change adds configuration options to configure, which error levels are suppressable/suppressed state taking into account. Configuration is only provided through the PHPUnit configuration file. CLI options would not be really usefull, due "true" defauls - and therefore some options would be needed to be added "inverse". Having this only as XML options is more then suitable.
Added xml configuration file options for:
NOTE ErrorLevels, which are configured to be ignored if
suppressed, will not fail with corresponding
--fail-on-*configuration/flag. On the other hand, this means that
if suppressed ignore is configured, it will fail even if
suppressed.
E_USER_ERROR, e.g. triggered by using
trigger_error('', E_USER_ERROR), are not failing like php errors (E_ERROR). They always dispatches corresponding event. Additionally, there is no--fail-on-errorflag which could control this for E_USER_ERROR. Therefore, E_USER_ERROR is left for now and should be targeted in a dedicated change.Furthermore, a couple of tests are added to cover the new options.
Resolves #5302