AbstractMethodUnitTest: improve finding of target token #531
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
These changes are similar to changes previously made in the same method in PHPCSUtils. As things were, there could be a situation where the `getTargetTokenFromFile()` method did not find the delimiter comment. In that case, the method would search for the target token starting at token 0, which would generally lead to an incorrect token being identified as the target token. This has now been fixed by verifying the outcome of the `findPrevious()` call and throwing an exception (causing the test to fail) when the delimiter comment was not found. Along the same lines, when the target token would not be found, an exception will now be thrown as well.
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.
Description
These changes are similar to changes previously made in the same method in PHPCSUtils.
As things were, there could be a situation where the
getTargetTokenFromFile()method did not find the delimiter comment. In that case, the method would search for the target token starting at token 0, which would generally lead to an incorrect token being identified as the target token.This has now been fixed by verifying the outcome of the
findPrevious()call and throwing an exception (causing the test to fail) when the delimiter comment was not found.Along the same lines, when the target token would not be found, an exception will now be thrown as well.
Suggested changelog entry
N/A (this is an internal use class, if external standards want to use a base class for testing utility methods, they should use the PHPCSUtils
UtilityMethodTestCase).Related issues/external references