Tests/Tokenizer: make failure messages more descriptive #310
Conversation
This file contains hidden or 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
Most Tokenizer tests first assert that the token `'code'` is correct and after that, that the token `'type'` is correct. When the first assertion fails, an error message like this will be displayed: `Failed asserting that 357 is identical to 313.` That's because the PHP native token constants are integers. And even if someone would memorize all token constant integers, the integer values are different depending on the PHP version being used. All in all, that makes error messages like the above hard to decipher. To mitigate this, a number of the Tokenizer tests already used the `$msg` parameter for the `assertSame()` call. This commit adds this `$msg` parameter to more assertions to make the failure messages actually useful. Includes introducing an interim `$tokenArray` variable in a lot of these tests to keep the line length in check.
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
Most Tokenizer tests first assert that the token
'code'is correct and after that, that the token'type'is correct. When the first assertion fails, an error message like this will be displayed:Failed asserting that 357 is identical to 313.That's because the PHP native token constants are integers. And even if someone would memorize all token constant integers, the integer values are different depending on the PHP version being used. All in all, that makes error messages like the above hard to decipher.
To mitigate this, a number of the Tokenizer tests already used the
$msgparameter for theassertSame()call.This commit adds this
$msgparameter to more assertions to make the failure messages actually useful.Includes introducing an interim
$tokenArrayvariable in a lot of these tests to keep the line length in check.Suggested changelog entry
N/A