add json_patch, json_patch_recipe and json_diff filters #9565
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
This comment was marked as outdated.
This comment was marked as outdated.
ansibullbot
added
ci_verified
felixfontein
added
check-before-release
There was a problem hiding this comment.
Thanks for your contriubtion! I've added some first comments.
Can you also add integration tests (tests/integration/targets/filter_json_patch/; see for example tests/integration/targets/filter_jc/ for how to install the required library before running the tests)?
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
ansibullbot
added
integration
|
Many thanks for the valuabe input. I have addressed the - hopefully all - comments. The filter now accepts binary data (even if not possible to pass it from the play) and there is a Thanks |
felixfontein
approved these changes
Jan 18, 2025
felixfontein
removed
the
check-before-release
Backport to stable-10: 💚 backport PR created✅ Backport PR branch: Backported as #9597 🤖 @patchback |
patchback bot
pushed a commit
that referenced
this pull request
Jan 21, 2025
* add json_patch, json_patch_recipe and json_diff filters * fix copyright notices * fix documentation * fix docs, add maintainer * fix review remarks * add integration test * fix docs (positional) * add input validation * formatting fixes * more typing tweaks * documentation fix * fix review comments * simplicfy input checking * accept bytes and bytearray input * add the fail_test argument * fix docs format * fix typing hints * remove unneeded __future__ imports (cherry picked from commit f5c1b9c)
felixfontein
pushed a commit
that referenced
this pull request
Jan 21, 2025
…cipe and json_diff filters (#9597) add json_patch, json_patch_recipe and json_diff filters (#9565) * add json_patch, json_patch_recipe and json_diff filters * fix copyright notices * fix documentation * fix docs, add maintainer * fix review remarks * add integration test * fix docs (positional) * add input validation * formatting fixes * more typing tweaks * documentation fix * fix review comments * simplicfy input checking * accept bytes and bytearray input * add the fail_test argument * fix docs format * fix typing hints * remove unneeded __future__ imports (cherry picked from commit f5c1b9c) Co-authored-by: Stanislav Meduna <[email protected]>
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.
SUMMARY
The Ansible collections lack a good way to modify JSON data. This PR leverages the jsonpatch package and adds three filters implementing RFC 6902 operations on an object.
ISSUE TYPE
COMPONENT NAME
JavaScript Object Notation (JSON) Patch Filter
ADDITIONAL INFORMATION
There is a previous work done in the (https://github.com/ParticleDecay/ansible-jsonpatch) repo, but I think that the operations themselves should be available on arbitrary data, not just on files; a file modification can be added as a role if necessary.
I am a moderate Ansible user, but the first time contributor to Ansible collections, so if I forgot something, please kindly point out the deficiencies and I'll do my best to fix it.
Thanks for a great tool and great modules!