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[\\\/]crash[\\\/]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   def FileFilterIncludeOrder(affected_file):
 722     black_list = (_EXCLUDED_PATHS + input_api.DEFAULT_BLACK_LIST)
 723     return input_api.FilterSourceFile(affected_file, black_list=black_list)
 724
 725   warnings = []
 726   for f in input_api.AffectedFiles(file_filter=FileFilterIncludeOrder):
 727     if f.LocalPath().endswith(('.cc', '.h')):
 728       changed_linenums = set(line_num for line_num, _ in f.ChangedContents())
 729       warnings.extend(_CheckIncludeOrderInFile(input_api, f, changed_linenums))
 730
 731   results = []
 732   if warnings:
 733     results.append(output_api.PresubmitPromptOrNotify(_INCLUDE_ORDER_WARNING,
 734                                                       warnings))
 735   return results
 736
 737
 738 def _CheckForVersionControlConflictsInFile(input_api, f):
 739   pattern = input_api.re.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
 740   errors = []
 741   for line_num, line in f.ChangedContents():
 742     if pattern.match(line):
 743       errors.append('    %s:%d %s' % (f.LocalPath(), line_num, line))
 744   return errors
 745
 746
 747 def _CheckForVersionControlConflicts(input_api, output_api):
 748   """Usually this is not intentional and will cause a compile failure."""
 749   errors = []
 750   for f in input_api.AffectedFiles():
 751     errors.extend(_CheckForVersionControlConflictsInFile(input_api, f))
 752
 753   results = []
 754   if errors:
 755     results.append(output_api.PresubmitError(
 756       'Version control conflict markers found, please resolve.', errors))
 757   return results
 758
 759
 760 def _CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api):
 761   def FilterFile(affected_file):
 762     """Filter function for use with input_api.AffectedSourceFiles,
 763     below.  This filters out everything except non-test files from
 764     top-level directories that generally speaking should not hard-code
 765     service URLs (e.g. src/android_webview/, src/content/ and others).
 766     """
 767     return input_api.FilterSourceFile(
 768       affected_file,
 769       white_list=(r'^(android_webview|base|content|net)[\\\/].*', ),
 770       black_list=(_EXCLUDED_PATHS +
 771                   _TEST_CODE_EXCLUDED_PATHS +
 772                   input_api.DEFAULT_BLACK_LIST))
 773
 774   base_pattern = '"[^"]*google\.com[^"]*"'
 775   comment_pattern = input_api.re.compile('//.*%s' % base_pattern)
 776   pattern = input_api.re.compile(base_pattern)
 777   problems = []  # items are (filename, line_number, line)
 778   for f in input_api.AffectedSourceFiles(FilterFile):
 779     for line_num, line in f.ChangedContents():
 780       if not comment_pattern.search(line) and pattern.search(line):
 781         problems.append((f.LocalPath(), line_num, line))
 782
 783   if problems:
 784     return [output_api.PresubmitPromptOrNotify(
 785         'Most layers below src/chrome/ should not hardcode service URLs.\n'
 786         'Are you sure this is correct?',
 787         ['  %s:%d:  %s' % (
 788             problem[0], problem[1], problem[2]) for problem in problems])]
 789   else:
 790     return []
 791
 792
 793 def _CheckNoAbbreviationInPngFileName(input_api, output_api):
 794   """Makes sure there are no abbreviations in the name of PNG files.
 795   """
 796   pattern = input_api.re.compile(r'.*_[a-z]_.*\.png$|.*_[a-z]\.png$')
 797   errors = []
 798   for f in input_api.AffectedFiles(include_deletes=False):
 799     if pattern.match(f.LocalPath()):
 800       errors.append('    %s' % f.LocalPath())
 801
 802   results = []
 803   if errors:
 804     results.append(output_api.PresubmitError(
 805         'The name of PNG files should not have abbreviations. \n'
 806         'Use _hover.png, _center.png, instead of _h.png, _c.png.\n'
 807         'Contact oshima@chromium.org if you have questions.', errors))
 808   return results
 809
 810
 811 def _FilesToCheckForIncomingDeps(re, changed_lines):
 812   """Helper method for _CheckAddedDepsHaveTargetApprovals. Returns
 813   a set of DEPS entries that we should look up.
 814
 815   For a directory (rather than a specific filename) we fake a path to
 816   a specific filename by adding /DEPS. This is chosen as a file that
 817   will seldom or never be subject to per-file include_rules.
 818   """
 819   # We ignore deps entries on auto-generated directories.
 820   AUTO_GENERATED_DIRS = ['grit', 'jni']
 821
 822   # This pattern grabs the path without basename in the first
 823   # parentheses, and the basename (if present) in the second. It
 824   # relies on the simple heuristic that if there is a basename it will
 825   # be a header file ending in ".h".
 826   pattern = re.compile(
 827       r"""['"]\+([^'"]+?)(/[a-zA-Z0-9_]+\.h)?['"].*""")
 828   results = set()
 829   for changed_line in changed_lines:
 830     m = pattern.match(changed_line)
 831     if m:
 832       path = m.group(1)
 833       if path.split('/')[0] not in AUTO_GENERATED_DIRS:
 834         if m.group(2):
 835           results.add('%s%s' % (path, m.group(2)))
 836         else:
 837           results.add('%s/DEPS' % path)
 838   return results
 839
 840
 841 def _CheckAddedDepsHaveTargetApprovals(input_api, output_api):
 842   """When a dependency prefixed with + is added to a DEPS file, we
 843   want to make sure that the change is reviewed by an OWNER of the
 844   target file or directory, to avoid layering violations from being
 845   introduced. This check verifies that this happens.
 846   """
 847   changed_lines = set()
 848   for f in input_api.AffectedFiles():
 849     filename = input_api.os_path.basename(f.LocalPath())
 850     if filename == 'DEPS':
 851       changed_lines |= set(line.strip()
 852                            for line_num, line
 853                            in f.ChangedContents())
 854   if not changed_lines:
 855     return []
 856
 857   virtual_depended_on_files = _FilesToCheckForIncomingDeps(input_api.re,
 858                                                            changed_lines)
 859   if not virtual_depended_on_files:
 860     return []
 861
 862   if input_api.is_committing:
 863     if input_api.tbr:
 864       return [output_api.PresubmitNotifyResult(
 865           '--tbr was specified, skipping OWNERS check for DEPS additions')]
 866     if not input_api.change.issue:
 867       return [output_api.PresubmitError(
 868           "DEPS approval by OWNERS check failed: this change has "
 869           "no Rietveld issue number, so we can't check it for approvals.")]
 870     output = output_api.PresubmitError
 871   else:
 872     output = output_api.PresubmitNotifyResult
 873
 874   owners_db = input_api.owners_db
 875   owner_email, reviewers = input_api.canned_checks._RietveldOwnerAndReviewers(
 876       input_api,
 877       owners_db.email_regexp,
 878       approval_needed=input_api.is_committing)
 879
 880   owner_email = owner_email or input_api.change.author_email
 881
 882   reviewers_plus_owner = set(reviewers)
 883   if owner_email:
 884     reviewers_plus_owner.add(owner_email)
 885   missing_files = owners_db.files_not_covered_by(virtual_depended_on_files,
 886                                                  reviewers_plus_owner)
 887
 888   # We strip the /DEPS part that was added by
 889   # _FilesToCheckForIncomingDeps to fake a path to a file in a
 890   # directory.
 891   def StripDeps(path):
 892     start_deps = path.rfind('/DEPS')
 893     if start_deps != -1:
 894       return path[:start_deps]
 895     else:
 896       return path
 897   unapproved_dependencies = ["'+%s'," % StripDeps(path)
 898                              for path in missing_files]
 899
 900   if unapproved_dependencies:
 901     output_list = [
 902       output('Missing LGTM from OWNERS of dependencies added to DEPS:\n    %s' %
 903              '\n    '.join(sorted(unapproved_dependencies)))]
 904     if not input_api.is_committing:
 905       suggested_owners = owners_db.reviewers_for(missing_files, owner_email)
 906       output_list.append(output(
 907           'Suggested missing target path OWNERS:\n    %s' %
 908           '\n    '.join(suggested_owners or [])))
 909     return output_list
 910
 911   return []
 912
 913
 914 def _CheckSpamLogging(input_api, output_api):
 915   file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
 916   black_list = (_EXCLUDED_PATHS +
 917                 _TEST_CODE_EXCLUDED_PATHS +
 918                 input_api.DEFAULT_BLACK_LIST +
 919                 (r"^base[\\\/]logging\.h$",
 920                  r"^base[\\\/]logging\.cc$",
 921                  r"^chrome[\\\/]app[\\\/]chrome_main_delegate\.cc$",
 922                  r"^chrome[\\\/]browser[\\\/]chrome_browser_main\.cc$",
 923                  r"^chrome[\\\/]browser[\\\/]ui[\\\/]startup[\\\/]"
 924                      r"startup_browser_creator\.cc$",
 925                  r"^chrome[\\\/]installer[\\\/]setup[\\\/].*",
 926                  r"chrome[\\\/]browser[\\\/]diagnostics[\\\/]" +
 927                      r"diagnostics_writer\.cc$",
 928                  r"^chrome_elf[\\\/]dll_hash[\\\/]dll_hash_main\.cc$",
 929                  r"^chromecast[\\\/]",
 930                  r"^cloud_print[\\\/]",
 931                  r"^content[\\\/]common[\\\/]gpu[\\\/]client[\\\/]"
 932                      r"gl_helper_benchmark\.cc$",
 933                  r"^extensions[\\\/]renderer[\\\/]logging_native_handler\.cc$",
 934                  r"^native_client_sdk[\\\/]",
 935                  r"^remoting[\\\/]base[\\\/]logging\.h$",
 936                  r"^remoting[\\\/]host[\\\/].*",
 937                  r"^sandbox[\\\/]linux[\\\/].*",
 938                  r"^tools[\\\/]",
 939                  r"^ui[\\\/]aura[\\\/]bench[\\\/]bench_main\.cc$",
 940                  r"^webkit[\\\/]browser[\\\/]fileapi[\\\/]" +
 941                      r"dump_file_system.cc$",))
 942   source_file_filter = lambda x: input_api.FilterSourceFile(
 943       x, white_list=(file_inclusion_pattern,), black_list=black_list)
 944
 945   log_info = []
 946   printf = []
 947
 948   for f in input_api.AffectedSourceFiles(source_file_filter):
 949     contents = input_api.ReadFile(f, 'rb')
 950     if re.search(r"\bD?LOG\s*\(\s*INFO\s*\)", contents):
 951       log_info.append(f.LocalPath())
 952     elif re.search(r"\bD?LOG_IF\s*\(\s*INFO\s*,", contents):
 953       log_info.append(f.LocalPath())
 954
 955     if re.search(r"\bprintf\(", contents):
 956       printf.append(f.LocalPath())
 957     elif re.search(r"\bfprintf\((stdout|stderr)", contents):
 958       printf.append(f.LocalPath())
 959
 960   if log_info:
 961     return [output_api.PresubmitError(
 962       'These files spam the console log with LOG(INFO):',
 963       items=log_info)]
 964   if printf:
 965     return [output_api.PresubmitError(
 966       'These files spam the console log with printf/fprintf:',
 967       items=printf)]
 968   return []
 969
 970
 971 def _CheckForAnonymousVariables(input_api, output_api):
 972   """These types are all expected to hold locks while in scope and
 973      so should never be anonymous (which causes them to be immediately
 974      destroyed)."""
 975   they_who_must_be_named = [
 976     'base::AutoLock',
 977     'base::AutoReset',
 978     'base::AutoUnlock',
 979     'SkAutoAlphaRestore',
 980     'SkAutoBitmapShaderInstall',
 981     'SkAutoBlitterChoose',
 982     'SkAutoBounderCommit',
 983     'SkAutoCallProc',
 984     'SkAutoCanvasRestore',
 985     'SkAutoCommentBlock',
 986     'SkAutoDescriptor',
 987     'SkAutoDisableDirectionCheck',
 988     'SkAutoDisableOvalCheck',
 989     'SkAutoFree',
 990     'SkAutoGlyphCache',
 991     'SkAutoHDC',
 992     'SkAutoLockColors',
 993     'SkAutoLockPixels',
 994     'SkAutoMalloc',
 995     'SkAutoMaskFreeImage',
 996     'SkAutoMutexAcquire',
 997     'SkAutoPathBoundsUpdate',
 998     'SkAutoPDFRelease',
 999     'SkAutoRasterClipValidate',
1000     'SkAutoRef',
1001     'SkAutoTime',
1002     'SkAutoTrace',
1003     'SkAutoUnref',
1004   ]
1005   anonymous = r'(%s)\s*[({]' % '|'.join(they_who_must_be_named)
1006   # bad: base::AutoLock(lock.get());
1007   # not bad: base::AutoLock lock(lock.get());
1008   bad_pattern = input_api.re.compile(anonymous)
1009   # good: new base::AutoLock(lock.get())
1010   good_pattern = input_api.re.compile(r'\bnew\s*' + anonymous)
1011   errors = []
1012
1013   for f in input_api.AffectedFiles():
1014     if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
1015       continue
1016     for linenum, line in f.ChangedContents():
1017       if bad_pattern.search(line) and not good_pattern.search(line):
1018         errors.append('%s:%d' % (f.LocalPath(), linenum))
1019
1020   if errors:
1021     return [output_api.PresubmitError(
1022       'These lines create anonymous variables that need to be named:',
1023       items=errors)]
1024   return []
1025
1026
1027 def _CheckCygwinShell(input_api, output_api):
1028   source_file_filter = lambda x: input_api.FilterSourceFile(
1029       x, white_list=(r'.+\.(gyp|gypi)$',))
1030   cygwin_shell = []
1031
1032   for f in input_api.AffectedSourceFiles(source_file_filter):
1033     for linenum, line in f.ChangedContents():
1034       if 'msvs_cygwin_shell' in line:
1035         cygwin_shell.append(f.LocalPath())
1036         break
1037
1038   if cygwin_shell:
1039     return [output_api.PresubmitError(
1040       'These files should not use msvs_cygwin_shell (the default is 0):',
1041       items=cygwin_shell)]
1042   return []
1043
1044
1045 def _CheckUserActionUpdate(input_api, output_api):
1046   """Checks if any new user action has been added."""
1047   if any('actions.xml' == input_api.os_path.basename(f) for f in
1048          input_api.LocalPaths()):
1049     # If actions.xml is already included in the changelist, the PRESUBMIT
1050     # for actions.xml will do a more complete presubmit check.
1051     return []
1052
1053   file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm'))
1054   action_re = r'[^a-zA-Z]UserMetricsAction\("([^"]*)'
1055   current_actions = None
1056   for f in input_api.AffectedFiles(file_filter=file_filter):
1057     for line_num, line in f.ChangedContents():
1058       match = input_api.re.search(action_re, line)
1059       if match:
1060         # Loads contents in tools/metrics/actions/actions.xml to memory. It's
1061         # loaded only once.
1062         if not current_actions:
1063           with open('tools/metrics/actions/actions.xml') as actions_f:
1064             current_actions = actions_f.read()
1065         # Search for the matched user action name in |current_actions|.
1066         for action_name in match.groups():
1067           action = 'name="{0}"'.format(action_name)
1068           if action not in current_actions:
1069             return [output_api.PresubmitPromptWarning(
1070               'File %s line %d: %s is missing in '
1071               'tools/metrics/actions/actions.xml. Please run '
1072               'tools/metrics/actions/extract_actions.py to update.'
1073               % (f.LocalPath(), line_num, action_name))]
1074   return []
1075
1076
1077 def _GetJSONParseError(input_api, filename, eat_comments=True):
1078   try:
1079     contents = input_api.ReadFile(filename)
1080     if eat_comments:
1081       json_comment_eater = input_api.os_path.join(
1082           input_api.PresubmitLocalPath(),
1083           'tools', 'json_comment_eater', 'json_comment_eater.py')
1084       process = input_api.subprocess.Popen(
1085           [input_api.python_executable, json_comment_eater],
1086           stdin=input_api.subprocess.PIPE,
1087           stdout=input_api.subprocess.PIPE,
1088           universal_newlines=True)
1089       (contents, _) = process.communicate(input=contents)
1090
1091     input_api.json.loads(contents)
1092   except ValueError as e:
1093     return e
1094   return None
1095
1096
1097 def _GetIDLParseError(input_api, filename):
1098   try:
1099     contents = input_api.ReadFile(filename)
1100     idl_schema = input_api.os_path.join(
1101         input_api.PresubmitLocalPath(),
1102         'tools', 'json_schema_compiler', 'idl_schema.py')
1103     process = input_api.subprocess.Popen(
1104         [input_api.python_executable, idl_schema],
1105         stdin=input_api.subprocess.PIPE,
1106         stdout=input_api.subprocess.PIPE,
1107         stderr=input_api.subprocess.PIPE,
1108         universal_newlines=True)
1109     (_, error) = process.communicate(input=contents)
1110     return error or None
1111   except ValueError as e:
1112     return e
1113
1114
1115 def _CheckParseErrors(input_api, output_api):
1116   """Check that IDL and JSON files do not contain syntax errors."""
1117   actions = {
1118     '.idl': _GetIDLParseError,
1119     '.json': _GetJSONParseError,
1120   }
1121   # These paths contain test data and other known invalid JSON files.
1122   excluded_patterns = [
1123     r'test[\\\/]data[\\\/]',
1124     r'^components[\\\/]policy[\\\/]resources[\\\/]policy_templates\.json$',
1125   ]
1126   # Most JSON files are preprocessed and support comments, but these do not.
1127   json_no_comments_patterns = [
1128     r'^testing[\\\/]',
1129   ]
1130   # Only run IDL checker on files in these directories.
1131   idl_included_patterns = [
1132     r'^chrome[\\\/]common[\\\/]extensions[\\\/]api[\\\/]',
1133     r'^extensions[\\\/]common[\\\/]api[\\\/]',
1134   ]
1135
1136   def get_action(affected_file):
1137     filename = affected_file.LocalPath()
1138     return actions.get(input_api.os_path.splitext(filename)[1])
1139
1140   def MatchesFile(patterns, path):
1141     for pattern in patterns:
1142       if input_api.re.search(pattern, path):
1143         return True
1144     return False
1145
1146   def FilterFile(affected_file):
1147     action = get_action(affected_file)
1148     if not action:
1149       return False
1150     path = affected_file.LocalPath()
1151
1152     if MatchesFile(excluded_patterns, path):
1153       return False
1154
1155     if (action == _GetIDLParseError and
1156         not MatchesFile(idl_included_patterns, path)):
1157       return False
1158     return True
1159
1160   results = []
1161   for affected_file in input_api.AffectedFiles(
1162       file_filter=FilterFile, include_deletes=False):
1163     action = get_action(affected_file)
1164     kwargs = {}
1165     if (action == _GetJSONParseError and
1166         MatchesFile(json_no_comments_patterns, affected_file.LocalPath())):
1167       kwargs['eat_comments'] = False
1168     parse_error = action(input_api,
1169                          affected_file.AbsoluteLocalPath(),
1170                          **kwargs)
1171     if parse_error:
1172       results.append(output_api.PresubmitError('%s could not be parsed: %s' %
1173           (affected_file.LocalPath(), parse_error)))
1174   return results
1175
1176
1177 def _CheckJavaStyle(input_api, output_api):
1178   """Runs checkstyle on changed java files and returns errors if any exist."""
1179   original_sys_path = sys.path
1180   try:
1181     sys.path = sys.path + [input_api.os_path.join(
1182         input_api.PresubmitLocalPath(), 'tools', 'android', 'checkstyle')]
1183     import checkstyle
1184   finally:
1185     # Restore sys.path to what it was before.
1186     sys.path = original_sys_path
1187
1188   return checkstyle.RunCheckstyle(
1189       input_api, output_api, 'tools/android/checkstyle/chromium-style-5.0.xml')
1190
1191
1192 _DEPRECATED_CSS = [
1193   # Values
1194   ( "-webkit-box", "flex" ),
1195   ( "-webkit-inline-box", "inline-flex" ),
1196   ( "-webkit-flex", "flex" ),
1197   ( "-webkit-inline-flex", "inline-flex" ),
1198   ( "-webkit-min-content", "min-content" ),
1199   ( "-webkit-max-content", "max-content" ),
1200
1201   # Properties
1202   ( "-webkit-background-clip", "background-clip" ),
1203   ( "-webkit-background-origin", "background-origin" ),
1204   ( "-webkit-background-size", "background-size" ),
1205   ( "-webkit-box-shadow", "box-shadow" ),
1206
1207   # Functions
1208   ( "-webkit-gradient", "gradient" ),
1209   ( "-webkit-repeating-gradient", "repeating-gradient" ),
1210   ( "-webkit-linear-gradient", "linear-gradient" ),
1211   ( "-webkit-repeating-linear-gradient", "repeating-linear-gradient" ),
1212   ( "-webkit-radial-gradient", "radial-gradient" ),
1213   ( "-webkit-repeating-radial-gradient", "repeating-radial-gradient" ),
1214 ]
1215
1216 def _CheckNoDeprecatedCSS(input_api, output_api):
1217   """ Make sure that we don't use deprecated CSS
1218       properties, functions or values. Our external
1219       documentation is ignored by the hooks as it
1220       needs to be consumed by WebKit. """
1221   results = []
1222   file_inclusion_pattern = (r".+\.css$")
1223   black_list = (_EXCLUDED_PATHS +
1224                 _TEST_CODE_EXCLUDED_PATHS +
1225                 input_api.DEFAULT_BLACK_LIST +
1226                 (r"^chrome/common/extensions/docs",
1227                  r"^chrome/docs",
1228                  r"^native_client_sdk"))
1229   file_filter = lambda f: input_api.FilterSourceFile(
1230       f, white_list=file_inclusion_pattern, black_list=black_list)
1231   for fpath in input_api.AffectedFiles(file_filter=file_filter):
1232     for line_num, line in fpath.ChangedContents():
1233       for (deprecated_value, value) in _DEPRECATED_CSS:
1234         if input_api.re.search(deprecated_value, line):
1235           results.append(output_api.PresubmitError(
1236               "%s:%d: Use of deprecated CSS %s, use %s instead" %
1237               (fpath.LocalPath(), line_num, deprecated_value, value)))
1238   return results
1239
1240 def _CommonChecks(input_api, output_api):
1241   """Checks common to both upload and commit."""
1242   results = []
1243   results.extend(input_api.canned_checks.PanProjectChecks(
1244       input_api, output_api,
1245       excluded_paths=_EXCLUDED_PATHS + _TESTRUNNER_PATHS))
1246   results.extend(_CheckAuthorizedAuthor(input_api, output_api))
1247   results.extend(
1248       _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
1249   results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
1250   results.extend(_CheckNoUNIT_TESTInSourceFiles(input_api, output_api))
1251   results.extend(_CheckNoNewWStrings(input_api, output_api))
1252   results.extend(_CheckNoDEPSGIT(input_api, output_api))
1253   results.extend(_CheckNoBannedFunctions(input_api, output_api))
1254   results.extend(_CheckNoPragmaOnce(input_api, output_api))
1255   results.extend(_CheckNoTrinaryTrueFalse(input_api, output_api))
1256   results.extend(_CheckUnwantedDependencies(input_api, output_api))
1257   results.extend(_CheckFilePermissions(input_api, output_api))
1258   results.extend(_CheckNoAuraWindowPropertyHInHeaders(input_api, output_api))
1259   results.extend(_CheckIncludeOrder(input_api, output_api))
1260   results.extend(_CheckForVersionControlConflicts(input_api, output_api))
1261   results.extend(_CheckPatchFiles(input_api, output_api))
1262   results.extend(_CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api))
1263   results.extend(_CheckNoAbbreviationInPngFileName(input_api, output_api))
1264   results.extend(_CheckForInvalidOSMacros(input_api, output_api))
1265   results.extend(_CheckAddedDepsHaveTargetApprovals(input_api, output_api))
1266   results.extend(
1267       input_api.canned_checks.CheckChangeHasNoTabs(
1268           input_api,
1269           output_api,
1270           source_file_filter=lambda x: x.LocalPath().endswith('.grd')))
1271   results.extend(_CheckSpamLogging(input_api, output_api))
1272   results.extend(_CheckForAnonymousVariables(input_api, output_api))
1273   results.extend(_CheckCygwinShell(input_api, output_api))
1274   results.extend(_CheckUserActionUpdate(input_api, output_api))
1275   results.extend(_CheckNoDeprecatedCSS(input_api, output_api))
1276   results.extend(_CheckParseErrors(input_api, output_api))
1277
1278   if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
1279     results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
1280         input_api, output_api,
1281         input_api.PresubmitLocalPath(),
1282         whitelist=[r'^PRESUBMIT_test\.py$']))
1283   return results
1284
1285
1286 def _CheckAuthorizedAuthor(input_api, output_api):
1287   """For non-googler/chromites committers, verify the author's email address is
1288   in AUTHORS.
1289   """
1290   # TODO(maruel): Add it to input_api?
1291   import fnmatch
1292
1293   author = input_api.change.author_email
1294   if not author:
1295     input_api.logging.info('No author, skipping AUTHOR check')
1296     return []
1297   authors_path = input_api.os_path.join(
1298       input_api.PresubmitLocalPath(), 'AUTHORS')
1299   valid_authors = (
1300       input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
1301       for line in open(authors_path))
1302   valid_authors = [item.group(1).lower() for item in valid_authors if item]
1303   if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
1304     input_api.logging.info('Valid authors are %s', ', '.join(valid_authors))
1305     return [output_api.PresubmitPromptWarning(
1306         ('%s is not in AUTHORS file. If you are a new contributor, please visit'
1307         '\n'
1308         'http://www.chromium.org/developers/contributing-code and read the '
1309         '"Legal" section\n'
1310         'If you are a chromite, verify the contributor signed the CLA.') %
1311         author)]
1312   return []
1313
1314
1315 def _CheckPatchFiles(input_api, output_api):
1316   problems = [f.LocalPath() for f in input_api.AffectedFiles()
1317       if f.LocalPath().endswith(('.orig', '.rej'))]
1318   if problems:
1319     return [output_api.PresubmitError(
1320         "Don't commit .rej and .orig files.", problems)]
1321   else:
1322     return []
1323
1324
1325 def _DidYouMeanOSMacro(bad_macro):
1326   try:
1327     return {'A': 'OS_ANDROID',
1328             'B': 'OS_BSD',
1329             'C': 'OS_CHROMEOS',
1330             'F': 'OS_FREEBSD',
1331             'L': 'OS_LINUX',
1332             'M': 'OS_MACOSX',
1333             'N': 'OS_NACL',
1334             'O': 'OS_OPENBSD',
1335             'P': 'OS_POSIX',
1336             'S': 'OS_SOLARIS',
1337             'W': 'OS_WIN'}[bad_macro[3].upper()]
1338   except KeyError:
1339     return ''
1340
1341
1342 def _CheckForInvalidOSMacrosInFile(input_api, f):
1343   """Check for sensible looking, totally invalid OS macros."""
1344   preprocessor_statement = input_api.re.compile(r'^\s*#')
1345   os_macro = input_api.re.compile(r'defined\((OS_[^)]+)\)')
1346   results = []
1347   for lnum, line in f.ChangedContents():
1348     if preprocessor_statement.search(line):
1349       for match in os_macro.finditer(line):
1350         if not match.group(1) in _VALID_OS_MACROS:
1351           good = _DidYouMeanOSMacro(match.group(1))
1352           did_you_mean = ' (did you mean %s?)' % good if good else ''
1353           results.append('    %s:%d %s%s' % (f.LocalPath(),
1354                                              lnum,
1355                                              match.group(1),
1356                                              did_you_mean))
1357   return results
1358
1359
1360 def _CheckForInvalidOSMacros(input_api, output_api):
1361   """Check all affected files for invalid OS macros."""
1362   bad_macros = []
1363   for f in input_api.AffectedFiles():
1364     if not f.LocalPath().endswith(('.py', '.js', '.html', '.css')):
1365       bad_macros.extend(_CheckForInvalidOSMacrosInFile(input_api, f))
1366
1367   if not bad_macros:
1368     return []
1369
1370   return [output_api.PresubmitError(
1371       'Possibly invalid OS macro[s] found. Please fix your code\n'
1372       'or add your macro to src/PRESUBMIT.py.', bad_macros)]
1373
1374
1375 def CheckChangeOnUpload(input_api, output_api):
1376   results = []
1377   results.extend(_CommonChecks(input_api, output_api))
1378   results.extend(_CheckJavaStyle(input_api, output_api))
1379   return results
1380
1381
1382 def GetTryServerMasterForBot(bot):
1383   """Returns the Try Server master for the given bot.
1384
1385   It tries to guess the master from the bot name, but may still fail
1386   and return None.  There is no longer a default master.
1387   """
1388   # Potentially ambiguous bot names are listed explicitly.
1389   master_map = {
1390       'linux_gpu': 'tryserver.chromium.gpu',
1391       'mac_gpu': 'tryserver.chromium.gpu',
1392       'win_gpu': 'tryserver.chromium.gpu',
1393       'chromium_presubmit': 'tryserver.chromium.linux',
1394       'blink_presubmit': 'tryserver.chromium.linux',
1395       'tools_build_presubmit': 'tryserver.chromium.linux',
1396   }
1397   master = master_map.get(bot)
1398   if not master:
1399     if 'gpu' in bot:
1400       master = 'tryserver.chromium.gpu'
1401     elif 'linux' in bot or 'android' in bot or 'presubmit' in bot:
1402       master = 'tryserver.chromium.linux'
1403     elif 'win' in bot:
1404       master = 'tryserver.chromium.win'
1405     elif 'mac' in bot or 'ios' in bot:
1406       master = 'tryserver.chromium.mac'
1407   return master
1408
1409
1410 def GetDefaultTryConfigs(bots=None):
1411   """Returns a list of ('bot', set(['tests']), optionally filtered by [bots].
1412
1413   To add tests to this list, they MUST be in the the corresponding master's
1414   gatekeeper config. For example, anything on master.chromium would be closed by
1415   tools/build/masters/master.chromium/master_gatekeeper_cfg.py.
1416
1417   If 'bots' is specified, will only return configurations for bots in that list.
1418   """
1419
1420   standard_tests = [
1421       'base_unittests',
1422       'browser_tests',
1423       'cacheinvalidation_unittests',
1424       'check_deps',
1425       'check_deps2git',
1426       'content_browsertests',
1427       'content_unittests',
1428       'crypto_unittests',
1429       'gpu_unittests',
1430       'interactive_ui_tests',
1431       'ipc_tests',
1432       'jingle_unittests',
1433       'media_unittests',
1434       'net_unittests',
1435       'ppapi_unittests',
1436       'printing_unittests',
1437       'sql_unittests',
1438       'sync_unit_tests',
1439       'unit_tests',
1440       # Broken in release.
1441       #'url_unittests',
1442       #'webkit_unit_tests',
1443   ]
1444
1445   builders_and_tests = {
1446       # TODO(maruel): Figure out a way to run 'sizes' where people can
1447       # effectively update the perf expectation correctly.  This requires a
1448       # clobber=True build running 'sizes'. 'sizes' is not accurate with
1449       # incremental build. Reference:
1450       # http://chromium.org/developers/tree-sheriffs/perf-sheriffs.
1451       # TODO(maruel): An option would be to run 'sizes' but not count a failure
1452       # of this step as a try job failure.
1453       'android_aosp': ['compile'],
1454       'android_chromium_gn_compile_rel': ['compile'],
1455       'android_clang_dbg': ['slave_steps'],
1456       'android_dbg_tests_recipe': ['slave_steps'],
1457       'cros_x86': ['defaulttests'],
1458       'ios_dbg_simulator': [
1459           'compile',
1460           'base_unittests',
1461           'content_unittests',
1462           'crypto_unittests',
1463           'url_unittests',
1464           'net_unittests',
1465           'sql_unittests',
1466           'ui_unittests',
1467       ],
1468       'ios_rel_device': ['compile'],
1469       'linux_asan': ['compile'],
1470       'mac_asan': ['compile'],
1471       #TODO(stip): Change the name of this builder to reflect that it's release.
1472       'linux_gtk': standard_tests,
1473       'linux_chromeos_asan': ['compile'],
1474       'linux_chromium_chromeos_clang_dbg': ['defaulttests'],
1475       'linux_chromium_chromeos_rel_swarming': ['defaulttests'],
1476       'linux_chromium_compile_dbg': ['defaulttests'],
1477       'linux_chromium_gn_rel': ['defaulttests'],
1478       'linux_chromium_rel_swarming': ['defaulttests'],
1479       'linux_chromium_clang_dbg': ['defaulttests'],
1480       'linux_gpu': ['defaulttests'],
1481       'linux_nacl_sdk_build': ['compile'],
1482       'mac_chromium_compile_dbg': ['defaulttests'],
1483       'mac_chromium_rel_swarming': ['defaulttests'],
1484       'mac_gpu': ['defaulttests'],
1485       'mac_nacl_sdk_build': ['compile'],
1486       'win_chromium_compile_dbg': ['defaulttests'],
1487       'win_chromium_dbg': ['defaulttests'],
1488       'win_chromium_rel_swarming': ['defaulttests'],
1489       'win_chromium_x64_rel_swarming': ['defaulttests'],
1490       'win_gpu': ['defaulttests'],
1491       'win_nacl_sdk_build': ['compile'],
1492   }
1493
1494   if bots:
1495     filtered_builders_and_tests = dict((bot, set(builders_and_tests[bot]))
1496                                        for bot in bots)
1497   else:
1498     filtered_builders_and_tests = dict(
1499         (bot, set(tests))
1500         for bot, tests in builders_and_tests.iteritems())
1501
1502   # Build up the mapping from tryserver master to bot/test.
1503   out = dict()
1504   for bot, tests in filtered_builders_and_tests.iteritems():
1505     out.setdefault(GetTryServerMasterForBot(bot), {})[bot] = tests
1506   return out
1507
1508
1509 def CheckChangeOnCommit(input_api, output_api):
1510   results = []
1511   results.extend(_CommonChecks(input_api, output_api))
1512   # TODO(thestig) temporarily disabled, doesn't work in third_party/
1513   #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
1514   #    input_api, output_api, sources))
1515   # Make sure the tree is 'open'.
1516   results.extend(input_api.canned_checks.CheckTreeIsOpen(
1517       input_api,
1518       output_api,
1519       json_url='http://chromium-status.appspot.com/current?format=json'))
1520
1521   results.extend(input_api.canned_checks.CheckChangeHasBugField(
1522       input_api, output_api))
1523   results.extend(input_api.canned_checks.CheckChangeHasDescription(
1524       input_api, output_api))
1525   return results
1526
1527
1528 def GetPreferredTryMasters(project, change):
1529   files = change.LocalPaths()
1530
1531   if not files or all(re.search(r'[\\\/]OWNERS$', f) for f in files):
1532     return {}
1533
1534   if all(re.search(r'\.(m|mm)$|(^|[\\\/_])mac[\\\/_.]', f) for f in files):
1535     return GetDefaultTryConfigs([
1536         'mac_chromium_compile_dbg',
1537         'mac_chromium_rel_swarming',
1538     ])
1539   if all(re.search('(^|[/_])win[/_.]', f) for f in files):
1540     return GetDefaultTryConfigs([
1541         'win_chromium_dbg',
1542         'win_chromium_rel_swarming',
1543     ])
1544   if all(re.search(r'(^|[\\\/_])android[\\\/_.]', f) for f in files):
1545     return GetDefaultTryConfigs([
1546         'android_aosp',
1547         'android_clang_dbg',
1548         'android_dbg_tests_recipe',
1549     ])
1550   if all(re.search(r'[\\\/_]ios[\\\/_.]', f) for f in files):
1551     return GetDefaultTryConfigs(['ios_rel_device', 'ios_dbg_simulator'])
1552
1553   builders = [
1554       'android_chromium_gn_compile_rel',
1555       'android_clang_dbg',
1556       'android_dbg_tests_recipe',
1557       'ios_dbg_simulator',
1558       'ios_rel_device',
1559       'linux_chromium_chromeos_rel_swarming',
1560       'linux_chromium_clang_dbg',
1561       'linux_chromium_gn_rel',
1562       'linux_chromium_rel_swarming',
1563       'linux_gpu',
1564       'mac_chromium_compile_dbg',
1565       'mac_chromium_rel_swarming',
1566       'mac_gpu',
1567       'win_chromium_compile_dbg',
1568       'win_chromium_rel_swarming',
1569       'win_chromium_x64_rel_swarming',
1570       'win_gpu',
1571   ]
1572
1573   # Match things like path/aura/file.cc and path/file_aura.cc.
1574   # Same for chromeos.
1575   if any(re.search(r'[\\\/_](aura|chromeos)', f) for f in files):
1576     builders.extend([
1577         'linux_chromeos_asan',
1578         'linux_chromium_chromeos_clang_dbg'
1579     ])
1580
1581   # If there are gyp changes to base, build, or chromeos, run a full cros build
1582   # in addition to the shorter linux_chromeos build. Changes to high level gyp
1583   # files have a much higher chance of breaking the cros build, which is
1584   # differnt from the linux_chromeos build that most chrome developers test
1585   # with.
1586   if any(re.search('^(base|build|chromeos).*\.gypi?$', f) for f in files):
1587     builders.extend(['cros_x86'])
1588
1589   # The AOSP bot doesn't build the chrome/ layer, so ignore any changes to it
1590   # unless they're .gyp(i) files as changes to those files can break the gyp
1591   # step on that bot.
1592   if (not all(re.search('^chrome', f) for f in files) or
1593       any(re.search('\.gypi?$', f) for f in files)):
1594     builders.extend(['android_aosp'])
1595
1596   return GetDefaultTryConfigs(builders)