PRESUBMIT.py

   1 # Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 """Top-level presubmit script for Chromium.
   6
   7 See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
   8 for more details about the presubmit API built into gcl.
   9 """
  10
  11 _EXCLUDED_PATHS = (
  12     r"^breakpad[\\\/].*",
  13     r"^net/tools/spdyshark/[\\\/].*",
  14     r"^skia[\\\/].*",
  15     r"^v8[\\\/].*",
  16     r".*MakeFile$",
  17 )
  18
  19
  20 def _CheckNoInterfacesInBase(input_api, output_api):
  21   """Checks to make sure no files in libbase.a have |@interface|."""
  22   pattern = input_api.re.compile(r'^\s*@interface', input_api.re.MULTILINE)
  23   files = []
  24   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
  25     if (f.LocalPath().startswith('base/') and
  26         not f.LocalPath().endswith('_unittest.mm')):
  27       contents = input_api.ReadFile(f)
  28       if pattern.search(contents):
  29         files.append(f)
  30
  31   if len(files):
  32     return [ output_api.PresubmitError(
  33         'Objective-C interfaces or categories are forbidden in libbase. ' +
  34         'See http://groups.google.com/a/chromium.org/group/chromium-dev/' +
  35         'browse_thread/thread/efb28c10435987fd',
  36         files) ]
  37   return []
  38
  39
  40 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
  41   """Attempts to prevent use of functions intended only for testing in
  42   non-testing code. For now this is just a best-effort implementation
  43   that ignores header files and may have some false positives. A
  44   better implementation would probably need a proper C++ parser.
  45   """
  46   # We only scan .cc files and the like, as the declaration of
  47   # for-testing functions in header files are hard to distinguish from
  48   # calls to such functions without a proper C++ parser.
  49   source_extensions = r'\.(cc|cpp|cxx|mm)$'
  50   file_inclusion_pattern = r'.+%s' % source_extensions
  51   file_exclusion_pattern = (
  52     r'((test_|mock_).+|.+(_test_support|profile_sync_service_harness|'
  53     r'_(api|browser|perf|unit|ui)?test))%s' % source_extensions)
  54   path_exclusion_pattern = r'.*[/\\](test|tool(s)?)[/\\].*'
  55
  56   base_function_pattern = r'ForTest(ing)?|for_test(ing)?'
  57   inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
  58   exclusion_pattern = input_api.re.compile(
  59     r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
  60       base_function_pattern, base_function_pattern))
  61
  62   def FilterFile(affected_file):
  63     black_list = ((file_exclusion_pattern, path_exclusion_pattern, ) +
  64                   _EXCLUDED_PATHS + input_api.DEFAULT_BLACK_LIST)
  65     return input_api.FilterSourceFile(
  66       affected_file,
  67       white_list=(file_inclusion_pattern, ),
  68       black_list=black_list)
  69
  70   problems = []
  71   for f in input_api.AffectedSourceFiles(FilterFile):
  72     local_path = f.LocalPath()
  73     lines = input_api.ReadFile(f).splitlines()
  74     line_number = 0
  75     for line in lines:
  76       if (inclusion_pattern.search(line) and
  77           not exclusion_pattern.search(line)):
  78         problems.append(
  79           '%s:%d\n    %s' % (local_path, line_number, line.strip()))
  80       line_number += 1
  81
  82   if problems:
  83     return [output_api.PresubmitPromptWarning(
  84         'You might be calling functions intended only for testing from\n'
  85         'production code. Please verify that the following usages are OK,\n'
  86         'and email joi@chromium.org if you are seeing false positives:',
  87         problems)]
  88   else:
  89     return []
  90
  91
  92 def _CheckNoIOStreamInHeaders(input_api, output_api):
  93   """Checks to make sure no .h files include <iostream>."""
  94   files = []
  95   pattern = input_api.re.compile(r'^#include\s*<iostream>',
  96                                  input_api.re.MULTILINE)
  97   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
  98     if not f.LocalPath().endswith('.h'):
  99       continue
 100     contents = input_api.ReadFile(f)
 101     if pattern.search(contents):
 102       files.append(f)
 103
 104   if len(files):
 105     return [ output_api.PresubmitError(
 106         'Do not #include <iostream> in header files, since it inserts static ' +
 107         'initialization into every file including the header. Instead, ' +
 108         '#include <ostream>. See http://crbug.com/94794',
 109         files) ]
 110   return []
 111
 112
 113 def _CheckNoNewWStrings(input_api, output_api):
 114   """Checks to make sure we don't introduce use of wstrings."""
 115   errors = []
 116   for f in input_api.AffectedFiles():
 117     for line_num, line in f.ChangedContents():
 118       if (not f.LocalPath().endswith(('.cc', '.h')) or
 119           f.LocalPath().endswith('test.cc')):
 120         continue
 121
 122       if 'wstring' in line:
 123         errors.append(output_api.PresubmitError(
 124             '%s, line %d: new code should not use wstrings.  If you are '
 125             'calling an API that accepts a wstring, fix the API.'
 126             % (f.LocalPath(), line_num)))
 127
 128   return errors
 129
 130
 131 def _CommonChecks(input_api, output_api):
 132   """Checks common to both upload and commit."""
 133   results = []
 134   results.extend(input_api.canned_checks.PanProjectChecks(
 135       input_api, output_api, excluded_paths=_EXCLUDED_PATHS))
 136   results.extend(_CheckNoInterfacesInBase(input_api, output_api))
 137   results.extend(_CheckAuthorizedAuthor(input_api, output_api))
 138   results.extend(
 139     _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
 140   results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
 141   results.extend(_CheckNoNewWStrings(input_api, output_api))
 142   return results
 143
 144
 145 def _CheckSubversionConfig(input_api, output_api):
 146   """Verifies the subversion config file is correctly setup.
 147
 148   Checks that autoprops are enabled, returns an error otherwise.
 149   """
 150   join = input_api.os_path.join
 151   if input_api.platform == 'win32':
 152     appdata = input_api.environ.get('APPDATA', '')
 153     if not appdata:
 154       return [output_api.PresubmitError('%APPDATA% is not configured.')]
 155     path = join(appdata, 'Subversion', 'config')
 156   else:
 157     home = input_api.environ.get('HOME', '')
 158     if not home:
 159       return [output_api.PresubmitError('$HOME is not configured.')]
 160     path = join(home, '.subversion', 'config')
 161
 162   error_msg = (
 163       'Please look at http://dev.chromium.org/developers/coding-style to\n'
 164       'configure your subversion configuration file. This enables automatic\n'
 165       'properties to simplify the project maintenance.\n'
 166       'Pro-tip: just download and install\n'
 167       'http://src.chromium.org/viewvc/chrome/trunk/tools/build/slave/config\n')
 168
 169   try:
 170     lines = open(path, 'r').read().splitlines()
 171     # Make sure auto-props is enabled and check for 2 Chromium standard
 172     # auto-prop.
 173     if (not '*.cc = svn:eol-style=LF' in lines or
 174         not '*.pdf = svn:mime-type=application/pdf' in lines or
 175         not 'enable-auto-props = yes' in lines):
 176       return [
 177           output_api.PresubmitNotifyResult(
 178               'It looks like you have not configured your subversion config '
 179               'file or it is not up-to-date.\n' + error_msg)
 180       ]
 181   except (OSError, IOError):
 182     return [
 183         output_api.PresubmitNotifyResult(
 184             'Can\'t find your subversion config file.\n' + error_msg)
 185     ]
 186   return []
 187
 188
 189 def _CheckAuthorizedAuthor(input_api, output_api):
 190   """For non-googler/chromites committers, verify the author's email address is
 191   in AUTHORS.
 192   """
 193   # TODO(maruel): Add it to input_api?
 194   import fnmatch
 195
 196   author = input_api.change.author_email
 197   if not author:
 198     input_api.logging.info('No author, skipping AUTHOR check')
 199     return []
 200   authors_path = input_api.os_path.join(
 201       input_api.PresubmitLocalPath(), 'AUTHORS')
 202   valid_authors = (
 203       input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
 204       for line in open(authors_path))
 205   valid_authors = [item.group(1).lower() for item in valid_authors if item]
 206   if input_api.verbose:
 207     print 'Valid authors are %s' % ', '.join(valid_authors)
 208   if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
 209     return [output_api.PresubmitPromptWarning(
 210         ('%s is not in AUTHORS file. If you are a new contributor, please visit'
 211         '\n'
 212         'http://www.chromium.org/developers/contributing-code and read the '
 213         '"Legal" section\n'
 214         'If you are a chromite, verify the contributor signed the CLA.') %
 215         author)]
 216   return []
 217
 218
 219 def CheckChangeOnUpload(input_api, output_api):
 220   results = []
 221   results.extend(_CommonChecks(input_api, output_api))
 222   return results
 223
 224
 225 def CheckChangeOnCommit(input_api, output_api):
 226   results = []
 227   results.extend(_CommonChecks(input_api, output_api))
 228   # TODO(thestig) temporarily disabled, doesn't work in third_party/
 229   #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
 230   #    input_api, output_api, sources))
 231   # Make sure the tree is 'open'.
 232   results.extend(input_api.canned_checks.CheckTreeIsOpen(
 233       input_api,
 234       output_api,
 235       json_url='http://chromium-status.appspot.com/current?format=json'))
 236   results.extend(input_api.canned_checks.CheckRietveldTryJobExecution(input_api,
 237       output_api, 'http://codereview.chromium.org', ('win', 'linux', 'mac'),
 238       'tryserver@chromium.org'))
 239
 240   results.extend(input_api.canned_checks.CheckChangeHasBugField(
 241       input_api, output_api))
 242   results.extend(input_api.canned_checks.CheckChangeHasTestField(
 243       input_api, output_api))
 244   results.extend(_CheckSubversionConfig(input_api, output_api))
 245   return results
 246
 247
 248 def GetPreferredTrySlaves(project, change):
 249   only_objc_files = all(
 250       f.LocalPath().endswith(('.mm', '.m')) for f in change.AffectedFiles())
 251   if only_objc_files:
 252     return ['mac']
 253   return ['win', 'linux', 'mac']