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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
from functools import partial
from typing import Callable, List, Tuple
from graphql.utilities import build_schema
from graphql.validation import NoDeprecatedCustomRule
from .harness import assert_validation_errors
def build_assertions(
sdl_str: str,
) -> Tuple[Callable[[str], None], Callable[[str, List], None]]:
schema = build_schema(sdl_str)
assert_errors = partial(
assert_validation_errors, NoDeprecatedCustomRule, schema=schema
)
assert_valid = partial(assert_errors, errors=[])
return (
assert_valid,
assert_errors,
) # type: ignore
def describe_validate_no_deprecated():
def describe_no_deprecated_fields():
_assert_valid, _assert_errors = build_assertions(
"""
type Query {
normalField: String
deprecatedField: String @deprecated(reason: "Some field reason.")
}
"""
)
def ignores_fields_and_enum_values_that_are_not_deprecated():
_assert_valid(
"""
{
normalField
}
"""
)
def ignores_unknown_fields():
_assert_valid(
"""
{
unknownField
}
fragment UnknownFragment on UnknownType {
deprecatedField
}
"""
)
def reports_error_when_a_deprecated_field_is_selected():
message = (
"The field Query.deprecatedField is deprecated. Some field reason."
)
_assert_errors(
"""
{
deprecatedField
}
fragment QueryFragment on Query {
deprecatedField
}
""",
[
{
"message": message,
"locations": [(3, 19)],
},
{
"message": message,
"locations": [(7, 19)],
},
],
)
def describe_no_deprecated_arguments_on_fields():
_assert_valid, _assert_errors = build_assertions(
"""
type Query {
someField(
normalArg: String,
deprecatedArg: String @deprecated(reason: "Some arg reason."),
): String
}
"""
)
def ignores_arguments_that_are_not_deprecated():
_assert_valid(
"""
{
normalField(normalArg: "")
}
"""
)
def ignores_unknown_arguments():
_assert_valid(
"""
{
someField(unknownArg: "")
unknownField(deprecatedArg: "")
}
"""
)
def reports_error_when_a_deprecated_argument_is_used():
_assert_errors(
"""
{
someField(deprecatedArg: "")
}
""",
[
{
"message": "Field 'Query.someField' argument 'deprecatedArg'"
" is deprecated. Some arg reason.",
"locations": [(3, 31)],
}
],
)
def describe_no_deprecated_arguments_on_directives():
_assert_valid, _assert_errors = build_assertions(
"""
type Query {
someField: String
}
directive @someDirective(
normalArg: String,
deprecatedArg: String @deprecated(reason: "Some arg reason."),
) on FIELD
"""
)
def ignores_arguments_that_are_not_deprecated():
_assert_valid(
"""
{
someField @someDirective(normalArg: "")
}
"""
)
def ignores_unknown_arguments():
_assert_valid(
"""
{
someField @someDirective(unknownArg: "")
someField @unknownDirective(deprecatedArg: "")
}
"""
)
def reports_error_when_a_deprecated_argument_is_used():
_assert_errors(
"""
{
someField @someDirective(deprecatedArg: "")
}
""",
[
{
"message": "Directive '@someDirective' argument 'deprecatedArg'"
" is deprecated. Some arg reason.",
"locations": [(3, 44)],
}
],
)
def describe_no_deprecated_input_fields():
_assert_valid, _assert_errors = build_assertions(
"""
input InputType {
normalField: String
deprecatedField: String @deprecated(reason: "Some input field reason.")
}
type Query {
someField(someArg: InputType): String
}
directive @someDirective(someArg: InputType) on FIELD
"""
)
def ignores_input_fields_that_are_not_deprecated():
_assert_valid(
"""
{
someField(
someArg: { normalField: "" }
) @someDirective(someArg: { normalField: "" })
}
"""
)
def ignores_unknown_input_fields():
_assert_valid(
"""
{
someField(
someArg: { unknownField: "" }
)
someField(
unknownArg: { unknownField: "" }
)
unknownField(
unknownArg: { unknownField: "" }
)
}
"""
)
def reports_error_when_a_deprecated_input_field_is_used():
message = (
"The input field InputType.deprecatedField is deprecated."
" Some input field reason."
)
_assert_errors(
"""
{
someField(
someArg: { deprecatedField: "" }
) @someDirective(someArg: { deprecatedField: "" })
}
""",
[
{"message": message, "locations": [(4, 32)]},
{"message": message, "locations": [(5, 47)]},
],
)
def describe_no_deprecated_enum_values():
_assert_valid, _assert_errors = build_assertions(
"""
enum EnumType {
NORMAL_VALUE
DEPRECATED_VALUE @deprecated(reason: "Some enum reason.")
}
type Query {
someField(enumArg: EnumType): String
}
"""
)
def ignores_enum_values_that_are_not_deprecated():
_assert_valid(
"""
{
normalField(enumArg: NORMAL_VALUE)
}
"""
)
def ignores_unknown_enum_values():
_assert_valid(
"""
query (
$unknownValue: EnumType = UNKNOWN_VALUE
$unknownType: UnknownType = UNKNOWN_VALUE
) {
someField(enumArg: UNKNOWN_VALUE)
someField(unknownArg: UNKNOWN_VALUE)
unknownField(unknownArg: UNKNOWN_VALUE)
}
fragment SomeFragment on Query {
someField(enumArg: UNKNOWN_VALUE)
}
"""
)
def reports_error_when_a_deprecated_enum_value_is_used():
message = (
"The enum value 'EnumType.DEPRECATED_VALUE' is deprecated."
" Some enum reason."
)
_assert_errors(
"""
query (
$variable: EnumType = DEPRECATED_VALUE
) {
someField(enumArg: DEPRECATED_VALUE)
}
""",
[
{
"message": message,
"locations": [(3, 41)],
},
{
"message": message,
"locations": [(5, 38)],
},
],
)
|
