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 subprocess
  14 import sys
  15
  16
  17 _EXCLUDED_PATHS = (
  18     r"^breakpad[\\\/].*",
  19     r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_rules.py",
  20     r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_simple.py",
  21     r"^native_client_sdk[\\\/]src[\\\/]tools[\\\/].*.mk",
  22     r"^net[\\\/]tools[\\\/]spdyshark[\\\/].*",
  23     r"^skia[\\\/].*",
  24     r"^v8[\\\/].*",
  25     r".*MakeFile$",
  26     r".+_autogen\.h$",
  27     r".+[\\\/]pnacl_shim\.c$",
  28     r"^gpu[\\\/]config[\\\/].*_list_json\.cc$",
  29 )
  30
  31 # Fragment of a regular expression that matches C++ and Objective-C++
  32 # implementation files.
  33 _IMPLEMENTATION_EXTENSIONS = r'\.(cc|cpp|cxx|mm)$'
  34
  35 # Regular expression that matches code only used for test binaries
  36 # (best effort).
  37 _TEST_CODE_EXCLUDED_PATHS = (
  38     r'.*[/\\](fake_|test_|mock_).+%s' % _IMPLEMENTATION_EXTENSIONS,
  39     r'.+_test_(base|support|util)%s' % _IMPLEMENTATION_EXTENSIONS,
  40     r'.+_(api|browser|perf|pixel|unit|ui)?test(_[a-z]+)?%s' %
  41         _IMPLEMENTATION_EXTENSIONS,
  42     r'.+profile_sync_service_harness%s' % _IMPLEMENTATION_EXTENSIONS,
  43     r'.*[/\\](test|tool(s)?)[/\\].*',
  44     # content_shell is used for running layout tests.
  45     r'content[/\\]shell[/\\].*',
  46     # At request of folks maintaining this folder.
  47     r'chrome[/\\]browser[/\\]automation[/\\].*',
  48 )
  49
  50 _TEST_ONLY_WARNING = (
  51     'You might be calling functions intended only for testing from\n'
  52     'production code.  It is OK to ignore this warning if you know what\n'
  53     'you are doing, as the heuristics used to detect the situation are\n'
  54     'not perfect.  The commit queue will not block on this warning.\n'
  55     'Email joi@chromium.org if you have questions.')
  56
  57
  58 _INCLUDE_ORDER_WARNING = (
  59     'Your #include order seems to be broken. Send mail to\n'
  60     'marja@chromium.org if this is not the case.')
  61
  62
  63 _BANNED_OBJC_FUNCTIONS = (
  64     (
  65       'addTrackingRect:',
  66       (
  67        'The use of -[NSView addTrackingRect:owner:userData:assumeInside:] is'
  68        'prohibited. Please use CrTrackingArea instead.',
  69        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  70       ),
  71       False,
  72     ),
  73     (
  74       'NSTrackingArea',
  75       (
  76        'The use of NSTrackingAreas is prohibited. Please use CrTrackingArea',
  77        'instead.',
  78        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  79       ),
  80       False,
  81     ),
  82     (
  83       'convertPointFromBase:',
  84       (
  85        'The use of -[NSView convertPointFromBase:] is almost certainly wrong.',
  86        'Please use |convertPoint:(point) fromView:nil| instead.',
  87        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  88       ),
  89       True,
  90     ),
  91     (
  92       'convertPointToBase:',
  93       (
  94        'The use of -[NSView convertPointToBase:] is almost certainly wrong.',
  95        'Please use |convertPoint:(point) toView:nil| instead.',
  96        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
  97       ),
  98       True,
  99     ),
 100     (
 101       'convertRectFromBase:',
 102       (
 103        'The use of -[NSView convertRectFromBase:] is almost certainly wrong.',
 104        'Please use |convertRect:(point) fromView:nil| instead.',
 105        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 106       ),
 107       True,
 108     ),
 109     (
 110       'convertRectToBase:',
 111       (
 112        'The use of -[NSView convertRectToBase:] is almost certainly wrong.',
 113        'Please use |convertRect:(point) toView:nil| instead.',
 114        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 115       ),
 116       True,
 117     ),
 118     (
 119       'convertSizeFromBase:',
 120       (
 121        'The use of -[NSView convertSizeFromBase:] is almost certainly wrong.',
 122        'Please use |convertSize:(point) fromView:nil| instead.',
 123        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 124       ),
 125       True,
 126     ),
 127     (
 128       'convertSizeToBase:',
 129       (
 130        'The use of -[NSView convertSizeToBase:] is almost certainly wrong.',
 131        'Please use |convertSize:(point) toView:nil| instead.',
 132        'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
 133       ),
 134       True,
 135     ),
 136 )
 137
 138
 139 _BANNED_CPP_FUNCTIONS = (
 140     # Make sure that gtest's FRIEND_TEST() macro is not used; the
 141     # FRIEND_TEST_ALL_PREFIXES() macro from base/gtest_prod_util.h should be
 142     # used instead since that allows for FLAKY_ and DISABLED_ prefixes.
 143     (
 144       'FRIEND_TEST(',
 145       (
 146        'Chromium code should not use gtest\'s FRIEND_TEST() macro. Include',
 147        'base/gtest_prod_util.h and use FRIEND_TEST_ALL_PREFIXES() instead.',
 148       ),
 149       False,
 150       (),
 151     ),
 152     (
 153       'ScopedAllowIO',
 154       (
 155        'New code should not use ScopedAllowIO. Post a task to the blocking',
 156        'pool or the FILE thread instead.',
 157       ),
 158       True,
 159       (
 160         r"^components[\\\/]breakpad[\\\/]app[\\\/]breakpad_mac\.mm$",
 161         r"^content[\\\/]shell[\\\/]browser[\\\/]shell_browser_main\.cc$",
 162         r"^content[\\\/]shell[\\\/]browser[\\\/]shell_message_filter\.cc$",
 163         r"^net[\\\/]disk_cache[\\\/]cache_util\.cc$",
 164       ),
 165     ),
 166     (
 167       'SkRefPtr',
 168       (
 169         'The use of SkRefPtr is prohibited. ',
 170         'Please use skia::RefPtr instead.'
 171       ),
 172       True,
 173       (),
 174     ),
 175     (
 176       'SkAutoRef',
 177       (
 178         'The indirect use of SkRefPtr via SkAutoRef is prohibited. ',
 179         'Please use skia::RefPtr instead.'
 180       ),
 181       True,
 182       (),
 183     ),
 184     (
 185       'SkAutoTUnref',
 186       (
 187         'The use of SkAutoTUnref is dangerous because it implicitly ',
 188         'converts to a raw pointer. Please use skia::RefPtr instead.'
 189       ),
 190       True,
 191       (),
 192     ),
 193     (
 194       'SkAutoUnref',
 195       (
 196         'The indirect use of SkAutoTUnref through SkAutoUnref is dangerous ',
 197         'because it implicitly converts to a raw pointer. ',
 198         'Please use skia::RefPtr instead.'
 199       ),
 200       True,
 201       (),
 202     ),
 203 )
 204
 205
 206 _VALID_OS_MACROS = (
 207     # Please keep sorted.
 208     'OS_ANDROID',
 209     'OS_BSD',
 210     'OS_CAT',       # For testing.
 211     'OS_CHROMEOS',
 212     'OS_FREEBSD',
 213     'OS_IOS',
 214     'OS_LINUX',
 215     'OS_MACOSX',
 216     'OS_NACL',
 217     'OS_OPENBSD',
 218     'OS_POSIX',
 219     'OS_SOLARIS',
 220     'OS_WIN',
 221 )
 222
 223
 224 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
 225   """Attempts to prevent use of functions intended only for testing in
 226   non-testing code. For now this is just a best-effort implementation
 227   that ignores header files and may have some false positives. A
 228   better implementation would probably need a proper C++ parser.
 229   """
 230   # We only scan .cc files and the like, as the declaration of
 231   # for-testing functions in header files are hard to distinguish from
 232   # calls to such functions without a proper C++ parser.
 233   file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
 234
 235   base_function_pattern = r'ForTest(ing)?|for_test(ing)?'
 236   inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
 237   comment_pattern = input_api.re.compile(r'//.*%s' % base_function_pattern)
 238   exclusion_pattern = input_api.re.compile(
 239     r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
 240       base_function_pattern, base_function_pattern))
 241
 242   def FilterFile(affected_file):
 243     black_list = (_EXCLUDED_PATHS +
 244                   _TEST_CODE_EXCLUDED_PATHS +
 245                   input_api.DEFAULT_BLACK_LIST)
 246     return input_api.FilterSourceFile(
 247       affected_file,
 248       white_list=(file_inclusion_pattern, ),
 249       black_list=black_list)
 250
 251   problems = []
 252   for f in input_api.AffectedSourceFiles(FilterFile):
 253     local_path = f.LocalPath()
 254     lines = input_api.ReadFile(f).splitlines()
 255     line_number = 0
 256     for line in lines:
 257       if (inclusion_pattern.search(line) and
 258           not comment_pattern.search(line) and
 259           not exclusion_pattern.search(line)):
 260         problems.append(
 261           '%s:%d\n    %s' % (local_path, line_number, line.strip()))
 262       line_number += 1
 263
 264   if problems:
 265     return [output_api.PresubmitPromptOrNotify(_TEST_ONLY_WARNING, problems)]
 266   else:
 267     return []
 268
 269
 270 def _CheckNoIOStreamInHeaders(input_api, output_api):
 271   """Checks to make sure no .h files include <iostream>."""
 272   files = []
 273   pattern = input_api.re.compile(r'^#include\s*<iostream>',
 274                                  input_api.re.MULTILINE)
 275   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 276     if not f.LocalPath().endswith('.h'):
 277       continue
 278     contents = input_api.ReadFile(f)
 279     if pattern.search(contents):
 280       files.append(f)
 281
 282   if len(files):
 283     return [ output_api.PresubmitError(
 284         'Do not #include <iostream> in header files, since it inserts static '
 285         'initialization into every file including the header. Instead, '
 286         '#include <ostream>. See http://crbug.com/94794',
 287         files) ]
 288   return []
 289
 290
 291 def _CheckNoUNIT_TESTInSourceFiles(input_api, output_api):
 292   """Checks to make sure no source files use UNIT_TEST"""
 293   problems = []
 294   for f in input_api.AffectedFiles():
 295     if (not f.LocalPath().endswith(('.cc', '.mm'))):
 296       continue
 297
 298     for line_num, line in f.ChangedContents():
 299       if 'UNIT_TEST ' in line or line.endswith('UNIT_TEST'):
 300         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 301
 302   if not problems:
 303     return []
 304   return [output_api.PresubmitPromptWarning('UNIT_TEST is only for headers.\n' +
 305       '\n'.join(problems))]
 306
 307
 308 def _CheckNoNewWStrings(input_api, output_api):
 309   """Checks to make sure we don't introduce use of wstrings."""
 310   problems = []
 311   for f in input_api.AffectedFiles():
 312     if (not f.LocalPath().endswith(('.cc', '.h')) or
 313         f.LocalPath().endswith(('test.cc', '_win.cc', '_win.h'))):
 314       continue
 315
 316     allowWString = False
 317     for line_num, line in f.ChangedContents():
 318       if 'presubmit: allow wstring' in line:
 319         allowWString = True
 320       elif not allowWString and 'wstring' in line:
 321         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 322         allowWString = False
 323       else:
 324         allowWString = False
 325
 326   if not problems:
 327     return []
 328   return [output_api.PresubmitPromptWarning('New code should not use wstrings.'
 329       '  If you are calling a cross-platform API that accepts a wstring, '
 330       'fix the API.\n' +
 331       '\n'.join(problems))]
 332
 333
 334 def _CheckNoDEPSGIT(input_api, output_api):
 335   """Make sure .DEPS.git is never modified manually."""
 336   if any(f.LocalPath().endswith('.DEPS.git') for f in
 337       input_api.AffectedFiles()):
 338     return [output_api.PresubmitError(
 339       'Never commit changes to .DEPS.git. This file is maintained by an\n'
 340       'automated system based on what\'s in DEPS and your changes will be\n'
 341       'overwritten.\n'
 342       'See http://code.google.com/p/chromium/wiki/UsingNewGit#Rolling_DEPS\n'
 343       'for more information')]
 344   return []
 345
 346
 347 def _CheckNoBannedFunctions(input_api, output_api):
 348   """Make sure that banned functions are not used."""
 349   warnings = []
 350   errors = []
 351
 352   file_filter = lambda f: f.LocalPath().endswith(('.mm', '.m', '.h'))
 353   for f in input_api.AffectedFiles(file_filter=file_filter):
 354     for line_num, line in f.ChangedContents():
 355       for func_name, message, error in _BANNED_OBJC_FUNCTIONS:
 356         if func_name in line:
 357           problems = warnings;
 358           if error:
 359             problems = errors;
 360           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 361           for message_line in message:
 362             problems.append('      %s' % message_line)
 363
 364   file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm', '.h'))
 365   for f in input_api.AffectedFiles(file_filter=file_filter):
 366     for line_num, line in f.ChangedContents():
 367       for func_name, message, error, excluded_paths in _BANNED_CPP_FUNCTIONS:
 368         def IsBlacklisted(affected_file, blacklist):
 369           local_path = affected_file.LocalPath()
 370           for item in blacklist:
 371             if input_api.re.match(item, local_path):
 372               return True
 373           return False
 374         if IsBlacklisted(f, excluded_paths):
 375           continue
 376         if func_name in line:
 377           problems = warnings;
 378           if error:
 379             problems = errors;
 380           problems.append('    %s:%d:' % (f.LocalPath(), line_num))
 381           for message_line in message:
 382             problems.append('      %s' % message_line)
 383
 384   result = []
 385   if (warnings):
 386     result.append(output_api.PresubmitPromptWarning(
 387         'Banned functions were used.\n' + '\n'.join(warnings)))
 388   if (errors):
 389     result.append(output_api.PresubmitError(
 390         'Banned functions were used.\n' + '\n'.join(errors)))
 391   return result
 392
 393
 394 def _CheckNoPragmaOnce(input_api, output_api):
 395   """Make sure that banned functions are not used."""
 396   files = []
 397   pattern = input_api.re.compile(r'^#pragma\s+once',
 398                                  input_api.re.MULTILINE)
 399   for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
 400     if not f.LocalPath().endswith('.h'):
 401       continue
 402     contents = input_api.ReadFile(f)
 403     if pattern.search(contents):
 404       files.append(f)
 405
 406   if files:
 407     return [output_api.PresubmitError(
 408         'Do not use #pragma once in header files.\n'
 409         'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
 410         files)]
 411   return []
 412
 413
 414 def _CheckNoTrinaryTrueFalse(input_api, output_api):
 415   """Checks to make sure we don't introduce use of foo ? true : false."""
 416   problems = []
 417   pattern = input_api.re.compile(r'\?\s*(true|false)\s*:\s*(true|false)')
 418   for f in input_api.AffectedFiles():
 419     if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
 420       continue
 421
 422     for line_num, line in f.ChangedContents():
 423       if pattern.match(line):
 424         problems.append('    %s:%d' % (f.LocalPath(), line_num))
 425
 426   if not problems:
 427     return []
 428   return [output_api.PresubmitPromptWarning(
 429       'Please consider avoiding the "? true : false" pattern if possible.\n' +
 430       '\n'.join(problems))]
 431
 432
 433 def _CheckUnwantedDependencies(input_api, output_api):
 434   """Runs checkdeps on #include statements added in this
 435   change. Breaking - rules is an error, breaking ! rules is a
 436   warning.
 437   """
 438   # We need to wait until we have an input_api object and use this
 439   # roundabout construct to import checkdeps because this file is
 440   # eval-ed and thus doesn't have __file__.
 441   original_sys_path = sys.path
 442   try:
 443     sys.path = sys.path + [input_api.os_path.join(
 444         input_api.PresubmitLocalPath(), 'tools', 'checkdeps')]
 445     import checkdeps
 446     from cpp_checker import CppChecker
 447     from rules import Rule
 448   finally:
 449     # Restore sys.path to what it was before.
 450     sys.path = original_sys_path
 451
 452   added_includes = []
 453   for f in input_api.AffectedFiles():
 454     if not CppChecker.IsCppFile(f.LocalPath()):
 455       continue
 456
 457     changed_lines = [line for line_num, line in f.ChangedContents()]
 458     added_includes.append([f.LocalPath(), changed_lines])
 459
 460   deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath())
 461
 462   error_descriptions = []
 463   warning_descriptions = []
 464   for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
 465       added_includes):
 466     description_with_path = '%s\n    %s' % (path, rule_description)
 467     if rule_type == Rule.DISALLOW:
 468       error_descriptions.append(description_with_path)
 469     else:
 470       warning_descriptions.append(description_with_path)
 471
 472   results = []
 473   if error_descriptions:
 474     results.append(output_api.PresubmitError(
 475         'You added one or more #includes that violate checkdeps rules.',
 476         error_descriptions))
 477   if warning_descriptions:
 478     results.append(output_api.PresubmitPromptOrNotify(
 479         'You added one or more #includes of files that are temporarily\n'
 480         'allowed but being removed. Can you avoid introducing the\n'
 481         '#include? See relevant DEPS file(s) for details and contacts.',
 482         warning_descriptions))
 483   return results
 484
 485
 486 def _CheckFilePermissions(input_api, output_api):
 487   """Check that all files have their permissions properly set."""
 488   args = [sys.executable, 'tools/checkperms/checkperms.py', '--root',
 489           input_api.change.RepositoryRoot()]
 490   for f in input_api.AffectedFiles():
 491     args += ['--file', f.LocalPath()]
 492   errors = []
 493   (errors, stderrdata) = subprocess.Popen(args).communicate()
 494
 495   results = []
 496   if errors:
 497     results.append(output_api.PresubmitError('checkperms.py failed.',
 498                                              errors))
 499   return results
 500
 501
 502 def _CheckNoAuraWindowPropertyHInHeaders(input_api, output_api):
 503   """Makes sure we don't include ui/aura/window_property.h
 504   in header files.
 505   """
 506   pattern = input_api.re.compile(r'^#include\s*"ui/aura/window_property.h"')
 507   errors = []
 508   for f in input_api.AffectedFiles():
 509     if not f.LocalPath().endswith('.h'):
 510       continue
 511     for line_num, line in f.ChangedContents():
 512       if pattern.match(line):
 513         errors.append('    %s:%d' % (f.LocalPath(), line_num))
 514
 515   results = []
 516   if errors:
 517     results.append(output_api.PresubmitError(
 518       'Header files should not include ui/aura/window_property.h', errors))
 519   return results
 520
 521
 522 def _CheckIncludeOrderForScope(scope, input_api, file_path, changed_linenums):
 523   """Checks that the lines in scope occur in the right order.
 524
 525   1. C system files in alphabetical order
 526   2. C++ system files in alphabetical order
 527   3. Project's .h files
 528   """
 529
 530   c_system_include_pattern = input_api.re.compile(r'\s*#include <.*\.h>')
 531   cpp_system_include_pattern = input_api.re.compile(r'\s*#include <.*>')
 532   custom_include_pattern = input_api.re.compile(r'\s*#include ".*')
 533
 534   C_SYSTEM_INCLUDES, CPP_SYSTEM_INCLUDES, CUSTOM_INCLUDES = range(3)
 535
 536   state = C_SYSTEM_INCLUDES
 537
 538   previous_line = ''
 539   previous_line_num = 0
 540   problem_linenums = []
 541   for line_num, line in scope:
 542     if c_system_include_pattern.match(line):
 543       if state != C_SYSTEM_INCLUDES:
 544         problem_linenums.append((line_num, previous_line_num))
 545       elif previous_line and previous_line > line:
 546         problem_linenums.append((line_num, previous_line_num))
 547     elif cpp_system_include_pattern.match(line):
 548       if state == C_SYSTEM_INCLUDES:
 549         state = CPP_SYSTEM_INCLUDES
 550       elif state == CUSTOM_INCLUDES:
 551         problem_linenums.append((line_num, previous_line_num))
 552       elif previous_line and previous_line > line:
 553         problem_linenums.append((line_num, previous_line_num))
 554     elif custom_include_pattern.match(line):
 555       if state != CUSTOM_INCLUDES:
 556         state = CUSTOM_INCLUDES
 557       elif previous_line and previous_line > line:
 558         problem_linenums.append((line_num, previous_line_num))
 559     else:
 560       problem_linenums.append(line_num)
 561     previous_line = line
 562     previous_line_num = line_num
 563
 564   warnings = []
 565   for (line_num, previous_line_num) in problem_linenums:
 566     if line_num in changed_linenums or previous_line_num in changed_linenums:
 567       warnings.append('    %s:%d' % (file_path, line_num))
 568   return warnings
 569
 570
 571 def _CheckIncludeOrderInFile(input_api, f, changed_linenums):
 572   """Checks the #include order for the given file f."""
 573
 574   system_include_pattern = input_api.re.compile(r'\s*#include \<.*')
 575   # Exclude the following includes from the check:
 576   # 1) #include <.../...>, e.g., <sys/...> includes often need to appear in a
 577   # specific order.
 578   # 2) <atlbase.h>, "build/build_config.h"
 579   excluded_include_pattern = input_api.re.compile(
 580       r'\s*#include (\<.*/.*|\<atlbase\.h\>|"build/build_config.h")')
 581   custom_include_pattern = input_api.re.compile(r'\s*#include "(?P<FILE>.*)"')
 582   # Match the final or penultimate token if it is xxxtest so we can ignore it
 583   # when considering the special first include.
 584   test_file_tag_pattern = input_api.re.compile(
 585     r'_[a-z]+test(?=(_[a-zA-Z0-9]+)?\.)')
 586   if_pattern = input_api.re.compile(
 587       r'\s*#\s*(if|elif|else|endif|define|undef).*')
 588   # Some files need specialized order of includes; exclude such files from this
 589   # check.
 590   uncheckable_includes_pattern = input_api.re.compile(
 591       r'\s*#include '
 592       '("ipc/.*macros\.h"|<windows\.h>|".*gl.*autogen.h")\s*')
 593
 594   contents = f.NewContents()
 595   warnings = []
 596   line_num = 0
 597
 598   # Handle the special first include. If the first include file is
 599   # some/path/file.h, the corresponding including file can be some/path/file.cc,
 600   # some/other/path/file.cc, some/path/file_platform.cc, some/path/file-suffix.h
 601   # etc. It's also possible that no special first include exists.
 602   # If the included file is some/path/file_platform.h the including file could
 603   # also be some/path/file_xxxtest_platform.h.
 604   including_file_base_name = test_file_tag_pattern.sub(
 605     '', input_api.os_path.basename(f.LocalPath()))
 606
 607   for line in contents:
 608     line_num += 1
 609     if system_include_pattern.match(line):
 610       # No special first include -> process the line again along with normal
 611       # includes.
 612       line_num -= 1
 613       break
 614     match = custom_include_pattern.match(line)
 615     if match:
 616       match_dict = match.groupdict()
 617       header_basename = test_file_tag_pattern.sub(
 618         '', input_api.os_path.basename(match_dict['FILE'])).replace('.h', '')
 619
 620       if header_basename not in including_file_base_name:
 621         # No special first include -> process the line again along with normal
 622         # includes.
 623         line_num -= 1
 624       break
 625
 626   # Split into scopes: Each region between #if and #endif is its own scope.
 627   scopes = []
 628   current_scope = []
 629   for line in contents[line_num:]:
 630     line_num += 1
 631     if uncheckable_includes_pattern.match(line):
 632       return []
 633     if if_pattern.match(line):
 634       scopes.append(current_scope)
 635       current_scope = []
 636     elif ((system_include_pattern.match(line) or
 637            custom_include_pattern.match(line)) and
 638           not excluded_include_pattern.match(line)):
 639       current_scope.append((line_num, line))
 640   scopes.append(current_scope)
 641
 642   for scope in scopes:
 643     warnings.extend(_CheckIncludeOrderForScope(scope, input_api, f.LocalPath(),
 644                                                changed_linenums))
 645   return warnings
 646
 647
 648 def _CheckIncludeOrder(input_api, output_api):
 649   """Checks that the #include order is correct.
 650
 651   1. The corresponding header for source files.
 652   2. C system files in alphabetical order
 653   3. C++ system files in alphabetical order
 654   4. Project's .h files in alphabetical order
 655
 656   Each region separated by #if, #elif, #else, #endif, #define and #undef follows
 657   these rules separately.
 658   """
 659
 660   warnings = []
 661   for f in input_api.AffectedFiles():
 662     if f.LocalPath().endswith(('.cc', '.h')):
 663       changed_linenums = set(line_num for line_num, _ in f.ChangedContents())
 664       warnings.extend(_CheckIncludeOrderInFile(input_api, f, changed_linenums))
 665
 666   results = []
 667   if warnings:
 668     results.append(output_api.PresubmitPromptOrNotify(_INCLUDE_ORDER_WARNING,
 669                                                       warnings))
 670   return results
 671
 672
 673 def _CheckForVersionControlConflictsInFile(input_api, f):
 674   pattern = input_api.re.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
 675   errors = []
 676   for line_num, line in f.ChangedContents():
 677     if pattern.match(line):
 678       errors.append('    %s:%d %s' % (f.LocalPath(), line_num, line))
 679   return errors
 680
 681
 682 def _CheckForVersionControlConflicts(input_api, output_api):
 683   """Usually this is not intentional and will cause a compile failure."""
 684   errors = []
 685   for f in input_api.AffectedFiles():
 686     errors.extend(_CheckForVersionControlConflictsInFile(input_api, f))
 687
 688   results = []
 689   if errors:
 690     results.append(output_api.PresubmitError(
 691       'Version control conflict markers found, please resolve.', errors))
 692   return results
 693
 694
 695 def _CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api):
 696   def FilterFile(affected_file):
 697     """Filter function for use with input_api.AffectedSourceFiles,
 698     below.  This filters out everything except non-test files from
 699     top-level directories that generally speaking should not hard-code
 700     service URLs (e.g. src/android_webview/, src/content/ and others).
 701     """
 702     return input_api.FilterSourceFile(
 703       affected_file,
 704       white_list=(r'^(android_webview|base|content|net)[\\\/].*', ),
 705       black_list=(_EXCLUDED_PATHS +
 706                   _TEST_CODE_EXCLUDED_PATHS +
 707                   input_api.DEFAULT_BLACK_LIST))
 708
 709   base_pattern = '"[^"]*google\.com[^"]*"'
 710   comment_pattern = input_api.re.compile('//.*%s' % base_pattern)
 711   pattern = input_api.re.compile(base_pattern)
 712   problems = []  # items are (filename, line_number, line)
 713   for f in input_api.AffectedSourceFiles(FilterFile):
 714     for line_num, line in f.ChangedContents():
 715       if not comment_pattern.search(line) and pattern.search(line):
 716         problems.append((f.LocalPath(), line_num, line))
 717
 718   if problems:
 719     return [output_api.PresubmitPromptOrNotify(
 720         'Most layers below src/chrome/ should not hardcode service URLs.\n'
 721         'Are you sure this is correct? (Contact: joi@chromium.org)',
 722         ['  %s:%d:  %s' % (
 723             problem[0], problem[1], problem[2]) for problem in problems])]
 724   else:
 725     return []
 726
 727
 728 def _CheckNoAbbreviationInPngFileName(input_api, output_api):
 729   """Makes sure there are no abbreviations in the name of PNG files.
 730   """
 731   pattern = input_api.re.compile(r'.*_[a-z]_.*\.png$|.*_[a-z]\.png$')
 732   errors = []
 733   for f in input_api.AffectedFiles(include_deletes=False):
 734     if pattern.match(f.LocalPath()):
 735       errors.append('    %s' % f.LocalPath())
 736
 737   results = []
 738   if errors:
 739     results.append(output_api.PresubmitError(
 740         'The name of PNG files should not have abbreviations. \n'
 741         'Use _hover.png, _center.png, instead of _h.png, _c.png.\n'
 742         'Contact oshima@chromium.org if you have questions.', errors))
 743   return results
 744
 745
 746 def _DepsFilesToCheck(re, changed_lines):
 747   """Helper method for _CheckAddedDepsHaveTargetApprovals. Returns
 748   a set of DEPS entries that we should look up."""
 749   # We ignore deps entries on auto-generated directories.
 750   AUTO_GENERATED_DIRS = ['grit', 'jni']
 751
 752   # This pattern grabs the path without basename in the first
 753   # parentheses, and the basename (if present) in the second. It
 754   # relies on the simple heuristic that if there is a basename it will
 755   # be a header file ending in ".h".
 756   pattern = re.compile(
 757       r"""['"]\+([^'"]+?)(/[a-zA-Z0-9_]+\.h)?['"].*""")
 758   results = set()
 759   for changed_line in changed_lines:
 760     m = pattern.match(changed_line)
 761     if m:
 762       path = m.group(1)
 763       if path.split('/')[0] not in AUTO_GENERATED_DIRS:
 764         results.add('%s/DEPS' % m.group(1))
 765   return results
 766
 767
 768 def _CheckAddedDepsHaveTargetApprovals(input_api, output_api):
 769   """When a dependency prefixed with + is added to a DEPS file, we
 770   want to make sure that the change is reviewed by an OWNER of the
 771   target file or directory, to avoid layering violations from being
 772   introduced. This check verifies that this happens.
 773   """
 774   changed_lines = set()
 775   for f in input_api.AffectedFiles():
 776     filename = input_api.os_path.basename(f.LocalPath())
 777     if filename == 'DEPS':
 778       changed_lines |= set(line.strip()
 779                            for line_num, line
 780                            in f.ChangedContents())
 781   if not changed_lines:
 782     return []
 783
 784   virtual_depended_on_files = _DepsFilesToCheck(input_api.re, changed_lines)
 785   if not virtual_depended_on_files:
 786     return []
 787
 788   if input_api.is_committing:
 789     if input_api.tbr:
 790       return [output_api.PresubmitNotifyResult(
 791           '--tbr was specified, skipping OWNERS check for DEPS additions')]
 792     if not input_api.change.issue:
 793       return [output_api.PresubmitError(
 794           "DEPS approval by OWNERS check failed: this change has "
 795           "no Rietveld issue number, so we can't check it for approvals.")]
 796     output = output_api.PresubmitError
 797   else:
 798     output = output_api.PresubmitNotifyResult
 799
 800   owners_db = input_api.owners_db
 801   owner_email, reviewers = input_api.canned_checks._RietveldOwnerAndReviewers(
 802       input_api,
 803       owners_db.email_regexp,
 804       approval_needed=input_api.is_committing)
 805
 806   owner_email = owner_email or input_api.change.author_email
 807
 808   reviewers_plus_owner = set(reviewers)
 809   if owner_email:
 810     reviewers_plus_owner.add(owner_email)
 811   missing_files = owners_db.files_not_covered_by(virtual_depended_on_files,
 812                                                  reviewers_plus_owner)
 813   unapproved_dependencies = ["'+%s'," % path[:-len('/DEPS')]
 814                              for path in missing_files]
 815
 816   if unapproved_dependencies:
 817     output_list = [
 818       output('Missing LGTM from OWNERS of directories added to DEPS:\n    %s' %
 819              '\n    '.join(sorted(unapproved_dependencies)))]
 820     if not input_api.is_committing:
 821       suggested_owners = owners_db.reviewers_for(missing_files, owner_email)
 822       output_list.append(output(
 823           'Suggested missing target path OWNERS:\n    %s' %
 824           '\n    '.join(suggested_owners or [])))
 825     return output_list
 826
 827   return []
 828
 829
 830 def _CommonChecks(input_api, output_api):
 831   """Checks common to both upload and commit."""
 832   results = []
 833   results.extend(input_api.canned_checks.PanProjectChecks(
 834       input_api, output_api, excluded_paths=_EXCLUDED_PATHS))
 835   results.extend(_CheckAuthorizedAuthor(input_api, output_api))
 836   results.extend(
 837     _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
 838   results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
 839   results.extend(_CheckNoUNIT_TESTInSourceFiles(input_api, output_api))
 840   results.extend(_CheckNoNewWStrings(input_api, output_api))
 841   results.extend(_CheckNoDEPSGIT(input_api, output_api))
 842   results.extend(_CheckNoBannedFunctions(input_api, output_api))
 843   results.extend(_CheckNoPragmaOnce(input_api, output_api))
 844   results.extend(_CheckNoTrinaryTrueFalse(input_api, output_api))
 845   results.extend(_CheckUnwantedDependencies(input_api, output_api))
 846   results.extend(_CheckFilePermissions(input_api, output_api))
 847   results.extend(_CheckNoAuraWindowPropertyHInHeaders(input_api, output_api))
 848   results.extend(_CheckIncludeOrder(input_api, output_api))
 849   results.extend(_CheckForVersionControlConflicts(input_api, output_api))
 850   results.extend(_CheckPatchFiles(input_api, output_api))
 851   results.extend(_CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api))
 852   results.extend(_CheckNoAbbreviationInPngFileName(input_api, output_api))
 853   results.extend(_CheckForInvalidOSMacros(input_api, output_api))
 854   results.extend(_CheckAddedDepsHaveTargetApprovals(input_api, output_api))
 855   results.extend(
 856       input_api.canned_checks.CheckChangeHasNoTabs(
 857           input_api,
 858           output_api,
 859           source_file_filter=lambda x: x.LocalPath().endswith('.grd')))
 860
 861   if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
 862     results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
 863         input_api, output_api,
 864         input_api.PresubmitLocalPath(),
 865         whitelist=[r'^PRESUBMIT_test\.py$']))
 866   return results
 867
 868
 869 def _CheckSubversionConfig(input_api, output_api):
 870   """Verifies the subversion config file is correctly setup.
 871
 872   Checks that autoprops are enabled, returns an error otherwise.
 873   """
 874   join = input_api.os_path.join
 875   if input_api.platform == 'win32':
 876     appdata = input_api.environ.get('APPDATA', '')
 877     if not appdata:
 878       return [output_api.PresubmitError('%APPDATA% is not configured.')]
 879     path = join(appdata, 'Subversion', 'config')
 880   else:
 881     home = input_api.environ.get('HOME', '')
 882     if not home:
 883       return [output_api.PresubmitError('$HOME is not configured.')]
 884     path = join(home, '.subversion', 'config')
 885
 886   error_msg = (
 887       'Please look at http://dev.chromium.org/developers/coding-style to\n'
 888       'configure your subversion configuration file. This enables automatic\n'
 889       'properties to simplify the project maintenance.\n'
 890       'Pro-tip: just download and install\n'
 891       'http://src.chromium.org/viewvc/chrome/trunk/tools/build/slave/config\n')
 892
 893   try:
 894     lines = open(path, 'r').read().splitlines()
 895     # Make sure auto-props is enabled and check for 2 Chromium standard
 896     # auto-prop.
 897     if (not '*.cc = svn:eol-style=LF' in lines or
 898         not '*.pdf = svn:mime-type=application/pdf' in lines or
 899         not 'enable-auto-props = yes' in lines):
 900       return [
 901           output_api.PresubmitNotifyResult(
 902               'It looks like you have not configured your subversion config '
 903               'file or it is not up-to-date.\n' + error_msg)
 904       ]
 905   except (OSError, IOError):
 906     return [
 907         output_api.PresubmitNotifyResult(
 908             'Can\'t find your subversion config file.\n' + error_msg)
 909     ]
 910   return []
 911
 912
 913 def _CheckAuthorizedAuthor(input_api, output_api):
 914   """For non-googler/chromites committers, verify the author's email address is
 915   in AUTHORS.
 916   """
 917   # TODO(maruel): Add it to input_api?
 918   import fnmatch
 919
 920   author = input_api.change.author_email
 921   if not author:
 922     input_api.logging.info('No author, skipping AUTHOR check')
 923     return []
 924   authors_path = input_api.os_path.join(
 925       input_api.PresubmitLocalPath(), 'AUTHORS')
 926   valid_authors = (
 927       input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
 928       for line in open(authors_path))
 929   valid_authors = [item.group(1).lower() for item in valid_authors if item]
 930   if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
 931     input_api.logging.info('Valid authors are %s', ', '.join(valid_authors))
 932     return [output_api.PresubmitPromptWarning(
 933         ('%s is not in AUTHORS file. If you are a new contributor, please visit'
 934         '\n'
 935         'http://www.chromium.org/developers/contributing-code and read the '
 936         '"Legal" section\n'
 937         'If you are a chromite, verify the contributor signed the CLA.') %
 938         author)]
 939   return []
 940
 941
 942 def _CheckPatchFiles(input_api, output_api):
 943   problems = [f.LocalPath() for f in input_api.AffectedFiles()
 944       if f.LocalPath().endswith(('.orig', '.rej'))]
 945   if problems:
 946     return [output_api.PresubmitError(
 947         "Don't commit .rej and .orig files.", problems)]
 948   else:
 949     return []
 950
 951
 952 def _DidYouMeanOSMacro(bad_macro):
 953   try:
 954     return {'A': 'OS_ANDROID',
 955             'B': 'OS_BSD',
 956             'C': 'OS_CHROMEOS',
 957             'F': 'OS_FREEBSD',
 958             'L': 'OS_LINUX',
 959             'M': 'OS_MACOSX',
 960             'N': 'OS_NACL',
 961             'O': 'OS_OPENBSD',
 962             'P': 'OS_POSIX',
 963             'S': 'OS_SOLARIS',
 964             'W': 'OS_WIN'}[bad_macro[3].upper()]
 965   except KeyError:
 966     return ''
 967
 968
 969 def _CheckForInvalidOSMacrosInFile(input_api, f):
 970   """Check for sensible looking, totally invalid OS macros."""
 971   preprocessor_statement = input_api.re.compile(r'^\s*#')
 972   os_macro = input_api.re.compile(r'defined\((OS_[^)]+)\)')
 973   results = []
 974   for lnum, line in f.ChangedContents():
 975     if preprocessor_statement.search(line):
 976       for match in os_macro.finditer(line):
 977         if not match.group(1) in _VALID_OS_MACROS:
 978           good = _DidYouMeanOSMacro(match.group(1))
 979           did_you_mean = ' (did you mean %s?)' % good if good else ''
 980           results.append('    %s:%d %s%s' % (f.LocalPath(),
 981                                              lnum,
 982                                              match.group(1),
 983                                              did_you_mean))
 984   return results
 985
 986
 987 def _CheckForInvalidOSMacros(input_api, output_api):
 988   """Check all affected files for invalid OS macros."""
 989   bad_macros = []
 990   for f in input_api.AffectedFiles():
 991     if not f.LocalPath().endswith(('.py', '.js', '.html', '.css')):
 992       bad_macros.extend(_CheckForInvalidOSMacrosInFile(input_api, f))
 993
 994   if not bad_macros:
 995     return []
 996
 997   return [output_api.PresubmitError(
 998       'Possibly invalid OS macro[s] found. Please fix your code\n'
 999       'or add your macro to src/PRESUBMIT.py.', bad_macros)]
1000
1001
1002 def CheckChangeOnUpload(input_api, output_api):
1003   results = []
1004   results.extend(_CommonChecks(input_api, output_api))
1005   return results
1006
1007
1008 def CheckChangeOnCommit(input_api, output_api):
1009   results = []
1010   results.extend(_CommonChecks(input_api, output_api))
1011   # TODO(thestig) temporarily disabled, doesn't work in third_party/
1012   #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
1013   #    input_api, output_api, sources))
1014   # Make sure the tree is 'open'.
1015   results.extend(input_api.canned_checks.CheckTreeIsOpen(
1016       input_api,
1017       output_api,
1018       json_url='http://chromium-status.appspot.com/current?format=json'))
1019   results.extend(input_api.canned_checks.CheckRietveldTryJobExecution(input_api,
1020       output_api, 'http://codereview.chromium.org',
1021       ('win_rel', 'linux_rel', 'mac_rel, win:compile'),
1022       'tryserver@chromium.org'))
1023
1024   results.extend(input_api.canned_checks.CheckChangeHasBugField(
1025       input_api, output_api))
1026   results.extend(input_api.canned_checks.CheckChangeHasDescription(
1027       input_api, output_api))
1028   results.extend(_CheckSubversionConfig(input_api, output_api))
1029   return results
1030
1031
1032 def GetPreferredTrySlaves(project, change):
1033   files = change.LocalPaths()
1034
1035   if not files or all(re.search(r'[\\/]OWNERS$', f) for f in files):
1036     return []
1037
1038   if all(re.search('\.(m|mm)$|(^|[/_])mac[/_.]', f) for f in files):
1039     return ['mac_rel', 'mac:compile']
1040   if all(re.search('(^|[/_])win[/_.]', f) for f in files):
1041     return ['win_rel', 'win:compile']
1042   if all(re.search('(^|[/_])android[/_.]', f) for f in files):
1043     return ['android_aosp', 'android_dbg', 'android_clang_dbg']
1044   if all(re.search('^native_client_sdk', f) for f in files):
1045     return ['linux_nacl_sdk', 'win_nacl_sdk', 'mac_nacl_sdk']
1046   if all(re.search('[/_]ios[/_.]', f) for f in files):
1047     return ['ios_rel_device', 'ios_dbg_simulator']
1048
1049   trybots = [
1050       'android_clang_dbg',
1051       'android_dbg',
1052       'ios_dbg_simulator',
1053       'ios_rel_device',
1054       'linux_asan',
1055       'linux_aura',
1056       'linux_chromeos',
1057       'linux_clang:compile',
1058       'linux_rel',
1059       'mac_rel',
1060       'mac:compile',
1061       'win_rel',
1062       'win:compile',
1063       'win_x64_rel:base_unittests',
1064   ]
1065
1066   # Match things like path/aura/file.cc and path/file_aura.cc.
1067   # Same for chromeos.
1068   if any(re.search('[/_](aura|chromeos)', f) for f in files):
1069     trybots += ['linux_chromeos_clang:compile', 'linux_chromeos_asan']
1070
1071   # If there are gyp changes to base, build, or chromeos, run a full cros build
1072   # in addition to the shorter linux_chromeos build. Changes to high level gyp
1073   # files have a much higher chance of breaking the cros build, which is
1074   # differnt from the linux_chromeos build that most chrome developers test
1075   # with.
1076   if any(re.search('^(base|build|chromeos).*\.gypi?$', f) for f in files):
1077     trybots += ['cros_x86']
1078
1079   # The AOSP bot doesn't build the chrome/ layer, so ignore any changes to it
1080   # unless they're .gyp(i) files as changes to those files can break the gyp
1081   # step on that bot.
1082   if (not all(re.search('^chrome', f) for f in files) or
1083       any(re.search('\.gypi?$', f) for f in files)):
1084     trybots += ['android_aosp']
1085
1086   return trybots