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 depot_tools.
   9 """
  10
  11
  12 _EXCLUDED_PATHS = (
  13     r"^breakpad[\\\/].*",
  14     r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_rules.py",
  15     r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_simple.py",
  16     r"^native_client_sdk[\\\/]src[\\\/]tools[\\\/].*.mk",
  17     r"^net[\\\/]tools[\\\/]spdyshark[\\\/].*",
  18     r"^skia[\\\/].*",
  19     r"^v8[\\\/].*",
  20     r".*MakeFile$",
  21     r".+_autogen\.h$",
  22     r".+[\\\/]pnacl_shim\.c$",
  23     r"^gpu[\\\/]config[\\\/].*_list_json\.cc$",
  24     r"^chrome[\\\/]browser[\\\/]resources[\\\/]pdf[\\\/]index.js"
  25 )
  26
  27 # The NetscapePlugIn library is excluded from pan-project as it will soon
  28 # be deleted together with the rest of the NPAPI and it's not worthwhile to
  29 # update the coding style until then.
  30 _TESTRUNNER_PATHS = (
  31     r"^content[\\\/]shell[\\\/]tools[\\\/]plugin[\\\/].*",
  32 )
  33
  34 # Fragment of a regular expression that matches C++ and Objective-C++
  35 # implementation files.
  36 _IMPLEMENTATION_EXTENSIONS = r'\.(cc|cpp|cxx|mm)$'
  37
  38 # Regular expression that matches code only used for test binaries
  39 # (best effort).
  40 _TEST_CODE_EXCLUDED_PATHS = (
  41     r'.*[\\\/](fake_|test_|mock_).+%s' % _IMPLEMENTATION_EXTENSIONS,
  42     r'.+_test_(base|support|util)%s' % _IMPLEMENTATION_EXTENSIONS,
  43     r'.+_(api|browser|kif|perf|pixel|unit|ui)?test(_[a-z]+)?%s' %
  44         _IMPLEMENTATION_EXTENSIONS,
  45     r'.+profile_sync_service_harness%s' % _IMPLEMENTATION_EXTENSIONS,
  46     r'.*[\\\/](test|tool(s)?)[\\\/].*',
  47     # content_shell is used for running layout tests.
  48     r'content[\\\/]shell[\\\/].*',
  49     # At request of folks maintaining this folder.
  50     r'chrome[\\\/]browser[\\\/]automation[\\\/].*',
  51     # Non-production example code.
  52     r'mojo[\\\/]examples[\\\/].*',
  53     # Launcher for running iOS tests on the simulator.
  54     r'testing[\\\/]iossim[\\\/]iossim\.mm$',
  55 )
  56
  57 _TEST_ONLY_WARNING = (
  58     'You might be calling functions intended only for testing from\n'
  59     'production code.  It is OK to ignore this warning if you know what\n'
  60     'you are doing, as the heuristics used to detect the situation are\n'
  61     'not perfect.  The commit queue will not block on this warning.')
  62
  63
  64 _INCLUDE_ORDER_WARNING = (
  65     'Your #include order seems to be broken. Remember to use the right '
  66     'collation (LC_COLLATE=C) and check https://google-styleguide.googlecode'
  67     '.com/svn/trunk/cppguide.html#Names_and_Order_of_Includes')
  68
  69 _BANNED_OBJC_FUNCTIONS = (
  70     (
  71       'addTrackingRect:',
  72       (
  73        'The use of -[NSView addTrackingRect:owner:userData:assumeInside:] is'
  74        'prohibited. Please use CrTrackingArea instead.',
  75        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  76       ),
  77       False,
  78     ),
  79     (
  80       r'/NSTrackingArea\W',
  81       (
  82        'The use of NSTrackingAreas is prohibited. Please use CrTrackingArea',
  83        'instead.',
  84        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  85       ),
  86       False,
  87     ),
  88     (
  89       'convertPointFromBase:',
  90       (
  91        'The use of -[NSView convertPointFromBase:] is almost certainly wrong.',
  92        'Please use |convertPoint:(point) fromView:nil| instead.',
  93        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  94       ),
  95       True,
  96     ),
  97     (
  98       'convertPointToBase:',
  99       (
 100        'The use of -[NSView convertPointToBase:] is almost certainly wrong.',
 101        'Please use |convertPoint:(point) toView:nil| instead.',
 102        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 103       ),
 104       True,
 105     ),
 106     (
 107       'convertRectFromBase:',
 108       (
 109        'The use of -[NSView convertRectFromBase:] is almost certainly wrong.',
 110        'Please use |convertRect:(point) fromView:nil| instead.',
 111        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 112       ),
 113       True,
 114     ),
 115     (
 116       'convertRectToBase:',
 117       (
 118        'The use of -[NSView convertRectToBase:] is almost certainly wrong.',
 119        'Please use |convertRect:(point) toView:nil| instead.',
 120        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 121       ),
 122       True,
 123     ),
 124     (
 125       'convertSizeFromBase:',
 126       (
 127        'The use of -[NSView convertSizeFromBase:] is almost certainly wrong.',
 128        'Please use |convertSize:(point) fromView:nil| instead.',
 129        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 130       ),
 131       True,
 132     ),
 133     (
 134       'convertSizeToBase:',
 135       (
 136        'The use of -[NSView convertSizeToBase:] is almost certainly wrong.',
 137        'Please use |convertSize:(point) toView:nil| instead.',
 138        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 139       ),
 140       True,
 141     ),
 142 )
 143
 144
 145 _BANNED_CPP_FUNCTIONS = (
 146     # Make sure that gtest's FRIEND_TEST() macro is not used; the
 147     # FRIEND_TEST_ALL_PREFIXES() macro from base/gtest_prod_util.h should be
 148     # used instead since that allows for FLAKY_ and DISABLED_ prefixes.
 149     (
 150       'FRIEND_TEST(',
 151       (
 152        'Chromium code should not use gtest\'s FRIEND_TEST() macro. Include',
 153        'base/gtest_prod_util.h and use FRIEND_TEST_ALL_PREFIXES() instead.',
 154       ),
 155       False,
 156       (),
 157     ),
 158     (
 159       'ScopedAllowIO',
 160       (
 161        'New code should not use ScopedAllowIO. Post a task to the blocking',
 162        'pool or the FILE thread instead.',
 163       ),
 164       True,
 165       (
 166         r"^base[\\\/]process[\\\/]process_metrics_linux\.cc$",
 167         r"^chrome[\\\/]browser[\\\/]chromeos[\\\/]boot_times_recorder\.cc$",
 168         r"^chrome[\\\/]browser[\\\/]chromeos[\\\/]"
 169             "customization_document_browsertest\.cc$",
 170         r"^components[\\\/]crash[\\\/]app[\\\/]breakpad_mac\.mm$",
 171         r"^content[\\\/]shell[\\\/]browser[\\\/]shell_browser_main\.cc$",
 172         r"^content[\\\/]shell[\\\/]browser[\\\/]shell_message_filter\.cc$",
 173         r"^mojo[\\\/]edk[\\\/]embedder[\\\/]" +
 174             r"simple_platform_shared_buffer_posix\.cc$",
 175         r"^net[\\\/]disk_cache[\\\/]cache_util\.cc$",
 176         r"^net[\\\/]url_request[\\\/]test_url_fetcher_factory\.cc$",
 177         r"^ui[\\\/]ozone[\\\/]platform[\\\/]drm[\\\/]host[\\\/]"
 178             "drm_display_host_manager\.cc$",
 179       ),
 180     ),
 181     (
 182       'SkRefPtr',
 183       (
 184         'The use of SkRefPtr is prohibited. ',
 185         'Please use skia::RefPtr instead.'
 186       ),
 187       True,
 188       (),
 189     ),
 190     (
 191       'SkAutoRef',
 192       (
 193         'The indirect use of SkRefPtr via SkAutoRef is prohibited. ',
 194         'Please use skia::RefPtr instead.'
 195       ),
 196       True,
 197       (),
 198     ),
 199     (
 200       'SkAutoTUnref',
 201       (
 202         'The use of SkAutoTUnref is dangerous because it implicitly ',
 203         'converts to a raw pointer. Please use skia::RefPtr instead.'
 204       ),
 205       True,
 206       (),
 207     ),
 208     (
 209       'SkAutoUnref',
 210       (
 211         'The indirect use of SkAutoTUnref through SkAutoUnref is dangerous ',
 212         'because it implicitly converts to a raw pointer. ',
 213         'Please use skia::RefPtr instead.'
 214       ),
 215       True,
 216       (),
 217     ),
 218     (
 219       r'/HANDLE_EINTR\(.*close',
 220       (
 221        'HANDLE_EINTR(close) is invalid. If close fails with EINTR, the file',
 222        'descriptor will be closed, and it is incorrect to retry the close.',
 223        'Either call close directly and ignore its return value, or wrap close',
 224        'in IGNORE_EINTR to use its return value. See http://crbug.com/269623'
 225       ),
 226       True,
 227       (),
 228     ),
 229     (
 230       r'/IGNORE_EINTR\((?!.*close)',
 231       (
 232        'IGNORE_EINTR is only valid when wrapping close. To wrap other system',
 233        'calls, use HANDLE_EINTR. See http://crbug.com/269623',
 234       ),
 235       True,
 236       (
 237         # Files that #define IGNORE_EINTR.
 238         r'^base[\\\/]posix[\\\/]eintr_wrapper\.h$',
 239         r'^ppapi[\\\/]tests[\\\/]test_broker\.cc$',
 240       ),
 241     ),
 242     (
 243       r'/v8::Extension\(',
 244       (
 245         'Do not introduce new v8::Extensions into the code base, use',
 246         'gin::Wrappable instead. See http://crbug.com/334679',
 247       ),
 248       True,
 249       (
 250         r'extensions[\\\/]renderer[\\\/]safe_builtins\.*',
 251       ),
 252     ),
 253     (
 254       '\<MessageLoopProxy\>',
 255       (
 256         'MessageLoopProxy is deprecated. ',
 257         'Please use SingleThreadTaskRunner or ThreadTaskRunnerHandle instead.'
 258       ),
 259       True,
 260       (
 261         # Internal message_loop related code may still use it.
 262         r'^base[\\\/]message_loop[\\\/].*',
 263       ),
 264     ),
 265 )
 266
 267 _IPC_ENUM_TRAITS_DEPRECATED = (
 268     'You are using IPC_ENUM_TRAITS() in your code. It has been deprecated.\n'
 269     'See http://www.chromium.org/Home/chromium-security/education/security-tips-for-ipc')
 270
 271
 272 _VALID_OS_MACROS = (
 273     # Please keep sorted.
 274     'OS_ANDROID',
 275     'OS_ANDROID_HOST',
 276     'OS_BSD',
 277     'OS_CAT',       # For testing.
 278     'OS_CHROMEOS',
 279     'OS_FREEBSD',
 280     'OS_IOS',
 281     'OS_LINUX',
 282     'OS_MACOSX',
 283     'OS_NACL',
 284     'OS_NACL_NONSFI',
 285     'OS_NACL_SFI',
 286     'OS_OPENBSD',
 287     'OS_POSIX',
 288     'OS_QNX',
 289     'OS_SOLARIS',
 290     'OS_WIN',
 291 )
 292
 293
 294 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
 295   """Attempts to prevent use of functions intended only for testing in
 296   non-testing code. For now this is just a best-effort implementation
 297   that ignores header files and may have some false positives. A
 298   better implementation would probably need a proper C++ parser.
 299   """
 300   # We only scan .cc files and the like, as the declaration of
 301   # for-testing functions in header files are hard to distinguish from
 302   # calls to such functions without a proper C++ parser.
 303   file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
 304
 305   base_function_pattern = r'[ :]test::[^\s]+|ForTest(ing)?|for_test(ing)?'
 306   inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
 307   comment_pattern = input_api.re.compile(r'//.*(%s)' % base_function_pattern)
 308   exclusion_pattern = input_api.re.compile(
 309     r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
 310       base_function_pattern, base_function_pattern))
 311
 312   def FilterFile(affected_file):
 313     black_list = (_EXCLUDED_PATHS +
 314                   _TEST_CODE_EXCLUDED_PATHS +
 315                   input_api.DEFAULT_BLACK_LIST)
 316     return input_api.FilterSourceFile(
 317       affected_file,
 318       white_list=(file_inclusion_pattern, ),
 319       black_list=black_list)
 320
 321   problems = []
 322   for f in input_api.AffectedSourceFiles(FilterFile):
 323     local_path = f.LocalPath()
 324     for line_number, line in f.ChangedContents():
 325       if (inclusion_pattern.search(line) and
 326           not comment_pattern.search(line) and
 327           not exclusion_pattern.search(line)):
 328         problems.append(
 329           '%s:%d\n    %s' % (local_path, line_number, line.strip()))
 330
 331   if problems:
 332     return [output_api.PresubmitPromptOrNotify(_TEST_ONLY_WARNING, problems)]
 333   else:
 334     return []
 335
 336
 337 def _CheckNoIOStreamInHeaders(input_api, output_api):
 338   """Checks to make sure no .h files include <iostream>."""
 339   files = []
 340   pattern = input_api.re.compile(r'^#include\s*<iostream>',
 341                                  input_api.re.MULTILINE)
 342   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 343     if not f.LocalPath().endswith('.h'):
 344       continue
 345     contents = input_api.ReadFile(f)
 346     if pattern.search(contents):
 347       files.append(f)
 348
 349   if len(files):
 350     return [ output_api.PresubmitError(
 351         'Do not #include <iostream> in header files, since it inserts static '
 352         'initialization into every file including the header. Instead, '
 353         '#include <ostream>. See http://crbug.com/94794',
 354         files) ]
 355   return []
 356
 357
 358 def _CheckNoUNIT_TESTInSourceFiles(input_api, output_api):
 359   """Checks to make sure no source files use UNIT_TEST"""
 360   problems = []
 361   for f in input_api.AffectedFiles():
 362     if (not f.LocalPath().endswith(('.cc', '.mm'))):
 363       continue
 364
 365     for line_num, line in f.ChangedContents():
 366       if 'UNIT_TEST ' in line or line.endswith('UNIT_TEST'):
 367         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 368
 369   if not problems:
 370     return []
 371   return [output_api.PresubmitPromptWarning('UNIT_TEST is only for headers.\n' +
 372       '\n'.join(problems))]
 373
 374
 375 def _FindHistogramNameInLine(histogram_name, line):
 376   """Tries to find a histogram name or prefix in a line."""
 377   if not "affected-histogram" in line:
 378     return histogram_name in line
 379   # A histogram_suffixes tag type has an affected-histogram name as a prefix of
 380   # the histogram_name.
 381   if not '"' in line:
 382     return False
 383   histogram_prefix = line.split('\"')[1]
 384   return histogram_prefix in histogram_name
 385
 386
 387 def _CheckUmaHistogramChanges(input_api, output_api):
 388   """Check that UMA histogram names in touched lines can still be found in other
 389   lines of the patch or in histograms.xml. Note that this check would not catch
 390   the reverse: changes in histograms.xml not matched in the code itself."""
 391   touched_histograms = []
 392   histograms_xml_modifications = []
 393   pattern = input_api.re.compile('UMA_HISTOGRAM.*\("(.*)"')
 394   for f in input_api.AffectedFiles():
 395     # If histograms.xml itself is modified, keep the modified lines for later.
 396     if f.LocalPath().endswith(('histograms.xml')):
 397       histograms_xml_modifications = f.ChangedContents()
 398       continue
 399     if not f.LocalPath().endswith(('cc', 'mm', 'cpp')):
 400       continue
 401     for line_num, line in f.ChangedContents():
 402       found = pattern.search(line)
 403       if found:
 404         touched_histograms.append([found.group(1), f, line_num])
 405
 406   # Search for the touched histogram names in the local modifications to
 407   # histograms.xml, and, if not found, on the base histograms.xml file.
 408   unmatched_histograms = []
 409   for histogram_info in touched_histograms:
 410     histogram_name_found = False
 411     for line_num, line in histograms_xml_modifications:
 412       histogram_name_found = _FindHistogramNameInLine(histogram_info[0], line)
 413       if histogram_name_found:
 414         break
 415     if not histogram_name_found:
 416       unmatched_histograms.append(histogram_info)
 417
 418   histograms_xml_path = 'tools/metrics/histograms/histograms.xml'
 419   problems = []
 420   if unmatched_histograms:
 421     with open(histograms_xml_path) as histograms_xml:
 422       for histogram_name, f, line_num in unmatched_histograms:
 423         histograms_xml.seek(0)
 424         histogram_name_found = False
 425         for line in histograms_xml:
 426           histogram_name_found = _FindHistogramNameInLine(histogram_name, line)
 427           if histogram_name_found:
 428             break
 429         if not histogram_name_found:
 430           problems.append(' [%s:%d] %s' %
 431                           (f.LocalPath(), line_num, histogram_name))
 432
 433   if not problems:
 434     return []
 435   return [output_api.PresubmitPromptWarning('Some UMA_HISTOGRAM lines have '
 436     'been modified and the associated histogram name has no match in either '
 437     '%s or the modifications of it:' % (histograms_xml_path),  problems)]
 438
 439
 440 def _CheckNoNewWStrings(input_api, output_api):
 441   """Checks to make sure we don't introduce use of wstrings."""
 442   problems = []
 443   for f in input_api.AffectedFiles():
 444     if (not f.LocalPath().endswith(('.cc', '.h')) or
 445         f.LocalPath().endswith(('test.cc', '_win.cc', '_win.h')) or
 446         '/win/' in f.LocalPath()):
 447       continue
 448
 449     allowWString = False
 450     for line_num, line in f.ChangedContents():
 451       if 'presubmit: allow wstring' in line:
 452         allowWString = True
 453       elif not allowWString and 'wstring' in line:
 454         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 455         allowWString = False
 456       else:
 457         allowWString = False
 458
 459   if not problems:
 460     return []
 461   return [output_api.PresubmitPromptWarning('New code should not use wstrings.'
 462       '  If you are calling a cross-platform API that accepts a wstring, '
 463       'fix the API.\n' +
 464       '\n'.join(problems))]
 465
 466
 467 def _CheckNoDEPSGIT(input_api, output_api):
 468   """Make sure .DEPS.git is never modified manually."""
 469   if any(f.LocalPath().endswith('.DEPS.git') for f in
 470       input_api.AffectedFiles()):
 471     return [output_api.PresubmitError(
 472       'Never commit changes to .DEPS.git. This file is maintained by an\n'
 473       'automated system based on what\'s in DEPS and your changes will be\n'
 474       'overwritten.\n'
 475       'See https://sites.google.com/a/chromium.org/dev/developers/how-tos/get-the-code#Rolling_DEPS\n'
 476       'for more information')]
 477   return []
 478
 479
 480 def _CheckValidHostsInDEPS(input_api, output_api):
 481   """Checks that DEPS file deps are from allowed_hosts."""
 482   # Run only if DEPS file has been modified to annoy fewer bystanders.
 483   if all(f.LocalPath() != 'DEPS' for f in input_api.AffectedFiles()):
 484     return []
 485   # Outsource work to gclient verify
 486   try:
 487     input_api.subprocess.check_output(['gclient', 'verify'])
 488     return []
 489   except input_api.subprocess.CalledProcessError, error:
 490     return [output_api.PresubmitError(
 491         'DEPS file must have only git dependencies.',
 492         long_text=error.output)]
 493
 494
 495 def _CheckNoBannedFunctions(input_api, output_api):
 496   """Make sure that banned functions are not used."""
 497   warnings = []
 498   errors = []
 499
 500   file_filter = lambda f: f.LocalPath().endswith(('.mm', '.m', '.h'))
 501   for f in input_api.AffectedFiles(file_filter=file_filter):
 502     for line_num, line in f.ChangedContents():
 503       for func_name, message, error in _BANNED_OBJC_FUNCTIONS:
 504         matched = False
 505         if func_name[0:1] == '/':
 506           regex = func_name[1:]
 507           if input_api.re.search(regex, line):
 508             matched = True
 509         elif func_name in line:
 510             matched = True
 511         if matched:
 512           problems = warnings;
 513           if error:
 514             problems = errors;
 515           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 516           for message_line in message:
 517             problems.append('      %s' % message_line)
 518
 519   file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm', '.h'))
 520   for f in input_api.AffectedFiles(file_filter=file_filter):
 521     for line_num, line in f.ChangedContents():
 522       for func_name, message, error, excluded_paths in _BANNED_CPP_FUNCTIONS:
 523         def IsBlacklisted(affected_file, blacklist):
 524           local_path = affected_file.LocalPath()
 525           for item in blacklist:
 526             if input_api.re.match(item, local_path):
 527               return True
 528           return False
 529         if IsBlacklisted(f, excluded_paths):
 530           continue
 531         matched = False
 532         if func_name[0:1] == '/':
 533           regex = func_name[1:]
 534           if input_api.re.search(regex, line):
 535             matched = True
 536         elif func_name in line:
 537             matched = True
 538         if matched:
 539           problems = warnings;
 540           if error:
 541             problems = errors;
 542           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 543           for message_line in message:
 544             problems.append('      %s' % message_line)
 545
 546   result = []
 547   if (warnings):
 548     result.append(output_api.PresubmitPromptWarning(
 549         'Banned functions were used.\n' + '\n'.join(warnings)))
 550   if (errors):
 551     result.append(output_api.PresubmitError(
 552         'Banned functions were used.\n' + '\n'.join(errors)))
 553   return result
 554
 555
 556 def _CheckNoPragmaOnce(input_api, output_api):
 557   """Make sure that banned functions are not used."""
 558   files = []
 559   pattern = input_api.re.compile(r'^#pragma\s+once',
 560                                  input_api.re.MULTILINE)
 561   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 562     if not f.LocalPath().endswith('.h'):
 563       continue
 564     contents = input_api.ReadFile(f)
 565     if pattern.search(contents):
 566       files.append(f)
 567
 568   if files:
 569     return [output_api.PresubmitError(
 570         'Do not use #pragma once in header files.\n'
 571         'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
 572         files)]
 573   return []
 574
 575
 576 def _CheckNoTrinaryTrueFalse(input_api, output_api):
 577   """Checks to make sure we don't introduce use of foo ? true : false."""
 578   problems = []
 579   pattern = input_api.re.compile(r'\?\s*(true|false)\s*:\s*(true|false)')
 580   for f in input_api.AffectedFiles():
 581     if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
 582       continue
 583
 584     for line_num, line in f.ChangedContents():
 585       if pattern.match(line):
 586         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 587
 588   if not problems:
 589     return []
 590   return [output_api.PresubmitPromptWarning(
 591       'Please consider avoiding the "? true : false" pattern if possible.\n' +
 592       '\n'.join(problems))]
 593
 594
 595 def _CheckUnwantedDependencies(input_api, output_api):
 596   """Runs checkdeps on #include statements added in this
 597   change. Breaking - rules is an error, breaking ! rules is a
 598   warning.
 599   """
 600   import sys
 601   # We need to wait until we have an input_api object and use this
 602   # roundabout construct to import checkdeps because this file is
 603   # eval-ed and thus doesn't have __file__.
 604   original_sys_path = sys.path
 605   try:
 606     sys.path = sys.path + [input_api.os_path.join(
 607         input_api.PresubmitLocalPath(), 'buildtools', 'checkdeps')]
 608     import checkdeps
 609     from cpp_checker import CppChecker
 610     from rules import Rule
 611   finally:
 612     # Restore sys.path to what it was before.
 613     sys.path = original_sys_path
 614
 615   added_includes = []
 616   for f in input_api.AffectedFiles():
 617     if not CppChecker.IsCppFile(f.LocalPath()):
 618       continue
 619
 620     changed_lines = [line for line_num, line in f.ChangedContents()]
 621     added_includes.append([f.LocalPath(), changed_lines])
 622
 623   deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath())
 624
 625   error_descriptions = []
 626   warning_descriptions = []
 627   for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
 628       added_includes):
 629     description_with_path = '%s\n    %s' % (path, rule_description)
 630     if rule_type == Rule.DISALLOW:
 631       error_descriptions.append(description_with_path)
 632     else:
 633       warning_descriptions.append(description_with_path)
 634
 635   results = []
 636   if error_descriptions:
 637     results.append(output_api.PresubmitError(
 638         'You added one or more #includes that violate checkdeps rules.',
 639         error_descriptions))
 640   if warning_descriptions:
 641     results.append(output_api.PresubmitPromptOrNotify(
 642         'You added one or more #includes of files that are temporarily\n'
 643         'allowed but being removed. Can you avoid introducing the\n'
 644         '#include? See relevant DEPS file(s) for details and contacts.',
 645         warning_descriptions))
 646   return results
 647
 648
 649 def _CheckFilePermissions(input_api, output_api):
 650   """Check that all files have their permissions properly set."""
 651   if input_api.platform == 'win32':
 652     return []
 653   args = [input_api.python_executable, 'tools/checkperms/checkperms.py',
 654           '--root', input_api.change.RepositoryRoot()]
 655   for f in input_api.AffectedFiles():
 656     args += ['--file', f.LocalPath()]
 657   checkperms = input_api.subprocess.Popen(args,
 658                                           stdout=input_api.subprocess.PIPE)
 659   errors = checkperms.communicate()[0].strip()
 660   if errors:
 661     return [output_api.PresubmitError('checkperms.py failed.',
 662                                       errors.splitlines())]
 663   return []
 664
 665
 666 def _CheckNoAuraWindowPropertyHInHeaders(input_api, output_api):
 667   """Makes sure we don't include ui/aura/window_property.h
 668   in header files.
 669   """
 670   pattern = input_api.re.compile(r'^#include\s*"ui/aura/window_property.h"')
 671   errors = []
 672   for f in input_api.AffectedFiles():
 673     if not f.LocalPath().endswith('.h'):
 674       continue
 675     for line_num, line in f.ChangedContents():
 676       if pattern.match(line):
 677         errors.append('    %s:%d' % (f.LocalPath(), line_num))
 678
 679   results = []
 680   if errors:
 681     results.append(output_api.PresubmitError(
 682       'Header files should not include ui/aura/window_property.h', errors))
 683   return results
 684
 685
 686 def _CheckIncludeOrderForScope(scope, input_api, file_path, changed_linenums):
 687   """Checks that the lines in scope occur in the right order.
 688
 689   1. C system files in alphabetical order
 690   2. C++ system files in alphabetical order
 691   3. Project's .h files
 692   """
 693
 694   c_system_include_pattern = input_api.re.compile(r'\s*#include <.*\.h>')
 695   cpp_system_include_pattern = input_api.re.compile(r'\s*#include <.*>')
 696   custom_include_pattern = input_api.re.compile(r'\s*#include ".*')
 697
 698   C_SYSTEM_INCLUDES, CPP_SYSTEM_INCLUDES, CUSTOM_INCLUDES = range(3)
 699
 700   state = C_SYSTEM_INCLUDES
 701
 702   previous_line = ''
 703   previous_line_num = 0
 704   problem_linenums = []
 705   for line_num, line in scope:
 706     if c_system_include_pattern.match(line):
 707       if state != C_SYSTEM_INCLUDES:
 708         problem_linenums.append((line_num, previous_line_num))
 709       elif previous_line and previous_line > line:
 710         problem_linenums.append((line_num, previous_line_num))
 711     elif cpp_system_include_pattern.match(line):
 712       if state == C_SYSTEM_INCLUDES:
 713         state = CPP_SYSTEM_INCLUDES
 714       elif state == CUSTOM_INCLUDES:
 715         problem_linenums.append((line_num, previous_line_num))
 716       elif previous_line and previous_line > line:
 717         problem_linenums.append((line_num, previous_line_num))
 718     elif custom_include_pattern.match(line):
 719       if state != CUSTOM_INCLUDES:
 720         state = CUSTOM_INCLUDES
 721       elif previous_line and previous_line > line:
 722         problem_linenums.append((line_num, previous_line_num))
 723     else:
 724       problem_linenums.append(line_num)
 725     previous_line = line
 726     previous_line_num = line_num
 727
 728   warnings = []
 729   for (line_num, previous_line_num) in problem_linenums:
 730     if line_num in changed_linenums or previous_line_num in changed_linenums:
 731       warnings.append('    %s:%d' % (file_path, line_num))
 732   return warnings
 733
 734
 735 def _CheckIncludeOrderInFile(input_api, f, changed_linenums):
 736   """Checks the #include order for the given file f."""
 737
 738   system_include_pattern = input_api.re.compile(r'\s*#include \<.*')
 739   # Exclude the following includes from the check:
 740   # 1) #include <.../...>, e.g., <sys/...> includes often need to appear in a
 741   # specific order.
 742   # 2) <atlbase.h>, "build/build_config.h"
 743   excluded_include_pattern = input_api.re.compile(
 744       r'\s*#include (\<.*/.*|\<atlbase\.h\>|"build/build_config.h")')
 745   custom_include_pattern = input_api.re.compile(r'\s*#include "(?P<FILE>.*)"')
 746   # Match the final or penultimate token if it is xxxtest so we can ignore it
 747   # when considering the special first include.
 748   test_file_tag_pattern = input_api.re.compile(
 749     r'_[a-z]+test(?=(_[a-zA-Z0-9]+)?\.)')
 750   if_pattern = input_api.re.compile(
 751       r'\s*#\s*(if|elif|else|endif|define|undef).*')
 752   # Some files need specialized order of includes; exclude such files from this
 753   # check.
 754   uncheckable_includes_pattern = input_api.re.compile(
 755       r'\s*#include '
 756       '("ipc/.*macros\.h"|<windows\.h>|".*gl.*autogen.h")\s*')
 757
 758   contents = f.NewContents()
 759   warnings = []
 760   line_num = 0
 761
 762   # Handle the special first include. If the first include file is
 763   # some/path/file.h, the corresponding including file can be some/path/file.cc,
 764   # some/other/path/file.cc, some/path/file_platform.cc, some/path/file-suffix.h
 765   # etc. It's also possible that no special first include exists.
 766   # If the included file is some/path/file_platform.h the including file could
 767   # also be some/path/file_xxxtest_platform.h.
 768   including_file_base_name = test_file_tag_pattern.sub(
 769     '', input_api.os_path.basename(f.LocalPath()))
 770
 771   for line in contents:
 772     line_num += 1
 773     if system_include_pattern.match(line):
 774       # No special first include -> process the line again along with normal
 775       # includes.
 776       line_num -= 1
 777       break
 778     match = custom_include_pattern.match(line)
 779     if match:
 780       match_dict = match.groupdict()
 781       header_basename = test_file_tag_pattern.sub(
 782         '', input_api.os_path.basename(match_dict['FILE'])).replace('.h', '')
 783
 784       if header_basename not in including_file_base_name:
 785         # No special first include -> process the line again along with normal
 786         # includes.
 787         line_num -= 1
 788       break
 789
 790   # Split into scopes: Each region between #if and #endif is its own scope.
 791   scopes = []
 792   current_scope = []
 793   for line in contents[line_num:]:
 794     line_num += 1
 795     if uncheckable_includes_pattern.match(line):
 796       continue
 797     if if_pattern.match(line):
 798       scopes.append(current_scope)
 799       current_scope = []
 800     elif ((system_include_pattern.match(line) or
 801            custom_include_pattern.match(line)) and
 802           not excluded_include_pattern.match(line)):
 803       current_scope.append((line_num, line))
 804   scopes.append(current_scope)
 805
 806   for scope in scopes:
 807     warnings.extend(_CheckIncludeOrderForScope(scope, input_api, f.LocalPath(),
 808                                                changed_linenums))
 809   return warnings
 810
 811
 812 def _CheckIncludeOrder(input_api, output_api):
 813   """Checks that the #include order is correct.
 814
 815   1. The corresponding header for source files.
 816   2. C system files in alphabetical order
 817   3. C++ system files in alphabetical order
 818   4. Project's .h files in alphabetical order
 819
 820   Each region separated by #if, #elif, #else, #endif, #define and #undef follows
 821   these rules separately.
 822   """
 823   def FileFilterIncludeOrder(affected_file):
 824     black_list = (_EXCLUDED_PATHS + input_api.DEFAULT_BLACK_LIST)
 825     return input_api.FilterSourceFile(affected_file, black_list=black_list)
 826
 827   warnings = []
 828   for f in input_api.AffectedFiles(file_filter=FileFilterIncludeOrder):
 829     if f.LocalPath().endswith(('.cc', '.h', '.mm')):
 830       changed_linenums = set(line_num for line_num, _ in f.ChangedContents())
 831       warnings.extend(_CheckIncludeOrderInFile(input_api, f, changed_linenums))
 832
 833   results = []
 834   if warnings:
 835     results.append(output_api.PresubmitPromptOrNotify(_INCLUDE_ORDER_WARNING,
 836                                                       warnings))
 837   return results
 838
 839
 840 def _CheckForVersionControlConflictsInFile(input_api, f):
 841   pattern = input_api.re.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
 842   errors = []
 843   for line_num, line in f.ChangedContents():
 844     if pattern.match(line):
 845       errors.append('    %s:%d %s' % (f.LocalPath(), line_num, line))
 846   return errors
 847
 848
 849 def _CheckForVersionControlConflicts(input_api, output_api):
 850   """Usually this is not intentional and will cause a compile failure."""
 851   errors = []
 852   for f in input_api.AffectedFiles():
 853     errors.extend(_CheckForVersionControlConflictsInFile(input_api, f))
 854
 855   results = []
 856   if errors:
 857     results.append(output_api.PresubmitError(
 858       'Version control conflict markers found, please resolve.', errors))
 859   return results
 860
 861
 862 def _CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api):
 863   def FilterFile(affected_file):
 864     """Filter function for use with input_api.AffectedSourceFiles,
 865     below.  This filters out everything except non-test files from
 866     top-level directories that generally speaking should not hard-code
 867     service URLs (e.g. src/android_webview/, src/content/ and others).
 868     """
 869     return input_api.FilterSourceFile(
 870       affected_file,
 871       white_list=(r'^(android_webview|base|content|net)[\\\/].*', ),
 872       black_list=(_EXCLUDED_PATHS +
 873                   _TEST_CODE_EXCLUDED_PATHS +
 874                   input_api.DEFAULT_BLACK_LIST))
 875
 876   base_pattern = '"[^"]*google\.com[^"]*"'
 877   comment_pattern = input_api.re.compile('//.*%s' % base_pattern)
 878   pattern = input_api.re.compile(base_pattern)
 879   problems = []  # items are (filename, line_number, line)
 880   for f in input_api.AffectedSourceFiles(FilterFile):
 881     for line_num, line in f.ChangedContents():
 882       if not comment_pattern.search(line) and pattern.search(line):
 883         problems.append((f.LocalPath(), line_num, line))
 884
 885   if problems:
 886     return [output_api.PresubmitPromptOrNotify(
 887         'Most layers below src/chrome/ should not hardcode service URLs.\n'
 888         'Are you sure this is correct?',
 889         ['  %s:%d:  %s' % (
 890             problem[0], problem[1], problem[2]) for problem in problems])]
 891   else:
 892     return []
 893
 894
 895 def _CheckNoAbbreviationInPngFileName(input_api, output_api):
 896   """Makes sure there are no abbreviations in the name of PNG files.
 897   The native_client_sdk directory is excluded because it has auto-generated PNG
 898   files for documentation.
 899   """
 900   errors = []
 901   white_list = (r'.*_[a-z]_.*\.png$|.*_[a-z]\.png$',)
 902   black_list = (r'^native_client_sdk[\\\/]',)
 903   file_filter = lambda f: input_api.FilterSourceFile(
 904       f, white_list=white_list, black_list=black_list)
 905   for f in input_api.AffectedFiles(include_deletes=False,
 906                                    file_filter=file_filter):
 907     errors.append('    %s' % f.LocalPath())
 908
 909   results = []
 910   if errors:
 911     results.append(output_api.PresubmitError(
 912         'The name of PNG files should not have abbreviations. \n'
 913         'Use _hover.png, _center.png, instead of _h.png, _c.png.\n'
 914         'Contact oshima@chromium.org if you have questions.', errors))
 915   return results
 916
 917
 918 def _FilesToCheckForIncomingDeps(re, changed_lines):
 919   """Helper method for _CheckAddedDepsHaveTargetApprovals. Returns
 920   a set of DEPS entries that we should look up.
 921
 922   For a directory (rather than a specific filename) we fake a path to
 923   a specific filename by adding /DEPS. This is chosen as a file that
 924   will seldom or never be subject to per-file include_rules.
 925   """
 926   # We ignore deps entries on auto-generated directories.
 927   AUTO_GENERATED_DIRS = ['grit', 'jni']
 928
 929   # This pattern grabs the path without basename in the first
 930   # parentheses, and the basename (if present) in the second. It
 931   # relies on the simple heuristic that if there is a basename it will
 932   # be a header file ending in ".h".
 933   pattern = re.compile(
 934       r"""['"]\+([^'"]+?)(/[a-zA-Z0-9_]+\.h)?['"].*""")
 935   results = set()
 936   for changed_line in changed_lines:
 937     m = pattern.match(changed_line)
 938     if m:
 939       path = m.group(1)
 940       if path.split('/')[0] not in AUTO_GENERATED_DIRS:
 941         if m.group(2):
 942           results.add('%s%s' % (path, m.group(2)))
 943         else:
 944           results.add('%s/DEPS' % path)
 945   return results
 946
 947
 948 def _CheckAddedDepsHaveTargetApprovals(input_api, output_api):
 949   """When a dependency prefixed with + is added to a DEPS file, we
 950   want to make sure that the change is reviewed by an OWNER of the
 951   target file or directory, to avoid layering violations from being
 952   introduced. This check verifies that this happens.
 953   """
 954   changed_lines = set()
 955   for f in input_api.AffectedFiles():
 956     filename = input_api.os_path.basename(f.LocalPath())
 957     if filename == 'DEPS':
 958       changed_lines |= set(line.strip()
 959                            for line_num, line
 960                            in f.ChangedContents())
 961   if not changed_lines:
 962     return []
 963
 964   virtual_depended_on_files = _FilesToCheckForIncomingDeps(input_api.re,
 965                                                            changed_lines)
 966   if not virtual_depended_on_files:
 967     return []
 968
 969   if input_api.is_committing:
 970     if input_api.tbr:
 971       return [output_api.PresubmitNotifyResult(
 972           '--tbr was specified, skipping OWNERS check for DEPS additions')]
 973     if not input_api.change.issue:
 974       return [output_api.PresubmitError(
 975           "DEPS approval by OWNERS check failed: this change has "
 976           "no Rietveld issue number, so we can't check it for approvals.")]
 977     output = output_api.PresubmitError
 978   else:
 979     output = output_api.PresubmitNotifyResult
 980
 981   owners_db = input_api.owners_db
 982   owner_email, reviewers = input_api.canned_checks._RietveldOwnerAndReviewers(
 983       input_api,
 984       owners_db.email_regexp,
 985       approval_needed=input_api.is_committing)
 986
 987   owner_email = owner_email or input_api.change.author_email
 988
 989   reviewers_plus_owner = set(reviewers)
 990   if owner_email:
 991     reviewers_plus_owner.add(owner_email)
 992   missing_files = owners_db.files_not_covered_by(virtual_depended_on_files,
 993                                                  reviewers_plus_owner)
 994
 995   # We strip the /DEPS part that was added by
 996   # _FilesToCheckForIncomingDeps to fake a path to a file in a
 997   # directory.
 998   def StripDeps(path):
 999     start_deps = path.rfind('/DEPS')
1000     if start_deps != -1:
1001       return path[:start_deps]
1002     else:
1003       return path
1004   unapproved_dependencies = ["'+%s'," % StripDeps(path)
1005                              for path in missing_files]
1006
1007   if unapproved_dependencies:
1008     output_list = [
1009       output('Missing LGTM from OWNERS of dependencies added to DEPS:\n    %s' %
1010              '\n    '.join(sorted(unapproved_dependencies)))]
1011     if not input_api.is_committing:
1012       suggested_owners = owners_db.reviewers_for(missing_files, owner_email)
1013       output_list.append(output(
1014           'Suggested missing target path OWNERS:\n    %s' %
1015           '\n    '.join(suggested_owners or [])))
1016     return output_list
1017
1018   return []
1019
1020
1021 def _CheckSpamLogging(input_api, output_api):
1022   file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
1023   black_list = (_EXCLUDED_PATHS +
1024                 _TEST_CODE_EXCLUDED_PATHS +
1025                 input_api.DEFAULT_BLACK_LIST +
1026                 (r"^base[\\\/]logging\.h$",
1027                  r"^base[\\\/]logging\.cc$",
1028                  r"^chrome[\\\/]app[\\\/]chrome_main_delegate\.cc$",
1029                  r"^chrome[\\\/]browser[\\\/]chrome_browser_main\.cc$",
1030                  r"^chrome[\\\/]browser[\\\/]ui[\\\/]startup[\\\/]"
1031                      r"startup_browser_creator\.cc$",
1032                  r"^chrome[\\\/]installer[\\\/]setup[\\\/].*",
1033                  r"chrome[\\\/]browser[\\\/]diagnostics[\\\/]" +
1034                      r"diagnostics_writer\.cc$",
1035                  r"^chrome_elf[\\\/]dll_hash[\\\/]dll_hash_main\.cc$",
1036                  r"^chromecast[\\\/]",
1037                  r"^cloud_print[\\\/]",
1038                  r"^content[\\\/]common[\\\/]gpu[\\\/]client[\\\/]"
1039                      r"gl_helper_benchmark\.cc$",
1040                  r"^courgette[\\\/]courgette_tool\.cc$",
1041                  r"^extensions[\\\/]renderer[\\\/]logging_native_handler\.cc$",
1042                  r"^ipc[\\\/]ipc_logging\.cc$",
1043                  r"^native_client_sdk[\\\/]",
1044                  r"^remoting[\\\/]base[\\\/]logging\.h$",
1045                  r"^remoting[\\\/]host[\\\/].*",
1046                  r"^sandbox[\\\/]linux[\\\/].*",
1047                  r"^tools[\\\/]",
1048                  r"^ui[\\\/]aura[\\\/]bench[\\\/]bench_main\.cc$",
1049                  r"^storage[\\\/]browser[\\\/]fileapi[\\\/]" +
1050                      r"dump_file_system.cc$",))
1051   source_file_filter = lambda x: input_api.FilterSourceFile(
1052       x, white_list=(file_inclusion_pattern,), black_list=black_list)
1053
1054   log_info = []
1055   printf = []
1056
1057   for f in input_api.AffectedSourceFiles(source_file_filter):
1058     contents = input_api.ReadFile(f, 'rb')
1059     if input_api.re.search(r"\bD?LOG\s*\(\s*INFO\s*\)", contents):
1060       log_info.append(f.LocalPath())
1061     elif input_api.re.search(r"\bD?LOG_IF\s*\(\s*INFO\s*,", contents):
1062       log_info.append(f.LocalPath())
1063
1064     if input_api.re.search(r"\bprintf\(", contents):
1065       printf.append(f.LocalPath())
1066     elif input_api.re.search(r"\bfprintf\((stdout|stderr)", contents):
1067       printf.append(f.LocalPath())
1068
1069   if log_info:
1070     return [output_api.PresubmitError(
1071       'These files spam the console log with LOG(INFO):',
1072       items=log_info)]
1073   if printf:
1074     return [output_api.PresubmitError(
1075       'These files spam the console log with printf/fprintf:',
1076       items=printf)]
1077   return []
1078
1079
1080 def _CheckForAnonymousVariables(input_api, output_api):
1081   """These types are all expected to hold locks while in scope and
1082      so should never be anonymous (which causes them to be immediately
1083      destroyed)."""
1084   they_who_must_be_named = [
1085     'base::AutoLock',
1086     'base::AutoReset',
1087     'base::AutoUnlock',
1088     'SkAutoAlphaRestore',
1089     'SkAutoBitmapShaderInstall',
1090     'SkAutoBlitterChoose',
1091     'SkAutoBounderCommit',
1092     'SkAutoCallProc',
1093     'SkAutoCanvasRestore',
1094     'SkAutoCommentBlock',
1095     'SkAutoDescriptor',
1096     'SkAutoDisableDirectionCheck',
1097     'SkAutoDisableOvalCheck',
1098     'SkAutoFree',
1099     'SkAutoGlyphCache',
1100     'SkAutoHDC',
1101     'SkAutoLockColors',
1102     'SkAutoLockPixels',
1103     'SkAutoMalloc',
1104     'SkAutoMaskFreeImage',
1105     'SkAutoMutexAcquire',
1106     'SkAutoPathBoundsUpdate',
1107     'SkAutoPDFRelease',
1108     'SkAutoRasterClipValidate',
1109     'SkAutoRef',
1110     'SkAutoTime',
1111     'SkAutoTrace',
1112     'SkAutoUnref',
1113   ]
1114   anonymous = r'(%s)\s*[({]' % '|'.join(they_who_must_be_named)
1115   # bad: base::AutoLock(lock.get());
1116   # not bad: base::AutoLock lock(lock.get());
1117   bad_pattern = input_api.re.compile(anonymous)
1118   # good: new base::AutoLock(lock.get())
1119   good_pattern = input_api.re.compile(r'\bnew\s*' + anonymous)
1120   errors = []
1121
1122   for f in input_api.AffectedFiles():
1123     if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
1124       continue
1125     for linenum, line in f.ChangedContents():
1126       if bad_pattern.search(line) and not good_pattern.search(line):
1127         errors.append('%s:%d' % (f.LocalPath(), linenum))
1128
1129   if errors:
1130     return [output_api.PresubmitError(
1131       'These lines create anonymous variables that need to be named:',
1132       items=errors)]
1133   return []
1134
1135
1136 def _CheckCygwinShell(input_api, output_api):
1137   source_file_filter = lambda x: input_api.FilterSourceFile(
1138       x, white_list=(r'.+\.(gyp|gypi)$',))
1139   cygwin_shell = []
1140
1141   for f in input_api.AffectedSourceFiles(source_file_filter):
1142     for linenum, line in f.ChangedContents():
1143       if 'msvs_cygwin_shell' in line:
1144         cygwin_shell.append(f.LocalPath())
1145         break
1146
1147   if cygwin_shell:
1148     return [output_api.PresubmitError(
1149       'These files should not use msvs_cygwin_shell (the default is 0):',
1150       items=cygwin_shell)]
1151   return []
1152
1153
1154 def _CheckUserActionUpdate(input_api, output_api):
1155   """Checks if any new user action has been added."""
1156   if any('actions.xml' == input_api.os_path.basename(f) for f in
1157          input_api.LocalPaths()):
1158     # If actions.xml is already included in the changelist, the PRESUBMIT
1159     # for actions.xml will do a more complete presubmit check.
1160     return []
1161
1162   file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm'))
1163   action_re = r'[^a-zA-Z]UserMetricsAction\("([^"]*)'
1164   current_actions = None
1165   for f in input_api.AffectedFiles(file_filter=file_filter):
1166     for line_num, line in f.ChangedContents():
1167       match = input_api.re.search(action_re, line)
1168       if match:
1169         # Loads contents in tools/metrics/actions/actions.xml to memory. It's
1170         # loaded only once.
1171         if not current_actions:
1172           with open('tools/metrics/actions/actions.xml') as actions_f:
1173             current_actions = actions_f.read()
1174         # Search for the matched user action name in |current_actions|.
1175         for action_name in match.groups():
1176           action = 'name="{0}"'.format(action_name)
1177           if action not in current_actions:
1178             return [output_api.PresubmitPromptWarning(
1179               'File %s line %d: %s is missing in '
1180               'tools/metrics/actions/actions.xml. Please run '
1181               'tools/metrics/actions/extract_actions.py to update.'
1182               % (f.LocalPath(), line_num, action_name))]
1183   return []
1184
1185
1186 def _GetJSONParseError(input_api, filename, eat_comments=True):
1187   try:
1188     contents = input_api.ReadFile(filename)
1189     if eat_comments:
1190       json_comment_eater = input_api.os_path.join(
1191           input_api.PresubmitLocalPath(),
1192           'tools', 'json_comment_eater', 'json_comment_eater.py')
1193       process = input_api.subprocess.Popen(
1194           [input_api.python_executable, json_comment_eater],
1195           stdin=input_api.subprocess.PIPE,
1196           stdout=input_api.subprocess.PIPE,
1197           universal_newlines=True)
1198       (contents, _) = process.communicate(input=contents)
1199
1200     input_api.json.loads(contents)
1201   except ValueError as e:
1202     return e
1203   return None
1204
1205
1206 def _GetIDLParseError(input_api, filename):
1207   try:
1208     contents = input_api.ReadFile(filename)
1209     idl_schema = input_api.os_path.join(
1210         input_api.PresubmitLocalPath(),
1211         'tools', 'json_schema_compiler', 'idl_schema.py')
1212     process = input_api.subprocess.Popen(
1213         [input_api.python_executable, idl_schema],
1214         stdin=input_api.subprocess.PIPE,
1215         stdout=input_api.subprocess.PIPE,
1216         stderr=input_api.subprocess.PIPE,
1217         universal_newlines=True)
1218     (_, error) = process.communicate(input=contents)
1219     return error or None
1220   except ValueError as e:
1221     return e
1222
1223
1224 def _CheckParseErrors(input_api, output_api):
1225   """Check that IDL and JSON files do not contain syntax errors."""
1226   actions = {
1227     '.idl': _GetIDLParseError,
1228     '.json': _GetJSONParseError,
1229   }
1230   # These paths contain test data and other known invalid JSON files.
1231   excluded_patterns = [
1232     r'test[\\\/]data[\\\/]',
1233     r'^components[\\\/]policy[\\\/]resources[\\\/]policy_templates\.json$',
1234   ]
1235   # Most JSON files are preprocessed and support comments, but these do not.
1236   json_no_comments_patterns = [
1237     r'^testing[\\\/]',
1238   ]
1239   # Only run IDL checker on files in these directories.
1240   idl_included_patterns = [
1241     r'^chrome[\\\/]common[\\\/]extensions[\\\/]api[\\\/]',
1242     r'^extensions[\\\/]common[\\\/]api[\\\/]',
1243   ]
1244
1245   def get_action(affected_file):
1246     filename = affected_file.LocalPath()
1247     return actions.get(input_api.os_path.splitext(filename)[1])
1248
1249   def MatchesFile(patterns, path):
1250     for pattern in patterns:
1251       if input_api.re.search(pattern, path):
1252         return True
1253     return False
1254
1255   def FilterFile(affected_file):
1256     action = get_action(affected_file)
1257     if not action:
1258       return False
1259     path = affected_file.LocalPath()
1260
1261     if MatchesFile(excluded_patterns, path):
1262       return False
1263
1264     if (action == _GetIDLParseError and
1265         not MatchesFile(idl_included_patterns, path)):
1266       return False
1267     return True
1268
1269   results = []
1270   for affected_file in input_api.AffectedFiles(
1271       file_filter=FilterFile, include_deletes=False):
1272     action = get_action(affected_file)
1273     kwargs = {}
1274     if (action == _GetJSONParseError and
1275         MatchesFile(json_no_comments_patterns, affected_file.LocalPath())):
1276       kwargs['eat_comments'] = False
1277     parse_error = action(input_api,
1278                          affected_file.AbsoluteLocalPath(),
1279                          **kwargs)
1280     if parse_error:
1281       results.append(output_api.PresubmitError('%s could not be parsed: %s' %
1282           (affected_file.LocalPath(), parse_error)))
1283   return results
1284
1285
1286 def _CheckJavaStyle(input_api, output_api):
1287   """Runs checkstyle on changed java files and returns errors if any exist."""
1288   import sys
1289   original_sys_path = sys.path
1290   try:
1291     sys.path = sys.path + [input_api.os_path.join(
1292         input_api.PresubmitLocalPath(), 'tools', 'android', 'checkstyle')]
1293     import checkstyle
1294   finally:
1295     # Restore sys.path to what it was before.
1296     sys.path = original_sys_path
1297
1298   return checkstyle.RunCheckstyle(
1299       input_api, output_api, 'tools/android/checkstyle/chromium-style-5.0.xml',
1300       black_list=_EXCLUDED_PATHS + input_api.DEFAULT_BLACK_LIST)
1301
1302
1303 def _CheckNoNewUtilLogUsage(input_api, output_api):
1304   """Checks that new logs are using org.chromium.base.Log."""
1305
1306   chromium_log_import_pattern = input_api.re.compile(
1307       r'^import org\.chromium\.base\.Log;$', input_api.re.MULTILINE);
1308   log_pattern = input_api.re.compile(r'^\s*(android\.util\.)?Log\.\w')
1309   sources = lambda x: input_api.FilterSourceFile(x, white_list=(r'.*\.java$',))
1310
1311   errors = []
1312
1313   for f in input_api.AffectedSourceFiles(sources):
1314     if chromium_log_import_pattern.search(input_api.ReadFile(f)) is not None:
1315       # Uses org.chromium.base.Log already
1316       continue
1317
1318     for line_num, line in f.ChangedContents():
1319       if log_pattern.search(line):
1320         errors.append("%s:%d" % (f.LocalPath(), line_num))
1321
1322   results = []
1323   if len(errors):
1324     results.append(output_api.PresubmitPromptWarning(
1325         'Please use org.chromium.base.Log for new logs.\n' +
1326         'See base/android/java/src/org/chromium/base/README_logging.md ' +
1327         'or contact dgn@chromium.org for more info.',
1328         errors))
1329   return results
1330
1331
1332 def _CheckForCopyrightedCode(input_api, output_api):
1333   """Verifies that newly added code doesn't contain copyrighted material
1334   and is properly licensed under the standard Chromium license.
1335
1336   As there can be false positives, we maintain a whitelist file. This check
1337   also verifies that the whitelist file is up to date.
1338   """
1339   import sys
1340   original_sys_path = sys.path
1341   try:
1342     sys.path = sys.path + [input_api.os_path.join(
1343         input_api.PresubmitLocalPath(), 'android_webview', 'tools')]
1344     import copyright_scanner
1345   finally:
1346     # Restore sys.path to what it was before.
1347     sys.path = original_sys_path
1348
1349   return copyright_scanner.ScanAtPresubmit(input_api, output_api)
1350
1351
1352 def _CheckSingletonInHeaders(input_api, output_api):
1353   """Checks to make sure no header files have |Singleton<|."""
1354   def FileFilter(affected_file):
1355     # It's ok for base/memory/singleton.h to have |Singleton<|.
1356     black_list = (_EXCLUDED_PATHS +
1357                   input_api.DEFAULT_BLACK_LIST +
1358                   (r"^base[\\\/]memory[\\\/]singleton\.h$",))
1359     return input_api.FilterSourceFile(affected_file, black_list=black_list)
1360
1361   pattern = input_api.re.compile(r'(?<!class\s)Singleton\s*<')
1362   files = []
1363   for f in input_api.AffectedSourceFiles(FileFilter):
1364     if (f.LocalPath().endswith('.h') or f.LocalPath().endswith('.hxx') or
1365         f.LocalPath().endswith('.hpp') or f.LocalPath().endswith('.inl')):
1366       contents = input_api.ReadFile(f)
1367       for line in contents.splitlines(False):
1368         if (not input_api.re.match(r'//', line) and # Strip C++ comment.
1369             pattern.search(line)):
1370           files.append(f)
1371           break
1372
1373   if files:
1374     return [ output_api.PresubmitError(
1375         'Found Singleton<T> in the following header files.\n' +
1376         'Please move them to an appropriate source file so that the ' +
1377         'template gets instantiated in a single compilation unit.',
1378         files) ]
1379   return []
1380
1381
1382 _DEPRECATED_CSS = [
1383   # Values
1384   ( "-webkit-box", "flex" ),
1385   ( "-webkit-inline-box", "inline-flex" ),
1386   ( "-webkit-flex", "flex" ),
1387   ( "-webkit-inline-flex", "inline-flex" ),
1388   ( "-webkit-min-content", "min-content" ),
1389   ( "-webkit-max-content", "max-content" ),
1390
1391   # Properties
1392   ( "-webkit-background-clip", "background-clip" ),
1393   ( "-webkit-background-origin", "background-origin" ),
1394   ( "-webkit-background-size", "background-size" ),
1395   ( "-webkit-box-shadow", "box-shadow" ),
1396
1397   # Functions
1398   ( "-webkit-gradient", "gradient" ),
1399   ( "-webkit-repeating-gradient", "repeating-gradient" ),
1400   ( "-webkit-linear-gradient", "linear-gradient" ),
1401   ( "-webkit-repeating-linear-gradient", "repeating-linear-gradient" ),
1402   ( "-webkit-radial-gradient", "radial-gradient" ),
1403   ( "-webkit-repeating-radial-gradient", "repeating-radial-gradient" ),
1404 ]
1405
1406 def _CheckNoDeprecatedCSS(input_api, output_api):
1407   """ Make sure that we don't use deprecated CSS
1408       properties, functions or values. Our external
1409       documentation is ignored by the hooks as it
1410       needs to be consumed by WebKit. """
1411   results = []
1412   file_inclusion_pattern = (r".+\.css$",)
1413   black_list = (_EXCLUDED_PATHS +
1414                 _TEST_CODE_EXCLUDED_PATHS +
1415                 input_api.DEFAULT_BLACK_LIST +
1416                 (r"^chrome/common/extensions/docs",
1417                  r"^chrome/docs",
1418                  r"^native_client_sdk"))
1419   file_filter = lambda f: input_api.FilterSourceFile(
1420       f, white_list=file_inclusion_pattern, black_list=black_list)
1421   for fpath in input_api.AffectedFiles(file_filter=file_filter):
1422     for line_num, line in fpath.ChangedContents():
1423       for (deprecated_value, value) in _DEPRECATED_CSS:
1424         if deprecated_value in line:
1425           results.append(output_api.PresubmitError(
1426               "%s:%d: Use of deprecated CSS %s, use %s instead" %
1427               (fpath.LocalPath(), line_num, deprecated_value, value)))
1428   return results
1429
1430
1431 _DEPRECATED_JS = [
1432   ( "__lookupGetter__", "Object.getOwnPropertyDescriptor" ),
1433   ( "__defineGetter__", "Object.defineProperty" ),
1434   ( "__defineSetter__", "Object.defineProperty" ),
1435 ]
1436
1437 def _CheckNoDeprecatedJS(input_api, output_api):
1438   """Make sure that we don't use deprecated JS in Chrome code."""
1439   results = []
1440   file_inclusion_pattern = (r".+\.js$",)  # TODO(dbeam): .html?
1441   black_list = (_EXCLUDED_PATHS + _TEST_CODE_EXCLUDED_PATHS +
1442                 input_api.DEFAULT_BLACK_LIST)
1443   file_filter = lambda f: input_api.FilterSourceFile(
1444       f, white_list=file_inclusion_pattern, black_list=black_list)
1445   for fpath in input_api.AffectedFiles(file_filter=file_filter):
1446     for lnum, line in fpath.ChangedContents():
1447       for (deprecated, replacement) in _DEPRECATED_JS:
1448         if deprecated in line:
1449           results.append(output_api.PresubmitError(
1450               "%s:%d: Use of deprecated JS %s, use %s instead" %
1451               (fpath.LocalPath(), lnum, deprecated, replacement)))
1452   return results
1453
1454
1455 def _CommonChecks(input_api, output_api):
1456   """Checks common to both upload and commit."""
1457   results = []
1458   results.extend(input_api.canned_checks.PanProjectChecks(
1459       input_api, output_api,
1460       excluded_paths=_EXCLUDED_PATHS + _TESTRUNNER_PATHS))
1461   results.extend(_CheckAuthorizedAuthor(input_api, output_api))
1462   results.extend(
1463       _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
1464   results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
1465   results.extend(_CheckNoUNIT_TESTInSourceFiles(input_api, output_api))
1466   results.extend(_CheckNoNewWStrings(input_api, output_api))
1467   results.extend(_CheckNoDEPSGIT(input_api, output_api))
1468   results.extend(_CheckNoBannedFunctions(input_api, output_api))
1469   results.extend(_CheckNoPragmaOnce(input_api, output_api))
1470   results.extend(_CheckNoTrinaryTrueFalse(input_api, output_api))
1471   results.extend(_CheckUnwantedDependencies(input_api, output_api))
1472   results.extend(_CheckFilePermissions(input_api, output_api))
1473   results.extend(_CheckNoAuraWindowPropertyHInHeaders(input_api, output_api))
1474   results.extend(_CheckIncludeOrder(input_api, output_api))
1475   results.extend(_CheckForVersionControlConflicts(input_api, output_api))
1476   results.extend(_CheckPatchFiles(input_api, output_api))
1477   results.extend(_CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api))
1478   results.extend(_CheckNoAbbreviationInPngFileName(input_api, output_api))
1479   results.extend(_CheckForInvalidOSMacros(input_api, output_api))
1480   results.extend(_CheckForInvalidIfDefinedMacros(input_api, output_api))
1481   # TODO(danakj): Remove this when base/move.h is removed.
1482   results.extend(_CheckForUsingSideEffectsOfPass(input_api, output_api))
1483   results.extend(_CheckAddedDepsHaveTargetApprovals(input_api, output_api))
1484   results.extend(
1485       input_api.canned_checks.CheckChangeHasNoTabs(
1486           input_api,
1487           output_api,
1488           source_file_filter=lambda x: x.LocalPath().endswith('.grd')))
1489   results.extend(_CheckSpamLogging(input_api, output_api))
1490   results.extend(_CheckForAnonymousVariables(input_api, output_api))
1491   results.extend(_CheckCygwinShell(input_api, output_api))
1492   results.extend(_CheckUserActionUpdate(input_api, output_api))
1493   results.extend(_CheckNoDeprecatedCSS(input_api, output_api))
1494   results.extend(_CheckNoDeprecatedJS(input_api, output_api))
1495   results.extend(_CheckParseErrors(input_api, output_api))
1496   results.extend(_CheckForIPCRules(input_api, output_api))
1497   results.extend(_CheckForCopyrightedCode(input_api, output_api))
1498   results.extend(_CheckForWindowsLineEndings(input_api, output_api))
1499   results.extend(_CheckSingletonInHeaders(input_api, output_api))
1500   results.extend(_CheckNoNewUtilLogUsage(input_api, output_api))
1501
1502   if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
1503     results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
1504         input_api, output_api,
1505         input_api.PresubmitLocalPath(),
1506         whitelist=[r'^PRESUBMIT_test\.py$']))
1507   return results
1508
1509
1510 def _CheckAuthorizedAuthor(input_api, output_api):
1511   """For non-googler/chromites committers, verify the author's email address is
1512   in AUTHORS.
1513   """
1514   # TODO(maruel): Add it to input_api?
1515   import fnmatch
1516
1517   author = input_api.change.author_email
1518   if not author:
1519     input_api.logging.info('No author, skipping AUTHOR check')
1520     return []
1521   authors_path = input_api.os_path.join(
1522       input_api.PresubmitLocalPath(), 'AUTHORS')
1523   valid_authors = (
1524       input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
1525       for line in open(authors_path))
1526   valid_authors = [item.group(1).lower() for item in valid_authors if item]
1527   if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
1528     input_api.logging.info('Valid authors are %s', ', '.join(valid_authors))
1529     return [output_api.PresubmitPromptWarning(
1530         ('%s is not in AUTHORS file. If you are a new contributor, please visit'
1531         '\n'
1532         'http://www.chromium.org/developers/contributing-code and read the '
1533         '"Legal" section\n'
1534         'If you are a chromite, verify the contributor signed the CLA.') %
1535         author)]
1536   return []
1537
1538
1539 def _CheckPatchFiles(input_api, output_api):
1540   problems = [f.LocalPath() for f in input_api.AffectedFiles()
1541       if f.LocalPath().endswith(('.orig', '.rej'))]
1542   if problems:
1543     return [output_api.PresubmitError(
1544         "Don't commit .rej and .orig files.", problems)]
1545   else:
1546     return []
1547
1548
1549 def _DidYouMeanOSMacro(bad_macro):
1550   try:
1551     return {'A': 'OS_ANDROID',
1552             'B': 'OS_BSD',
1553             'C': 'OS_CHROMEOS',
1554             'F': 'OS_FREEBSD',
1555             'L': 'OS_LINUX',
1556             'M': 'OS_MACOSX',
1557             'N': 'OS_NACL',
1558             'O': 'OS_OPENBSD',
1559             'P': 'OS_POSIX',
1560             'S': 'OS_SOLARIS',
1561             'W': 'OS_WIN'}[bad_macro[3].upper()]
1562   except KeyError:
1563     return ''
1564
1565
1566 def _CheckForInvalidOSMacrosInFile(input_api, f):
1567   """Check for sensible looking, totally invalid OS macros."""
1568   preprocessor_statement = input_api.re.compile(r'^\s*#')
1569   os_macro = input_api.re.compile(r'defined\((OS_[^)]+)\)')
1570   results = []
1571   for lnum, line in f.ChangedContents():
1572     if preprocessor_statement.search(line):
1573       for match in os_macro.finditer(line):
1574         if not match.group(1) in _VALID_OS_MACROS:
1575           good = _DidYouMeanOSMacro(match.group(1))
1576           did_you_mean = ' (did you mean %s?)' % good if good else ''
1577           results.append('    %s:%d %s%s' % (f.LocalPath(),
1578                                              lnum,
1579                                              match.group(1),
1580                                              did_you_mean))
1581   return results
1582
1583
1584 def _CheckForInvalidOSMacros(input_api, output_api):
1585   """Check all affected files for invalid OS macros."""
1586   bad_macros = []
1587   for f in input_api.AffectedFiles():
1588     if not f.LocalPath().endswith(('.py', '.js', '.html', '.css')):
1589       bad_macros.extend(_CheckForInvalidOSMacrosInFile(input_api, f))
1590
1591   if not bad_macros:
1592     return []
1593
1594   return [output_api.PresubmitError(
1595       'Possibly invalid OS macro[s] found. Please fix your code\n'
1596       'or add your macro to src/PRESUBMIT.py.', bad_macros)]
1597
1598
1599 def _CheckForInvalidIfDefinedMacrosInFile(input_api, f):
1600   """Check all affected files for invalid "if defined" macros."""
1601   ALWAYS_DEFINED_MACROS = (
1602       "TARGET_CPU_PPC",
1603       "TARGET_CPU_PPC64",
1604       "TARGET_CPU_68K",
1605       "TARGET_CPU_X86",
1606       "TARGET_CPU_ARM",
1607       "TARGET_CPU_MIPS",
1608       "TARGET_CPU_SPARC",
1609       "TARGET_CPU_ALPHA",
1610       "TARGET_IPHONE_SIMULATOR",
1611       "TARGET_OS_EMBEDDED",
1612       "TARGET_OS_IPHONE",
1613       "TARGET_OS_MAC",
1614       "TARGET_OS_UNIX",
1615       "TARGET_OS_WIN32",
1616   )
1617   ifdef_macro = input_api.re.compile(r'^\s*#.*(?:ifdef\s|defined\()([^\s\)]+)')
1618   results = []
1619   for lnum, line in f.ChangedContents():
1620     for match in ifdef_macro.finditer(line):
1621       if match.group(1) in ALWAYS_DEFINED_MACROS:
1622         always_defined = ' %s is always defined. ' % match.group(1)
1623         did_you_mean = 'Did you mean \'#if %s\'?' % match.group(1)
1624         results.append('    %s:%d %s\n\t%s' % (f.LocalPath(),
1625                                                lnum,
1626                                                always_defined,
1627                                                did_you_mean))
1628   return results
1629
1630
1631 def _CheckForInvalidIfDefinedMacros(input_api, output_api):
1632   """Check all affected files for invalid "if defined" macros."""
1633   bad_macros = []
1634   for f in input_api.AffectedFiles():
1635     if f.LocalPath().endswith(('.h', '.c', '.cc', '.m', '.mm')):
1636       bad_macros.extend(_CheckForInvalidIfDefinedMacrosInFile(input_api, f))
1637
1638   if not bad_macros:
1639     return []
1640
1641   return [output_api.PresubmitError(
1642       'Found ifdef check on always-defined macro[s]. Please fix your code\n'
1643       'or check the list of ALWAYS_DEFINED_MACROS in src/PRESUBMIT.py.',
1644       bad_macros)]
1645
1646
1647 def _CheckForUsingSideEffectsOfPass(input_api, output_api):
1648   """Check all affected files for using side effects of Pass."""
1649   errors = []
1650   for f in input_api.AffectedFiles():
1651     if f.LocalPath().endswith(('.h', '.c', '.cc', '.m', '.mm')):
1652       for lnum, line in f.ChangedContents():
1653         # Disallow Foo(*my_scoped_thing.Pass()); See crbug.com/418297.
1654         if input_api.re.search(r'\*[a-zA-Z0-9_]+\.Pass\(\)', line):
1655           errors.append(output_api.PresubmitError(
1656             ('%s:%d uses *foo.Pass() to delete the contents of scoped_ptr. ' +
1657              'See crbug.com/418297.') % (f.LocalPath(), lnum)))
1658   return errors
1659
1660
1661 def _CheckForIPCRules(input_api, output_api):
1662   """Check for same IPC rules described in
1663   http://www.chromium.org/Home/chromium-security/education/security-tips-for-ipc
1664   """
1665   base_pattern = r'IPC_ENUM_TRAITS\('
1666   inclusion_pattern = input_api.re.compile(r'(%s)' % base_pattern)
1667   comment_pattern = input_api.re.compile(r'//.*(%s)' % base_pattern)
1668
1669   problems = []
1670   for f in input_api.AffectedSourceFiles(None):
1671     local_path = f.LocalPath()
1672     if not local_path.endswith('.h'):
1673       continue
1674     for line_number, line in f.ChangedContents():
1675       if inclusion_pattern.search(line) and not comment_pattern.search(line):
1676         problems.append(
1677           '%s:%d\n    %s' % (local_path, line_number, line.strip()))
1678
1679   if problems:
1680     return [output_api.PresubmitPromptWarning(
1681         _IPC_ENUM_TRAITS_DEPRECATED, problems)]
1682   else:
1683     return []
1684
1685
1686 def _CheckForWindowsLineEndings(input_api, output_api):
1687   """Check source code and known ascii text files for Windows style line
1688   endings.
1689   """
1690   known_text_files = r'.*\.(txt|html|htm|mhtml|py|gyp|gypi|gn|isolate)$'
1691
1692   file_inclusion_pattern = (
1693     known_text_files,
1694     r'.+%s' % _IMPLEMENTATION_EXTENSIONS
1695   )
1696
1697   filter = lambda f: input_api.FilterSourceFile(
1698     f, white_list=file_inclusion_pattern, black_list=None)
1699   files = [f.LocalPath() for f in
1700            input_api.AffectedSourceFiles(filter)]
1701
1702   problems = []
1703
1704   for file in files:
1705     fp = open(file, 'r')
1706     for line in fp:
1707       if line.endswith('\r\n'):
1708         problems.append(file)
1709         break
1710     fp.close()
1711
1712   if problems:
1713     return [output_api.PresubmitPromptWarning('Are you sure that you want '
1714         'these files to contain Windows style line endings?\n' +
1715         '\n'.join(problems))]
1716
1717   return []
1718
1719
1720 def CheckChangeOnUpload(input_api, output_api):
1721   results = []
1722   results.extend(_CommonChecks(input_api, output_api))
1723   results.extend(_CheckValidHostsInDEPS(input_api, output_api))
1724   results.extend(_CheckJavaStyle(input_api, output_api))
1725   results.extend(
1726       input_api.canned_checks.CheckGNFormatted(input_api, output_api))
1727   results.extend(_CheckUmaHistogramChanges(input_api, output_api))
1728   return results
1729
1730
1731 def GetTryServerMasterForBot(bot):
1732   """Returns the Try Server master for the given bot.
1733
1734   It tries to guess the master from the bot name, but may still fail
1735   and return None.  There is no longer a default master.
1736   """
1737   # Potentially ambiguous bot names are listed explicitly.
1738   master_map = {
1739       'chromium_presubmit': 'tryserver.chromium.linux',
1740       'blink_presubmit': 'tryserver.chromium.linux',
1741       'tools_build_presubmit': 'tryserver.chromium.linux',
1742   }
1743   master = master_map.get(bot)
1744   if not master:
1745     if 'linux' in bot or 'android' in bot or 'presubmit' in bot:
1746       master = 'tryserver.chromium.linux'
1747     elif 'win' in bot:
1748       master = 'tryserver.chromium.win'
1749     elif 'mac' in bot or 'ios' in bot:
1750       master = 'tryserver.chromium.mac'
1751   return master
1752
1753
1754 def GetDefaultTryConfigs(bots):
1755   """Returns a list of ('bot', set(['tests']), filtered by [bots].
1756   """
1757
1758   builders_and_tests = dict((bot, set(['defaulttests'])) for bot in bots)
1759
1760   # Build up the mapping from tryserver master to bot/test.
1761   out = dict()
1762   for bot, tests in builders_and_tests.iteritems():
1763     out.setdefault(GetTryServerMasterForBot(bot), {})[bot] = tests
1764   return out
1765
1766
1767 def CheckChangeOnCommit(input_api, output_api):
1768   results = []
1769   results.extend(_CommonChecks(input_api, output_api))
1770   # TODO(thestig) temporarily disabled, doesn't work in third_party/
1771   #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
1772   #    input_api, output_api, sources))
1773   # Make sure the tree is 'open'.
1774   results.extend(input_api.canned_checks.CheckTreeIsOpen(
1775       input_api,
1776       output_api,
1777       json_url='http://chromium-status.appspot.com/current?format=json'))
1778
1779   results.extend(input_api.canned_checks.CheckChangeHasBugField(
1780       input_api, output_api))
1781   results.extend(input_api.canned_checks.CheckChangeHasDescription(
1782       input_api, output_api))
1783   return results
1784
1785
1786 def GetPreferredTryMasters(project, change):
1787   import re
1788   files = change.LocalPaths()
1789
1790   import os
1791   import json
1792   with open(os.path.join(
1793       change.RepositoryRoot(), 'testing', 'commit_queue', 'config.json')) as f:
1794     cq_config = json.load(f)
1795     cq_verifiers = cq_config.get('verifiers_no_patch', {})
1796     cq_try_jobs = cq_verifiers.get('try_job_verifier', {})
1797     builders = cq_try_jobs.get('launched', {})
1798
1799     for master, master_config in cq_try_jobs.get('triggered', {}).iteritems():
1800       for triggered_bot in master_config:
1801         builders.get(master, {}).pop(triggered_bot, None)
1802
1803     # Explicitly iterate over copies of dicts since we mutate them.
1804     for master in builders.keys():
1805       for builder in builders[master].keys():
1806         # Do not trigger presubmit builders, since they're likely to fail
1807         # (e.g. OWNERS checks before finished code review), and we're
1808         # running local presubmit anyway.
1809         if 'presubmit' in builder:
1810           builders[master].pop(builder)
1811
1812   return builders