Add test documentation for the component #21090
Open
+71
−0
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
Updates the documentation to document `JsonPathAssertionsTrait` and related constraints (closes symfony#20977). Complete the previous work done in symfony#21078.
e4e14e1 to
b1c2340
Compare
OskarStark
reviewed
Jun 17, 2025
javiereguiluz
approved these changes
Jun 18, 2025
| The trait provides the following assertion methods: | ||
|
|
||
| * :method:`Symfony\\Component\\JsonPath\\Test\\JsonPathAssertionsTrait::assertJsonPathCount` | ||
| Asserts that the number of elements found by the JSONPath expression matches an expected count:: |
There was a problem hiding this comment.
There's a minor RST syntax here. The contents of list items must use the same indentation and the code inside it must be indeneted by 4 spaces. E.g., the first item here should be:
* :method:`Symfony\\Component\\JsonPath\\Test\\JsonPathAssertionsTrait::assertJsonPathCount`
Asserts that the number of elements found by the JSONPath expression matches an expected count::
$json = '{"a": [1, 2, 3]}';
self::assertJsonPathCount(3, '$.a[*]', $json);| self::assertJsonPathCount(3, '$.a[*]', $json); | ||
|
|
||
| * :method:`Symfony\\Component\\JsonPath\\Test\\JsonPathAssertionsTrait::assertJsonPathEquals` | ||
| Asserts that the result of a JSONPath expression is equal (``==``) to an expected value. This assertion uses type coercion:: |
There was a problem hiding this comment.
I'd use this to make sure nobody misses this:
Asserts that the result of a JSONPath expression is equal to an expected value.
The comparison uses ``==`` (type coercion) instead of ``===``::
| self::assertJsonPathEquals(['1'], '$.a[0]', $json); | ||
|
|
||
| * :method:`Symfony\\Component\\JsonPath\\Test\\JsonPathAssertionsTrait::assertJsonPathNotEquals` | ||
| Asserts that the result of a JSONPath expression is not equal (``!=``) to an expected value:: |
There was a problem hiding this comment.
I'd do the same reword here as in the previous example of euqals.
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.
Updates the documentation to document
JsonPathAssertionsTraitand related constraints (closes #20977).Complete the previous work done in #21078.