UtilityMethodTestCase::getTargetToken(): add option to throw an exception... #248
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
…tion instead of failing the test By default, if the target token cannot be found, the `UtilityMethodTestCase::getTargetToken()` method will automatically fail the test. In a limited set of circumstances, however, it can be preferred for the method to throw a (catchable) exception instead. Case in point: finding a token which - depending on the PHPCS version used - may have a slightly different token content which could inhibit finding the target token in one go. In that case, it would be preferable for the method to throw a catchable exception, allowing the test to catch the exception and then to try finding the target token again with a slightly different content. To that end, a new `$failTest` parameter has been added which, when set to `false`, will direct the `UtilityMethodTestCase::getTargetToken()` method to throw a PHP native `RuntimeException` instead of marking the test as failed. Includes a test covering this new functionality.
jrfnl
deleted the
feature/utilitymethodtestcase-gettergettoken-extra-param
branch
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.
… instead of failing the test
By default, if the target token cannot be found, the
UtilityMethodTestCase::getTargetToken()method will automatically fail the test.In a limited set of circumstances, however, it can be preferred for the method to throw a (catchable) exception instead.
Case in point: finding a token which - depending on the PHPCS version used - may have a slightly different token content which could inhibit finding the target token in one go.
In that case, it would be preferable for the method to throw a catchable exception, allowing the test to catch the exception and then to try finding the target token again with a slightly different content.
To that end, a new
$failTestparameter has been added which, when set tofalse, will direct theUtilityMethodTestCase::getTargetToken()method to throw a PHP nativeRuntimeExceptioninstead of marking the test as failed.Includes a test covering this new functionality.