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
|
# Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
import json
import logging
import subprocess
from pathlib import Path
from typing import Dict, Union
import pytest
from pytest import LogCaptureFixture
from pylint.testutils.primer import PackageToLint
PRIMER_DIRECTORY = Path(".pylint_primer_tests/").resolve()
def get_packages_to_lint_from_json(
json_path: Union[Path, str]
) -> Dict[str, PackageToLint]:
result: Dict[str, PackageToLint] = {}
with open(json_path, encoding="utf8") as f:
for name, package_data in json.load(f).items():
result[name] = PackageToLint(**package_data)
return result
PACKAGE_TO_LINT_JSON_BATCH_ONE = (
Path(__file__).parent / "packages_to_lint_batch_one.json"
)
PACKAGES_TO_LINT_BATCH_ONE = get_packages_to_lint_from_json(
PACKAGE_TO_LINT_JSON_BATCH_ONE
)
"""Dictionary of external packages used during the primer test in batch one."""
PACKAGE_TO_LINT_JSON_BATCH_TWO = (
Path(__file__).parent / "packages_to_lint_batch_two.json"
)
PACKAGES_TO_LINT_BATCH_TWO = get_packages_to_lint_from_json(
PACKAGE_TO_LINT_JSON_BATCH_TWO
)
"""Dictionary of external packages used during the primer test in batch two."""
class TestPrimer:
@staticmethod
@pytest.mark.primer_external_batch_one
@pytest.mark.parametrize(
"package", PACKAGES_TO_LINT_BATCH_ONE.values(), ids=PACKAGES_TO_LINT_BATCH_ONE
)
def test_primer_external_packages_no_crash_batch_one(
package: PackageToLint,
caplog: LogCaptureFixture,
) -> None:
__tracebackhide__ = True # pylint: disable=unused-variable
TestPrimer._primer_test(package, caplog)
@staticmethod
@pytest.mark.primer_external_batch_two
@pytest.mark.parametrize(
"package", PACKAGES_TO_LINT_BATCH_TWO.values(), ids=PACKAGES_TO_LINT_BATCH_TWO
)
def test_primer_external_packages_no_crash_batch_two(
package: PackageToLint,
caplog: LogCaptureFixture,
) -> None:
__tracebackhide__ = True # pylint: disable=unused-variable
TestPrimer._primer_test(package, caplog)
@staticmethod
def _primer_test(package: PackageToLint, caplog: LogCaptureFixture) -> None:
"""Runs pylint over external packages to check for crashes and fatal messages.
We only check for crashes (bit-encoded exit code 32) and fatal messages
(bit-encoded exit code 1). We assume that these external repositories do not
have any fatal errors in their code so that any fatal errors are pylint false
positives
"""
caplog.set_level(logging.INFO)
package.lazy_clone()
try:
# We want to test all the code we can
enables = ["--enable-all-extensions", "--enable=all"]
# Duplicate code takes too long and is relatively safe
disables = ["--disable=duplicate-code"]
command = ["pylint"] + enables + disables + package.pylint_args
logging.info("Launching primer:\n%s", " ".join(command))
subprocess.run(command, check=True)
except subprocess.CalledProcessError as ex:
msg = f"Encountered {{}} during primer test for {package}"
assert ex.returncode != 32, msg.format("a crash")
assert ex.returncode % 2 == 0, msg.format("a message of category 'fatal'")
|
