An Ansible module for patching JSON files
This Ansible module follows RFC 6901 for JSON notation and RFC 6902 for JSON patching.
In addition to the standard, there is an extra notation feature not outlined in RFC 6901: you can specify every member of an array with a * character in the path.
In order to make use of this module, download the json_patch.py file to the library directory in the root of your Ansible project:
myproject/
├── ansible.cfg
├── inv/
├── library/
│ ├── json_patch.py
├── playbooks/
├── roles/
The module json_patch takes the following options:
| Name | Description | Choices |
|---|---|---|
src |
The path to a file containing JSON | |
dest |
The path to an optional output file to write the patched JSON (default is to overwrite src file) |
|
operations |
A list of valid operations to perform against the given JSON file | See RFC 6902 |
backup |
Backup the JSON file (the one that will be overwritten) before editing (default: no) |
yes/no |
unsafe_writes |
Allow Ansible to fall back to unsafe (i.e. non-atomic) methods of writing files (default: no) |
yes/no |
pretty |
Write JSON output in human-readable format | yes/no |
create |
Create file if it does not exist | yes/no |
create_type |
Type of JSON structure to create if empty (default: object) |
object/array |
Operations may consist of two or more of the following properties:
| Name | Required | Value |
|---|---|---|
op |
yes | one of add, remove, replace, move, copy, or test |
path |
yes | RFC 6901 JSON notation |
from |
no | RFC 6901 JSON notation (only applies to move and copy) |
value |
no | any valid JSON value |
There are two special notations:
- The
-character refers to the end of an array (for appending a non-existent value) - (non-RFC 6901 compliant) The
*character may refer to every member of an array (for testing each member)
{
"foo": "bar"
}- name: Add or replace 'baz' member
json_patch:
src: "test.json"
operations:
- op: add
path: "/baz"
value: "quz"{
"foo": "bar",
"baz": "quz"
}[
{"foo": "bar", "baz": "quz"},
{"foo": "qux", "hello": "world"}
]- name: Remove the 'hello' property
json_patch:
src: "test.json"
operations:
- op: remove
path: "/1/hello"[
{"foo": "bar", "baz": "quz"},
{"foo": "qux"}
][
{
"foo": [
{"vegetable": "corn"},
{"vegetable": "broccoli"},
{"vegetable": "tomato"}
]
}
]- name: Ensure 'tomato' isn't listed as a vegetable
json_patch:
src: "test.json"
operations:
- op: replace
path: "/0/foo/2/vegetable"
value: "cauliflower"[
{
"foo": [
{"vegetable": "corn"},
{"vegetable": "broccoli"},
{"vegetable": "cauliflower"}
]
}
][
{"one": 1, "two": 2, "six": 6},
{"four": 4, "five": 5, "three": 3}
]- name: Move the numbers into their appropriate objects
json_patch:
src: "test.json"
operations:
- op: move
from: "/0/six"
path: "/1/six"
- op: move
from: "/1/three"
path: "/0/three"[
{"one": 1, "two": 2, "three": 3},
{"four": 4, "five": 5, "six": 6}
][
{"name": "The Shawshank Redemption", "rating": "good"},
{"name": "The Dark Knight", "rating": "bad"}
]- name: Correct the rating for The Dark Knight
json_patch:
src: "test.json"
backup: yes
operations:
- op: copy
from: "/0/rating"
path: "/1/rating"[
{"name": "The Shawshank Redemption", "rating": "good"},
{"name": "The Dark Knight", "rating": "good"}
]{
"name": "Ansible",
"gitPath": "/home/ubuntu/projects/ansible",
"enabled": true
}- name: Ensure the Ansible project is enabled
json_patch:
src: "test.json"
operations:
- op: test
path: "/enabled"
value: true{
"media": "/mnt/media",
"scan": [
{"movie": "Independence Day"},
{"movie": "The Sandlot"},
{"movie": "Bird Box"}
]
}- name: Add all of our movies to the list
json_patch:
src: "test.json"
operations:
- op: add
path: "/scan/-"
value:
movie: "{{ item }}"
with_items:
- "Se7en"
- "Firestarter"
- "The Last Samurai"
- "Fast and the Furious 17"{
"media": "/mnt/media",
"scan": [
{"movie": "Independence Day"},
{"movie": "The Sandlot"},
{"movie": "Bird Box"},
{"movie": "Se7en"},
{"movie": "Firestarter"},
{"movie": "The Last Samurai"},
{"movie": "Fast and the Furious 17"}
]
}{
"media": "/mnt/media",
"scan": [
{"movie": "Independence Day"},
{"movie": "The Sandlot"},
{"movie": "Bird Box"},
{"movie": "Se7en"},
{"movie": "Firestarter"},
{"movie": "The Last Samurai"},
{"movie": "Fast and the Furious 17"}
]
}- name: Ensure The Last Samurai is definitely in our list
json_patch:
src: "test.json"
operations:
- op: test
path: "/scan/*/movie"
value: "The Last Samurai"Testing is simple if you have pytest installed:
pytestNote you may have to copy the json_patch.py file into your Ansible installation's lib/ansible/modules/files/ dir.
PRs welcome! Just make sure you update tests as well.
Current needs:
- Special character handling (RFC 6901 - Syntax)
- Applying
*support to other operations:addshould affect every member of an arrayremoveshould remove the path from each member of an arrayreplaceshould replace for each member of an array
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent