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