PRESUBMIT.py

   1 # Copyright (c) 2012 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
  12 import re
  13 import subprocess
  14 import sys
  15
  16
  17 _EXCLUDED_PATHS = (
  18     r"^breakpad[\\\/].*",
  19     r"^native_client_sdk[\\\/].*",
  20     r"^net[\\\/]tools[\\\/]spdyshark[\\\/].*",
  21     r"^skia[\\\/].*",
  22     r"^v8[\\\/].*",
  23     r".*MakeFile$",
  24     r".+_autogen\.h$",
  25     r"^cc[\\\/].*",
  26 )
  27
  28
  29 _TEST_ONLY_WARNING = (
  30     'You might be calling functions intended only for testing from\n'
  31     'production code.  It is OK to ignore this warning if you know what\n'
  32     'you are doing, as the heuristics used to detect the situation are\n'
  33     'not perfect.  The commit queue will not block on this warning.\n'
  34     'Email joi@chromium.org if you have questions.')
  35
  36
  37 _BANNED_OBJC_FUNCTIONS = (
  38     (
  39       'addTrackingRect:',
  40       (
  41        'The use of -[NSView addTrackingRect:owner:userData:assumeInside:] is'
  42        'prohibited. Please use CrTrackingArea instead.',
  43        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  44       ),
  45       False,
  46     ),
  47     (
  48       'NSTrackingArea',
  49       (
  50        'The use of NSTrackingAreas is prohibited. Please use CrTrackingArea',
  51        'instead.',
  52        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  53       ),
  54       False,
  55     ),
  56     (
  57       'convertPointFromBase:',
  58       (
  59        'The use of -[NSView convertPointFromBase:] is almost certainly wrong.',
  60        'Please use |convertPoint:(point) fromView:nil| instead.',
  61        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  62       ),
  63       True,
  64     ),
  65     (
  66       'convertPointToBase:',
  67       (
  68        'The use of -[NSView convertPointToBase:] is almost certainly wrong.',
  69        'Please use |convertPoint:(point) toView:nil| instead.',
  70        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  71       ),
  72       True,
  73     ),
  74     (
  75       'convertRectFromBase:',
  76       (
  77        'The use of -[NSView convertRectFromBase:] is almost certainly wrong.',
  78        'Please use |convertRect:(point) fromView:nil| instead.',
  79        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  80       ),
  81       True,
  82     ),
  83     (
  84       'convertRectToBase:',
  85       (
  86        'The use of -[NSView convertRectToBase:] is almost certainly wrong.',
  87        'Please use |convertRect:(point) toView:nil| instead.',
  88        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  89       ),
  90       True,
  91     ),
  92     (
  93       'convertSizeFromBase:',
  94       (
  95        'The use of -[NSView convertSizeFromBase:] is almost certainly wrong.',
  96        'Please use |convertSize:(point) fromView:nil| instead.',
  97        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  98       ),
  99       True,
 100     ),
 101     (
 102       'convertSizeToBase:',
 103       (
 104        'The use of -[NSView convertSizeToBase:] is almost certainly wrong.',
 105        'Please use |convertSize:(point) toView:nil| instead.',
 106        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 107       ),
 108       True,
 109     ),
 110 )
 111
 112
 113 _BANNED_CPP_FUNCTIONS = (
 114     # Make sure that gtest's FRIEND_TEST() macro is not used; the
 115     # FRIEND_TEST_ALL_PREFIXES() macro from base/gtest_prod_util.h should be
 116     # used instead since that allows for FLAKY_, FAILS_ and DISABLED_ prefixes.
 117     (
 118       'FRIEND_TEST(',
 119       (
 120        'Chromium code should not use gtest\'s FRIEND_TEST() macro. Include',
 121        'base/gtest_prod_util.h and use FRIEND_TEST_ALL_PREFIXES() instead.',
 122       ),
 123       False,
 124     ),
 125     (
 126       'ScopedAllowIO',
 127       (
 128        'New code should not use ScopedAllowIO. Post a task to the blocking',
 129        'pool or the FILE thread instead.',
 130       ),
 131       True,
 132     ),
 133     (
 134       'FilePathWatcher::Delegate',
 135       (
 136        'New code should not use FilePathWatcher::Delegate. Use the callback',
 137        'interface instead.',
 138       ),
 139       False,
 140     ),
 141     (
 142       'browser::FindLastActiveWithProfile',
 143       (
 144        'This function is deprecated and we\'re working on removing it. Pass',
 145        'more context to get a Browser*, like a WebContents, window, or session',
 146        'id. Talk to ben@ or jam@ for more information.',
 147       ),
 148       True,
 149     ),
 150     (
 151       'browser::FindAnyBrowser',
 152       (
 153        'This function is deprecated and we\'re working on removing it. Pass',
 154        'more context to get a Browser*, like a WebContents, window, or session',
 155        'id. Talk to ben@ or jam@ for more information.',
 156       ),
 157       True,
 158     ),
 159     (
 160       'browser::FindOrCreateTabbedBrowser',
 161       (
 162        'This function is deprecated and we\'re working on removing it. Pass',
 163        'more context to get a Browser*, like a WebContents, window, or session',
 164        'id. Talk to ben@ or jam@ for more information.',
 165       ),
 166       True,
 167     ),
 168     (
 169       'browser::FindTabbedBrowser',
 170       (
 171        'This function is deprecated and we\'re working on removing it. Pass',
 172        'more context to get a Browser*, like a WebContents, window, or session',
 173        'id. Talk to ben@ or jam@ for more information.',
 174       ),
 175       True,
 176     ),
 177 )
 178
 179
 180
 181 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
 182   """Attempts to prevent use of functions intended only for testing in
 183   non-testing code. For now this is just a best-effort implementation
 184   that ignores header files and may have some false positives. A
 185   better implementation would probably need a proper C++ parser.
 186   """
 187   # We only scan .cc files and the like, as the declaration of
 188   # for-testing functions in header files are hard to distinguish from
 189   # calls to such functions without a proper C++ parser.
 190   platform_specifiers = r'(_(android|chromeos|gtk|mac|posix|win))?'
 191   source_extensions = r'\.(cc|cpp|cxx|mm)$'
 192   file_inclusion_pattern = r'.+%s' % source_extensions
 193   file_exclusion_patterns = (
 194       r'.*[/\\](test_|mock_).+%s' % source_extensions,
 195       r'.+_test_(base|support|util)%s' % source_extensions,
 196       r'.+_(api|browser|perf|unit|ui)?test%s%s' % (platform_specifiers,
 197                                                    source_extensions),
 198       r'.+profile_sync_service_harness%s' % source_extensions,
 199       )
 200   path_exclusion_patterns = (
 201       r'.*[/\\](test|tool(s)?)[/\\].*',
 202       # At request of folks maintaining this folder.
 203       r'chrome[/\\]browser[/\\]automation[/\\].*',
 204       )
 205
 206   base_function_pattern = r'ForTest(ing)?|for_test(ing)?'
 207   inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
 208   exclusion_pattern = input_api.re.compile(
 209     r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
 210       base_function_pattern, base_function_pattern))
 211
 212   def FilterFile(affected_file):
 213     black_list = (file_exclusion_patterns + path_exclusion_patterns +
 214                   _EXCLUDED_PATHS + input_api.DEFAULT_BLACK_LIST)
 215     return input_api.FilterSourceFile(
 216       affected_file,
 217       white_list=(file_inclusion_pattern, ),
 218       black_list=black_list)
 219
 220   problems = []
 221   for f in input_api.AffectedSourceFiles(FilterFile):
 222     local_path = f.LocalPath()
 223     lines = input_api.ReadFile(f).splitlines()
 224     line_number = 0
 225     for line in lines:
 226       if (inclusion_pattern.search(line) and
 227           not exclusion_pattern.search(line)):
 228         problems.append(
 229           '%s:%d\n    %s' % (local_path, line_number, line.strip()))
 230       line_number += 1
 231
 232   if problems:
 233     if not input_api.is_committing:
 234       return [output_api.PresubmitPromptWarning(_TEST_ONLY_WARNING, problems)]
 235     else:
 236       # We don't warn on commit, to avoid stopping commits going through CQ.
 237       return [output_api.PresubmitNotifyResult(_TEST_ONLY_WARNING, problems)]
 238   else:
 239     return []
 240
 241
 242 def _CheckNoIOStreamInHeaders(input_api, output_api):
 243   """Checks to make sure no .h files include <iostream>."""
 244   files = []
 245   pattern = input_api.re.compile(r'^#include\s*<iostream>',
 246                                  input_api.re.MULTILINE)
 247   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 248     if not f.LocalPath().endswith('.h'):
 249       continue
 250     contents = input_api.ReadFile(f)
 251     if pattern.search(contents):
 252       files.append(f)
 253
 254   if len(files):
 255     return [ output_api.PresubmitError(
 256         'Do not #include <iostream> in header files, since it inserts static '
 257         'initialization into every file including the header. Instead, '
 258         '#include <ostream>. See http://crbug.com/94794',
 259         files) ]
 260   return []
 261
 262
 263 def _CheckNoUNIT_TESTInSourceFiles(input_api, output_api):
 264   """Checks to make sure no source files use UNIT_TEST"""
 265   problems = []
 266   for f in input_api.AffectedFiles():
 267     if (not f.LocalPath().endswith(('.cc', '.mm'))):
 268       continue
 269
 270     for line_num, line in f.ChangedContents():
 271       if 'UNIT_TEST' in line:
 272         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 273
 274   if not problems:
 275     return []
 276   return [output_api.PresubmitPromptWarning('UNIT_TEST is only for headers.\n' +
 277       '\n'.join(problems))]
 278
 279
 280 def _CheckNoNewWStrings(input_api, output_api):
 281   """Checks to make sure we don't introduce use of wstrings."""
 282   problems = []
 283   for f in input_api.AffectedFiles():
 284     if (not f.LocalPath().endswith(('.cc', '.h')) or
 285         f.LocalPath().endswith('test.cc')):
 286       continue
 287
 288     allowWString = False
 289     for line_num, line in f.ChangedContents():
 290       if 'presubmit: allow wstring' in line:
 291         allowWString = True
 292       elif not allowWString and 'wstring' in line:
 293         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 294         allowWString = False
 295       else:
 296         allowWString = False
 297
 298   if not problems:
 299     return []
 300   return [output_api.PresubmitPromptWarning('New code should not use wstrings.'
 301       '  If you are calling a cross-platform API that accepts a wstring, '
 302       'fix the API.\n' +
 303       '\n'.join(problems))]
 304
 305
 306 def _CheckNoDEPSGIT(input_api, output_api):
 307   """Make sure .DEPS.git is never modified manually."""
 308   if any(f.LocalPath().endswith('.DEPS.git') for f in
 309       input_api.AffectedFiles()):
 310     return [output_api.PresubmitError(
 311       'Never commit changes to .DEPS.git. This file is maintained by an\n'
 312       'automated system based on what\'s in DEPS and your changes will be\n'
 313       'overwritten.\n'
 314       'See http://code.google.com/p/chromium/wiki/UsingNewGit#Rolling_DEPS\n'
 315       'for more information')]
 316   return []
 317
 318
 319 def _CheckNoBannedFunctions(input_api, output_api):
 320   """Make sure that banned functions are not used."""
 321   warnings = []
 322   errors = []
 323
 324   file_filter = lambda f: f.LocalPath().endswith(('.mm', '.m', '.h'))
 325   for f in input_api.AffectedFiles(file_filter=file_filter):
 326     for line_num, line in f.ChangedContents():
 327       for func_name, message, error in _BANNED_OBJC_FUNCTIONS:
 328         if func_name in line:
 329           problems = warnings;
 330           if error:
 331             problems = errors;
 332           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 333           for message_line in message:
 334             problems.append('      %s' % message_line)
 335
 336   file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm', '.h'))
 337   for f in input_api.AffectedFiles(file_filter=file_filter):
 338     for line_num, line in f.ChangedContents():
 339       for func_name, message, error in _BANNED_CPP_FUNCTIONS:
 340         if func_name in line:
 341           problems = warnings;
 342           if error:
 343             problems = errors;
 344           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 345           for message_line in message:
 346             problems.append('      %s' % message_line)
 347
 348   result = []
 349   if (warnings):
 350     result.append(output_api.PresubmitPromptWarning(
 351         'Banned functions were used.\n' + '\n'.join(warnings)))
 352   if (errors):
 353     result.append(output_api.PresubmitError(
 354         'Banned functions were used.\n' + '\n'.join(errors)))
 355   return result
 356
 357
 358 def _CheckNoPragmaOnce(input_api, output_api):
 359   """Make sure that banned functions are not used."""
 360   files = []
 361   pattern = input_api.re.compile(r'^#pragma\s+once',
 362                                  input_api.re.MULTILINE)
 363   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 364     if not f.LocalPath().endswith('.h'):
 365       continue
 366     contents = input_api.ReadFile(f)
 367     if pattern.search(contents):
 368       files.append(f)
 369
 370   if files:
 371     return [output_api.PresubmitError(
 372         'Do not use #pragma once in header files.\n'
 373         'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
 374         files)]
 375   return []
 376
 377
 378 def _CheckUnwantedDependencies(input_api, output_api):
 379   """Runs checkdeps on #include statements added in this
 380   change. Breaking - rules is an error, breaking ! rules is a
 381   warning.
 382   """
 383   # We need to wait until we have an input_api object and use this
 384   # roundabout construct to import checkdeps because this file is
 385   # eval-ed and thus doesn't have __file__.
 386   original_sys_path = sys.path
 387   try:
 388     sys.path = sys.path + [input_api.os_path.join(
 389         input_api.PresubmitLocalPath(), 'tools', 'checkdeps')]
 390     import checkdeps
 391     from cpp_checker import CppChecker
 392     from rules import Rule
 393   finally:
 394     # Restore sys.path to what it was before.
 395     sys.path = original_sys_path
 396
 397   added_includes = []
 398   for f in input_api.AffectedFiles():
 399     if not CppChecker.IsCppFile(f.LocalPath()):
 400       continue
 401
 402     changed_lines = [line for line_num, line in f.ChangedContents()]
 403     added_includes.append([f.LocalPath(), changed_lines])
 404
 405   deps_checker = checkdeps.DepsChecker()
 406
 407   error_descriptions = []
 408   warning_descriptions = []
 409   for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
 410       added_includes):
 411     description_with_path = '%s\n    %s' % (path, rule_description)
 412     if rule_type == Rule.DISALLOW:
 413       error_descriptions.append(description_with_path)
 414     else:
 415       warning_descriptions.append(description_with_path)
 416
 417   results = []
 418   if error_descriptions:
 419     results.append(output_api.PresubmitError(
 420         'You added one or more #includes that violate checkdeps rules.',
 421         error_descriptions))
 422   if warning_descriptions:
 423     if not input_api.is_committing:
 424       warning_factory = output_api.PresubmitPromptWarning
 425     else:
 426       # We don't want to block use of the CQ when there is a warning
 427       # of this kind, so we only show a message when committing.
 428       warning_factory = output_api.PresubmitNotifyResult
 429     results.append(warning_factory(
 430         'You added one or more #includes of files that are temporarily\n'
 431         'allowed but being removed. Can you avoid introducing the\n'
 432         '#include? See relevant DEPS file(s) for details and contacts.',
 433         warning_descriptions))
 434   return results
 435
 436
 437 def _CheckFilePermissions(input_api, output_api):
 438   """Check that all files have their permissions properly set."""
 439   args = [sys.executable, 'tools/checkperms/checkperms.py', '--root',
 440           input_api.change.RepositoryRoot()]
 441   for f in input_api.AffectedFiles():
 442     args += ['--file', f.LocalPath()]
 443   errors = []
 444   (errors, stderrdata) = subprocess.Popen(args).communicate()
 445
 446   results = []
 447   if errors:
 448     results.append(output_api.PreSubmitError('checkperms.py failed.',
 449                                              errors))
 450   return results
 451
 452
 453 def _CommonChecks(input_api, output_api):
 454   """Checks common to both upload and commit."""
 455   results = []
 456   results.extend(input_api.canned_checks.PanProjectChecks(
 457       input_api, output_api, excluded_paths=_EXCLUDED_PATHS))
 458   results.extend(_CheckAuthorizedAuthor(input_api, output_api))
 459   results.extend(
 460     _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
 461   results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
 462   results.extend(_CheckNoUNIT_TESTInSourceFiles(input_api, output_api))
 463   results.extend(_CheckNoNewWStrings(input_api, output_api))
 464   results.extend(_CheckNoDEPSGIT(input_api, output_api))
 465   results.extend(_CheckNoBannedFunctions(input_api, output_api))
 466   results.extend(_CheckNoPragmaOnce(input_api, output_api))
 467   results.extend(_CheckUnwantedDependencies(input_api, output_api))
 468   results.extend(_CheckFilePermissions(input_api, output_api))
 469   return results
 470
 471
 472 def _CheckSubversionConfig(input_api, output_api):
 473   """Verifies the subversion config file is correctly setup.
 474
 475   Checks that autoprops are enabled, returns an error otherwise.
 476   """
 477   join = input_api.os_path.join
 478   if input_api.platform == 'win32':
 479     appdata = input_api.environ.get('APPDATA', '')
 480     if not appdata:
 481       return [output_api.PresubmitError('%APPDATA% is not configured.')]
 482     path = join(appdata, 'Subversion', 'config')
 483   else:
 484     home = input_api.environ.get('HOME', '')
 485     if not home:
 486       return [output_api.PresubmitError('$HOME is not configured.')]
 487     path = join(home, '.subversion', 'config')
 488
 489   error_msg = (
 490       'Please look at http://dev.chromium.org/developers/coding-style to\n'
 491       'configure your subversion configuration file. This enables automatic\n'
 492       'properties to simplify the project maintenance.\n'
 493       'Pro-tip: just download and install\n'
 494       'http://src.chromium.org/viewvc/chrome/trunk/tools/build/slave/config\n')
 495
 496   try:
 497     lines = open(path, 'r').read().splitlines()
 498     # Make sure auto-props is enabled and check for 2 Chromium standard
 499     # auto-prop.
 500     if (not '*.cc = svn:eol-style=LF' in lines or
 501         not '*.pdf = svn:mime-type=application/pdf' in lines or
 502         not 'enable-auto-props = yes' in lines):
 503       return [
 504           output_api.PresubmitNotifyResult(
 505               'It looks like you have not configured your subversion config '
 506               'file or it is not up-to-date.\n' + error_msg)
 507       ]
 508   except (OSError, IOError):
 509     return [
 510         output_api.PresubmitNotifyResult(
 511             'Can\'t find your subversion config file.\n' + error_msg)
 512     ]
 513   return []
 514
 515
 516 def _CheckAuthorizedAuthor(input_api, output_api):
 517   """For non-googler/chromites committers, verify the author's email address is
 518   in AUTHORS.
 519   """
 520   # TODO(maruel): Add it to input_api?
 521   import fnmatch
 522
 523   author = input_api.change.author_email
 524   if not author:
 525     input_api.logging.info('No author, skipping AUTHOR check')
 526     return []
 527   authors_path = input_api.os_path.join(
 528       input_api.PresubmitLocalPath(), 'AUTHORS')
 529   valid_authors = (
 530       input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
 531       for line in open(authors_path))
 532   valid_authors = [item.group(1).lower() for item in valid_authors if item]
 533   if input_api.verbose:
 534     print 'Valid authors are %s' % ', '.join(valid_authors)
 535   if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
 536     return [output_api.PresubmitPromptWarning(
 537         ('%s is not in AUTHORS file. If you are a new contributor, please visit'
 538         '\n'
 539         'http://www.chromium.org/developers/contributing-code and read the '
 540         '"Legal" section\n'
 541         'If you are a chromite, verify the contributor signed the CLA.') %
 542         author)]
 543   return []
 544
 545
 546 def CheckChangeOnUpload(input_api, output_api):
 547   results = []
 548   results.extend(_CommonChecks(input_api, output_api))
 549   return results
 550
 551
 552 def CheckChangeOnCommit(input_api, output_api):
 553   results = []
 554   results.extend(_CommonChecks(input_api, output_api))
 555   # TODO(thestig) temporarily disabled, doesn't work in third_party/
 556   #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
 557   #    input_api, output_api, sources))
 558   # Make sure the tree is 'open'.
 559   results.extend(input_api.canned_checks.CheckTreeIsOpen(
 560       input_api,
 561       output_api,
 562       json_url='http://chromium-status.appspot.com/current?format=json'))
 563   results.extend(input_api.canned_checks.CheckRietveldTryJobExecution(input_api,
 564       output_api, 'http://codereview.chromium.org',
 565       ('win_rel', 'linux_rel', 'mac_rel, win:compile'),
 566       'tryserver@chromium.org'))
 567
 568   results.extend(input_api.canned_checks.CheckChangeHasBugField(
 569       input_api, output_api))
 570   results.extend(input_api.canned_checks.CheckChangeHasDescription(
 571       input_api, output_api))
 572   results.extend(_CheckSubversionConfig(input_api, output_api))
 573   return results
 574
 575
 576 def GetPreferredTrySlaves(project, change):
 577   files = change.LocalPaths()
 578
 579   if not files:
 580     return []
 581
 582   if all(re.search('\.(m|mm)$|[/_]mac[/_.]', f) for f in files):
 583     return ['mac_rel']
 584   if all(re.search('[/_]win[/_.]', f) for f in files):
 585     return ['win_rel']
 586   if all(re.search('[/_]android[/_.]', f) for f in files):
 587     return ['android']
 588
 589   trybots = ['win_rel', 'linux_rel', 'mac_rel', 'linux_clang:compile',
 590              'android']
 591
 592   # Match things like path/aura/file.cc and path/file_aura.cc.
 593   # Same for ash and chromeos.
 594   if any(re.search('[/_](ash|aura)', f) for f in files):
 595     trybots += ['linux_chromeos', 'linux_chromeos_clang:compile', 'win_aura']
 596   else:
 597     if any(re.search('[/_]chromeos', f) for f in files):
 598       trybots += ['linux_chromeos', 'linux_chromeos_clang:compile']
 599
 600   return trybots