-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
Copy pathunittest_lint.py
1279 lines (1087 loc) · 42 KB
/
unittest_lint.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
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/pylint-dev/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/pylint-dev/pylint/blob/main/CONTRIBUTORS.txt
# pylint: disable=redefined-outer-name
from __future__ import annotations
import argparse
import os
import re
import sys
import tempfile
from collections.abc import Iterator
from contextlib import contextmanager
from io import StringIO
from os import chdir, getcwd
from os.path import abspath, dirname, join, sep
from pathlib import Path
from shutil import copy, rmtree
from unittest import mock
import astroid
import platformdirs
import pytest
from astroid import nodes
from pytest import CaptureFixture
from pylint import checkers, constants, exceptions, interfaces, lint, testutils
from pylint.checkers.utils import only_required_for_messages
from pylint.constants import (
MSG_STATE_CONFIDENCE,
MSG_STATE_SCOPE_CONFIG,
MSG_STATE_SCOPE_MODULE,
PYLINT_HOME,
_get_pylint_home,
)
from pylint.exceptions import InvalidMessageError
from pylint.lint import PyLinter, expand_modules
from pylint.message import Message
from pylint.reporters import text
from pylint.testutils import create_files
from pylint.testutils._run import _Run as Run
from pylint.typing import MessageLocationTuple
from pylint.utils import (
FileState,
LinterStats,
print_full_documentation,
tokenize_module,
)
if os.name == "java":
if os.name == "nt":
HOME = "USERPROFILE"
else:
HOME = "HOME"
elif sys.platform == "win32":
HOME = "USERPROFILE"
else:
HOME = "HOME"
@contextmanager
def fake_home() -> Iterator[str]:
folder = tempfile.mkdtemp("fake-home")
old_home = os.environ.get(HOME)
try:
os.environ[HOME] = folder
yield folder
finally:
os.environ.pop("PYLINTRC", "")
if old_home is None:
del os.environ[HOME]
else:
os.environ[HOME] = old_home
rmtree(folder, ignore_errors=True)
def remove(file: str) -> None:
try:
os.remove(file)
except OSError:
pass
HERE = abspath(dirname(__file__))
INPUT_DIR = join(HERE, "..", "input")
REGRTEST_DATA_DIR = join(HERE, "..", "regrtest_data")
DATA_DIR = join(HERE, "..", "data")
@contextmanager
def tempdir() -> Iterator[str]:
"""Create a temp directory and change the current location to it.
This is supposed to be used with a *with* statement.
"""
tmp = tempfile.mkdtemp()
# Get real path of tempfile, otherwise test fail on mac os x
current_dir = getcwd()
chdir(tmp)
abs_tmp = abspath(".")
try:
yield abs_tmp
finally:
chdir(current_dir)
rmtree(abs_tmp)
@pytest.fixture
def fake_path() -> Iterator[list[str]]:
orig = list(sys.path)
fake = ["1", "2", "3"]
sys.path[:] = fake
yield fake
sys.path[:] = orig
def test_no_args(fake_path: list[str]) -> None:
with lint.augmented_sys_path([]):
assert sys.path == fake_path
assert sys.path == fake_path
@pytest.mark.parametrize(
"case", [["a/b/"], ["a/b"], ["a/b/__init__.py"], ["a/"], ["a"]]
)
def test_one_arg(fake_path: list[str], case: list[str]) -> None:
with tempdir() as chroot:
create_files(["a/b/__init__.py"])
expected = [join(chroot, "a"), *fake_path]
extra_sys_paths = [
path
for arg in case
for path in expand_modules.discover_package_path(arg, [])
]
assert sys.path == fake_path
with lint.augmented_sys_path(extra_sys_paths):
assert sys.path == expected
assert sys.path == fake_path
@pytest.mark.parametrize(
"case",
[
["a/b", "a/c"],
["a/c/", "a/b/"],
["a/b/__init__.py", "a/c/__init__.py"],
["a", "a/c/__init__.py"],
],
)
def test_two_similar_args(fake_path: list[str], case: list[str]) -> None:
with tempdir() as chroot:
create_files(["a/b/__init__.py", "a/c/__init__.py"])
expected = [join(chroot, "a"), *fake_path]
extra_sys_paths = [
path
for arg in case
for path in expand_modules.discover_package_path(arg, [])
]
assert sys.path == fake_path
with lint.augmented_sys_path(extra_sys_paths):
assert sys.path == expected
assert sys.path == fake_path
@pytest.mark.parametrize(
"case",
[
["a/b/c/__init__.py", "a/d/__init__.py", "a/e/f.py"],
["a/b/c", "a", "a/e"],
["a/b/c", "a", "a/b/c", "a/e", "a"],
],
)
def test_more_args(fake_path: list[str], case: list[str]) -> None:
with tempdir() as chroot:
create_files(["a/b/c/__init__.py", "a/d/__init__.py", "a/e/f.py"])
expected = [
join(chroot, suffix)
for suffix in (sep.join(("a", "b")), "a", sep.join(("a", "e")))
] + fake_path
extra_sys_paths = [
path
for arg in case
for path in expand_modules.discover_package_path(arg, [])
]
assert sys.path == fake_path
with lint.augmented_sys_path(extra_sys_paths):
assert sys.path == expected
assert sys.path == fake_path
@pytest.fixture(scope="module")
def disable() -> list[str]:
return ["I"]
@pytest.fixture(scope="module")
def reporter() -> type[testutils.GenericTestReporter]:
return testutils.GenericTestReporter
@pytest.fixture
def initialized_linter(linter: PyLinter) -> PyLinter:
linter.open()
linter.set_current_module("long_test_file", "long_test_file")
linter.file_state = FileState(
"long_test_file",
linter.msgs_store,
linter.get_ast(
str(join(REGRTEST_DATA_DIR, "long_test_file.py")), "long_test_file"
),
)
return linter
def test_pylint_visit_method_taken_in_account(linter: PyLinter) -> None:
class CustomChecker(checkers.BaseChecker):
name = "custom"
msgs = {"W9999": ("", "custom", "")}
@only_required_for_messages("custom")
def visit_class(self, _: nodes.ClassDef) -> None:
pass
linter.register_checker(CustomChecker(linter))
linter.open()
out = StringIO()
linter.set_reporter(text.TextReporter(out))
linter.check(["abc"])
def test_enable_message(initialized_linter: PyLinter) -> None:
linter = initialized_linter
assert linter.is_message_enabled("W0101")
assert linter.is_message_enabled("W0102")
linter.disable("W0101", scope="package")
linter.disable("W0102", scope="module", line=1)
assert not linter.is_message_enabled("W0101")
assert not linter.is_message_enabled("W0102", 1)
linter.set_current_module("tutu")
assert not linter.is_message_enabled("W0101")
assert linter.is_message_enabled("W0102")
linter.enable("W0101", scope="package")
linter.enable("W0102", scope="module", line=1)
assert linter.is_message_enabled("W0101")
assert linter.is_message_enabled("W0102", 1)
def test_enable_message_category(initialized_linter: PyLinter) -> None:
linter = initialized_linter
assert linter.is_message_enabled("W0101")
assert linter.is_message_enabled("C0202")
linter.disable("W", scope="package")
linter.disable("C", scope="module", line=1)
assert not linter.is_message_enabled("W0101")
assert linter.is_message_enabled("C0202")
assert not linter.is_message_enabled("C0202", line=1)
linter.set_current_module("tutu")
assert not linter.is_message_enabled("W0101")
assert linter.is_message_enabled("C0202")
linter.enable("W", scope="package")
linter.enable("C", scope="module", line=1)
assert linter.is_message_enabled("W0101")
assert linter.is_message_enabled("C0202")
assert linter.is_message_enabled("C0202", line=1)
def test_message_state_scope(initialized_linter: PyLinter) -> None:
class FakeConfig(argparse.Namespace):
confidence = ["HIGH"]
linter = initialized_linter
linter.disable("C0202")
assert MSG_STATE_SCOPE_CONFIG == linter._get_message_state_scope("C0202")
linter.disable("W0101", scope="module", line=3)
assert MSG_STATE_SCOPE_CONFIG == linter._get_message_state_scope("C0202")
assert MSG_STATE_SCOPE_MODULE == linter._get_message_state_scope("W0101", 3)
linter.enable("W0102", scope="module", line=3)
assert MSG_STATE_SCOPE_MODULE == linter._get_message_state_scope("W0102", 3)
linter.config = FakeConfig()
assert MSG_STATE_CONFIDENCE == linter._get_message_state_scope(
"this-is-bad", confidence=interfaces.INFERENCE
)
def test_enable_message_block(initialized_linter: PyLinter) -> None:
linter = initialized_linter
linter.open()
filepath = join(REGRTEST_DATA_DIR, "func_block_disable_msg.py")
linter.set_current_module("func_block_disable_msg")
astroid = linter.get_ast(filepath, "func_block_disable_msg")
linter.file_state = FileState("func_block_disable_msg", linter.msgs_store, astroid)
linter.process_tokens(tokenize_module(astroid))
fs = linter.file_state
# global (module level)
assert linter.is_message_enabled("W0613")
assert linter.is_message_enabled("E1101")
# meth1
assert linter.is_message_enabled("W0613", 13)
# meth2
assert not linter.is_message_enabled("W0613", 18)
# meth3
assert not linter.is_message_enabled("E1101", 24)
assert linter.is_message_enabled("E1101", 26)
# meth4
assert not linter.is_message_enabled("E1101", 32)
assert linter.is_message_enabled("E1101", 36)
# meth5
assert not linter.is_message_enabled("E1101", 42)
assert not linter.is_message_enabled("E1101", 43)
assert linter.is_message_enabled("E1101", 46)
assert not linter.is_message_enabled("E1101", 49)
assert not linter.is_message_enabled("E1101", 51)
# meth6
assert not linter.is_message_enabled("E1101", 57)
assert linter.is_message_enabled("E1101", 61)
assert linter.is_message_enabled("E1101", 64)
assert not linter.is_message_enabled("E1101", 66)
assert linter.is_message_enabled("E0602", 57)
assert linter.is_message_enabled("E0602", 61)
assert not linter.is_message_enabled("E0602", 62)
assert linter.is_message_enabled("E0602", 64)
assert linter.is_message_enabled("E0602", 66)
# meth7
assert not linter.is_message_enabled("E1101", 70)
assert linter.is_message_enabled("E1101", 72)
assert linter.is_message_enabled("E1101", 75)
assert linter.is_message_enabled("E1101", 77)
assert fs._suppression_mapping["W0613", 18] == 17
assert fs._suppression_mapping["E1101", 33] == 30
assert ("E1101", 46) not in fs._suppression_mapping
assert fs._suppression_mapping["C0302", 18] == 1
assert fs._suppression_mapping["C0302", 50] == 1
# This is tricky. While the disable in line 106 is disabling
# both 108 and 110, this is usually not what the user wanted.
# Therefore, we report the closest previous disable comment.
assert fs._suppression_mapping["E1101", 108] == 106
assert fs._suppression_mapping["E1101", 110] == 109
def test_enable_by_symbol(initialized_linter: PyLinter) -> None:
"""Messages can be controlled by symbolic names.
The state is consistent across symbols and numbers.
"""
linter = initialized_linter
assert linter.is_message_enabled("W0101")
assert linter.is_message_enabled("unreachable")
assert linter.is_message_enabled("W0102")
assert linter.is_message_enabled("dangerous-default-value")
linter.disable("unreachable", scope="package")
linter.disable("dangerous-default-value", scope="module", line=1)
assert not linter.is_message_enabled("W0101")
assert not linter.is_message_enabled("unreachable")
assert not linter.is_message_enabled("W0102", 1)
assert not linter.is_message_enabled("dangerous-default-value", 1)
linter.set_current_module("tutu")
assert not linter.is_message_enabled("W0101")
assert not linter.is_message_enabled("unreachable")
assert linter.is_message_enabled("W0102")
assert linter.is_message_enabled("dangerous-default-value")
linter.enable("unreachable", scope="package")
linter.enable("dangerous-default-value", scope="module", line=1)
assert linter.is_message_enabled("W0101")
assert linter.is_message_enabled("unreachable")
assert linter.is_message_enabled("W0102", 1)
assert linter.is_message_enabled("dangerous-default-value", 1)
def test_enable_report(linter: PyLinter) -> None:
assert linter.report_is_enabled("RP0001")
linter.disable("RP0001")
assert not linter.report_is_enabled("RP0001")
linter.enable("RP0001")
assert linter.report_is_enabled("RP0001")
def test_report_output_format_aliased(linter: PyLinter) -> None:
text.register(linter)
linter.set_option("output-format", "text")
assert linter.reporter.__class__.__name__ == "TextReporter"
def test_set_unsupported_reporter(linter: PyLinter) -> None:
text.register(linter)
# ImportError
with pytest.raises(exceptions.InvalidReporterError):
linter.set_option("output-format", "missing.module.Class")
# AssertionError
with pytest.raises(exceptions.InvalidReporterError):
linter.set_option("output-format", "lint.unittest_lint._CustomPyLinter")
# AttributeError
with pytest.raises(exceptions.InvalidReporterError):
linter.set_option("output-format", "lint.unittest_lint.MyReporter")
def test_set_option_1(initialized_linter: PyLinter) -> None:
linter = initialized_linter
linter.set_option("disable", "C0111,W0234")
assert not linter.is_message_enabled("C0111")
assert not linter.is_message_enabled("W0234")
assert linter.is_message_enabled("W0113")
assert not linter.is_message_enabled("missing-docstring")
assert not linter.is_message_enabled("non-iterator-returned")
def test_set_option_2(initialized_linter: PyLinter) -> None:
linter = initialized_linter
linter.set_option("disable", ("C0111", "W0234"))
assert not linter.is_message_enabled("C0111")
assert not linter.is_message_enabled("W0234")
assert linter.is_message_enabled("W0113")
assert not linter.is_message_enabled("missing-docstring")
assert not linter.is_message_enabled("non-iterator-returned")
def test_enable_checkers(linter: PyLinter) -> None:
linter.disable("design")
assert "design" not in [c.name for c in linter.prepare_checkers()]
linter.enable("design")
assert "design" in [c.name for c in linter.prepare_checkers()]
def test_errors_only(initialized_linter: PyLinter) -> None:
linter = initialized_linter
linter._error_mode = True
linter._parse_error_mode()
checkers = linter.prepare_checkers()
checker_names = {c.name for c in checkers}
should_not = {"design", "format", "metrics", "miscellaneous", "similarities"}
assert set() == should_not & checker_names
def test_disable_similar(initialized_linter: PyLinter) -> None:
linter = initialized_linter
linter.set_option("disable", "RP0801")
linter.set_option("disable", "R0801")
assert "similarities" not in [c.name for c in linter.prepare_checkers()]
def test_disable_alot(linter: PyLinter) -> None:
"""Check that we disabled a lot of checkers."""
linter.set_option("reports", False)
linter.set_option("disable", "R,C,W")
checker_names = [c.name for c in linter.prepare_checkers()]
for cname in ("design", "metrics", "similarities"):
assert cname not in checker_names, cname
def test_addmessage(linter: PyLinter) -> None:
linter.set_reporter(testutils.GenericTestReporter())
linter.open()
linter.set_current_module("0123")
linter.add_message("C0301", line=1, args=(1, 2))
linter.add_message("line-too-long", line=2, args=(3, 4))
assert len(linter.reporter.messages) == 2
assert linter.reporter.messages[0] == Message(
msg_id="C0301",
symbol="line-too-long",
msg="Line too long (1/2)",
confidence=interfaces.Confidence(
name="UNDEFINED",
description="Warning without any associated confidence level.",
),
location=MessageLocationTuple(
abspath="0123",
path="0123",
module="0123",
obj="",
line=1,
column=0,
end_line=None,
end_column=None,
),
)
assert linter.reporter.messages[1] == Message(
msg_id="C0301",
symbol="line-too-long",
msg="Line too long (3/4)",
confidence=interfaces.Confidence(
name="UNDEFINED",
description="Warning without any associated confidence level.",
),
location=MessageLocationTuple(
abspath="0123",
path="0123",
module="0123",
obj="",
line=2,
column=0,
end_line=None,
end_column=None,
),
)
def test_addmessage_invalid(linter: PyLinter) -> None:
linter.set_reporter(testutils.GenericTestReporter())
linter.open()
linter.set_current_module("0123")
with pytest.raises(InvalidMessageError) as cm:
linter.add_message("line-too-long", args=(1, 2))
assert str(cm.value) == "Message C0301 must provide line, got None"
with pytest.raises(InvalidMessageError) as cm:
linter.add_message("line-too-long", line=2, node="fake_node", args=(1, 2))
assert (
str(cm.value)
== "Message C0301 must only provide line, got line=2, node=fake_node"
)
with pytest.raises(InvalidMessageError) as cm:
linter.add_message("C0321")
assert str(cm.value) == "Message C0321 must provide Node, got None"
def test_load_plugin_command_line() -> None:
dummy_plugin_path = join(REGRTEST_DATA_DIR, "dummy_plugin")
sys.path.append(dummy_plugin_path)
run = Run(
["--load-plugins", "dummy_plugin", join(REGRTEST_DATA_DIR, "empty.py")],
exit=False,
)
assert (
len([ch.name for ch in run.linter.get_checkers() if ch.name == "dummy_plugin"])
== 2
)
sys.path.remove(dummy_plugin_path)
@pytest.mark.usefixtures("pop_pylintrc")
def test_load_plugin_path_manipulation_case_6() -> None:
"""Case 6 refers to GitHub issue #7264.
This is where we supply a plugin we want to load on both the CLI and
config file, but that plugin is only loadable after the ``init-hook`` in
the config file has run. This is not supported, and was previously a silent
failure. This test ensures a ``bad-plugin-value`` message is emitted.
"""
dummy_plugin_path = abspath(
join(REGRTEST_DATA_DIR, "dummy_plugin", "dummy_plugin.py")
)
with fake_home() as home_path:
# construct a basic rc file that just modifies the path
pylintrc_file = join(home_path, "pylintrc")
with open(pylintrc_file, "w", encoding="utf8") as out:
out.writelines(
[
"[MASTER]\n",
f"init-hook=\"import sys; sys.path.append(r'{home_path}')\"\n",
"load-plugins=copy_dummy\n",
]
)
copy(dummy_plugin_path, join(home_path, "copy_dummy.py"))
# To confirm we won't load this module _without_ the init hook running.
assert home_path not in sys.path
run = Run(
[
"--rcfile",
pylintrc_file,
"--load-plugins",
"copy_dummy",
join(REGRTEST_DATA_DIR, "empty.py"),
],
reporter=testutils.GenericTestReporter(),
exit=False,
)
assert run._rcfile == pylintrc_file
assert home_path in sys.path
# The module should not be loaded
assert not any(ch.name == "dummy_plugin" for ch in run.linter.get_checkers())
# There should be a bad-plugin-message for this module
assert len(run.linter.reporter.messages) == 1
assert run.linter.reporter.messages[0] == Message(
msg_id="E0013",
symbol="bad-plugin-value",
msg="Plugin 'copy_dummy' is impossible to load, is it installed ? ('No module named 'copy_dummy'')",
confidence=interfaces.Confidence(
name="UNDEFINED",
description="Warning without any associated confidence level.",
),
location=MessageLocationTuple(
abspath="Command line or configuration file",
path="Command line or configuration file",
module="Command line or configuration file",
obj="",
line=1,
column=0,
end_line=None,
end_column=None,
),
)
# Necessary as the executed init-hook modifies sys.path
sys.path.remove(home_path)
@pytest.mark.usefixtures("pop_pylintrc")
def test_load_plugin_path_manipulation_case_3() -> None:
"""Case 3 refers to GitHub issue #7264.
This is where we supply a plugin we want to load on the CLI only,
but that plugin is only loadable after the ``init-hook`` in
the config file has run. This is not supported, and was previously a silent
failure. This test ensures a ``bad-plugin-value`` message is emitted.
"""
dummy_plugin_path = abspath(
join(REGRTEST_DATA_DIR, "dummy_plugin", "dummy_plugin.py")
)
with fake_home() as home_path:
# construct a basic rc file that just modifies the path
pylintrc_file = join(home_path, "pylintrc")
with open(pylintrc_file, "w", encoding="utf8") as out:
out.writelines(
[
"[MASTER]\n",
f"init-hook=\"import sys; sys.path.append(r'{home_path}')\"\n",
]
)
copy(dummy_plugin_path, join(home_path, "copy_dummy.py"))
# To confirm we won't load this module _without_ the init hook running.
assert home_path not in sys.path
run = Run(
[
"--rcfile",
pylintrc_file,
"--load-plugins",
"copy_dummy",
join(REGRTEST_DATA_DIR, "empty.py"),
],
reporter=testutils.GenericTestReporter(),
exit=False,
)
assert run._rcfile == pylintrc_file
assert home_path in sys.path
# The module should not be loaded
assert not any(ch.name == "dummy_plugin" for ch in run.linter.get_checkers())
# There should be a bad-plugin-message for this module
assert len(run.linter.reporter.messages) == 1
assert run.linter.reporter.messages[0] == Message(
msg_id="E0013",
symbol="bad-plugin-value",
msg="Plugin 'copy_dummy' is impossible to load, is it installed ? ('No module named 'copy_dummy'')",
confidence=interfaces.Confidence(
name="UNDEFINED",
description="Warning without any associated confidence level.",
),
location=MessageLocationTuple(
abspath="Command line or configuration file",
path="Command line or configuration file",
module="Command line or configuration file",
obj="",
line=1,
column=0,
end_line=None,
end_column=None,
),
)
# Necessary as the executed init-hook modifies sys.path
sys.path.remove(home_path)
@pytest.mark.usefixtures("pop_pylintrc")
def test_load_plugin_pylintrc_order_independent() -> None:
"""Test that the init-hook is called independent of the order in a config file.
We want to ensure that any path manipulation in init hook
that means a plugin can load (as per GitHub Issue #7264 Cases 4+7)
runs before the load call, regardless of the order of lines in the
pylintrc file.
"""
dummy_plugin_path = abspath(
join(REGRTEST_DATA_DIR, "dummy_plugin", "dummy_plugin.py")
)
with fake_home() as home_path:
copy(dummy_plugin_path, join(home_path, "copy_dummy.py"))
# construct a basic rc file that just modifies the path
pylintrc_file_before = join(home_path, "pylintrc_before")
with open(pylintrc_file_before, "w", encoding="utf8") as out:
out.writelines(
[
"[MASTER]\n",
f"init-hook=\"import sys; sys.path.append(r'{home_path}')\"\n",
"load-plugins=copy_dummy\n",
]
)
pylintrc_file_after = join(home_path, "pylintrc_after")
with open(pylintrc_file_after, "w", encoding="utf8") as out:
out.writelines(
[
"[MASTER]\n",
"load-plugins=copy_dummy\n"
f"init-hook=\"import sys; sys.path.append(r'{home_path}')\"\n",
]
)
for rcfile in (pylintrc_file_before, pylintrc_file_after):
# To confirm we won't load this module _without_ the init hook running.
assert home_path not in sys.path
run = Run(
[
"--rcfile",
rcfile,
join(REGRTEST_DATA_DIR, "empty.py"),
],
exit=False,
)
assert (
len(
[
ch.name
for ch in run.linter.get_checkers()
if ch.name == "dummy_plugin"
]
)
== 2
)
assert run._rcfile == rcfile
assert home_path in sys.path
# Necessary as the executed init-hook modifies sys.path
sys.path.remove(home_path)
def test_load_plugin_command_line_before_init_hook() -> None:
"""Check that the order of 'load-plugins' and 'init-hook' doesn't affect execution."""
dummy_plugin_path = abspath(
join(REGRTEST_DATA_DIR, "dummy_plugin", "dummy_plugin.py")
)
with fake_home() as home_path:
copy(dummy_plugin_path, join(home_path, "copy_dummy.py"))
# construct a basic rc file that just modifies the path
assert home_path not in sys.path
run = Run(
[
"--load-plugins",
"copy_dummy",
"--init-hook",
f'import sys; sys.path.append(r"{home_path}")',
join(REGRTEST_DATA_DIR, "empty.py"),
],
exit=False,
)
assert home_path in sys.path
assert (
len(
[
ch.name
for ch in run.linter.get_checkers()
if ch.name == "dummy_plugin"
]
)
== 2
)
# Necessary as the executed init-hook modifies sys.path
sys.path.remove(home_path)
def test_load_plugin_command_line_with_init_hook_command_line() -> None:
dummy_plugin_path = abspath(
join(REGRTEST_DATA_DIR, "dummy_plugin", "dummy_plugin.py")
)
with fake_home() as home_path:
copy(dummy_plugin_path, join(home_path, "copy_dummy.py"))
# construct a basic rc file that just modifies the path
assert home_path not in sys.path
run = Run(
[
"--init-hook",
f'import sys; sys.path.append(r"{home_path}")',
"--load-plugins",
"copy_dummy",
join(REGRTEST_DATA_DIR, "empty.py"),
],
exit=False,
)
assert (
len(
[
ch.name
for ch in run.linter.get_checkers()
if ch.name == "dummy_plugin"
]
)
== 2
)
assert home_path in sys.path
# Necessary as the executed init-hook modifies sys.path
sys.path.remove(home_path)
def test_load_plugin_config_file() -> None:
dummy_plugin_path = join(REGRTEST_DATA_DIR, "dummy_plugin")
sys.path.append(dummy_plugin_path)
config_path = join(REGRTEST_DATA_DIR, "dummy_plugin.rc")
run = Run(
["--rcfile", config_path, join(REGRTEST_DATA_DIR, "empty.py")],
exit=False,
)
assert (
len([ch.name for ch in run.linter.get_checkers() if ch.name == "dummy_plugin"])
== 2
)
sys.path.remove(dummy_plugin_path)
def test_load_plugin_configuration() -> None:
dummy_plugin_path = join(REGRTEST_DATA_DIR, "dummy_plugin")
sys.path.append(dummy_plugin_path)
run = Run(
[
"--load-plugins",
"dummy_conf_plugin",
"--ignore",
"foo,bar",
join(REGRTEST_DATA_DIR, "empty.py"),
],
exit=False,
)
sys.path.remove(dummy_plugin_path)
assert run.linter.config.ignore == ["foo", "bar", "bin"]
def test_init_hooks_called_before_load_plugins() -> None:
with pytest.raises(RuntimeError):
Run(["--load-plugins", "unexistant", "--init-hook", "raise RuntimeError"])
with pytest.raises(RuntimeError):
Run(["--init-hook", "raise RuntimeError", "--load-plugins", "unexistant"])
with pytest.raises(SystemExit):
Run(["--init-hook"])
def test_analyze_explicit_script(linter: PyLinter) -> None:
linter.set_reporter(testutils.GenericTestReporter())
linter.check([os.path.join(DATA_DIR, "a_script")])
assert len(linter.reporter.messages) == 1
assert linter.reporter.messages[0] == Message(
msg_id="C0301",
symbol="line-too-long",
msg="Line too long (175/100)",
confidence=interfaces.Confidence(
name="UNDEFINED",
description="Warning without any associated confidence level.",
),
location=MessageLocationTuple(
abspath=os.path.join(abspath(dirname(__file__)), "a_script").replace(
f"lint{os.path.sep}a_script", f"data{os.path.sep}a_script"
),
path=f"tests{os.path.sep}data{os.path.sep}a_script",
module="data.a_script",
obj="",
line=2,
column=0,
end_line=None,
end_column=None,
),
)
def test_full_documentation(linter: PyLinter) -> None:
out = StringIO()
print_full_documentation(linter, out)
output = out.getvalue()
# A few spot checks only
for re_str in (
# auto-generated text
"^Pylint global options and switches$",
"Verbatim name of the checker is ``variables``",
# messages
"^:undefined-loop-variable \\(W0631\\): *",
# options
"^:dummy-variables-rgx:",
):
regexp = re.compile(re_str, re.MULTILINE)
assert re.search(regexp, output)
def test_list_msgs_enabled(
initialized_linter: PyLinter, capsys: CaptureFixture[str]
) -> None:
linter = initialized_linter
linter.enable("W0101", scope="package")
linter.disable("W0102", scope="package")
linter.list_messages_enabled()
lines = capsys.readouterr().out.splitlines()
assert "Enabled messages:" in lines
assert " unreachable (W0101)" in lines
assert "Disabled messages:" in lines
disabled_ix = lines.index("Disabled messages:")
# W0101 should be in the enabled section
assert lines.index(" unreachable (W0101)") < disabled_ix
assert " dangerous-default-value (W0102)" in lines
# W0102 should be in the disabled section
assert lines.index(" dangerous-default-value (W0102)") > disabled_ix
@pytest.fixture
def pop_pylintrc() -> None:
os.environ.pop("PYLINTRC", None)
@pytest.mark.usefixtures("pop_pylintrc")
def test_pylint_home() -> None:
expected = platformdirs.user_cache_dir("pylint")
assert constants.PYLINT_HOME == expected
assert PYLINT_HOME == expected
@mock.patch.dict(os.environ, {"PYLINTHOME": "whatever.d"})
def test_pylint_home_from_environ() -> None:
assert _get_pylint_home() == "whatever.d"
class _CustomPyLinter(PyLinter):
@staticmethod
def should_analyze_file(modname: str, path: str, is_argument: bool = False) -> bool:
if os.path.basename(path) == "wrong.py":
return False
return super(_CustomPyLinter, _CustomPyLinter).should_analyze_file(
modname, path, is_argument=is_argument
)
@pytest.mark.needs_two_cores
def test_custom_should_analyze_file() -> None:
"""Check that we can write custom should_analyze_file that work
even for arguments.
"""
package_dir = os.path.join(REGRTEST_DATA_DIR, "bad_package")
wrong_file = os.path.join(package_dir, "wrong.py")
for jobs in (1, 2):
reporter = testutils.GenericTestReporter()
linter = _CustomPyLinter()
linter.config.jobs = jobs
linter.config.persistent = 0
linter.open()
linter.set_reporter(reporter)
try:
sys.path.append(os.path.dirname(package_dir))
linter.check([package_dir, wrong_file])
finally:
sys.path.pop()
messages = reporter.messages
assert len(messages) == 1
assert "invalid syntax" in messages[0].msg
# we do the check with jobs=1 as well, so that we are sure that the duplicates
# are created by the multiprocessing problem.
@pytest.mark.needs_two_cores
@pytest.mark.parametrize("jobs", [1, 2])
def test_multiprocessing(jobs: int) -> None:
"""Check that multiprocessing does not create duplicates."""
# For the bug (#3584) to show up we need more than one file with issues
# per process
filenames = [
"special_attr_scope_lookup_crash.py",
"syntax_error.py",