Add ability to format errors as a list of temp-allow rules to paste

tools/checkdeps/java_checker.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Checks Java files for illegal imports."""
 
 import codecs
 import os
 import re
 
+import results
 from rules import Rule
 
 
 class JavaChecker(object):
   """Import checker for Java files.
 
   The CheckFile method uses real filesystem paths, but Java imports work in
   terms of package names. To deal with this, we have an extra "prescan" pass
   that reads all the .java files and builds a mapping of class name -> filepath.
   In CheckFile, we convert each import statement into a real filepath, and check
@@ skipping 55 matching lines @@
             print
           else:
             self._classmap[full_class_name] = filepath
           return
       print 'WARNING: no package definition found in %s' % filepath
 
   def CheckFile(self, rules, filepath):
     if self._verbose:
       print 'Checking: ' + filepath
 
-    result = ''
+    dependee_status = results.DependeeStatus(filepath)
     with codecs.open(filepath, encoding='utf-8') as f:
       for line in f:
         for clazz in re.findall('^import\s+(?:static\s+)?([\w\.]+)\s*;', line):
           if clazz not in self._classmap:
             # Importing a class from outside the Chromium tree. That's fine --
             # it's probably a Java or Android system class.
             continue
           include_path = os.path.relpath(
               self._classmap[clazz], self._base_directory)
           # Convert Windows paths to Unix style, as used in DEPS files.
           include_path = include_path.replace(os.path.sep, '/')
-          (allowed, why_failed) = rules.DirAllowed(include_path)
-          if allowed == Rule.DISALLOW:
-            if self._verbose:
-              result += '\nFor %s' % rules
-            result += 'Illegal include: "%s"\n    Because of %s\n' % (
-                include_path, why_failed)
+          rule = rules.RuleApplyingTo(include_path)
+          if rule.allow == Rule.DISALLOW:
+            dependee_status.AddViolation(
+                results.DependencyViolation(include_path, rule, rules))

[erikwright (departed), 2012/07/31 17:22:46]

I note that you don't check for 'fail_on_temp_allow' here (vs CPP).

It might be more appropriate to pass each include path and rule to
dependee_status. It could accumulate all temp_allow and disallow (and allow, why
not?) and the client of the Checker can decide what to do with them.

[Jói, 2012/08/01 15:22:58]

I might do this as a follow-up change; making the temp-allow stuff work with
Java files is a TODO.  For now, I don't want to mess too much with the possible
performance characteristics of checkdeps.py, especially since I made it a
presubmit check to verify added and modified lines against the DEPS rules.

         if '{' in line:
           # This is code, so we're finished reading imports for this file.
           break
 
-    return result
+    return dependee_status