1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
|
"""JSON Patch test cases."""
import json
import re
from collections.abc import Mapping
from io import StringIO
from typing import Any
from typing import Iterator
import pytest
from jsonpath import JSONPatch
from jsonpath import patch
from jsonpath.exceptions import JSONPatchError
class MockMapping(Mapping): # type: ignore
def __getitem__(self, __key: Any) -> Any:
return "foo"
def __iter__(self) -> Iterator[str]:
return iter(["foo"])
def __len__(self) -> int:
return 1
def test_add_to_immutable_mapping() -> None:
patch = JSONPatch().add("/foo/bar", "baz")
with pytest.raises(
JSONPatchError, match=re.escape("unexpected operation on 'MockMapping' (add:0)")
):
patch.apply({"foo": MockMapping()})
def test_remove_root() -> None:
patch = JSONPatch().remove("")
with pytest.raises(JSONPatchError, match=re.escape("can't remove root (remove:0)")):
patch.apply({"foo": "bar"})
def test_remove_nonexistent_value() -> None:
patch = JSONPatch().remove("/baz")
with pytest.raises(
JSONPatchError, match=re.escape("can't remove nonexistent property (remove:0)")
):
patch.apply({"foo": "bar"})
def test_remove_array_end() -> None:
patch = JSONPatch().remove("/foo/-")
with pytest.raises(
JSONPatchError, match=re.escape("can't remove nonexistent item (remove:0)")
):
patch.apply({"foo": [1, 2, 3]})
def test_remove_from_immutable_mapping() -> None:
patch = JSONPatch().remove("/bar/foo")
with pytest.raises(
JSONPatchError,
match=re.escape("unexpected operation on 'MockMapping' (remove:0)"),
):
patch.apply({"bar": MockMapping()})
def test_replace_root() -> None:
assert patch.apply(
[{"op": "replace", "path": "", "value": [1, 2, 3]}], {"foo": "bar"}
) == [1, 2, 3]
def test_replace_a_nonexistent_item() -> None:
with pytest.raises(
JSONPatchError, match=re.escape("can't replace nonexistent item (replace:0)")
):
patch.apply(
[{"op": "replace", "path": "/foo/99", "value": 5}], {"foo": [1, 2, 3]}
)
def test_replace_a_nonexistent_value() -> None:
with pytest.raises(
JSONPatchError,
match=re.escape("can't replace nonexistent property (replace:0)"),
):
patch.apply(
[{"op": "replace", "path": "/foo/bar", "value": 5}], {"foo": {"baz": 10}}
)
def test_replace_immutable_mapping() -> None:
with pytest.raises(
JSONPatchError,
match=re.escape("unexpected operation on 'MockMapping' (replace:0)"),
):
patch.apply(
[{"op": "replace", "path": "/bar/foo", "value": "baz"}],
{"bar": MockMapping()},
)
def test_move_to_child() -> None:
with pytest.raises(
JSONPatchError,
match=re.escape("can't move object to one of its own children (move:0)"),
):
patch.apply(
[{"op": "move", "from": "/foo/bar", "path": "/foo/bar/baz"}],
{"foo": {"bar": {"baz": [1, 2, 3]}}},
)
def test_move_nonexistent_value() -> None:
with pytest.raises(
JSONPatchError, match=re.escape("source object does not exist (move:0)")
):
JSONPatch().move(from_="/foo/bar", path="/bar").apply({"foo": {"baz": 1}})
def test_move_to_root() -> None:
patch = JSONPatch().move(from_="/foo", path="")
assert patch.apply({"foo": {"bar": "baz"}}) == {"bar": "baz"}
def test_move_to_immutable_mapping() -> None:
patch = JSONPatch().move(from_="/foo/bar", path="/baz/bar")
with pytest.raises(
JSONPatchError,
match=re.escape("unexpected operation on 'MockMapping' (move:0)"),
):
patch.apply({"foo": {"bar": "hello"}, "baz": MockMapping()})
def test_copy_nonexistent_value() -> None:
with pytest.raises(
JSONPatchError, match=re.escape("source object does not exist (copy:0)")
):
JSONPatch().copy(from_="/foo/bar", path="/bar").apply({"foo": {"baz": "hello"}})
def test_copy_to_root() -> None:
patch = JSONPatch().copy(from_="/foo/bar", path="")
assert patch.apply({"foo": {"bar": [1, 2, 3]}}) == [1, 2, 3]
def test_copy_to_immutable_mapping() -> None:
with pytest.raises(
JSONPatchError,
match=re.escape("unexpected operation on 'MockMapping' (copy:0)"),
):
JSONPatch().copy(from_="/foo/bar", path="/baz/bar").apply(
{"foo": {"bar": [1, 2, 3]}, "baz": MockMapping()}
)
def test_patch_from_file_like() -> None:
patch_doc = StringIO(
json.dumps(
[
{"op": "add", "path": "", "value": {"foo": {}}},
{"op": "add", "path": "/foo", "value": {"bar": []}},
{"op": "add", "path": "/foo/bar/-", "value": 1},
]
)
)
patch = JSONPatch(patch_doc)
assert patch.apply({}) == {"foo": {"bar": [1]}}
def test_patch_from_string() -> None:
patch_doc = json.dumps(
[
{"op": "add", "path": "", "value": {"foo": {}}},
{"op": "add", "path": "/foo", "value": {"bar": []}},
{"op": "add", "path": "/foo/bar/-", "value": 1},
]
)
patch = JSONPatch(patch_doc)
assert patch.apply({}) == {"foo": {"bar": [1]}}
def test_unexpected_patch_ops() -> None:
with pytest.raises(
JSONPatchError,
match=re.escape("expected a sequence of patch operations, found 'MockMapping'"),
):
JSONPatch(MockMapping()) # type: ignore
def test_construct_missing_op() -> None:
with pytest.raises(JSONPatchError, match=re.escape("missing 'op' member at op 0")):
JSONPatch([{}])
def test_construct_unknown_op() -> None:
msg = (
"expected 'op' to be one of 'add', 'remove', 'replace', "
"'move', 'copy' or 'test' (foo:0)"
)
with pytest.raises(JSONPatchError, match=re.escape(msg)):
JSONPatch([{"op": "foo"}])
def test_construct_missing_pointer() -> None:
msg = "missing property 'path' (add:0)"
with pytest.raises(JSONPatchError, match=re.escape(msg)):
JSONPatch([{"op": "add", "value": "foo"}])
def test_construct_missing_value() -> None:
msg = "missing property 'value' (add:0)"
with pytest.raises(JSONPatchError, match=re.escape(msg)):
JSONPatch([{"op": "add", "path": "/foo"}])
def test_construct_pointer_not_a_string() -> None:
msg = "expected a JSON Pointer string for 'path', found 'int' (add:0)"
with pytest.raises(JSONPatchError, match=re.escape(msg)):
JSONPatch([{"op": "add", "path": 5, "value": "foo"}])
def test_apply_to_str() -> None:
patch_doc = json.dumps(
[
{"op": "add", "path": "", "value": {"foo": {}}},
{"op": "add", "path": "/foo", "value": {"bar": []}},
{"op": "add", "path": "/foo/bar/-", "value": 1},
]
)
data_doc = json.dumps({})
assert patch.apply(patch_doc, data_doc) == {"foo": {"bar": [1]}}
def test_apply_to_file_like() -> None:
patch_doc = StringIO(
json.dumps(
[
{"op": "add", "path": "", "value": {"foo": {}}},
{"op": "add", "path": "/foo", "value": {"bar": []}},
{"op": "add", "path": "/foo/bar/-", "value": 1},
]
)
)
data_doc = StringIO(json.dumps({}))
assert patch.apply(patch_doc, data_doc) == {"foo": {"bar": [1]}}
def test_asdict() -> None:
patch_doc = [
{"op": "add", "path": "/foo/bar", "value": "foo"},
{"op": "remove", "path": "/foo/bar"},
{"op": "replace", "path": "/foo/bar", "value": "foo"},
{"op": "move", "from": "/baz/foo", "path": "/foo/bar"},
{"op": "copy", "from": "/baz/foo", "path": "/foo/bar"},
{"op": "test", "path": "/foo/bar", "value": "foo"},
]
patch = JSONPatch(patch_doc)
assert patch.asdicts() == patch_doc
def test_non_standard_addap_op() -> None:
# Index 7 is out of range and would raises a JSONPatchError with the `add` op.
patch = JSONPatch().addap(path="/foo/7", value=99)
assert patch.apply({"foo": [1, 2, 3]}) == {"foo": [1, 2, 3, 99]}
def test_add_to_mapping_with_int_key() -> None:
patch = JSONPatch().add(path="/1", value=99)
assert patch.apply({"foo": 1}) == {"foo": 1, "1": 99}
|
