[PATCH] patman: Parse checkpatch by message instead of by line

* [PATCH] patman: Parse checkpatch by message instead of by line
@ 2021-04-01  2:49 Evan Benn
  2021-04-01  5:42 ` Simon Glass
  2021-04-29 16:03 ` Simon Glass
  0 siblings, 2 replies; 5+ messages in thread
From: Evan Benn @ 2021-04-01  2:49 UTC (permalink / raw)
  To: u-boot

Parse each empty-line-delimited message separately. This saves having to
deal with all the different line content styles, we only care about the
header ERROR | WARNING | NOTE...

Also make checkpatch print line information for a uboot specific
warning.

Signed-off-by: Evan Benn <evanbenn@chromium.org>
---

 scripts/checkpatch.pl      |  18 +--
 tools/patman/checkpatch.py | 218 +++++++++++++++++++++++--------------
 2 files changed, 144 insertions(+), 92 deletions(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 755f4802a4..8f7cf3f865 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2326,13 +2326,15 @@ sub get_raw_comment {
 #   suffix: Suffix to expect on member, e.g. "_priv"
 #   warning: Warning name, e.g. "PRIV_AUTO"
 sub u_boot_struct_name {
-	my ($line, $auto, $suffix, $warning) = @_;
+	my ($line, $auto, $suffix, $warning, $herecurr) = @_;
 
 	# Use _priv as a suffix for the device-private data struct
 	if ($line =~ /^\+\s*\.${auto}\s*=\s*sizeof\(struct\((\w+)\).*/) {
 		my $struct_name = $1;
 		if ($struct_name !~ /^\w+${suffix}/) {
-			WARN($warning, "struct \'$struct_name\' should have a ${suffix} suffix");
+			WARN($warning,
+				 "struct \'$struct_name\' should have a ${suffix} suffix\n"
+				 . $herecurr);
 		}
 	}
 }
@@ -2404,17 +2406,17 @@ sub u_boot_line {
 	}
 
 	# Check struct names for the 'auto' members of struct driver
-	u_boot_struct_name($line, "priv_auto", "_priv", "PRIV_AUTO");
-	u_boot_struct_name($line, "plat_auto", "_plat", "PLAT_AUTO");
-	u_boot_struct_name($line, "per_child_auto", "_priv", "CHILD_PRIV_AUTO");
+	u_boot_struct_name($line, "priv_auto", "_priv", "PRIV_AUTO", $herecurr);
+	u_boot_struct_name($line, "plat_auto", "_plat", "PLAT_AUTO", $herecurr);
+	u_boot_struct_name($line, "per_child_auto", "_priv", "CHILD_PRIV_AUTO", $herecurr);
 	u_boot_struct_name($line, "per_child_plat_auto", "_plat",
-		"CHILD_PLAT_AUTO");
+		"CHILD_PLAT_AUTO", $herecurr);
 
 	# Now the ones for struct uclass, skipping those in common with above
 	u_boot_struct_name($line, "per_device_auto", "_priv",
-		"DEVICE_PRIV_AUTO");
+		"DEVICE_PRIV_AUTO", $herecurr);
 	u_boot_struct_name($line, "per_device_plat_auto", "_plat",
-		"DEVICE_PLAT_AUTO");
+		"DEVICE_PLAT_AUTO", $herecurr);
 }
 
 sub process {
diff --git a/tools/patman/checkpatch.py b/tools/patman/checkpatch.py
index 63a8e37e8c..8978df25c1 100644
--- a/tools/patman/checkpatch.py
+++ b/tools/patman/checkpatch.py
@@ -10,7 +10,15 @@ import sys
 from patman import command
 from patman import gitutil
 from patman import terminal
-from patman import tools
+
+EMACS_PREFIX = r'(?:[0-9]{4}.*\.patch:[0-9]+: )?'
+TYPE_NAME = r'([A-Z_]+:)?'
+RE_ERROR = re.compile(r'ERROR:%s (.*)' % TYPE_NAME)
+RE_WARNING = re.compile(EMACS_PREFIX + r'WARNING:%s (.*)' % TYPE_NAME)
+RE_CHECK = re.compile(r'CHECK:%s (.*)' % TYPE_NAME)
+RE_FILE = re.compile(r'#(\d+): (FILE: ([^:]*):(\d+):)?')
+RE_NOTE = re.compile(r'NOTE: (.*)')
+
 
 def FindCheckPatch():
     top_level = gitutil.GetTopLevel()
@@ -38,14 +46,81 @@ def FindCheckPatch():
     sys.exit('Cannot find checkpatch.pl - please put it in your ' +
              '~/bin directory or use --no-check')
 
-def CheckPatch(fname, verbose=False, show_types=False):
-    """Run checkpatch.pl on a file.
+
+def CheckPatchParseOneMessage(message):
+    """Parse one checkpatch message
 
     Args:
-        fname: Filename to check
+        message: string to parse
+
+    Returns:
+        dict:
+            'type'; error or warning
+            'msg': text message
+            'file' : filename
+            'line': line number
+    """
+
+    if RE_NOTE.match(message):
+        return {}
+
+    item = {}
+
+    err_match = RE_ERROR.match(message)
+    warn_match = RE_WARNING.match(message)
+    check_match = RE_CHECK.match(message)
+    if err_match:
+        item['cptype'] = err_match.group(1)
+        item['msg'] = err_match.group(2)
+        item['type'] = 'error'
+    elif warn_match:
+        item['cptype'] = warn_match.group(1)
+        item['msg'] = warn_match.group(2)
+        item['type'] = 'warning'
+    elif check_match:
+        item['cptype'] = check_match.group(1)
+        item['msg'] = check_match.group(2)
+        item['type'] = 'check'
+    else:
+        message_indent = '    '
+        print('patman: failed to parse checkpatch message:\n%s' %
+              (message_indent + message.replace('\n', '\n' + message_indent)),
+              file=sys.stderr)
+        return {}
+
+    file_match = RE_FILE.search(message)
+    # some messages have no file, catch those here
+    no_file_match = any(s in message for s in [
+        '\nSubject:', 'Missing Signed-off-by: line(s)',
+        'does MAINTAINERS need updating'
+    ])
+
+    if file_match:
+        err_fname = file_match.group(3)
+        if err_fname:
+            item['file'] = err_fname
+            item['line'] = int(file_match.group(4))
+        else:
+            item['file'] = '<patch>'
+            item['line'] = int(file_match.group(1))
+    elif no_file_match:
+        item['file'] = '<patch>'
+    else:
+        message_indent = '    '
+        print('patman: failed to find file / line information:\n%s' %
+              (message_indent + message.replace('\n', '\n' + message_indent)),
+              file=sys.stderr)
+
+    return item
+
+
+def CheckPatchParse(checkpatch_output, verbose=False):
+    """Parse checkpatch.pl output
+
+    Args:
+        checkpatch_output: string to parse
         verbose: True to print out every line of the checkpatch output as it is
             parsed
-        show_types: Tell checkpatch to show the type (number) of each message
 
     Returns:
         namedtuple containing:
@@ -59,67 +134,38 @@ def CheckPatch(fname, verbose=False, show_types=False):
             warnings: Number of warnings
             checks: Number of checks
             lines: Number of lines
-            stdout: Full output of checkpatch
+            stdout: checkpatch_output
     """
     fields = ['ok', 'problems', 'errors', 'warnings', 'checks', 'lines',
               'stdout']
     result = collections.namedtuple('CheckPatchResult', fields)
+    result.stdout = checkpatch_output
     result.ok = False
     result.errors, result.warnings, result.checks = 0, 0, 0
     result.lines = 0
     result.problems = []
-    chk = FindCheckPatch()
-    item = {}
-    args = [chk, '--no-tree']
-    if show_types:
-        args.append('--show-types')
-    result.stdout = command.Output(*args, fname, raise_on_error=False)
-    #pipe = subprocess.Popen(cmd, stdout=subprocess.PIPE)
-    #stdout, stderr = pipe.communicate()
 
     # total: 0 errors, 0 warnings, 159 lines checked
     # or:
     # total: 0 errors, 2 warnings, 7 checks, 473 lines checked
-    emacs_prefix = '(?:[0-9]{4}.*\.patch:[0-9]+: )?'
-    emacs_stats = '(?:[0-9]{4}.*\.patch )?'
+    emacs_stats = r'(?:[0-9]{4}.*\.patch )?'
     re_stats = re.compile(emacs_stats +
-                          'total: (\\d+) errors, (\d+) warnings, (\d+)')
+                          r'total: (\d+) errors, (\d+) warnings, (\d+)')
     re_stats_full = re.compile(emacs_stats +
-                               'total: (\\d+) errors, (\d+) warnings, (\d+)'
-                               ' checks, (\d+)')
-    re_ok = re.compile('.*has no obvious style problems')
-    re_bad = re.compile('.*has style problems, please review')
-    type_name = '([A-Z_]+:)?'
-    re_error = re.compile('ERROR:%s (.*)' % type_name)
-    re_warning = re.compile(emacs_prefix + 'WARNING:%s (.*)' % type_name)
-    re_check = re.compile('CHECK:%s (.*)' % type_name)
-    re_file = re.compile('#(\d+): (FILE: ([^:]*):(\d+):)?')
-    re_note = re.compile('NOTE: (.*)')
-    re_new_file = re.compile('new file mode .*')
-    indent = ' ' * 6
-    for line in result.stdout.splitlines():
+                               r'total: (\d+) errors, (\d+) warnings, (\d+)'
+                               r' checks, (\d+)')
+    re_ok = re.compile(r'.*has no obvious style problems')
+    re_bad = re.compile(r'.*has style problems, please review')
+
+    # A blank line indicates the end of a message
+    for message in result.stdout.split('\n\n'):
         if verbose:
-            print(line)
-
-        # A blank line indicates the end of a message
-        if not line:
-            if item:
-                result.problems.append(item)
-                item = {}
-            continue
-        if re_note.match(line):
-            continue
-        # Skip lines which quote code
-        if line.startswith(indent):
-            continue
-        # Skip code quotes
-        if line.startswith('+'):
-            continue
-        if re_new_file.match(line):
-            continue
-        match = re_stats_full.match(line)
+            print(message)
+
+        # either find stats, the verdict, or delegate
+        match = re_stats_full.match(message)
         if not match:
-            match = re_stats.match(line)
+            match = re_stats.match(message)
         if match:
             result.errors = int(match.group(1))
             result.warnings = int(match.group(2))
@@ -128,46 +174,50 @@ def CheckPatch(fname, verbose=False, show_types=False):
                 result.lines = int(match.group(4))
             else:
                 result.lines = int(match.group(3))
-            continue
-        elif re_ok.match(line):
+        elif re_ok.match(message):
             result.ok = True
-            continue
-        elif re_bad.match(line):
+        elif re_bad.match(message):
             result.ok = False
-            continue
-        err_match = re_error.match(line)
-        warn_match = re_warning.match(line)
-        file_match = re_file.match(line)
-        check_match = re_check.match(line)
-        subject_match = line.startswith('Subject:')
-        if err_match:
-            item['cptype'] = err_match.group(1)
-            item['msg'] = err_match.group(2)
-            item['type'] = 'error'
-        elif warn_match:
-            item['cptype'] = warn_match.group(1)
-            item['msg'] = warn_match.group(2)
-            item['type'] = 'warning'
-        elif check_match:
-            item['cptype'] = check_match.group(1)
-            item['msg'] = check_match.group(2)
-            item['type'] = 'check'
-        elif file_match:
-            err_fname = file_match.group(3)
-            if err_fname:
-                item['file'] = err_fname
-                item['line'] = int(file_match.group(4))
-            else:
-                item['file'] = '<patch>'
-                item['line'] = int(file_match.group(1))
-        elif subject_match:
-            item['file'] = '<patch subject>'
-            item['line'] = None
         else:
-            print('bad line "%s", %d' % (line, len(line)))
+            problem = CheckPatchParseOneMessage(message)
+            if problem:
+                result.problems.append(problem)
 
     return result
 
+
+def CheckPatch(fname, verbose=False, show_types=False):
+    """Run checkpatch.pl on a file and parse the results.
+
+    Args:
+        fname: Filename to check
+        verbose: True to print out every line of the checkpatch output as it is
+            parsed
+        show_types: Tell checkpatch to show the type (number) of each message
+
+    Returns:
+        namedtuple containing:
+            ok: False=failure, True=ok
+            problems: List of problems, each a dict:
+                'type'; error or warning
+                'msg': text message
+                'file' : filename
+                'line': line number
+            errors: Number of errors
+            warnings: Number of warnings
+            checks: Number of checks
+            lines: Number of lines
+            stdout: Full output of checkpatch
+    """
+    chk = FindCheckPatch()
+    args = [chk, '--no-tree']
+    if show_types:
+        args.append('--show-types')
+    output = command.Output(*args, fname, raise_on_error=False)
+
+    return CheckPatchParse(output, verbose)
+
+
 def GetWarningMsg(col, msg_type, fname, line, msg):
     '''Create a message for a given file/line
 
-- 
2.31.0.291.g576ba9dcdaf-goog

^ permalink raw reply related	[flat|nested] 5+ messages in thread