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
|
# Copyright (C) 2010, Stefano Rivera <stefanor@debian.org>
# Copyright (C) 2017-2018, Benjamin Drung <bdrung@debian.org>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.
"""Run pylint."""
import os
import re
import subprocess
import sys
import unittest
import pylint
from debian.debian_support import Version
from . import get_source_files, unittest_verbosity
CONFIG = os.path.join(os.path.dirname(__file__), "pylint.conf")
def check_pylint_version():
return Version(pylint.__version__) >= Version("2.11.1")
@unittest.skipIf(not check_pylint_version(), "pylint version not supported")
class PylintTestCase(unittest.TestCase):
"""
This unittest class provides a test that runs the pylint code check
on the Python source code. The list of source files is provided by
the get_source_files() function and pylint is purely configured via
a config file.
"""
def test_pylint(self) -> None:
"""Test: Run pylint on Python source code."""
cmd = ["pylint", "--rcfile=" + CONFIG, "--"] + get_source_files()
if unittest_verbosity() >= 2:
sys.stderr.write(f"Running following command:\n{' '.join(cmd)}\n")
process = subprocess.run(cmd, capture_output=True, check=False, text=True)
if process.returncode != 0: # pragma: no cover
# Strip trailing summary (introduced in pylint 1.7).
# This summary might look like:
#
# ------------------------------------
# Your code has been rated at 10.00/10
#
out = re.sub(
"^(-+|Your code has been rated at .*)$",
"",
process.stdout,
flags=re.MULTILINE,
).rstrip()
# Strip logging of used config file (introduced in pylint 1.8)
err = re.sub("^Using config file .*\n", "", process.stderr.rstrip())
msgs = []
if err:
msgs.append(
f"pylint exited with code {process.returncode} "
f"and has unexpected output on stderr:\n{err}"
)
if out:
msgs.append(f"pylint found issues:\n{out}")
if not msgs:
msgs.append(
f"pylint exited with code {process.returncode} "
"and has no output on stdout or stderr."
)
self.fail("\n".join(msgs))
|
