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