xref: /openbmc/qemu/tests/qemu-iotests/297 (revision f1be6219) 
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
24from typing import List
25
26import iotests
27
28
29# TODO: Empty this list!
30SKIP_FILES = (
31    '030', '040', '041', '044', '045', '055', '056', '057', '065', '093',
32    '096', '118', '124', '132', '136', '139', '147', '148', '149',
33    '151', '152', '155', '163', '165', '194', '196', '202',
34    '203', '205', '206', '207', '208', '210', '211', '212', '213', '216',
35    '218', '219', '224', '228', '234', '235', '236', '237', '238',
36    '240', '242', '245', '246', '248', '255', '256', '257', '258', '260',
37    '262', '264', '266', '274', '277', '280', '281', '295', '296', '298',
38    '299', '302', '303', '304', '307',
39    'nbd-fault-injector.py', 'qcow2.py', 'qcow2_format.py', 'qed.py'
40)
41
42
43def is_python_file(filename):
44    if not os.path.isfile(filename):
45        return False
46
47    if filename.endswith('.py'):
48        return True
49
50    with open(filename, encoding='utf-8') as f:
51        try:
52            first_line = f.readline()
53            return re.match('^#!.*python', first_line) is not None
54        except UnicodeDecodeError:  # Ignore binary files
55            return False
56
57
58def get_test_files() -> List[str]:
59    named_tests = [f'tests/{entry}' for entry in os.listdir('tests')]
60    check_tests = set(os.listdir('.') + named_tests) - set(SKIP_FILES)
61    return list(filter(is_python_file, check_tests))
62
63
64def run_linters():
65    files = get_test_files()
66
67    iotests.logger.debug('Files to be checked:')
68    iotests.logger.debug(', '.join(sorted(files)))
69
70    print('=== pylint ===')
71    sys.stdout.flush()
72
73    env = os.environ.copy()
74    subprocess.run(('python3', '-m', 'pylint', *files),
75                   env=env, check=False)
76
77    print('=== mypy ===')
78    sys.stdout.flush()
79
80    env['MYPYPATH'] = env['PYTHONPATH']
81    p = subprocess.run(('python3', '-m', 'mypy', *files),
82                       env=env,
83                       check=False,
84                       stdout=subprocess.PIPE,
85                       stderr=subprocess.STDOUT,
86                       universal_newlines=True)
87
88    if p.returncode != 0:
89        print(p.stdout)
90
91
92def main() -> None:
93    for linter in ('pylint-3', 'mypy'):
94        if shutil.which(linter) is None:
95            iotests.notrun(f'{linter} not found')
96
97    run_linters()
98
99
100iotests.script_main(main)
101