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