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
|
# This file is part of Hypothesis, which may be found at
# https://github.com/HypothesisWorks/hypothesis/
#
# Copyright the Hypothesis Authors.
# Individual contributors are listed in AUTHORS.rst and the git log.
#
# This Source Code Form is subject to the terms of the Mozilla Public License,
# v. 2.0. If a copy of the MPL was not distributed with this file, You can
# obtain one at https://mozilla.org/MPL/2.0/.
import ast
import inspect
import subprocess
import sys
import textwrap
from types import ModuleType
import pytest
from hypothesis import example, given, note, strategies as st
from hypothesis.internal.compat import PYPY
from hypothesis.internal.constants_ast import (
Constants,
ConstantVisitor,
TooManyConstants,
_constants_file_str,
_constants_from_source,
constants_from_module,
is_local_module_file,
)
from tests.common.utils import skipif_emscripten, skipif_threading
constant_ints = st.integers(max_value=-101) | st.integers(min_value=101)
constant_floats = st.floats(allow_nan=False, allow_infinity=False)
constant_bytes = st.binary(min_size=1, max_size=50)
constant_strings = st.text(min_size=1, max_size=10).filter(lambda s: not s.isspace())
constants = constant_ints | constant_floats | constant_bytes | constant_strings
constants_classes = st.builds(
Constants,
integers=st.sets(constant_ints),
floats=st.sets(constant_floats),
bytes=st.sets(constant_bytes),
strings=st.sets(constant_strings),
)
def constants_from_ast(tree):
visitor = ConstantVisitor(limit=True)
visitor.visit(tree)
return visitor.constants
def test_constants_set_from_type_invalid():
with pytest.raises(ValueError):
Constants().set_for_type("not_a_type")
@given(st.integers())
def test_constants_contains(n):
assert n in Constants(integers={n})
@given(constants_classes)
def test_constants_not_equal_to_set(constants):
assert constants != set()
assert constants != set(constants)
@pytest.mark.parametrize(
"source, expected",
[
(
"""
a1 = 142
a2 = 3.14
a3 = 'test1'
a4 = b'test2'
a5 = (101, 102)
a6 = frozenset([103])
""",
{142, 3.14, 101, 102, 103, "test1", b"test2"},
),
(
"a = (101, (102, 103), frozenset([104, 105]))",
{101, 102, 103, 104, 105},
),
("a = {'b': 101}", {"b", 101}),
("a = [101]", {101}),
("a = +142", {142}),
("a = 101 + 102", {101, 102}),
("a = ~ 142", {142}),
# the following cases are ignored:
# * booleans
# * math.inf and math.nan (not constants, but we don't want to collect them
# even if they were)
# * f-strings
# * long strings
# * pure-whitespace strings
# * standalone string expressions (strings not assigned to a variable).
# This covers docstrings of all kinds.
# * small integers
# * the empty bytestring b""
("a = True", set()),
("a = False", set()),
("a = not False", set()),
("a = 1e999", set()),
("a = math.inf", set()),
("a = math.nan", set()),
('a = f"test {x}"', set()),
(f'a = "{"b" * 100}"', set()),
('a = ""', set()),
('a = " "', set()),
('a = "\\n \\n \\n"', set()),
("'test'", set()),
("'test with \\n newlines'", set()),
("a = 10", set()),
("a = -1", set()),
("a = b''", set()),
],
)
def test_constants_from_ast(source, expected):
source = textwrap.dedent(source)
tree = ast.parse(source)
assert set(constants_from_ast(tree)) == expected
@given(st.integers(max_value=-101))
def test_parses_negatives(n):
assert constants_from_ast(ast.parse(f"a = {n}")) == Constants(integers={n})
@given(st.tuples(constants))
def test_tuple_constants(value):
tree = ast.parse(str(value))
assert set(constants_from_ast(tree)) == set(value)
@given(st.frozensets(constants))
def test_frozenset_constants(value):
tree = ast.parse(str(value))
assert set(constants_from_ast(tree)) == set(value)
@skipif_threading
@skipif_emscripten
def test_constants_from_running_file(tmp_path):
p = tmp_path / "my_constants.py"
p.write_text(
textwrap.dedent(
"""
import sys
# stdlib
import json
# third-party
import pytest
import hypothesis
from hypothesis.internal.constants_ast import (
is_local_module_file,
constants_from_module,
Constants
)
# these modules are in fact detected as local if they are installed
# as editable (as is common for contributors). Prevent the ast constant
# logic from picking up on them
for module in sys.modules.copy():
if module.startswith("hypofuzz"):
del sys.modules[module]
constants = Constants()
for module in sys.modules.values():
if getattr(module, "__file__", None) is not None and is_local_module_file(
module.__file__
):
constants |= constants_from_module(module)
expected = Constants(
strings={'float', 'string', 'bytes', 'integer', 'test', 'hypofuzz', '__file__'},
floats={3.14},
bytes={b'test'},
integers={142, 101, 102, 103, 104},
)
assert constants == expected, set(constants).symmetric_difference(set(expected))
# local
a = 142
b = "test"
c = True
d = 3.14
e = b"test"
f = (101, 102)
g = frozenset([103, 104])
""",
),
encoding="utf-8",
)
# this test doubles as a regression test for
# https://github.com/HypothesisWorks/hypothesis/issues/4375. Fail on comparisons
# between bytes and str.
subprocess.check_call([sys.executable, "-bb", str(p)])
def test_constants_from_bad_module():
# covering test for the except branch
module = ModuleType("nonexistent")
assert constants_from_module(module) == Constants()
@pytest.mark.parametrize(
"path",
[
"/path/to/tests/module",
"/path/to/test/module",
"/a/test_file.py",
"/a/file_test.py",
],
)
def test_local_modules_ignores_test_modules(path):
assert not is_local_module_file(path)
@skipif_threading
@pytest.mark.skipif(PYPY, reason="no memory error on pypy")
def test_ignores_ast_parse_error(tmp_path):
p = tmp_path / "errors_on_parse.py"
p.write_text("[1, " * 200 + "]" * 200, encoding="utf-8")
module = ModuleType("<test_ignores_ast_parse_error>")
module.__file__ = str(p)
source = inspect.getsource(module)
with pytest.raises(MemoryError):
ast.parse(source)
assert constants_from_module(module) == Constants()
@example(
constants=Constants(
integers={-101, 101},
floats={101.0},
bytes=set(),
strings=set(),
),
)
@example(
constants=Constants(
integers={-101, 100},
floats={-101.0, 101.0},
bytes={b"-101.0", b"101.0"},
strings={"-101.0", "101.0"},
),
)
@given(constants_classes)
def test_constant_visitor_roundtrips_string(constants):
# our files in storage_directory("constants") rely on this roundtrip
visitor = ConstantVisitor(limit=True)
s = _constants_file_str(constants)
visitor.visit(ast.parse(s))
note(f"{constants=}")
note(f"{visitor.constants=}")
assert visitor.constants == constants
def test_too_many_constants():
visitor = ConstantVisitor(limit=True)
# start at n=1000 to avoid ConstantVisitor ignoring small integers
s = "; ".join(
f"n = {i}" for i in range(1000, 1000 + ConstantVisitor.CONSTANTS_LIMIT + 1)
)
# visitor should raise on too many constants
with pytest.raises(TooManyConstants):
visitor.visit(ast.parse(s))
# and also _constants_from_source should return empty on too many constants
assert _constants_from_source(s, limit=True) == Constants()
# but it parses fine with limit=False
visitor = ConstantVisitor(limit=False)
visitor.visit(ast.parse(s))
assert _constants_from_source(s, limit=False) == Constants(
integers=set(range(1000, 1000 + ConstantVisitor.CONSTANTS_LIMIT + 1))
)
@skipif_threading # concurrent writes to the same file
def test_module_too_large(tmp_path):
constant = 11231783
p = tmp_path / "large_file.py"
content = f"a = {constant}\n\n" + "#" * (512 * 1024 + 1)
p.write_text(content, encoding="utf-8")
module = ModuleType("large_module")
module.__file__ = str(p)
assert constants_from_module(module) == Constants()
assert constants_from_module(module, limit=False) == Constants(integers={constant})
|