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
|
"""Function well-typedness test derived from IETF spec examples.
The test cases defined here are taken from version 11 of the JSONPath
internet draft, draft-ietf-jsonpath-base-11. In accordance with
https://trustee.ietf.org/license-info, Revised BSD License text
is included bellow.
See https://datatracker.ietf.org/doc/html/draft-ietf-jsonpath-base-20
Copyright (c) 2023 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.
""" # noqa: D205
import dataclasses
import operator
import pytest
from jsonpath import JSONPathEnvironment
from jsonpath.exceptions import JSONPathTypeError
from jsonpath.function_extensions import ExpressionType
from jsonpath.function_extensions import FilterFunction
from jsonpath.match import NodeList
@dataclasses.dataclass
class Case:
description: str
path: str
valid: bool
TEST_CASES = [
Case(
description="length, singular query, compared",
path="$[?length(@) < 3]",
valid=True,
),
Case(
description="length, non-singular query, compared",
path="$[?length(@.*) < 3]",
valid=False,
),
Case(
description="count, non-singular query, compared",
path="$[?count(@.*) == 1]",
valid=True,
),
Case(
description="count, int literal, compared",
path="$[?count(1) == 1]",
valid=False,
),
Case(
description="nested function, LogicalType -> NodesType",
path="$[?count(foo(@.*)) == 1]",
valid=True,
),
Case(
description="match, singular query, string literal",
path="$[?match(@.timezone, 'Europe/.*')]",
valid=True,
),
Case(
description="match, singular query, string literal, compared",
path="$[?match(@.timezone, 'Europe/.*') == true]",
valid=False,
),
Case(
description="value, non-singular query param, comparison",
path="$[?value(@..color) == 'red']",
valid=True,
),
Case(
description="value, non-singular query param",
path="$[?value(@..color)]",
valid=False,
),
Case(
description="function, singular query, value type param, logical return type",
path="$[?bar(@.a)]",
valid=True,
),
Case(
description=(
"function, non-singular query, value type param, logical return type"
),
path="$[?bar(@.*)]",
valid=False,
),
Case(
description=(
"function, non-singular query, nodes type param, logical return type"
),
path="$[?bn(@.*)]",
valid=True,
),
Case(
description=(
"function, non-singular query, logical type param, logical return type"
),
path="$[?bl(@.*)]",
valid=True,
),
Case(
description="function, logical type param, comparison, logical return type",
path="$[?bl(1==1)]",
valid=True,
),
Case(
description="function, logical type param, literal, logical return type",
path="$[?bl(1)]",
valid=False,
),
Case(
description="function, value type param, literal, logical return type",
path="$[?bar(1)]",
valid=True,
),
]
class MockFoo(FilterFunction):
arg_types = [ExpressionType.NODES]
return_type = ExpressionType.NODES
def __call__(self, nodes: NodeList) -> NodeList: # noqa: D102
return nodes
class MockBar(FilterFunction):
arg_types = [ExpressionType.VALUE]
return_type = ExpressionType.LOGICAL
def __call__(self) -> bool: # noqa: D102
return False
class MockBn(FilterFunction):
arg_types = [ExpressionType.NODES]
return_type = ExpressionType.LOGICAL
def __call__(self, _: object) -> bool: # noqa: D102
return False
class MockBl(FilterFunction):
arg_types = [ExpressionType.LOGICAL]
return_type = ExpressionType.LOGICAL
def __call__(self, _: object) -> bool: # noqa: D102
return False
@pytest.fixture()
def env() -> JSONPathEnvironment:
environment = JSONPathEnvironment()
environment.function_extensions["foo"] = MockFoo()
environment.function_extensions["bar"] = MockBar()
environment.function_extensions["bn"] = MockBn()
environment.function_extensions["bl"] = MockBl()
return environment
@pytest.mark.parametrize("case", TEST_CASES, ids=operator.attrgetter("description"))
def test_ietf_well_typedness(env: JSONPathEnvironment, case: Case) -> None:
if case.valid:
env.compile(case.path)
else:
with pytest.raises(JSONPathTypeError):
env.compile(case.path)
|
