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
|
"""Test cases from rfc6902 examples.
Most of the test cases defined here are taken from rfc6902. The appropriate
Simplified BSD License is included below.
Copyright (c) 2013 IETF Trust and the persons identified as authors of the
code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
- Neither the name of Internet Society, IETF or IETF Trust, nor the names of
specific contributors, may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
"""
import copy
import dataclasses
import re
from operator import attrgetter
from typing import Dict
from typing import MutableMapping
from typing import MutableSequence
from typing import Union
import pytest
from jsonpath import JSONPatch
from jsonpath.exceptions import JSONPatchError
from jsonpath.exceptions import JSONPatchTestFailure
@dataclasses.dataclass
class Case:
description: str
data: Union[MutableSequence[object], MutableMapping[str, object]]
patch: JSONPatch
op: Dict[str, object]
want: Union[MutableSequence[object], MutableMapping[str, object]]
TEST_CASES = [
Case(
description="add an object member",
data={"foo": "bar"},
patch=JSONPatch().add(path="/baz", value="qux"),
op={"op": "add", "path": "/baz", "value": "qux"},
want={"foo": "bar", "baz": "qux"},
),
Case(
description="add an array element",
data={"foo": ["bar", "baz"]},
patch=JSONPatch().add(path="/foo/1", value="qux"),
op={"op": "add", "path": "/foo/1", "value": "qux"},
want={"foo": ["bar", "qux", "baz"]},
),
Case(
description="append to an array",
data={"foo": ["bar", "baz"]},
patch=JSONPatch().add(path="/foo/-", value="qux"),
op={"op": "add", "path": "/foo/-", "value": "qux"},
want={"foo": ["bar", "baz", "qux"]},
),
Case(
description="add to the root",
data={"foo": "bar"},
patch=JSONPatch().add(path="", value={"some": "thing"}),
op={"op": "add", "path": "", "value": {"some": "thing"}},
want={"some": "thing"},
),
Case(
description="remove an object member",
data={"baz": "qux", "foo": "bar"},
patch=JSONPatch().remove(path="/baz"),
op={"op": "remove", "path": "/baz"},
want={"foo": "bar"},
),
Case(
description="remove an array element",
data={"foo": ["bar", "qux", "baz"]},
patch=JSONPatch().remove(path="/foo/1"),
op={"op": "remove", "path": "/foo/1"},
want={"foo": ["bar", "baz"]},
),
Case(
description="replace an object member",
data={"baz": "qux", "foo": "bar"},
patch=JSONPatch().replace(path="/baz", value="boo"),
op={"op": "replace", "path": "/baz", "value": "boo"},
want={"baz": "boo", "foo": "bar"},
),
Case(
description="replace an array element",
data={"foo": [1, 2, 3]},
patch=JSONPatch().replace(path="/foo/0", value=9),
op={"op": "replace", "path": "/foo/0", "value": 9},
want={"foo": [9, 2, 3]},
),
Case(
description="move a value",
data={"foo": {"bar": "baz", "waldo": "fred"}, "qux": {"corge": "grault"}},
patch=JSONPatch().move(from_="/foo/waldo", path="/qux/thud"),
op={"op": "move", "from": "/foo/waldo", "path": "/qux/thud"},
want={"foo": {"bar": "baz"}, "qux": {"corge": "grault", "thud": "fred"}},
),
Case(
description="move an array element",
data={"foo": ["all", "grass", "cows", "eat"]},
patch=JSONPatch().move(from_="/foo/1", path="/foo/3"),
op={"op": "move", "from": "/foo/1", "path": "/foo/3"},
want={"foo": ["all", "cows", "eat", "grass"]},
),
Case(
description="copy a value",
data={"foo": {"bar": "baz", "waldo": "fred"}, "qux": {"corge": "grault"}},
patch=JSONPatch().copy(from_="/foo/waldo", path="/qux/thud"),
op={"op": "copy", "from": "/foo/waldo", "path": "/qux/thud"},
want={
"foo": {"bar": "baz", "waldo": "fred"},
"qux": {"corge": "grault", "thud": "fred"},
},
),
Case(
description="copy an array element",
data={"foo": ["all", "grass", "cows", "eat"]},
patch=JSONPatch().copy(from_="/foo/1", path="/foo/3"),
op={"op": "copy", "path": "/foo/3", "from": "/foo/1"},
want={"foo": ["all", "grass", "cows", "grass", "eat"]},
),
Case(
description="test a value",
data={"baz": "qux", "foo": ["a", 2, "c"]},
patch=JSONPatch().test(path="/baz", value="qux").test(path="/foo/1", value=2),
op={"op": "test", "path": "/baz", "value": "qux"},
want={"baz": "qux", "foo": ["a", 2, "c"]},
),
Case(
description="add a nested member object",
data={"foo": "bar"},
patch=JSONPatch().add(path="/child", value={"grandchild": {}}),
op={"op": "add", "path": "/child", "value": {"grandchild": {}}},
want={"foo": "bar", "child": {"grandchild": {}}},
),
Case(
description="add an array value",
data={"foo": ["bar"]},
patch=JSONPatch().add(path="/foo/-", value=["abc", "def"]),
op={"op": "add", "path": "/foo/-", "value": ["abc", "def"]},
want={"foo": ["bar", ["abc", "def"]]},
),
]
@pytest.mark.parametrize("case", TEST_CASES, ids=attrgetter("description"))
def test_rfc6902_examples(case: Case) -> None:
assert case.patch.apply(copy.deepcopy(case.data)) == case.want
def test_test_op_failure() -> None:
patch = JSONPatch().test(path="/baz", value="bar")
with pytest.raises(JSONPatchTestFailure, match=re.escape("test failed (test:0)")):
patch.apply({"baz": "qux"})
def test_add_to_nonexistent_target() -> None:
patch = JSONPatch().add(path="/baz/bat", value="qux")
with pytest.raises(
JSONPatchError, match=re.escape("pointer key error: 'baz' (add:0)")
):
patch.apply({"foo": "bar"})
def test_add_array_index_out_of_range() -> None:
patch = JSONPatch().add(path="/foo/7", value=99)
with pytest.raises(JSONPatchError, match=re.escape("index out of range (add:0)")):
patch.apply({"foo": [1, 2, 3]})
@pytest.mark.parametrize("case", TEST_CASES, ids=attrgetter("description"))
def test_json_patch_constructor(case: Case) -> None:
patch = JSONPatch([case.op])
assert len(patch.ops) == 1
assert patch.apply(copy.deepcopy(case.data)) == case.want
|
