-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
test_config_and_args.py
448 lines (363 loc) · 12.4 KB
/
test_config_and_args.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
"""Various tests for testing argument and config parsing."""
from __future__ import annotations
import ast
import subprocess
import sys
from pathlib import Path
import pytest
from flake8_async import Plugin, main
from .test_flake8_async import initialize_options
EXAMPLE_PY_TEXT = """import trio
with trio.move_on_after(10):
...
"""
EXAMPLE_PY_AUTOFIXED_TEXT = "import trio\n...\n"
EXAMPLE_PY_ERROR = (
"./example.py:2:6: ASYNC100 trio.move_on_after context contains no checkpoints,"
" remove the context or add `await trio.lowlevel.checkpoint()`.\n"
)
def write_examplepy(tmp_path: Path, text: str = EXAMPLE_PY_TEXT) -> None:
assert tmp_path.joinpath("example.py").write_text(text)
def assert_autofixed(tmp_path: Path, text: str = EXAMPLE_PY_AUTOFIXED_TEXT) -> None:
assert tmp_path.joinpath("example.py").read_text() == text
def assert_unchanged(tmp_path: Path, text: str = EXAMPLE_PY_TEXT) -> None:
assert tmp_path.joinpath("example.py").read_text() == text
def monkeypatch_argv(
monkeypatch: pytest.MonkeyPatch,
tmp_path: Path,
argv: list[Path | str] | None = None,
) -> None:
if argv is None:
argv = [tmp_path / "flake8-async", "./example.py"]
monkeypatch.chdir(tmp_path)
monkeypatch.setattr(sys, "argv", argv)
def test_run_flake8_async(tmp_path: Path):
write_examplepy(tmp_path)
res = subprocess.run(
[
"flake8-async",
"./example.py",
],
cwd=tmp_path,
capture_output=True,
check=False,
)
assert res.returncode == 1
assert not res.stderr
assert res.stdout == EXAMPLE_PY_ERROR.encode("ascii")
def test_systemexit_0(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
monkeypatch_argv(monkeypatch, tmp_path)
tmp_path.joinpath("example.py").write_text("")
with pytest.raises(SystemExit) as exc_info:
from flake8_async import __main__ # noqa: F401
assert exc_info.value.code == 0
out, err = capsys.readouterr()
assert not out
assert not err
def test_systemexit_1(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
write_examplepy(tmp_path)
monkeypatch_argv(monkeypatch, tmp_path)
with pytest.raises(SystemExit) as exc_info:
from flake8_async import __main__ # noqa: F401
assert exc_info.value.code == 1
out, err = capsys.readouterr()
assert out == EXAMPLE_PY_ERROR
assert not err
def test_run_in_git_repo(tmp_path: Path):
write_examplepy(tmp_path)
subprocess.run(["git", "init"], cwd=tmp_path, capture_output=True, check=True)
subprocess.run(["git", "add", "example.py"], cwd=tmp_path, check=True)
res = subprocess.run(
[
"flake8-async",
],
cwd=tmp_path,
capture_output=True,
check=False,
)
assert res.returncode == 1
assert not res.stderr
assert res.stdout == EXAMPLE_PY_ERROR.encode("ascii")
def test_run_no_git_repo(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
monkeypatch_argv(monkeypatch, tmp_path, [tmp_path / "flake8-async"])
assert main() == 1
out, err = capsys.readouterr()
assert err == "Doesn't seem to be a git repo; pass filenames to format.\n"
assert not out
def test_run_100_autofix(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
write_examplepy(tmp_path)
monkeypatch_argv(
monkeypatch,
tmp_path,
[tmp_path / "flake8-async", "--autofix=ASYNC", "./example.py"],
)
assert main() == 1
out, err = capsys.readouterr()
assert out == EXAMPLE_PY_ERROR
assert not err
assert_autofixed(tmp_path)
def test_114_raises_on_invalid_parameter(capsys: pytest.CaptureFixture[str]):
plugin = Plugin(ast.AST(), [])
# flake8 will reraise ArgumentError as SystemExit
for arg in "blah.foo", "foo*", "*":
with pytest.raises(SystemExit):
initialize_options(plugin, args=[f"--startable-in-context-manager={arg}"])
out, err = capsys.readouterr()
assert not out
assert f"{arg!r} is not a valid method identifier" in err
def test_200_options(capsys: pytest.CaptureFixture[str]):
plugin = Plugin(ast.AST(), [])
for i, arg in (0, "foo"), (2, "foo->->bar"), (2, "foo->bar->fee"):
with pytest.raises(SystemExit):
initialize_options(plugin, args=[f"--async200-blocking-calls={arg}"])
out, err = capsys.readouterr()
assert not out, out
assert all(word in err for word in (str(i), arg, "->"))
def test_anyio_from_config(tmp_path: Path, capsys: pytest.CaptureFixture[str]):
assert tmp_path.joinpath(".flake8").write_text(
"""
[flake8]
anyio = True
select = ASYNC220
"""
)
from flake8_async.visitors.visitor2xx import Visitor22X
err_msg = Visitor22X.error_codes["ASYNC220"].format(
"subprocess.Popen",
"[anyio/trio]",
)
err_file = Path(__file__).parent / "eval_files" / "anyio_trio.py"
# find the line with the expected error
for lineno, line in enumerate( # noqa: B007 # lineno not used in loop body
err_file.read_text().split("\n"), start=1
):
if "# ASYNC220: " in line:
break
else:
raise AssertionError("could not find error in file")
# construct the full error message
expected = f"{err_file}:{lineno}:5: ASYNC220 {err_msg}\n"
from flake8.main.cli import main
returnvalue = main(
argv=[
str(err_file),
"--config",
str(tmp_path / ".flake8"),
]
)
out, err = capsys.readouterr()
assert not err
assert expected == out
assert returnvalue == 1
# `code` parameter temporarily introduced to test deprecation of trio200-blocking-calls
def _test_async200_from_config_common(tmp_path: Path, code: str = "async200") -> str:
assert tmp_path.joinpath(".flake8").write_text(
f"""
[flake8]
{code}-blocking-calls =
other -> async,
sync_fns.* -> the_async_equivalent,
select = ASYNC200
extend-ignore = E
"""
)
assert tmp_path.joinpath("example.py").write_text(
"""
import sync_fns
async def foo():
sync_fns.takes_a_long_time()
"""
)
return (
"./example.py:5:5: ASYNC200 User-configured blocking sync call sync_fns.* "
"in async function, consider replacing with the_async_equivalent.\n"
)
def test_200_from_config_flake8_internals(
tmp_path: Path, capsys: pytest.CaptureFixture[str]
):
# abuse flake8 internals to avoid having to use subprocess
# which breaks breakpoints and hinders debugging
# TODO: fixture (?) to change working directory
EXAMPLE_PY_TEXT = _test_async200_from_config_common(tmp_path)
# replace ./ with tmp_path/
err_msg = str(tmp_path) + EXAMPLE_PY_TEXT[1:]
from flake8.main.cli import main
returnvalue = main(
argv=[
str(tmp_path / "example.py"),
"--append-config",
str(tmp_path / ".flake8"),
]
)
out, err = capsys.readouterr()
assert returnvalue == 1
assert not err
assert err_msg == out
def test_200_from_config_subprocess(tmp_path: Path):
err_msg = _test_async200_from_config_common(tmp_path)
res = subprocess.run(["flake8"], cwd=tmp_path, capture_output=True, check=False)
assert res.returncode == 1
assert not res.stderr
assert res.stdout == err_msg.encode("ascii")
def test_trio200_from_config_subprocess(tmp_path: Path):
err_msg = _test_async200_from_config_common(tmp_path, code="trio200")
res = subprocess.run(["flake8"], cwd=tmp_path, capture_output=True, check=False)
assert res.returncode == 1
assert res.stderr.endswith(
b"UserWarning: trio200-blocking-calls has been deprecated in favor of "
b"async200-blocking-calls\n warnings.warn(\n"
)
assert res.stdout == err_msg.encode("ascii")
def test_900_default_off(capsys: pytest.CaptureFixture[str]):
from flake8.main.cli import main
returnvalue = main(
argv=[
"tests/trio900.py",
]
)
out, err = capsys.readouterr()
assert returnvalue == 1
assert not err
assert "ASYNC900" not in out
def test_enable(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
write_examplepy(tmp_path)
argv: list[Path | str] = [tmp_path / "flake8-async", "./example.py"]
monkeypatch_argv(monkeypatch, tmp_path, argv)
def _helper(*args: str, error: bool = False, autofix: bool = False) -> None:
argv.extend(args)
main()
out, err = capsys.readouterr()
if error:
assert out == EXAMPLE_PY_ERROR
else:
assert not out
if autofix:
assert_autofixed(tmp_path)
write_examplepy(tmp_path)
else:
assert_unchanged(tmp_path)
assert not err
for _ in args:
argv.pop()
# default enable
_helper(error=True)
# explicit enable
_helper("--enable=ASYNC100", error=True)
# explicit enable other
_helper("--enable=ASYNC101")
# make sure commas don't enable others
_helper("--enable=ASYNC101,")
_helper("--enable=,")
_helper("--enable=ASYNC101,,ASYNC102")
# disable
_helper("--disable=ASYNC100")
# disable enabled code
_helper("--disable=ASYNC100", "--enable=ASYNC100")
# don't enable, but autofix
_helper(
"--enable=''",
"--autofix=ASYNC100",
error=True, # TODO: should be False
autofix=True,
)
_helper(
"--enable=''",
"--autofix=ASYNC100",
"--error-on-autofix",
error=True,
autofix=True,
)
def test_flake8_plugin_with_autofix_fails(tmp_path: Path):
write_examplepy(tmp_path)
res = subprocess.run(
[
"flake8",
"./example.py",
"--autofix=ASYNC",
],
cwd=tmp_path,
capture_output=True,
check=False,
)
assert res.returncode == 1
assert not res.stdout
assert res.stderr == b"Cannot autofix when run as a flake8 plugin.\n"
NOQA_TEXT = """import trio
with trio.move_on_after(10): ... # noqa
"""
NOQA_TEXT_AST = """import trio as foo # noqa"""
def test_noqa(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
write_examplepy(tmp_path, text=NOQA_TEXT)
monkeypatch_argv(monkeypatch, tmp_path)
assert main() == 0
def test_disable_noqa_cst(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
write_examplepy(tmp_path, text=NOQA_TEXT)
monkeypatch_argv(
monkeypatch,
tmp_path,
[tmp_path / "flake8-async", "./example.py", "--disable-noqa"],
)
assert main() == 1
out, err = capsys.readouterr()
assert not err
assert (
out == "./example.py:2:6: ASYNC100 trio.move_on_after context contains no"
" checkpoints, remove the context or add `await"
" trio.lowlevel.checkpoint()`.\n"
)
def test_disable_noqa_ast(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
):
write_examplepy(tmp_path, text=NOQA_TEXT_AST)
monkeypatch_argv(
monkeypatch,
tmp_path,
[tmp_path / "flake8-async", "./example.py", "--disable-noqa"],
)
assert main() == 1
out, err = capsys.readouterr()
assert not err
assert (
out
== "./example.py:1:1: ASYNC106 trio must be imported with `import trio` for the"
" linter to work.\n"
)
@pytest.mark.xfail(reason="flake8>=6 enforces three-letter error codes in config")
def test_config_ignore_error_code(tmp_path: Path) -> None:
assert tmp_path.joinpath(".flake8").write_text(
"""
[flake8]
ignore = ASYNC100
"""
)
res = subprocess.run(
["flake8", "--help"], cwd=tmp_path, capture_output=True, check=False
)
assert not res.stderr
assert res.returncode == 0
# but make sure we can disable selected codes
def test_config_disable_error_code(tmp_path: Path) -> None:
# select ASYNC200 and create file that induces ASYNC200
_test_async200_from_config_common(tmp_path)
# disable ASYNC200
with open(tmp_path.joinpath(".flake8"), "a", encoding="utf-8") as file:
file.write("disable = ASYNC200")
# it now returns no errors
res = subprocess.run(["flake8"], cwd=tmp_path, capture_output=True, check=True)
assert not res.stdout
assert not res.stderr
assert res.returncode == 0