tools/patman/checkpatch.py

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