xref: /openbmc/qemu/tests/qemu-iotests/297 (revision 5b3e7517)
1#!/usr/bin/env python3
2# group: meta
3#
4# Copyright (C) 2020 Red Hat, Inc.
5#
6# This program is free software; you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation; either version 2 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19import os
20import re
21import shutil
22import subprocess
23import sys
24
25import iotests
26
27
28# TODO: Empty this list!
29SKIP_FILES = (
30    '030', '040', '041', '044', '045', '055', '056', '057', '065', '093',
31    '096', '118', '124', '132', '136', '139', '147', '148', '149',
32    '151', '152', '155', '163', '165', '194', '196', '202',
33    '203', '205', '206', '207', '208', '210', '211', '212', '213', '216',
34    '218', '219', '224', '228', '234', '235', '236', '237', '238',
35    '240', '242', '245', '246', '248', '255', '256', '257', '258', '260',
36    '262', '264', '266', '274', '277', '280', '281', '295', '296', '298',
37    '299', '302', '303', '304', '307',
38    'nbd-fault-injector.py', 'qcow2.py', 'qcow2_format.py', 'qed.py'
39)
40
41
42def is_python_file(filename):
43    if not os.path.isfile(filename):
44        return False
45
46    if filename.endswith('.py'):
47        return True
48
49    with open(filename, encoding='utf-8') as f:
50        try:
51            first_line = f.readline()
52            return re.match('^#!.*python', first_line) is not None
53        except UnicodeDecodeError:  # Ignore binary files
54            return False
55
56
57def run_linters():
58    named_tests = [f'tests/{entry}' for entry in os.listdir('tests')]
59    check_tests = set(os.listdir('.') + named_tests) - set(SKIP_FILES)
60    files = [filename for filename in check_tests if is_python_file(filename)]
61
62    iotests.logger.debug('Files to be checked:')
63    iotests.logger.debug(', '.join(sorted(files)))
64
65    print('=== pylint ===')
66    sys.stdout.flush()
67
68    # Todo notes are fine, but fixme's or xxx's should probably just be
69    # fixed (in tests, at least)
70    env = os.environ.copy()
71    qemu_module_path = os.path.join(os.path.dirname(__file__),
72                                    '..', '..', 'python')
73    try:
74        env['PYTHONPATH'] += os.pathsep + qemu_module_path
75    except KeyError:
76        env['PYTHONPATH'] = qemu_module_path
77    subprocess.run(('pylint-3', '--score=n', '--notes=FIXME,XXX', *files),
78                   env=env, check=False)
79
80    print('=== mypy ===')
81    sys.stdout.flush()
82
83    # We have to call mypy separately for each file.  Otherwise, it
84    # will interpret all given files as belonging together (i.e., they
85    # may not both define the same classes, etc.; most notably, they
86    # must not both define the __main__ module).
87    env['MYPYPATH'] = env['PYTHONPATH']
88    for filename in files:
89        p = subprocess.run(('mypy',
90                            '--warn-unused-configs',
91                            '--disallow-subclassing-any',
92                            '--disallow-any-generics',
93                            '--disallow-incomplete-defs',
94                            '--disallow-untyped-decorators',
95                            '--no-implicit-optional',
96                            '--warn-redundant-casts',
97                            '--warn-unused-ignores',
98                            '--no-implicit-reexport',
99                            '--namespace-packages',
100                            filename),
101                           env=env,
102                           check=False,
103                           stdout=subprocess.PIPE,
104                           stderr=subprocess.STDOUT,
105                           universal_newlines=True)
106
107        if p.returncode != 0:
108            print(p.stdout)
109
110
111for linter in ('pylint-3', 'mypy'):
112    if shutil.which(linter) is None:
113        iotests.notrun(f'{linter} not found')
114
115iotests.script_main(run_linters)
116