git.sur5r.net Git - u-boot/blob - tools/patman/checkpatch.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2011 The Chromium OS Authors.
   3 #
   4
   5 import collections
   6 import command
   7 import gitutil
   8 import os
   9 import re
  10 import sys
  11 import terminal
  12
  13 def FindCheckPatch():
  14     top_level = gitutil.GetTopLevel()
  15     try_list = [
  16         os.getcwd(),
  17         os.path.join(os.getcwd(), '..', '..'),
  18         os.path.join(top_level, 'tools'),
  19         os.path.join(top_level, 'scripts'),
  20         '%s/bin' % os.getenv('HOME'),
  21         ]
  22     # Look in current dir
  23     for path in try_list:
  24         fname = os.path.join(path, 'checkpatch.pl')
  25         if os.path.isfile(fname):
  26             return fname
  27
  28     # Look upwwards for a Chrome OS tree
  29     while not os.path.ismount(path):
  30         fname = os.path.join(path, 'src', 'third_party', 'kernel', 'files',
  31                 'scripts', 'checkpatch.pl')
  32         if os.path.isfile(fname):
  33             return fname
  34         path = os.path.dirname(path)
  35
  36     sys.exit('Cannot find checkpatch.pl - please put it in your ' +
  37              '~/bin directory or use --no-check')
  38
  39 def CheckPatch(fname, verbose=False):
  40     """Run checkpatch.pl on a file.
  41
  42     Returns:
  43         namedtuple containing:
  44             ok: False=failure, True=ok
  45             problems: List of problems, each a dict:
  46                 'type'; error or warning
  47                 'msg': text message
  48                 'file' : filename
  49                 'line': line number
  50             errors: Number of errors
  51             warnings: Number of warnings
  52             checks: Number of checks
  53             lines: Number of lines
  54             stdout: Full output of checkpatch
  55     """
  56     fields = ['ok', 'problems', 'errors', 'warnings', 'checks', 'lines',
  57               'stdout']
  58     result = collections.namedtuple('CheckPatchResult', fields)
  59     result.ok = False
  60     result.errors, result.warning, result.checks = 0, 0, 0
  61     result.lines = 0
  62     result.problems = []
  63     chk = FindCheckPatch()
  64     item = {}
  65     result.stdout = command.Output(chk, '--no-tree', fname,
  66                                    raise_on_error=False)
  67     #pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
  68     #stdout, stderr = pipe.communicate()
  69
  70     # total: 0 errors, 0 warnings, 159 lines checked
  71     # or:
  72     # total: 0 errors, 2 warnings, 7 checks, 473 lines checked
  73     re_stats = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)')
  74     re_stats_full = re.compile('total: (\\d+) errors, (\d+) warnings, (\d+)'
  75                                ' checks, (\d+)')
  76     re_ok = re.compile('.*has no obvious style problems')
  77     re_bad = re.compile('.*has style problems, please review')
  78     re_error = re.compile('ERROR: (.*)')
  79     re_warning = re.compile('WARNING: (.*)')
  80     re_check = re.compile('CHECK: (.*)')
  81     re_file = re.compile('#\d+: FILE: ([^:]*):(\d+):')
  82
  83     for line in result.stdout.splitlines():
  84         if verbose:
  85             print(line)
  86
  87         # A blank line indicates the end of a message
  88         if not line and item:
  89             result.problems.append(item)
  90             item = {}
  91         match = re_stats_full.match(line)
  92         if not match:
  93             match = re_stats.match(line)
  94         if match:
  95             result.errors = int(match.group(1))
  96             result.warnings = int(match.group(2))
  97             if len(match.groups()) == 4:
  98                 result.checks = int(match.group(3))
  99                 result.lines = int(match.group(4))
 100             else:
 101                 result.lines = int(match.group(3))
 102         elif re_ok.match(line):
 103             result.ok = True
 104         elif re_bad.match(line):
 105             result.ok = False
 106         err_match = re_error.match(line)
 107         warn_match = re_warning.match(line)
 108         file_match = re_file.match(line)
 109         check_match = re_check.match(line)
 110         if err_match:
 111             item['msg'] = err_match.group(1)
 112             item['type'] = 'error'
 113         elif warn_match:
 114             item['msg'] = warn_match.group(1)
 115             item['type'] = 'warning'
 116         elif check_match:
 117             item['msg'] = check_match.group(1)
 118             item['type'] = 'check'
 119         elif file_match:
 120             item['file'] = file_match.group(1)
 121             item['line'] = int(file_match.group(2))
 122
 123     return result
 124
 125 def GetWarningMsg(col, msg_type, fname, line, msg):
 126     '''Create a message for a given file/line
 127
 128     Args:
 129         msg_type: Message type ('error' or 'warning')
 130         fname: Filename which reports the problem
 131         line: Line number where it was noticed
 132         msg: Message to report
 133     '''
 134     if msg_type == 'warning':
 135         msg_type = col.Color(col.YELLOW, msg_type)
 136     elif msg_type == 'error':
 137         msg_type = col.Color(col.RED, msg_type)
 138     elif msg_type == 'check':
 139         msg_type = col.Color(col.MAGENTA, msg_type)
 140     return '%s:%d: %s: %s\n' % (fname, line, msg_type, msg)
 141
 142 def CheckPatches(verbose, args):
 143     '''Run the checkpatch.pl script on each patch'''
 144     error_count, warning_count, check_count = 0, 0, 0
 145     col = terminal.Color()
 146
 147     for fname in args:
 148         result = CheckPatch(fname, verbose)
 149         if not result.ok:
 150             error_count += result.errors
 151             warning_count += result.warnings
 152             check_count += result.checks
 153             print('%d errors, %d warnings, %d checks for %s:' % (result.errors,
 154                     result.warnings, result.checks, col.Color(col.BLUE, fname)))
 155             if (len(result.problems) != result.errors + result.warnings +
 156                     result.checks):
 157                 print("Internal error: some problems lost")
 158             for item in result.problems:
 159                 sys.stderr.write(
 160                     GetWarningMsg(col, item.get('type', '<unknown>'),
 161                         item.get('file', '<unknown>'),
 162                         item.get('line', 0), item.get('msg', 'message')))
 163             print
 164             #print(stdout)
 165     if error_count or warning_count or check_count:
 166         str = 'checkpatch.pl found %d error(s), %d warning(s), %d checks(s)'
 167         color = col.GREEN
 168         if warning_count:
 169             color = col.YELLOW
 170         if error_count:
 171             color = col.RED
 172         print(col.Color(color, str % (error_count, warning_count, check_count)))
 173         return False
 174     return True