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 sys
  14
  15
  16 _EXCLUDED_PATHS = (
  17     r"^breakpad[\\\/].*",
  18     r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_rules.py",
  19     r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_simple.py",
  20     r"^native_client_sdk[\\\/]src[\\\/]tools[\\\/].*.mk",
  21     r"^net[\\\/]tools[\\\/]spdyshark[\\\/].*",
  22     r"^skia[\\\/].*",
  23     r"^v8[\\\/].*",
  24     r".*MakeFile$",
  25     r".+_autogen\.h$",
  26     r".+[\\\/]pnacl_shim\.c$",
  27     r"^gpu[\\\/]config[\\\/].*_list_json\.cc$",
  28 )
  29
  30 # TestRunner and NetscapePlugIn library is temporarily excluded from pan-project
  31 # checks until it's transitioned to chromium coding style.
  32 _TESTRUNNER_PATHS = (
  33     r"^content[\\\/]shell[\\\/]renderer[\\\/]test_runner[\\\/].*",
  34     r"^content[\\\/]shell[\\\/]common[\\\/]test_runner[\\\/].*",
  35     r"^content[\\\/]shell[\\\/]tools[\\\/]plugin[\\\/].*",
  36 )
  37
  38 # Fragment of a regular expression that matches C++ and Objective-C++
  39 # implementation files.
  40 _IMPLEMENTATION_EXTENSIONS = r'\.(cc|cpp|cxx|mm)$'
  41
  42 # Regular expression that matches code only used for test binaries
  43 # (best effort).
  44 _TEST_CODE_EXCLUDED_PATHS = (
  45     r'.*[/\\](fake_|test_|mock_).+%s' % _IMPLEMENTATION_EXTENSIONS,
  46     r'.+_test_(base|support|util)%s' % _IMPLEMENTATION_EXTENSIONS,
  47     r'.+_(api|browser|kif|perf|pixel|unit|ui)?test(_[a-z]+)?%s' %
  48         _IMPLEMENTATION_EXTENSIONS,
  49     r'.+profile_sync_service_harness%s' % _IMPLEMENTATION_EXTENSIONS,
  50     r'.*[/\\](test|tool(s)?)[/\\].*',
  51     # content_shell is used for running layout tests.
  52     r'content[/\\]shell[/\\].*',
  53     # At request of folks maintaining this folder.
  54     r'chrome[/\\]browser[/\\]automation[/\\].*',
  55     # Non-production example code.
  56     r'mojo[/\\]examples[/\\].*',
  57 )
  58
  59 _TEST_ONLY_WARNING = (
  60     'You might be calling functions intended only for testing from\n'
  61     'production code.  It is OK to ignore this warning if you know what\n'
  62     'you are doing, as the heuristics used to detect the situation are\n'
  63     'not perfect.  The commit queue will not block on this warning.\n'
  64     'Email joi@chromium.org if you have questions.')
  65
  66
  67 _INCLUDE_ORDER_WARNING = (
  68     'Your #include order seems to be broken. Send mail to\n'
  69     'marja@chromium.org if this is not the case.')
  70
  71
  72 _BANNED_OBJC_FUNCTIONS = (
  73     (
  74       'addTrackingRect:',
  75       (
  76        'The use of -[NSView addTrackingRect:owner:userData:assumeInside:] is'
  77        'prohibited. Please use CrTrackingArea instead.',
  78        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  79       ),
  80       False,
  81     ),
  82     (
  83       'NSTrackingArea',
  84       (
  85        'The use of NSTrackingAreas is prohibited. Please use CrTrackingArea',
  86        'instead.',
  87        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  88       ),
  89       False,
  90     ),
  91     (
  92       'convertPointFromBase:',
  93       (
  94        'The use of -[NSView convertPointFromBase:] is almost certainly wrong.',
  95        'Please use |convertPoint:(point) fromView:nil| instead.',
  96        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  97       ),
  98       True,
  99     ),
 100     (
 101       'convertPointToBase:',
 102       (
 103        'The use of -[NSView convertPointToBase:] is almost certainly wrong.',
 104        'Please use |convertPoint:(point) toView:nil| instead.',
 105        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 106       ),
 107       True,
 108     ),
 109     (
 110       'convertRectFromBase:',
 111       (
 112        'The use of -[NSView convertRectFromBase:] is almost certainly wrong.',
 113        'Please use |convertRect:(point) fromView:nil| instead.',
 114        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 115       ),
 116       True,
 117     ),
 118     (
 119       'convertRectToBase:',
 120       (
 121        'The use of -[NSView convertRectToBase:] is almost certainly wrong.',
 122        'Please use |convertRect:(point) toView:nil| instead.',
 123        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 124       ),
 125       True,
 126     ),
 127     (
 128       'convertSizeFromBase:',
 129       (
 130        'The use of -[NSView convertSizeFromBase:] is almost certainly wrong.',
 131        'Please use |convertSize:(point) fromView:nil| instead.',
 132        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 133       ),
 134       True,
 135     ),
 136     (
 137       'convertSizeToBase:',
 138       (
 139        'The use of -[NSView convertSizeToBase:] is almost certainly wrong.',
 140        'Please use |convertSize:(point) toView:nil| instead.',
 141        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 142       ),
 143       True,
 144     ),
 145 )
 146
 147
 148 _BANNED_CPP_FUNCTIONS = (
 149     # Make sure that gtest's FRIEND_TEST() macro is not used; the
 150     # FRIEND_TEST_ALL_PREFIXES() macro from base/gtest_prod_util.h should be
 151     # used instead since that allows for FLAKY_ and DISABLED_ prefixes.
 152     (
 153       'FRIEND_TEST(',
 154       (
 155        'Chromium code should not use gtest\'s FRIEND_TEST() macro. Include',
 156        'base/gtest_prod_util.h and use FRIEND_TEST_ALL_PREFIXES() instead.',
 157       ),
 158       False,
 159       (),
 160     ),
 161     (
 162       'ScopedAllowIO',
 163       (
 164        'New code should not use ScopedAllowIO. Post a task to the blocking',
 165        'pool or the FILE thread instead.',
 166       ),
 167       True,
 168       (
 169         r"^components[\\\/]breakpad[\\\/]app[\\\/]breakpad_mac\.mm$",
 170         r"^content[\\\/]shell[\\\/]browser[\\\/]shell_browser_main\.cc$",
 171         r"^content[\\\/]shell[\\\/]browser[\\\/]shell_message_filter\.cc$",
 172         r"^net[\\\/]disk_cache[\\\/]cache_util\.cc$",
 173       ),
 174     ),
 175     (
 176       'SkRefPtr',
 177       (
 178         'The use of SkRefPtr is prohibited. ',
 179         'Please use skia::RefPtr instead.'
 180       ),
 181       True,
 182       (),
 183     ),
 184     (
 185       'SkAutoRef',
 186       (
 187         'The indirect use of SkRefPtr via SkAutoRef is prohibited. ',
 188         'Please use skia::RefPtr instead.'
 189       ),
 190       True,
 191       (),
 192     ),
 193     (
 194       'SkAutoTUnref',
 195       (
 196         'The use of SkAutoTUnref is dangerous because it implicitly ',
 197         'converts to a raw pointer. Please use skia::RefPtr instead.'
 198       ),
 199       True,
 200       (),
 201     ),
 202     (
 203       'SkAutoUnref',
 204       (
 205         'The indirect use of SkAutoTUnref through SkAutoUnref is dangerous ',
 206         'because it implicitly converts to a raw pointer. ',
 207         'Please use skia::RefPtr instead.'
 208       ),
 209       True,
 210       (),
 211     ),
 212     (
 213       r'/HANDLE_EINTR\(.*close',
 214       (
 215        'HANDLE_EINTR(close) is invalid. If close fails with EINTR, the file',
 216        'descriptor will be closed, and it is incorrect to retry the close.',
 217        'Either call close directly and ignore its return value, or wrap close',
 218        'in IGNORE_EINTR to use its return value. See http://crbug.com/269623'
 219       ),
 220       True,
 221       (),
 222     ),
 223     (
 224       r'/IGNORE_EINTR\((?!.*close)',
 225       (
 226        'IGNORE_EINTR is only valid when wrapping close. To wrap other system',
 227        'calls, use HANDLE_EINTR. See http://crbug.com/269623',
 228       ),
 229       True,
 230       (
 231         # Files that #define IGNORE_EINTR.
 232         r'^base[\\\/]posix[\\\/]eintr_wrapper\.h$',
 233         r'^ppapi[\\\/]tests[\\\/]test_broker\.cc$',
 234       ),
 235     ),
 236 )
 237
 238
 239 _VALID_OS_MACROS = (
 240     # Please keep sorted.
 241     'OS_ANDROID',
 242     'OS_BSD',
 243     'OS_CAT',       # For testing.
 244     'OS_CHROMEOS',
 245     'OS_FREEBSD',
 246     'OS_IOS',
 247     'OS_LINUX',
 248     'OS_MACOSX',
 249     'OS_NACL',
 250     'OS_OPENBSD',
 251     'OS_POSIX',
 252     'OS_QNX',
 253     'OS_SOLARIS',
 254     'OS_WIN',
 255 )
 256
 257
 258 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
 259   """Attempts to prevent use of functions intended only for testing in
 260   non-testing code. For now this is just a best-effort implementation
 261   that ignores header files and may have some false positives. A
 262   better implementation would probably need a proper C++ parser.
 263   """
 264   # We only scan .cc files and the like, as the declaration of
 265   # for-testing functions in header files are hard to distinguish from
 266   # calls to such functions without a proper C++ parser.
 267   file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
 268
 269   base_function_pattern = r'ForTest(ing)?|for_test(ing)?'
 270   inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
 271   comment_pattern = input_api.re.compile(r'//.*%s' % base_function_pattern)
 272   exclusion_pattern = input_api.re.compile(
 273     r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
 274       base_function_pattern, base_function_pattern))
 275
 276   def FilterFile(affected_file):
 277     black_list = (_EXCLUDED_PATHS +
 278                   _TEST_CODE_EXCLUDED_PATHS +
 279                   input_api.DEFAULT_BLACK_LIST)
 280     return input_api.FilterSourceFile(
 281       affected_file,
 282       white_list=(file_inclusion_pattern, ),
 283       black_list=black_list)
 284
 285   problems = []
 286   for f in input_api.AffectedSourceFiles(FilterFile):
 287     local_path = f.LocalPath()
 288     for line_number, line in f.ChangedContents():
 289       if (inclusion_pattern.search(line) and
 290           not comment_pattern.search(line) and
 291           not exclusion_pattern.search(line)):
 292         problems.append(
 293           '%s:%d\n    %s' % (local_path, line_number, line.strip()))
 294
 295   if problems:
 296     return [output_api.PresubmitPromptOrNotify(_TEST_ONLY_WARNING, problems)]
 297   else:
 298     return []
 299
 300
 301 def _CheckNoIOStreamInHeaders(input_api, output_api):
 302   """Checks to make sure no .h files include <iostream>."""
 303   files = []
 304   pattern = input_api.re.compile(r'^#include\s*<iostream>',
 305                                  input_api.re.MULTILINE)
 306   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 307     if not f.LocalPath().endswith('.h'):
 308       continue
 309     contents = input_api.ReadFile(f)
 310     if pattern.search(contents):
 311       files.append(f)
 312
 313   if len(files):
 314     return [ output_api.PresubmitError(
 315         'Do not #include <iostream> in header files, since it inserts static '
 316         'initialization into every file including the header. Instead, '
 317         '#include <ostream>. See http://crbug.com/94794',
 318         files) ]
 319   return []
 320
 321
 322 def _CheckNoUNIT_TESTInSourceFiles(input_api, output_api):
 323   """Checks to make sure no source files use UNIT_TEST"""
 324   problems = []
 325   for f in input_api.AffectedFiles():
 326     if (not f.LocalPath().endswith(('.cc', '.mm'))):
 327       continue
 328
 329     for line_num, line in f.ChangedContents():
 330       if 'UNIT_TEST ' in line or line.endswith('UNIT_TEST'):
 331         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 332
 333   if not problems:
 334     return []
 335   return [output_api.PresubmitPromptWarning('UNIT_TEST is only for headers.\n' +
 336       '\n'.join(problems))]
 337
 338
 339 def _CheckNoNewWStrings(input_api, output_api):
 340   """Checks to make sure we don't introduce use of wstrings."""
 341   problems = []
 342   for f in input_api.AffectedFiles():
 343     if (not f.LocalPath().endswith(('.cc', '.h')) or
 344         f.LocalPath().endswith(('test.cc', '_win.cc', '_win.h'))):
 345       continue
 346
 347     allowWString = False
 348     for line_num, line in f.ChangedContents():
 349       if 'presubmit: allow wstring' in line:
 350         allowWString = True
 351       elif not allowWString and 'wstring' in line:
 352         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 353         allowWString = False
 354       else:
 355         allowWString = False
 356
 357   if not problems:
 358     return []
 359   return [output_api.PresubmitPromptWarning('New code should not use wstrings.'
 360       '  If you are calling a cross-platform API that accepts a wstring, '
 361       'fix the API.\n' +
 362       '\n'.join(problems))]
 363
 364
 365 def _CheckNoDEPSGIT(input_api, output_api):
 366   """Make sure .DEPS.git is never modified manually."""
 367   if any(f.LocalPath().endswith('.DEPS.git') for f in
 368       input_api.AffectedFiles()):
 369     return [output_api.PresubmitError(
 370       'Never commit changes to .DEPS.git. This file is maintained by an\n'
 371       'automated system based on what\'s in DEPS and your changes will be\n'
 372       'overwritten.\n'
 373       'See http://code.google.com/p/chromium/wiki/UsingNewGit#Rolling_DEPS\n'
 374       'for more information')]
 375   return []
 376
 377
 378 def _CheckNoBannedFunctions(input_api, output_api):
 379   """Make sure that banned functions are not used."""
 380   warnings = []
 381   errors = []
 382
 383   file_filter = lambda f: f.LocalPath().endswith(('.mm', '.m', '.h'))
 384   for f in input_api.AffectedFiles(file_filter=file_filter):
 385     for line_num, line in f.ChangedContents():
 386       for func_name, message, error in _BANNED_OBJC_FUNCTIONS:
 387         if func_name in line:
 388           problems = warnings;
 389           if error:
 390             problems = errors;
 391           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 392           for message_line in message:
 393             problems.append('      %s' % message_line)
 394
 395   file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm', '.h'))
 396   for f in input_api.AffectedFiles(file_filter=file_filter):
 397     for line_num, line in f.ChangedContents():
 398       for func_name, message, error, excluded_paths in _BANNED_CPP_FUNCTIONS:
 399         def IsBlacklisted(affected_file, blacklist):
 400           local_path = affected_file.LocalPath()
 401           for item in blacklist:
 402             if input_api.re.match(item, local_path):
 403               return True
 404           return False
 405         if IsBlacklisted(f, excluded_paths):
 406           continue
 407         matched = False
 408         if func_name[0:1] == '/':
 409           regex = func_name[1:]
 410           if input_api.re.search(regex, line):
 411             matched = True
 412         elif func_name in line:
 413             matched = True
 414         if matched:
 415           problems = warnings;
 416           if error:
 417             problems = errors;
 418           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 419           for message_line in message:
 420             problems.append('      %s' % message_line)
 421
 422   result = []
 423   if (warnings):
 424     result.append(output_api.PresubmitPromptWarning(
 425         'Banned functions were used.\n' + '\n'.join(warnings)))
 426   if (errors):
 427     result.append(output_api.PresubmitError(
 428         'Banned functions were used.\n' + '\n'.join(errors)))
 429   return result
 430
 431
 432 def _CheckNoPragmaOnce(input_api, output_api):
 433   """Make sure that banned functions are not used."""
 434   files = []
 435   pattern = input_api.re.compile(r'^#pragma\s+once',
 436                                  input_api.re.MULTILINE)
 437   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 438     if not f.LocalPath().endswith('.h'):
 439       continue
 440     contents = input_api.ReadFile(f)
 441     if pattern.search(contents):
 442       files.append(f)
 443
 444   if files:
 445     return [output_api.PresubmitError(
 446         'Do not use #pragma once in header files.\n'
 447         'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
 448         files)]
 449   return []
 450
 451
 452 def _CheckNoTrinaryTrueFalse(input_api, output_api):
 453   """Checks to make sure we don't introduce use of foo ? true : false."""
 454   problems = []
 455   pattern = input_api.re.compile(r'\?\s*(true|false)\s*:\s*(true|false)')
 456   for f in input_api.AffectedFiles():
 457     if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
 458       continue
 459
 460     for line_num, line in f.ChangedContents():
 461       if pattern.match(line):
 462         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 463
 464   if not problems:
 465     return []
 466   return [output_api.PresubmitPromptWarning(
 467       'Please consider avoiding the "? true : false" pattern if possible.\n' +
 468       '\n'.join(problems))]
 469
 470
 471 def _CheckUnwantedDependencies(input_api, output_api):
 472   """Runs checkdeps on #include statements added in this
 473   change. Breaking - rules is an error, breaking ! rules is a
 474   warning.
 475   """
 476   # We need to wait until we have an input_api object and use this
 477   # roundabout construct to import checkdeps because this file is
 478   # eval-ed and thus doesn't have __file__.
 479   original_sys_path = sys.path
 480   try:
 481     sys.path = sys.path + [input_api.os_path.join(
 482         input_api.PresubmitLocalPath(), 'tools', 'checkdeps')]
 483     import checkdeps
 484     from cpp_checker import CppChecker
 485     from rules import Rule
 486   finally:
 487     # Restore sys.path to what it was before.
 488     sys.path = original_sys_path
 489
 490   added_includes = []
 491   for f in input_api.AffectedFiles():
 492     if not CppChecker.IsCppFile(f.LocalPath()):
 493       continue
 494
 495     changed_lines = [line for line_num, line in f.ChangedContents()]
 496     added_includes.append([f.LocalPath(), changed_lines])
 497
 498   deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath())
 499
 500   error_descriptions = []
 501   warning_descriptions = []
 502   for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
 503       added_includes):
 504     description_with_path = '%s\n    %s' % (path, rule_description)
 505     if rule_type == Rule.DISALLOW:
 506       error_descriptions.append(description_with_path)
 507     else:
 508       warning_descriptions.append(description_with_path)
 509
 510   results = []
 511   if error_descriptions:
 512     results.append(output_api.PresubmitError(
 513         'You added one or more #includes that violate checkdeps rules.',
 514         error_descriptions))
 515   if warning_descriptions:
 516     results.append(output_api.PresubmitPromptOrNotify(
 517         'You added one or more #includes of files that are temporarily\n'
 518         'allowed but being removed. Can you avoid introducing the\n'
 519         '#include? See relevant DEPS file(s) for details and contacts.',
 520         warning_descriptions))
 521   return results
 522
 523
 524 def _CheckFilePermissions(input_api, output_api):
 525   """Check that all files have their permissions properly set."""
 526   if input_api.platform == 'win32':
 527     return []
 528   args = [sys.executable, 'tools/checkperms/checkperms.py', '--root',
 529           input_api.change.RepositoryRoot()]
 530   for f in input_api.AffectedFiles():
 531     args += ['--file', f.LocalPath()]
 532   checkperms = input_api.subprocess.Popen(args,
 533                                           stdout=input_api.subprocess.PIPE)
 534   errors = checkperms.communicate()[0].strip()
 535   if errors:
 536     return [output_api.PresubmitError('checkperms.py failed.',
 537                                       errors.splitlines())]
 538   return []
 539
 540
 541 def _CheckNoAuraWindowPropertyHInHeaders(input_api, output_api):
 542   """Makes sure we don't include ui/aura/window_property.h
 543   in header files.
 544   """
 545   pattern = input_api.re.compile(r'^#include\s*"ui/aura/window_property.h"')
 546   errors = []
 547   for f in input_api.AffectedFiles():
 548     if not f.LocalPath().endswith('.h'):
 549       continue
 550     for line_num, line in f.ChangedContents():
 551       if pattern.match(line):
 552         errors.append('    %s:%d' % (f.LocalPath(), line_num))
 553
 554   results = []
 555   if errors:
 556     results.append(output_api.PresubmitError(
 557       'Header files should not include ui/aura/window_property.h', errors))
 558   return results
 559
 560
 561 def _CheckIncludeOrderForScope(scope, input_api, file_path, changed_linenums):
 562   """Checks that the lines in scope occur in the right order.
 563
 564   1. C system files in alphabetical order
 565   2. C++ system files in alphabetical order
 566   3. Project's .h files
 567   """
 568
 569   c_system_include_pattern = input_api.re.compile(r'\s*#include <.*\.h>')
 570   cpp_system_include_pattern = input_api.re.compile(r'\s*#include <.*>')
 571   custom_include_pattern = input_api.re.compile(r'\s*#include ".*')
 572
 573   C_SYSTEM_INCLUDES, CPP_SYSTEM_INCLUDES, CUSTOM_INCLUDES = range(3)
 574
 575   state = C_SYSTEM_INCLUDES
 576
 577   previous_line = ''
 578   previous_line_num = 0
 579   problem_linenums = []
 580   for line_num, line in scope:
 581     if c_system_include_pattern.match(line):
 582       if state != C_SYSTEM_INCLUDES:
 583         problem_linenums.append((line_num, previous_line_num))
 584       elif previous_line and previous_line > line:
 585         problem_linenums.append((line_num, previous_line_num))
 586     elif cpp_system_include_pattern.match(line):
 587       if state == C_SYSTEM_INCLUDES:
 588         state = CPP_SYSTEM_INCLUDES
 589       elif state == CUSTOM_INCLUDES:
 590         problem_linenums.append((line_num, previous_line_num))
 591       elif previous_line and previous_line > line:
 592         problem_linenums.append((line_num, previous_line_num))
 593     elif custom_include_pattern.match(line):
 594       if state != CUSTOM_INCLUDES:
 595         state = CUSTOM_INCLUDES
 596       elif previous_line and previous_line > line:
 597         problem_linenums.append((line_num, previous_line_num))
 598     else:
 599       problem_linenums.append(line_num)
 600     previous_line = line
 601     previous_line_num = line_num
 602
 603   warnings = []
 604   for (line_num, previous_line_num) in problem_linenums:
 605     if line_num in changed_linenums or previous_line_num in changed_linenums:
 606       warnings.append('    %s:%d' % (file_path, line_num))
 607   return warnings
 608
 609
 610 def _CheckIncludeOrderInFile(input_api, f, changed_linenums):
 611   """Checks the #include order for the given file f."""
 612
 613   system_include_pattern = input_api.re.compile(r'\s*#include \<.*')
 614   # Exclude the following includes from the check:
 615   # 1) #include <.../...>, e.g., <sys/...> includes often need to appear in a
 616   # specific order.
 617   # 2) <atlbase.h>, "build/build_config.h"
 618   excluded_include_pattern = input_api.re.compile(
 619       r'\s*#include (\<.*/.*|\<atlbase\.h\>|"build/build_config.h")')
 620   custom_include_pattern = input_api.re.compile(r'\s*#include "(?P<FILE>.*)"')
 621   # Match the final or penultimate token if it is xxxtest so we can ignore it
 622   # when considering the special first include.
 623   test_file_tag_pattern = input_api.re.compile(
 624     r'_[a-z]+test(?=(_[a-zA-Z0-9]+)?\.)')
 625   if_pattern = input_api.re.compile(
 626       r'\s*#\s*(if|elif|else|endif|define|undef).*')
 627   # Some files need specialized order of includes; exclude such files from this
 628   # check.
 629   uncheckable_includes_pattern = input_api.re.compile(
 630       r'\s*#include '
 631       '("ipc/.*macros\.h"|<windows\.h>|".*gl.*autogen.h")\s*')
 632
 633   contents = f.NewContents()
 634   warnings = []
 635   line_num = 0
 636
 637   # Handle the special first include. If the first include file is
 638   # some/path/file.h, the corresponding including file can be some/path/file.cc,
 639   # some/other/path/file.cc, some/path/file_platform.cc, some/path/file-suffix.h
 640   # etc. It's also possible that no special first include exists.
 641   # If the included file is some/path/file_platform.h the including file could
 642   # also be some/path/file_xxxtest_platform.h.
 643   including_file_base_name = test_file_tag_pattern.sub(
 644     '', input_api.os_path.basename(f.LocalPath()))
 645
 646   for line in contents:
 647     line_num += 1
 648     if system_include_pattern.match(line):
 649       # No special first include -> process the line again along with normal
 650       # includes.
 651       line_num -= 1
 652       break
 653     match = custom_include_pattern.match(line)
 654     if match:
 655       match_dict = match.groupdict()
 656       header_basename = test_file_tag_pattern.sub(
 657         '', input_api.os_path.basename(match_dict['FILE'])).replace('.h', '')
 658
 659       if header_basename not in including_file_base_name:
 660         # No special first include -> process the line again along with normal
 661         # includes.
 662         line_num -= 1
 663       break
 664
 665   # Split into scopes: Each region between #if and #endif is its own scope.
 666   scopes = []
 667   current_scope = []
 668   for line in contents[line_num:]:
 669     line_num += 1
 670     if uncheckable_includes_pattern.match(line):
 671       continue
 672     if if_pattern.match(line):
 673       scopes.append(current_scope)
 674       current_scope = []
 675     elif ((system_include_pattern.match(line) or
 676            custom_include_pattern.match(line)) and
 677           not excluded_include_pattern.match(line)):
 678       current_scope.append((line_num, line))
 679   scopes.append(current_scope)
 680
 681   for scope in scopes:
 682     warnings.extend(_CheckIncludeOrderForScope(scope, input_api, f.LocalPath(),
 683                                                changed_linenums))
 684   return warnings
 685
 686
 687 def _CheckIncludeOrder(input_api, output_api):
 688   """Checks that the #include order is correct.
 689
 690   1. The corresponding header for source files.
 691   2. C system files in alphabetical order
 692   3. C++ system files in alphabetical order
 693   4. Project's .h files in alphabetical order
 694
 695   Each region separated by #if, #elif, #else, #endif, #define and #undef follows
 696   these rules separately.
 697   """
 698
 699   warnings = []
 700   for f in input_api.AffectedFiles():
 701     if f.LocalPath().endswith(('.cc', '.h')):
 702       changed_linenums = set(line_num for line_num, _ in f.ChangedContents())
 703       warnings.extend(_CheckIncludeOrderInFile(input_api, f, changed_linenums))
 704
 705   results = []
 706   if warnings:
 707     results.append(output_api.PresubmitPromptOrNotify(_INCLUDE_ORDER_WARNING,
 708                                                       warnings))
 709   return results
 710
 711
 712 def _CheckForVersionControlConflictsInFile(input_api, f):
 713   pattern = input_api.re.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
 714   errors = []
 715   for line_num, line in f.ChangedContents():
 716     if pattern.match(line):
 717       errors.append('    %s:%d %s' % (f.LocalPath(), line_num, line))
 718   return errors
 719
 720
 721 def _CheckForVersionControlConflicts(input_api, output_api):
 722   """Usually this is not intentional and will cause a compile failure."""
 723   errors = []
 724   for f in input_api.AffectedFiles():
 725     errors.extend(_CheckForVersionControlConflictsInFile(input_api, f))
 726
 727   results = []
 728   if errors:
 729     results.append(output_api.PresubmitError(
 730       'Version control conflict markers found, please resolve.', errors))
 731   return results
 732
 733
 734 def _CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api):
 735   def FilterFile(affected_file):
 736     """Filter function for use with input_api.AffectedSourceFiles,
 737     below.  This filters out everything except non-test files from
 738     top-level directories that generally speaking should not hard-code
 739     service URLs (e.g. src/android_webview/, src/content/ and others).
 740     """
 741     return input_api.FilterSourceFile(
 742       affected_file,
 743       white_list=(r'^(android_webview|base|content|net)[\\\/].*', ),
 744       black_list=(_EXCLUDED_PATHS +
 745                   _TEST_CODE_EXCLUDED_PATHS +
 746                   input_api.DEFAULT_BLACK_LIST))
 747
 748   base_pattern = '"[^"]*google\.com[^"]*"'
 749   comment_pattern = input_api.re.compile('//.*%s' % base_pattern)
 750   pattern = input_api.re.compile(base_pattern)
 751   problems = []  # items are (filename, line_number, line)
 752   for f in input_api.AffectedSourceFiles(FilterFile):
 753     for line_num, line in f.ChangedContents():
 754       if not comment_pattern.search(line) and pattern.search(line):
 755         problems.append((f.LocalPath(), line_num, line))
 756
 757   if problems:
 758     return [output_api.PresubmitPromptOrNotify(
 759         'Most layers below src/chrome/ should not hardcode service URLs.\n'
 760         'Are you sure this is correct? (Contact: joi@chromium.org)',
 761         ['  %s:%d:  %s' % (
 762             problem[0], problem[1], problem[2]) for problem in problems])]
 763   else:
 764     return []
 765
 766
 767 def _CheckNoAbbreviationInPngFileName(input_api, output_api):
 768   """Makes sure there are no abbreviations in the name of PNG files.
 769   """
 770   pattern = input_api.re.compile(r'.*_[a-z]_.*\.png$|.*_[a-z]\.png$')
 771   errors = []
 772   for f in input_api.AffectedFiles(include_deletes=False):
 773     if pattern.match(f.LocalPath()):
 774       errors.append('    %s' % f.LocalPath())
 775
 776   results = []
 777   if errors:
 778     results.append(output_api.PresubmitError(
 779         'The name of PNG files should not have abbreviations. \n'
 780         'Use _hover.png, _center.png, instead of _h.png, _c.png.\n'
 781         'Contact oshima@chromium.org if you have questions.', errors))
 782   return results
 783
 784
 785 def _FilesToCheckForIncomingDeps(re, changed_lines):
 786   """Helper method for _CheckAddedDepsHaveTargetApprovals. Returns
 787   a set of DEPS entries that we should look up.
 788
 789   For a directory (rather than a specific filename) we fake a path to
 790   a specific filename by adding /DEPS. This is chosen as a file that
 791   will seldom or never be subject to per-file include_rules.
 792   """
 793   # We ignore deps entries on auto-generated directories.
 794   AUTO_GENERATED_DIRS = ['grit', 'jni']
 795
 796   # This pattern grabs the path without basename in the first
 797   # parentheses, and the basename (if present) in the second. It
 798   # relies on the simple heuristic that if there is a basename it will
 799   # be a header file ending in ".h".
 800   pattern = re.compile(
 801       r"""['"]\+([^'"]+?)(/[a-zA-Z0-9_]+\.h)?['"].*""")
 802   results = set()
 803   for changed_line in changed_lines:
 804     m = pattern.match(changed_line)
 805     if m:
 806       path = m.group(1)
 807       if path.split('/')[0] not in AUTO_GENERATED_DIRS:
 808         if m.group(2):
 809           results.add('%s%s' % (path, m.group(2)))
 810         else:
 811           results.add('%s/DEPS' % path)
 812   return results
 813
 814
 815 def _CheckAddedDepsHaveTargetApprovals(input_api, output_api):
 816   """When a dependency prefixed with + is added to a DEPS file, we
 817   want to make sure that the change is reviewed by an OWNER of the
 818   target file or directory, to avoid layering violations from being
 819   introduced. This check verifies that this happens.
 820   """
 821   changed_lines = set()
 822   for f in input_api.AffectedFiles():
 823     filename = input_api.os_path.basename(f.LocalPath())
 824     if filename == 'DEPS':
 825       changed_lines |= set(line.strip()
 826                            for line_num, line
 827                            in f.ChangedContents())
 828   if not changed_lines:
 829     return []
 830
 831   virtual_depended_on_files = _FilesToCheckForIncomingDeps(input_api.re,
 832                                                            changed_lines)
 833   if not virtual_depended_on_files:
 834     return []
 835
 836   if input_api.is_committing:
 837     if input_api.tbr:
 838       return [output_api.PresubmitNotifyResult(
 839           '--tbr was specified, skipping OWNERS check for DEPS additions')]
 840     if not input_api.change.issue:
 841       return [output_api.PresubmitError(
 842           "DEPS approval by OWNERS check failed: this change has "
 843           "no Rietveld issue number, so we can't check it for approvals.")]
 844     output = output_api.PresubmitError
 845   else:
 846     output = output_api.PresubmitNotifyResult
 847
 848   owners_db = input_api.owners_db
 849   owner_email, reviewers = input_api.canned_checks._RietveldOwnerAndReviewers(
 850       input_api,
 851       owners_db.email_regexp,
 852       approval_needed=input_api.is_committing)
 853
 854   owner_email = owner_email or input_api.change.author_email
 855
 856   reviewers_plus_owner = set(reviewers)
 857   if owner_email:
 858     reviewers_plus_owner.add(owner_email)
 859   missing_files = owners_db.files_not_covered_by(virtual_depended_on_files,
 860                                                  reviewers_plus_owner)
 861
 862   # We strip the /DEPS part that was added by
 863   # _FilesToCheckForIncomingDeps to fake a path to a file in a
 864   # directory.
 865   def StripDeps(path):
 866     start_deps = path.rfind('/DEPS')
 867     if start_deps != -1:
 868       return path[:start_deps]
 869     else:
 870       return path
 871   unapproved_dependencies = ["'+%s'," % StripDeps(path)
 872                              for path in missing_files]
 873
 874   if unapproved_dependencies:
 875     output_list = [
 876       output('Missing LGTM from OWNERS of dependencies added to DEPS:\n    %s' %
 877              '\n    '.join(sorted(unapproved_dependencies)))]
 878     if not input_api.is_committing:
 879       suggested_owners = owners_db.reviewers_for(missing_files, owner_email)
 880       output_list.append(output(
 881           'Suggested missing target path OWNERS:\n    %s' %
 882           '\n    '.join(suggested_owners or [])))
 883     return output_list
 884
 885   return []
 886
 887
 888 def _CheckSpamLogging(input_api, output_api):
 889   file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
 890   black_list = (_EXCLUDED_PATHS +
 891                 _TEST_CODE_EXCLUDED_PATHS +
 892                 input_api.DEFAULT_BLACK_LIST +
 893                 (r"^base[\\\/]logging\.h$",
 894                  r"^base[\\\/]logging\.cc$",
 895                  r"^cloud_print[\\\/]",
 896                  r"^chrome[\\\/]app[\\\/]chrome_main_delegate\.cc$",
 897                  r"^chrome[\\\/]browser[\\\/]chrome_browser_main\.cc$",
 898                  r"^chrome[\\\/]browser[\\\/]ui[\\\/]startup[\\\/]"
 899                      r"startup_browser_creator\.cc$",
 900                  r"^chrome[\\\/]installer[\\\/]setup[\\\/].*",
 901                  r"^chrome[\\\/]renderer[\\\/]extensions[\\\/]"
 902                      r"logging_native_handler\.cc$",
 903                  r"^content[\\\/]common[\\\/]gpu[\\\/]client[\\\/]"
 904                      r"gl_helper_benchmark\.cc$",
 905                  r"^remoting[\\\/]base[\\\/]logging\.h$",
 906                  r"^remoting[\\\/]host[\\\/].*",
 907                  r"^sandbox[\\\/]linux[\\\/].*",
 908                  r"^tools[\\\/]",
 909                  r"^ui[\\\/]aura[\\\/]bench[\\\/]bench_main\.cc$",))
 910   source_file_filter = lambda x: input_api.FilterSourceFile(
 911       x, white_list=(file_inclusion_pattern,), black_list=black_list)
 912
 913   log_info = []
 914   printf = []
 915
 916   for f in input_api.AffectedSourceFiles(source_file_filter):
 917     contents = input_api.ReadFile(f, 'rb')
 918     if re.search(r"\bD?LOG\s*\(\s*INFO\s*\)", contents):
 919       log_info.append(f.LocalPath())
 920     elif re.search(r"\bD?LOG_IF\s*\(\s*INFO\s*,", contents):
 921       log_info.append(f.LocalPath())
 922
 923     if re.search(r"\bprintf\(", contents):
 924       printf.append(f.LocalPath())
 925     elif re.search(r"\bfprintf\((stdout|stderr)", contents):
 926       printf.append(f.LocalPath())
 927
 928   if log_info:
 929     return [output_api.PresubmitError(
 930       'These files spam the console log with LOG(INFO):',
 931       items=log_info)]
 932   if printf:
 933     return [output_api.PresubmitError(
 934       'These files spam the console log with printf/fprintf:',
 935       items=printf)]
 936   return []
 937
 938
 939 def _CheckForAnonymousVariables(input_api, output_api):
 940   """These types are all expected to hold locks while in scope and
 941      so should never be anonymous (which causes them to be immediately
 942      destroyed)."""
 943   they_who_must_be_named = [
 944     'base::AutoLock',
 945     'base::AutoReset',
 946     'base::AutoUnlock',
 947     'SkAutoAlphaRestore',
 948     'SkAutoBitmapShaderInstall',
 949     'SkAutoBlitterChoose',
 950     'SkAutoBounderCommit',
 951     'SkAutoCallProc',
 952     'SkAutoCanvasRestore',
 953     'SkAutoCommentBlock',
 954     'SkAutoDescriptor',
 955     'SkAutoDisableDirectionCheck',
 956     'SkAutoDisableOvalCheck',
 957     'SkAutoFree',
 958     'SkAutoGlyphCache',
 959     'SkAutoHDC',
 960     'SkAutoLockColors',
 961     'SkAutoLockPixels',
 962     'SkAutoMalloc',
 963     'SkAutoMaskFreeImage',
 964     'SkAutoMutexAcquire',
 965     'SkAutoPathBoundsUpdate',
 966     'SkAutoPDFRelease',
 967     'SkAutoRasterClipValidate',
 968     'SkAutoRef',
 969     'SkAutoTime',
 970     'SkAutoTrace',
 971     'SkAutoUnref',
 972   ]
 973   anonymous = r'(%s)\s*[({]' % '|'.join(they_who_must_be_named)
 974   # bad: base::AutoLock(lock.get());
 975   # not bad: base::AutoLock lock(lock.get());
 976   bad_pattern = input_api.re.compile(anonymous)
 977   # good: new base::AutoLock(lock.get())
 978   good_pattern = input_api.re.compile(r'\bnew\s*' + anonymous)
 979   errors = []
 980
 981   for f in input_api.AffectedFiles():
 982     if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
 983       continue
 984     for linenum, line in f.ChangedContents():
 985       if bad_pattern.search(line) and not good_pattern.search(line):
 986         errors.append('%s:%d' % (f.LocalPath(), linenum))
 987
 988   if errors:
 989     return [output_api.PresubmitError(
 990       'These lines create anonymous variables that need to be named:',
 991       items=errors)]
 992   return []
 993
 994
 995 def _CheckCygwinShell(input_api, output_api):
 996   source_file_filter = lambda x: input_api.FilterSourceFile(
 997       x, white_list=(r'.+\.(gyp|gypi)$',))
 998   cygwin_shell = []
 999
1000   for f in input_api.AffectedSourceFiles(source_file_filter):
1001     for linenum, line in f.ChangedContents():
1002       if 'msvs_cygwin_shell' in line:
1003         cygwin_shell.append(f.LocalPath())
1004         break
1005
1006   if cygwin_shell:
1007     return [output_api.PresubmitError(
1008       'These files should not use msvs_cygwin_shell (the default is 0):',
1009       items=cygwin_shell)]
1010   return []
1011
1012
1013 def _CheckJavaStyle(input_api, output_api):
1014   """Runs checkstyle on changed java files and returns errors if any exist."""
1015   original_sys_path = sys.path
1016   try:
1017     sys.path = sys.path + [input_api.os_path.join(
1018         input_api.PresubmitLocalPath(), 'tools', 'android', 'checkstyle')]
1019     import checkstyle
1020   finally:
1021     # Restore sys.path to what it was before.
1022     sys.path = original_sys_path
1023
1024   return checkstyle.RunCheckstyle(
1025       input_api, output_api, 'tools/android/checkstyle/chromium-style-5.0.xml')
1026
1027
1028 def _CommonChecks(input_api, output_api):
1029   """Checks common to both upload and commit."""
1030   results = []
1031   results.extend(input_api.canned_checks.PanProjectChecks(
1032       input_api, output_api,
1033       excluded_paths=_EXCLUDED_PATHS + _TESTRUNNER_PATHS))
1034   results.extend(_CheckAuthorizedAuthor(input_api, output_api))
1035   results.extend(
1036       _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
1037   results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
1038   results.extend(_CheckNoUNIT_TESTInSourceFiles(input_api, output_api))
1039   results.extend(_CheckNoNewWStrings(input_api, output_api))
1040   results.extend(_CheckNoDEPSGIT(input_api, output_api))
1041   results.extend(_CheckNoBannedFunctions(input_api, output_api))
1042   results.extend(_CheckNoPragmaOnce(input_api, output_api))
1043   results.extend(_CheckNoTrinaryTrueFalse(input_api, output_api))
1044   results.extend(_CheckUnwantedDependencies(input_api, output_api))
1045   results.extend(_CheckFilePermissions(input_api, output_api))
1046   results.extend(_CheckNoAuraWindowPropertyHInHeaders(input_api, output_api))
1047   results.extend(_CheckIncludeOrder(input_api, output_api))
1048   results.extend(_CheckForVersionControlConflicts(input_api, output_api))
1049   results.extend(_CheckPatchFiles(input_api, output_api))
1050   results.extend(_CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api))
1051   results.extend(_CheckNoAbbreviationInPngFileName(input_api, output_api))
1052   results.extend(_CheckForInvalidOSMacros(input_api, output_api))
1053   results.extend(_CheckAddedDepsHaveTargetApprovals(input_api, output_api))
1054   results.extend(
1055       input_api.canned_checks.CheckChangeHasNoTabs(
1056           input_api,
1057           output_api,
1058           source_file_filter=lambda x: x.LocalPath().endswith('.grd')))
1059   results.extend(_CheckSpamLogging(input_api, output_api))
1060   results.extend(_CheckForAnonymousVariables(input_api, output_api))
1061   results.extend(_CheckCygwinShell(input_api, output_api))
1062   results.extend(_CheckJavaStyle(input_api, output_api))
1063
1064   if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
1065     results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
1066         input_api, output_api,
1067         input_api.PresubmitLocalPath(),
1068         whitelist=[r'^PRESUBMIT_test\.py$']))
1069   return results
1070
1071
1072 def _CheckSubversionConfig(input_api, output_api):
1073   """Verifies the subversion config file is correctly setup.
1074
1075   Checks that autoprops are enabled, returns an error otherwise.
1076   """
1077   join = input_api.os_path.join
1078   if input_api.platform == 'win32':
1079     appdata = input_api.environ.get('APPDATA', '')
1080     if not appdata:
1081       return [output_api.PresubmitError('%APPDATA% is not configured.')]
1082     path = join(appdata, 'Subversion', 'config')
1083   else:
1084     home = input_api.environ.get('HOME', '')
1085     if not home:
1086       return [output_api.PresubmitError('$HOME is not configured.')]
1087     path = join(home, '.subversion', 'config')
1088
1089   error_msg = (
1090       'Please look at http://dev.chromium.org/developers/coding-style to\n'
1091       'configure your subversion configuration file. This enables automatic\n'
1092       'properties to simplify the project maintenance.\n'
1093       'Pro-tip: just download and install\n'
1094       'http://src.chromium.org/viewvc/chrome/trunk/tools/build/slave/config\n')
1095
1096   try:
1097     lines = open(path, 'r').read().splitlines()
1098     # Make sure auto-props is enabled and check for 2 Chromium standard
1099     # auto-prop.
1100     if (not '*.cc = svn:eol-style=LF' in lines or
1101         not '*.pdf = svn:mime-type=application/pdf' in lines or
1102         not 'enable-auto-props = yes' in lines):
1103       return [
1104           output_api.PresubmitNotifyResult(
1105               'It looks like you have not configured your subversion config '
1106               'file or it is not up-to-date.\n' + error_msg)
1107       ]
1108   except (OSError, IOError):
1109     return [
1110         output_api.PresubmitNotifyResult(
1111             'Can\'t find your subversion config file.\n' + error_msg)
1112     ]
1113   return []
1114
1115
1116 def _CheckAuthorizedAuthor(input_api, output_api):
1117   """For non-googler/chromites committers, verify the author's email address is
1118   in AUTHORS.
1119   """
1120   # TODO(maruel): Add it to input_api?
1121   import fnmatch
1122
1123   author = input_api.change.author_email
1124   if not author:
1125     input_api.logging.info('No author, skipping AUTHOR check')
1126     return []
1127   authors_path = input_api.os_path.join(
1128       input_api.PresubmitLocalPath(), 'AUTHORS')
1129   valid_authors = (
1130       input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
1131       for line in open(authors_path))
1132   valid_authors = [item.group(1).lower() for item in valid_authors if item]
1133   if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
1134     input_api.logging.info('Valid authors are %s', ', '.join(valid_authors))
1135     return [output_api.PresubmitPromptWarning(
1136         ('%s is not in AUTHORS file. If you are a new contributor, please visit'
1137         '\n'
1138         'http://www.chromium.org/developers/contributing-code and read the '
1139         '"Legal" section\n'
1140         'If you are a chromite, verify the contributor signed the CLA.') %
1141         author)]
1142   return []
1143
1144
1145 def _CheckPatchFiles(input_api, output_api):
1146   problems = [f.LocalPath() for f in input_api.AffectedFiles()
1147       if f.LocalPath().endswith(('.orig', '.rej'))]
1148   if problems:
1149     return [output_api.PresubmitError(
1150         "Don't commit .rej and .orig files.", problems)]
1151   else:
1152     return []
1153
1154
1155 def _DidYouMeanOSMacro(bad_macro):
1156   try:
1157     return {'A': 'OS_ANDROID',
1158             'B': 'OS_BSD',
1159             'C': 'OS_CHROMEOS',
1160             'F': 'OS_FREEBSD',
1161             'L': 'OS_LINUX',
1162             'M': 'OS_MACOSX',
1163             'N': 'OS_NACL',
1164             'O': 'OS_OPENBSD',
1165             'P': 'OS_POSIX',
1166             'S': 'OS_SOLARIS',
1167             'W': 'OS_WIN'}[bad_macro[3].upper()]
1168   except KeyError:
1169     return ''
1170
1171
1172 def _CheckForInvalidOSMacrosInFile(input_api, f):
1173   """Check for sensible looking, totally invalid OS macros."""
1174   preprocessor_statement = input_api.re.compile(r'^\s*#')
1175   os_macro = input_api.re.compile(r'defined\((OS_[^)]+)\)')
1176   results = []
1177   for lnum, line in f.ChangedContents():
1178     if preprocessor_statement.search(line):
1179       for match in os_macro.finditer(line):
1180         if not match.group(1) in _VALID_OS_MACROS:
1181           good = _DidYouMeanOSMacro(match.group(1))
1182           did_you_mean = ' (did you mean %s?)' % good if good else ''
1183           results.append('    %s:%d %s%s' % (f.LocalPath(),
1184                                              lnum,
1185                                              match.group(1),
1186                                              did_you_mean))
1187   return results
1188
1189
1190 def _CheckForInvalidOSMacros(input_api, output_api):
1191   """Check all affected files for invalid OS macros."""
1192   bad_macros = []
1193   for f in input_api.AffectedFiles():
1194     if not f.LocalPath().endswith(('.py', '.js', '.html', '.css')):
1195       bad_macros.extend(_CheckForInvalidOSMacrosInFile(input_api, f))
1196
1197   if not bad_macros:
1198     return []
1199
1200   return [output_api.PresubmitError(
1201       'Possibly invalid OS macro[s] found. Please fix your code\n'
1202       'or add your macro to src/PRESUBMIT.py.', bad_macros)]
1203
1204
1205 def CheckChangeOnUpload(input_api, output_api):
1206   results = []
1207   results.extend(_CommonChecks(input_api, output_api))
1208   return results
1209
1210
1211 def GetDefaultTryConfigs(bots=None):
1212   """Returns a list of ('bot', set(['tests']), optionally filtered by [bots].
1213
1214   To add tests to this list, they MUST be in the the corresponding master's
1215   gatekeeper config. For example, anything on master.chromium would be closed by
1216   tools/build/masters/master.chromium/master_gatekeeper_cfg.py.
1217
1218   If 'bots' is specified, will only return configurations for bots in that list.
1219   """
1220
1221   standard_tests = [
1222       'base_unittests',
1223       'browser_tests',
1224       'cacheinvalidation_unittests',
1225       'check_deps',
1226       'check_deps2git',
1227       'content_browsertests',
1228       'content_unittests',
1229       'crypto_unittests',
1230       #'gfx_unittests',
1231       'gpu_unittests',
1232       'interactive_ui_tests',
1233       'ipc_tests',
1234       'jingle_unittests',
1235       'media_unittests',
1236       'net_unittests',
1237       'ppapi_unittests',
1238       'printing_unittests',
1239       'sql_unittests',
1240       'sync_unit_tests',
1241       'unit_tests',
1242       # Broken in release.
1243       #'url_unittests',
1244       #'webkit_unit_tests',
1245   ]
1246
1247   builders_and_tests = {
1248       # TODO(maruel): Figure out a way to run 'sizes' where people can
1249       # effectively update the perf expectation correctly.  This requires a
1250       # clobber=True build running 'sizes'. 'sizes' is not accurate with
1251       # incremental build. Reference:
1252       # http://chromium.org/developers/tree-sheriffs/perf-sheriffs.
1253       # TODO(maruel): An option would be to run 'sizes' but not count a failure
1254       # of this step as a try job failure.
1255       'android_aosp': ['compile'],
1256       'android_clang_dbg': ['slave_steps'],
1257       'android_dbg': ['slave_steps'],
1258       'cros_x86': ['defaulttests'],
1259       'ios_dbg_simulator': [
1260           'compile',
1261           'base_unittests',
1262           'content_unittests',
1263           'crypto_unittests',
1264           'url_unittests',
1265           'net_unittests',
1266           'sql_unittests',
1267           'ui_unittests',
1268       ],
1269       'ios_rel_device': ['compile'],
1270       'linux_asan': ['defaulttests'],
1271       #TODO(stip): Change the name of this builder to reflect that it's release.
1272       'linux_gtk': standard_tests,
1273       'linux_chromeos_asan': ['defaulttests'],
1274       'linux_chromeos_clang': ['compile'],
1275       # Note: It is a Release builder even if its name convey otherwise.
1276       'linux_chromeos': standard_tests + [
1277           'app_list_unittests',
1278           'aura_unittests',
1279           'ash_unittests',
1280           'chromeos_unittests',
1281           'components_unittests',
1282           'dbus_unittests',
1283           'device_unittests',
1284           'events_unittests',
1285           'google_apis_unittests',
1286           'sandbox_linux_unittests',
1287       ],
1288       'linux_chromium_dbg': ['defaulttests'],
1289       'linux_chromium_rel': ['defaulttests'],
1290       'linux_clang': ['compile'],
1291       'linux_nacl_sdk_build': ['compile'],
1292       'linux_rel': standard_tests + [
1293           'app_list_unittests',
1294           'aura_unittests',
1295           'cc_unittests',
1296           'chromedriver_unittests',
1297           'components_unittests',
1298           'compositor_unittests',
1299           'events_unittests',
1300           'google_apis_unittests',
1301           'nacl_integration',
1302           'remoting_unittests',
1303           'sandbox_linux_unittests',
1304           'sync_integration_tests',
1305           'telemetry_perf_unittests',
1306           'telemetry_unittests',
1307       ],
1308       'mac': ['compile'],
1309       'mac_chromium_dbg': ['defaulttests'],
1310       'mac_chromium_rel': ['defaulttests'],
1311       'mac_nacl_sdk_build': ['compile'],
1312       'mac_rel': standard_tests + [
1313           'app_list_unittests',
1314           'cc_unittests',
1315           'chromedriver_unittests',
1316           'components_unittests',
1317           'google_apis_unittests',
1318           'message_center_unittests',
1319           'nacl_integration',
1320           'remoting_unittests',
1321           'sync_integration_tests',
1322           'telemetry_perf_unittests',
1323           'telemetry_unittests',
1324       ],
1325       'win': ['compile'],
1326       'win_nacl_sdk_build': ['compile'],
1327       'win_rel': standard_tests + [
1328           'app_list_unittests',
1329           'ash_unittests',
1330           'aura_unittests',
1331           'cc_unittests',
1332           'chrome_elf_unittests',
1333           'chromedriver_unittests',
1334           'components_unittests',
1335           'compositor_unittests',
1336           'events_unittests',
1337           'google_apis_unittests',
1338           'installer_util_unittests',
1339           'mini_installer_test',
1340           'nacl_integration',
1341           'remoting_unittests',
1342           'sync_integration_tests',
1343           'telemetry_perf_unittests',
1344           'telemetry_unittests',
1345           'views_unittests',
1346       ],
1347       'win_x64_rel': [
1348           'base_unittests',
1349       ],
1350   }
1351
1352   swarm_enabled_builders = (
1353       'linux_rel',
1354       'mac_rel',
1355       'win_rel',
1356   )
1357
1358   swarm_enabled_tests = (
1359       'base_unittests',
1360       'browser_tests',
1361       'interactive_ui_tests',
1362       'net_unittests',
1363       'unit_tests',
1364   )
1365
1366   for bot in builders_and_tests:
1367     if bot in swarm_enabled_builders:
1368       builders_and_tests[bot] = [x + '_swarm' if x in swarm_enabled_tests else x
1369                                  for x in builders_and_tests[bot]]
1370
1371   if bots:
1372     return [(bot, set(builders_and_tests[bot])) for bot in bots]
1373   else:
1374     return [(bot, set(tests)) for bot, tests in builders_and_tests.iteritems()]
1375
1376
1377 def CheckChangeOnCommit(input_api, output_api):
1378   results = []
1379   results.extend(_CommonChecks(input_api, output_api))
1380   # TODO(thestig) temporarily disabled, doesn't work in third_party/
1381   #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
1382   #    input_api, output_api, sources))
1383   # Make sure the tree is 'open'.
1384   results.extend(input_api.canned_checks.CheckTreeIsOpen(
1385       input_api,
1386       output_api,
1387       json_url='http://chromium-status.appspot.com/current?format=json'))
1388   results.extend(input_api.canned_checks.CheckRietveldTryJobExecution(input_api,
1389       output_api, 'http://codereview.chromium.org',
1390       ('win_rel', 'linux_rel', 'mac_rel, win:compile'),
1391       'tryserver@chromium.org'))
1392
1393   results.extend(input_api.canned_checks.CheckChangeHasBugField(
1394       input_api, output_api))
1395   results.extend(input_api.canned_checks.CheckChangeHasDescription(
1396       input_api, output_api))
1397   results.extend(_CheckSubversionConfig(input_api, output_api))
1398   return results
1399
1400
1401 def GetPreferredTrySlaves(project, change):
1402   files = change.LocalPaths()
1403
1404   if not files or all(re.search(r'[\\/]OWNERS$', f) for f in files):
1405     return []
1406
1407   if all(re.search('\.(m|mm)$|(^|[/_])mac[/_.]', f) for f in files):
1408     return GetDefaultTryConfigs(['mac', 'mac_rel'])
1409   if all(re.search('(^|[/_])win[/_.]', f) for f in files):
1410     return GetDefaultTryConfigs(['win', 'win_rel'])
1411   if all(re.search('(^|[/_])android[/_.]', f) for f in files):
1412     return GetDefaultTryConfigs([
1413         'android_aosp',
1414         'android_clang_dbg',
1415         'android_dbg',
1416     ])
1417   if all(re.search('[/_]ios[/_.]', f) for f in files):
1418     return GetDefaultTryConfigs(['ios_rel_device', 'ios_dbg_simulator'])
1419
1420   trybots = GetDefaultTryConfigs([
1421       'android_clang_dbg',
1422       'android_dbg',
1423       'ios_dbg_simulator',
1424       'ios_rel_device',
1425       'linux_gtk',
1426       'linux_asan',
1427       'linux_chromeos',
1428       'linux_clang',
1429       'linux_nacl_sdk_build',
1430       'linux_rel',
1431       'mac',
1432       'mac_nacl_sdk_build',
1433       'mac_rel',
1434       'win',
1435       'win_nacl_sdk_build',
1436       'win_rel',
1437       'win_x64_rel',
1438   ])
1439
1440   # Match things like path/aura/file.cc and path/file_aura.cc.
1441   # Same for chromeos.
1442   if any(re.search('[/_](aura|chromeos)', f) for f in files):
1443     trybots.extend(GetDefaultTryConfigs([
1444         'linux_chromeos_asan', 'linux_chromeos_clang']))
1445
1446   # If there are gyp changes to base, build, or chromeos, run a full cros build
1447   # in addition to the shorter linux_chromeos build. Changes to high level gyp
1448   # files have a much higher chance of breaking the cros build, which is
1449   # differnt from the linux_chromeos build that most chrome developers test
1450   # with.
1451   if any(re.search('^(base|build|chromeos).*\.gypi?$', f) for f in files):
1452     trybots.extend(GetDefaultTryConfigs(['cros_x86']))
1453
1454   # The AOSP bot doesn't build the chrome/ layer, so ignore any changes to it
1455   # unless they're .gyp(i) files as changes to those files can break the gyp
1456   # step on that bot.
1457   if (not all(re.search('^chrome', f) for f in files) or
1458       any(re.search('\.gypi?$', f) for f in files)):
1459     trybots.extend(GetDefaultTryConfigs(['android_aosp']))
1460
1461   return trybots