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
|
from functools import partial
from graphql.validation import NoUnusedVariablesRule
from .harness import assert_validation_errors
assert_errors = partial(assert_validation_errors, NoUnusedVariablesRule)
assert_valid = partial(assert_errors, errors=[])
def describe_validate_no_unused_variables():
def uses_all_variables():
assert_valid(
"""
query ($a: String, $b: String, $c: String) {
field(a: $a, b: $b, c: $c)
}
"""
)
def uses_all_variables_deeply():
assert_valid(
"""
query Foo($a: String, $b: String, $c: String) {
field(a: $a) {
field(b: $b) {
field(c: $c)
}
}
}
"""
)
def uses_all_variables_deeply_in_inline_fragments():
assert_valid(
"""
query Foo($a: String, $b: String, $c: String) {
... on Type {
field(a: $a) {
field(b: $b) {
... on Type {
field(c: $c)
}
}
}
}
}
"""
)
def uses_all_variables_in_fragment():
assert_valid(
"""
query Foo($a: String, $b: String, $c: String) {
...FragA
}
fragment FragA on Type {
field(a: $a) {
...FragB
}
}
fragment FragB on Type {
field(b: $b) {
...FragC
}
}
fragment FragC on Type {
field(c: $c)
}
"""
)
def variable_used_by_fragment_in_multiple_operations():
assert_valid(
"""
query Foo($a: String) {
...FragA
}
query Bar($b: String) {
...FragB
}
fragment FragA on Type {
field(a: $a)
}
fragment FragB on Type {
field(b: $b)
}
"""
)
def variable_used_by_recursive_fragment():
assert_valid(
"""
query Foo($a: String) {
...FragA
}
fragment FragA on Type {
field(a: $a) {
...FragA
}
}
"""
)
def variable_not_used():
assert_errors(
"""
query ($a: String, $b: String, $c: String) {
field(a: $a, b: $b)
}
""",
[{"message": "Variable '$c' is never used.", "locations": [(2, 44)]}],
)
def multiple_variables_not_used():
assert_errors(
"""
query Foo($a: String, $b: String, $c: String) {
field(b: $b)
}
""",
[
{
"message": "Variable '$a' is never used in operation 'Foo'.",
"locations": [(2, 23)],
},
{
"message": "Variable '$c' is never used in operation 'Foo'.",
"locations": [(2, 47)],
},
],
)
def variable_not_used_in_fragments():
assert_errors(
"""
query Foo($a: String, $b: String, $c: String) {
...FragA
}
fragment FragA on Type {
field(a: $a) {
...FragB
}
}
fragment FragB on Type {
field(b: $b) {
...FragC
}
}
fragment FragC on Type {
field
}
""",
[
{
"message": "Variable '$c' is never used in operation 'Foo'.",
"locations": [(2, 47)],
},
],
)
def multiple_variables_not_used_in_fragments():
assert_errors(
"""
query Foo($a: String, $b: String, $c: String) {
...FragA
}
fragment FragA on Type {
field {
...FragB
}
}
fragment FragB on Type {
field(b: $b) {
...FragC
}
}
fragment FragC on Type {
field
}
""",
[
{
"message": "Variable '$a' is never used in operation 'Foo'.",
"locations": [(2, 23)],
},
{
"message": "Variable '$c' is never used in operation 'Foo'.",
"locations": [(2, 47)],
},
],
)
def variable_not_used_by_unreferenced_fragment():
assert_errors(
"""
query Foo($b: String) {
...FragA
}
fragment FragA on Type {
field(a: $a)
}
fragment FragB on Type {
field(b: $b)
}
""",
[
{
"message": "Variable '$b' is never used in operation 'Foo'.",
"locations": [(2, 23)],
},
],
)
def variable_not_used_by_fragment_used_by_other_operation():
assert_errors(
"""
query Foo($b: String) {
...FragA
}
query Bar($a: String) {
...FragB
}
fragment FragA on Type {
field(a: $a)
}
fragment FragB on Type {
field(b: $b)
}
""",
[
{
"message": "Variable '$b' is never used in operation 'Foo'.",
"locations": [(2, 23)],
},
{
"message": "Variable '$a' is never used in operation 'Bar'.",
"locations": [(5, 23)],
},
],
)
|