-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
/
test_guarded_eval.py
602 lines (445 loc) · 15.3 KB
/
test_guarded_eval.py
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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
from contextlib import contextmanager
from typing import NamedTuple
from functools import partial
from IPython.core.guarded_eval import (
EvaluationContext,
GuardRejection,
guarded_eval,
_unbind_method,
)
from IPython.testing import decorators as dec
import pytest
def create_context(evaluation: str, **kwargs):
return EvaluationContext(locals=kwargs, globals={}, evaluation=evaluation)
forbidden = partial(create_context, "forbidden")
minimal = partial(create_context, "minimal")
limited = partial(create_context, "limited")
unsafe = partial(create_context, "unsafe")
dangerous = partial(create_context, "dangerous")
LIMITED_OR_HIGHER = [limited, unsafe, dangerous]
MINIMAL_OR_HIGHER = [minimal, *LIMITED_OR_HIGHER]
@contextmanager
def module_not_installed(module: str):
import sys
try:
to_restore = sys.modules[module]
del sys.modules[module]
except KeyError:
to_restore = None
try:
yield
finally:
sys.modules[module] = to_restore
def test_external_not_installed():
"""
Because attribute check requires checking if object is not of allowed
external type, this tests logic for absence of external module.
"""
class Custom:
def __init__(self):
self.test = 1
def __getattr__(self, key):
return key
with module_not_installed("pandas"):
context = limited(x=Custom())
with pytest.raises(GuardRejection):
guarded_eval("x.test", context)
@dec.skip_without("pandas")
def test_external_changed_api(monkeypatch):
"""Check that the execution rejects if external API changed paths"""
import pandas as pd
series = pd.Series([1], index=["a"])
with monkeypatch.context() as m:
m.delattr(pd, "Series")
context = limited(data=series)
with pytest.raises(GuardRejection):
guarded_eval("data.iloc[0]", context)
@dec.skip_without("pandas")
def test_pandas_series_iloc():
import pandas as pd
series = pd.Series([1], index=["a"])
context = limited(data=series)
assert guarded_eval("data.iloc[0]", context) == 1
def test_rejects_custom_properties():
class BadProperty:
@property
def iloc(self):
return [None]
series = BadProperty()
context = limited(data=series)
with pytest.raises(GuardRejection):
guarded_eval("data.iloc[0]", context)
@dec.skip_without("pandas")
def test_accepts_non_overriden_properties():
import pandas as pd
class GoodProperty(pd.Series):
pass
series = GoodProperty([1], index=["a"])
context = limited(data=series)
assert guarded_eval("data.iloc[0]", context) == 1
@dec.skip_without("pandas")
def test_pandas_series():
import pandas as pd
context = limited(data=pd.Series([1], index=["a"]))
assert guarded_eval('data["a"]', context) == 1
with pytest.raises(KeyError):
guarded_eval('data["c"]', context)
@dec.skip_without("pandas")
def test_pandas_bad_series():
import pandas as pd
class BadItemSeries(pd.Series):
def __getitem__(self, key):
return "CUSTOM_ITEM"
class BadAttrSeries(pd.Series):
def __getattr__(self, key):
return "CUSTOM_ATTR"
bad_series = BadItemSeries([1], index=["a"])
context = limited(data=bad_series)
with pytest.raises(GuardRejection):
guarded_eval('data["a"]', context)
with pytest.raises(GuardRejection):
guarded_eval('data["c"]', context)
# note: here result is a bit unexpected because
# pandas `__getattr__` calls `__getitem__`;
# FIXME - special case to handle it?
assert guarded_eval("data.a", context) == "CUSTOM_ITEM"
context = unsafe(data=bad_series)
assert guarded_eval('data["a"]', context) == "CUSTOM_ITEM"
bad_attr_series = BadAttrSeries([1], index=["a"])
context = limited(data=bad_attr_series)
assert guarded_eval('data["a"]', context) == 1
with pytest.raises(GuardRejection):
guarded_eval("data.a", context)
@dec.skip_without("pandas")
def test_pandas_dataframe_loc():
import pandas as pd
from pandas.testing import assert_series_equal
data = pd.DataFrame([{"a": 1}])
context = limited(data=data)
assert_series_equal(guarded_eval('data.loc[:, "a"]', context), data["a"])
def test_named_tuple():
class GoodNamedTuple(NamedTuple):
a: str
pass
class BadNamedTuple(NamedTuple):
a: str
def __getitem__(self, key):
return None
good = GoodNamedTuple(a="x")
bad = BadNamedTuple(a="x")
context = limited(data=good)
assert guarded_eval("data[0]", context) == "x"
context = limited(data=bad)
with pytest.raises(GuardRejection):
guarded_eval("data[0]", context)
def test_dict():
context = limited(data={"a": 1, "b": {"x": 2}, ("x", "y"): 3})
assert guarded_eval('data["a"]', context) == 1
assert guarded_eval('data["b"]', context) == {"x": 2}
assert guarded_eval('data["b"]["x"]', context) == 2
assert guarded_eval('data["x", "y"]', context) == 3
assert guarded_eval("data.keys", context)
def test_set():
context = limited(data={"a", "b"})
assert guarded_eval("data.difference", context)
def test_list():
context = limited(data=[1, 2, 3])
assert guarded_eval("data[1]", context) == 2
assert guarded_eval("data.copy", context)
def test_dict_literal():
context = limited()
assert guarded_eval("{}", context) == {}
assert guarded_eval('{"a": 1}', context) == {"a": 1}
def test_list_literal():
context = limited()
assert guarded_eval("[]", context) == []
assert guarded_eval('[1, "a"]', context) == [1, "a"]
def test_set_literal():
context = limited()
assert guarded_eval("set()", context) == set()
assert guarded_eval('{"a"}', context) == {"a"}
def test_evaluates_if_expression():
context = limited()
assert guarded_eval("2 if True else 3", context) == 2
assert guarded_eval("4 if False else 5", context) == 5
def test_object():
obj = object()
context = limited(obj=obj)
assert guarded_eval("obj.__dir__", context) == obj.__dir__
@pytest.mark.parametrize(
"code,expected",
[
["int.numerator", int.numerator],
["float.is_integer", float.is_integer],
["complex.real", complex.real],
],
)
def test_number_attributes(code, expected):
assert guarded_eval(code, limited()) == expected
def test_method_descriptor():
context = limited()
assert guarded_eval("list.copy.__name__", context) == "copy"
class HeapType:
pass
class CallCreatesHeapType:
def __call__(self) -> HeapType:
return HeapType()
class CallCreatesBuiltin:
def __call__(self) -> frozenset:
return frozenset()
@pytest.mark.parametrize(
"data,good,bad,expected, equality",
[
[[1, 2, 3], "data.index(2)", "data.append(4)", 1, True],
[{"a": 1}, "data.keys().isdisjoint({})", "data.update()", True, True],
[CallCreatesHeapType(), "data()", "data.__class__()", HeapType, False],
[CallCreatesBuiltin(), "data()", "data.__class__()", frozenset, False],
],
)
def test_evaluates_calls(data, good, bad, expected, equality):
context = limited(data=data)
value = guarded_eval(good, context)
if equality:
assert value == expected
else:
assert isinstance(value, expected)
with pytest.raises(GuardRejection):
guarded_eval(bad, context)
@pytest.mark.parametrize(
"code,expected",
[
["(1\n+\n1)", 2],
["list(range(10))[-1:]", [9]],
["list(range(20))[3:-2:3]", [3, 6, 9, 12, 15]],
],
)
@pytest.mark.parametrize("context", LIMITED_OR_HIGHER)
def test_evaluates_complex_cases(code, expected, context):
assert guarded_eval(code, context()) == expected
@pytest.mark.parametrize(
"code,expected",
[
["1", 1],
["1.0", 1.0],
["0xdeedbeef", 0xDEEDBEEF],
["True", True],
["None", None],
["{}", {}],
["[]", []],
],
)
@pytest.mark.parametrize("context", MINIMAL_OR_HIGHER)
def test_evaluates_literals(code, expected, context):
assert guarded_eval(code, context()) == expected
@pytest.mark.parametrize(
"code,expected",
[
["-5", -5],
["+5", +5],
["~5", -6],
],
)
@pytest.mark.parametrize("context", LIMITED_OR_HIGHER)
def test_evaluates_unary_operations(code, expected, context):
assert guarded_eval(code, context()) == expected
@pytest.mark.parametrize(
"code,expected",
[
["1 + 1", 2],
["3 - 1", 2],
["2 * 3", 6],
["5 // 2", 2],
["5 / 2", 2.5],
["5**2", 25],
["2 >> 1", 1],
["2 << 1", 4],
["1 | 2", 3],
["1 & 1", 1],
["1 & 2", 0],
],
)
@pytest.mark.parametrize("context", LIMITED_OR_HIGHER)
def test_evaluates_binary_operations(code, expected, context):
assert guarded_eval(code, context()) == expected
@pytest.mark.parametrize(
"code,expected",
[
["2 > 1", True],
["2 < 1", False],
["2 <= 1", False],
["2 <= 2", True],
["1 >= 2", False],
["2 >= 2", True],
["2 == 2", True],
["1 == 2", False],
["1 != 2", True],
["1 != 1", False],
["1 < 4 < 3", False],
["(1 < 4) < 3", True],
["4 > 3 > 2 > 1", True],
["4 > 3 > 2 > 9", False],
["1 < 2 < 3 < 4", True],
["9 < 2 < 3 < 4", False],
["1 < 2 > 1 > 0 > -1 < 1", True],
["1 in [1] in [[1]]", True],
["1 in [1] in [[2]]", False],
["1 in [1]", True],
["0 in [1]", False],
["1 not in [1]", False],
["0 not in [1]", True],
["True is True", True],
["False is False", True],
["True is False", False],
["True is not True", False],
["False is not True", True],
],
)
@pytest.mark.parametrize("context", LIMITED_OR_HIGHER)
def test_evaluates_comparisons(code, expected, context):
assert guarded_eval(code, context()) == expected
def test_guards_comparisons():
class GoodEq(int):
pass
class BadEq(int):
def __eq__(self, other):
assert False
context = limited(bad=BadEq(1), good=GoodEq(1))
with pytest.raises(GuardRejection):
guarded_eval("bad == 1", context)
with pytest.raises(GuardRejection):
guarded_eval("bad != 1", context)
with pytest.raises(GuardRejection):
guarded_eval("1 == bad", context)
with pytest.raises(GuardRejection):
guarded_eval("1 != bad", context)
assert guarded_eval("good == 1", context) is True
assert guarded_eval("good != 1", context) is False
assert guarded_eval("1 == good", context) is True
assert guarded_eval("1 != good", context) is False
def test_guards_unary_operations():
class GoodOp(int):
pass
class BadOpInv(int):
def __inv__(self, other):
assert False
class BadOpInverse(int):
def __inv__(self, other):
assert False
context = limited(good=GoodOp(1), bad1=BadOpInv(1), bad2=BadOpInverse(1))
with pytest.raises(GuardRejection):
guarded_eval("~bad1", context)
with pytest.raises(GuardRejection):
guarded_eval("~bad2", context)
def test_guards_binary_operations():
class GoodOp(int):
pass
class BadOp(int):
def __add__(self, other):
assert False
context = limited(good=GoodOp(1), bad=BadOp(1))
with pytest.raises(GuardRejection):
guarded_eval("1 + bad", context)
with pytest.raises(GuardRejection):
guarded_eval("bad + 1", context)
assert guarded_eval("good + 1", context) == 2
assert guarded_eval("1 + good", context) == 2
def test_guards_attributes():
class GoodAttr(float):
pass
class BadAttr1(float):
def __getattr__(self, key):
assert False
class BadAttr2(float):
def __getattribute__(self, key):
assert False
context = limited(good=GoodAttr(0.5), bad1=BadAttr1(0.5), bad2=BadAttr2(0.5))
with pytest.raises(GuardRejection):
guarded_eval("bad1.as_integer_ratio", context)
with pytest.raises(GuardRejection):
guarded_eval("bad2.as_integer_ratio", context)
assert guarded_eval("good.as_integer_ratio()", context) == (1, 2)
@pytest.mark.parametrize("context", MINIMAL_OR_HIGHER)
def test_access_builtins(context):
assert guarded_eval("round", context()) == round
def test_access_builtins_fails():
context = limited()
with pytest.raises(NameError):
guarded_eval("this_is_not_builtin", context)
def test_rejects_forbidden():
context = forbidden()
with pytest.raises(GuardRejection):
guarded_eval("1", context)
def test_guards_locals_and_globals():
context = EvaluationContext(
locals={"local_a": "a"}, globals={"global_b": "b"}, evaluation="minimal"
)
with pytest.raises(GuardRejection):
guarded_eval("local_a", context)
with pytest.raises(GuardRejection):
guarded_eval("global_b", context)
def test_access_locals_and_globals():
context = EvaluationContext(
locals={"local_a": "a"}, globals={"global_b": "b"}, evaluation="limited"
)
assert guarded_eval("local_a", context) == "a"
assert guarded_eval("global_b", context) == "b"
@pytest.mark.parametrize(
"code",
["def func(): pass", "class C: pass", "x = 1", "x += 1", "del x", "import ast"],
)
@pytest.mark.parametrize("context", [minimal(), limited(), unsafe()])
def test_rejects_side_effect_syntax(code, context):
with pytest.raises(SyntaxError):
guarded_eval(code, context)
def test_subscript():
context = EvaluationContext(
locals={}, globals={}, evaluation="limited", in_subscript=True
)
empty_slice = slice(None, None, None)
assert guarded_eval("", context) == tuple()
assert guarded_eval(":", context) == empty_slice
assert guarded_eval("1:2:3", context) == slice(1, 2, 3)
assert guarded_eval(':, "a"', context) == (empty_slice, "a")
def test_unbind_method():
class X(list):
def index(self, k):
return "CUSTOM"
x = X()
assert _unbind_method(x.index) is X.index
assert _unbind_method([].index) is list.index
assert _unbind_method(list.index) is None
def test_assumption_instance_attr_do_not_matter():
"""This is semi-specified in Python documentation.
However, since the specification says 'not guaranteed
to work' rather than 'is forbidden to work', future
versions could invalidate this assumptions. This test
is meant to catch such a change if it ever comes true.
"""
class T:
def __getitem__(self, k):
return "a"
def __getattr__(self, k):
return "a"
def f(self):
return "b"
t = T()
t.__getitem__ = f
t.__getattr__ = f
assert t[1] == "a"
assert t[1] == "a"
def test_assumption_named_tuples_share_getitem():
"""Check assumption on named tuples sharing __getitem__"""
from typing import NamedTuple
class A(NamedTuple):
pass
class B(NamedTuple):
pass
assert A.__getitem__ == B.__getitem__
@dec.skip_without("numpy")
def test_module_access():
import numpy
context = limited(numpy=numpy)
assert guarded_eval("numpy.linalg.norm", context) == numpy.linalg.norm
context = minimal(numpy=numpy)
with pytest.raises(GuardRejection):
guarded_eval("np.linalg.norm", context)