[10.x] Add assertJsonPathCanonicalizing
method
#48117
Merged
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.
When testing API calls, I often have lots of tests that need to check if a json response contains all the expected ids without looking at the order of the ids in the response. For example, in a API call test that asserts if a querystring filter option works correctly, you will not (or not easily be able to) setup your expected models with fixed and known order in the response. That is currently not possible as
assertJsonPath
takes the order of the expected values into account.To fix this, this PR adds a dedicated json assertion. I used the "canonicalizing" suffix because that is what PHPUnit calls this kind of assertion. (But maybe someone knows a better, more Laravel-like 😅, name for this method?)