OffsetY() is only used by InfoBarView. Move it there.
[chromium-blink-merge.git] / PRESUBMIT.py
blob2a96a9b3b986766ab658ea7453bc5b01ace60100
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.
5 """Top-level presubmit script for Chromium.
7 See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
8 for more details about the presubmit API built into gcl.
9 """
12 import re
13 import subprocess
14 import sys
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$",
31 # Fragment of a regular expression that matches C++ and Objective-C++
32 # implementation files.
33 _IMPLEMENTATION_EXTENSIONS = r'\.(cc|cpp|cxx|mm)$'
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 # Non-production example code.
49 r'mojo[/\\]examples[/\\].*',
52 _TEST_ONLY_WARNING = (
53 'You might be calling functions intended only for testing from\n'
54 'production code. It is OK to ignore this warning if you know what\n'
55 'you are doing, as the heuristics used to detect the situation are\n'
56 'not perfect. The commit queue will not block on this warning.\n'
57 'Email joi@chromium.org if you have questions.')
60 _INCLUDE_ORDER_WARNING = (
61 'Your #include order seems to be broken. Send mail to\n'
62 'marja@chromium.org if this is not the case.')
65 _BANNED_OBJC_FUNCTIONS = (
67 'addTrackingRect:',
69 'The use of -[NSView addTrackingRect:owner:userData:assumeInside:] is'
70 'prohibited. Please use CrTrackingArea instead.',
71 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
73 False,
76 'NSTrackingArea',
78 'The use of NSTrackingAreas is prohibited. Please use CrTrackingArea',
79 'instead.',
80 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
82 False,
85 'convertPointFromBase:',
87 'The use of -[NSView convertPointFromBase:] is almost certainly wrong.',
88 'Please use |convertPoint:(point) fromView:nil| instead.',
89 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
91 True,
94 'convertPointToBase:',
96 'The use of -[NSView convertPointToBase:] is almost certainly wrong.',
97 'Please use |convertPoint:(point) toView:nil| instead.',
98 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
100 True,
103 'convertRectFromBase:',
105 'The use of -[NSView convertRectFromBase:] is almost certainly wrong.',
106 'Please use |convertRect:(point) fromView:nil| instead.',
107 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
109 True,
112 'convertRectToBase:',
114 'The use of -[NSView convertRectToBase:] is almost certainly wrong.',
115 'Please use |convertRect:(point) toView:nil| instead.',
116 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
118 True,
121 'convertSizeFromBase:',
123 'The use of -[NSView convertSizeFromBase:] is almost certainly wrong.',
124 'Please use |convertSize:(point) fromView:nil| instead.',
125 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
127 True,
130 'convertSizeToBase:',
132 'The use of -[NSView convertSizeToBase:] is almost certainly wrong.',
133 'Please use |convertSize:(point) toView:nil| instead.',
134 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
136 True,
141 _BANNED_CPP_FUNCTIONS = (
142 # Make sure that gtest's FRIEND_TEST() macro is not used; the
143 # FRIEND_TEST_ALL_PREFIXES() macro from base/gtest_prod_util.h should be
144 # used instead since that allows for FLAKY_ and DISABLED_ prefixes.
146 'FRIEND_TEST(',
148 'Chromium code should not use gtest\'s FRIEND_TEST() macro. Include',
149 'base/gtest_prod_util.h and use FRIEND_TEST_ALL_PREFIXES() instead.',
151 False,
155 'ScopedAllowIO',
157 'New code should not use ScopedAllowIO. Post a task to the blocking',
158 'pool or the FILE thread instead.',
160 True,
162 r"^components[\\\/]breakpad[\\\/]app[\\\/]breakpad_mac\.mm$",
163 r"^content[\\\/]shell[\\\/]browser[\\\/]shell_browser_main\.cc$",
164 r"^content[\\\/]shell[\\\/]browser[\\\/]shell_message_filter\.cc$",
165 r"^net[\\\/]disk_cache[\\\/]cache_util\.cc$",
169 'SkRefPtr',
171 'The use of SkRefPtr is prohibited. ',
172 'Please use skia::RefPtr instead.'
174 True,
178 'SkAutoRef',
180 'The indirect use of SkRefPtr via SkAutoRef is prohibited. ',
181 'Please use skia::RefPtr instead.'
183 True,
187 'SkAutoTUnref',
189 'The use of SkAutoTUnref is dangerous because it implicitly ',
190 'converts to a raw pointer. Please use skia::RefPtr instead.'
192 True,
196 'SkAutoUnref',
198 'The indirect use of SkAutoTUnref through SkAutoUnref is dangerous ',
199 'because it implicitly converts to a raw pointer. ',
200 'Please use skia::RefPtr instead.'
202 True,
206 r'/HANDLE_EINTR\(.*close',
208 'HANDLE_EINTR(close) is invalid. If close fails with EINTR, the file',
209 'descriptor will be closed, and it is incorrect to retry the close.',
210 'Either call close directly and ignore its return value, or wrap close',
211 'in IGNORE_EINTR to use its return value. See http://crbug.com/269623'
213 True,
217 r'/IGNORE_EINTR\((?!.*close)',
219 'IGNORE_EINTR is only valid when wrapping close. To wrap other system',
220 'calls, use HANDLE_EINTR. See http://crbug.com/269623',
222 True,
224 # Files that #define IGNORE_EINTR.
225 r'^base[\\\/]posix[\\\/]eintr_wrapper\.h$',
226 r'^ppapi[\\\/]tests[\\\/]test_broker\.cc$',
232 _VALID_OS_MACROS = (
233 # Please keep sorted.
234 'OS_ANDROID',
235 'OS_BSD',
236 'OS_CAT', # For testing.
237 'OS_CHROMEOS',
238 'OS_FREEBSD',
239 'OS_IOS',
240 'OS_LINUX',
241 'OS_MACOSX',
242 'OS_NACL',
243 'OS_OPENBSD',
244 'OS_POSIX',
245 'OS_SOLARIS',
246 'OS_WIN',
250 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
251 """Attempts to prevent use of functions intended only for testing in
252 non-testing code. For now this is just a best-effort implementation
253 that ignores header files and may have some false positives. A
254 better implementation would probably need a proper C++ parser.
256 # We only scan .cc files and the like, as the declaration of
257 # for-testing functions in header files are hard to distinguish from
258 # calls to such functions without a proper C++ parser.
259 file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
261 base_function_pattern = r'ForTest(ing)?|for_test(ing)?'
262 inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
263 comment_pattern = input_api.re.compile(r'//.*%s' % base_function_pattern)
264 exclusion_pattern = input_api.re.compile(
265 r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
266 base_function_pattern, base_function_pattern))
268 def FilterFile(affected_file):
269 black_list = (_EXCLUDED_PATHS +
270 _TEST_CODE_EXCLUDED_PATHS +
271 input_api.DEFAULT_BLACK_LIST)
272 return input_api.FilterSourceFile(
273 affected_file,
274 white_list=(file_inclusion_pattern, ),
275 black_list=black_list)
277 problems = []
278 for f in input_api.AffectedSourceFiles(FilterFile):
279 local_path = f.LocalPath()
280 lines = input_api.ReadFile(f).splitlines()
281 line_number = 0
282 for line in lines:
283 if (inclusion_pattern.search(line) and
284 not comment_pattern.search(line) and
285 not exclusion_pattern.search(line)):
286 problems.append(
287 '%s:%d\n %s' % (local_path, line_number, line.strip()))
288 line_number += 1
290 if problems:
291 return [output_api.PresubmitPromptOrNotify(_TEST_ONLY_WARNING, problems)]
292 else:
293 return []
296 def _CheckNoIOStreamInHeaders(input_api, output_api):
297 """Checks to make sure no .h files include <iostream>."""
298 files = []
299 pattern = input_api.re.compile(r'^#include\s*<iostream>',
300 input_api.re.MULTILINE)
301 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
302 if not f.LocalPath().endswith('.h'):
303 continue
304 contents = input_api.ReadFile(f)
305 if pattern.search(contents):
306 files.append(f)
308 if len(files):
309 return [ output_api.PresubmitError(
310 'Do not #include <iostream> in header files, since it inserts static '
311 'initialization into every file including the header. Instead, '
312 '#include <ostream>. See http://crbug.com/94794',
313 files) ]
314 return []
317 def _CheckNoUNIT_TESTInSourceFiles(input_api, output_api):
318 """Checks to make sure no source files use UNIT_TEST"""
319 problems = []
320 for f in input_api.AffectedFiles():
321 if (not f.LocalPath().endswith(('.cc', '.mm'))):
322 continue
324 for line_num, line in f.ChangedContents():
325 if 'UNIT_TEST ' in line or line.endswith('UNIT_TEST'):
326 problems.append(' %s:%d' % (f.LocalPath(), line_num))
328 if not problems:
329 return []
330 return [output_api.PresubmitPromptWarning('UNIT_TEST is only for headers.\n' +
331 '\n'.join(problems))]
334 def _CheckNoNewWStrings(input_api, output_api):
335 """Checks to make sure we don't introduce use of wstrings."""
336 problems = []
337 for f in input_api.AffectedFiles():
338 if (not f.LocalPath().endswith(('.cc', '.h')) or
339 f.LocalPath().endswith(('test.cc', '_win.cc', '_win.h'))):
340 continue
342 allowWString = False
343 for line_num, line in f.ChangedContents():
344 if 'presubmit: allow wstring' in line:
345 allowWString = True
346 elif not allowWString and 'wstring' in line:
347 problems.append(' %s:%d' % (f.LocalPath(), line_num))
348 allowWString = False
349 else:
350 allowWString = False
352 if not problems:
353 return []
354 return [output_api.PresubmitPromptWarning('New code should not use wstrings.'
355 ' If you are calling a cross-platform API that accepts a wstring, '
356 'fix the API.\n' +
357 '\n'.join(problems))]
360 def _CheckNoDEPSGIT(input_api, output_api):
361 """Make sure .DEPS.git is never modified manually."""
362 if any(f.LocalPath().endswith('.DEPS.git') for f in
363 input_api.AffectedFiles()):
364 return [output_api.PresubmitError(
365 'Never commit changes to .DEPS.git. This file is maintained by an\n'
366 'automated system based on what\'s in DEPS and your changes will be\n'
367 'overwritten.\n'
368 'See http://code.google.com/p/chromium/wiki/UsingNewGit#Rolling_DEPS\n'
369 'for more information')]
370 return []
373 def _CheckNoBannedFunctions(input_api, output_api):
374 """Make sure that banned functions are not used."""
375 warnings = []
376 errors = []
378 file_filter = lambda f: f.LocalPath().endswith(('.mm', '.m', '.h'))
379 for f in input_api.AffectedFiles(file_filter=file_filter):
380 for line_num, line in f.ChangedContents():
381 for func_name, message, error in _BANNED_OBJC_FUNCTIONS:
382 if func_name in line:
383 problems = warnings;
384 if error:
385 problems = errors;
386 problems.append(' %s:%d:' % (f.LocalPath(), line_num))
387 for message_line in message:
388 problems.append(' %s' % message_line)
390 file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm', '.h'))
391 for f in input_api.AffectedFiles(file_filter=file_filter):
392 for line_num, line in f.ChangedContents():
393 for func_name, message, error, excluded_paths in _BANNED_CPP_FUNCTIONS:
394 def IsBlacklisted(affected_file, blacklist):
395 local_path = affected_file.LocalPath()
396 for item in blacklist:
397 if input_api.re.match(item, local_path):
398 return True
399 return False
400 if IsBlacklisted(f, excluded_paths):
401 continue
402 matched = False
403 if func_name[0:1] == '/':
404 regex = func_name[1:]
405 if input_api.re.search(regex, line):
406 matched = True
407 elif func_name in line:
408 matched = True
409 if matched:
410 problems = warnings;
411 if error:
412 problems = errors;
413 problems.append(' %s:%d:' % (f.LocalPath(), line_num))
414 for message_line in message:
415 problems.append(' %s' % message_line)
417 result = []
418 if (warnings):
419 result.append(output_api.PresubmitPromptWarning(
420 'Banned functions were used.\n' + '\n'.join(warnings)))
421 if (errors):
422 result.append(output_api.PresubmitError(
423 'Banned functions were used.\n' + '\n'.join(errors)))
424 return result
427 def _CheckNoPragmaOnce(input_api, output_api):
428 """Make sure that banned functions are not used."""
429 files = []
430 pattern = input_api.re.compile(r'^#pragma\s+once',
431 input_api.re.MULTILINE)
432 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
433 if not f.LocalPath().endswith('.h'):
434 continue
435 contents = input_api.ReadFile(f)
436 if pattern.search(contents):
437 files.append(f)
439 if files:
440 return [output_api.PresubmitError(
441 'Do not use #pragma once in header files.\n'
442 'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
443 files)]
444 return []
447 def _CheckNoTrinaryTrueFalse(input_api, output_api):
448 """Checks to make sure we don't introduce use of foo ? true : false."""
449 problems = []
450 pattern = input_api.re.compile(r'\?\s*(true|false)\s*:\s*(true|false)')
451 for f in input_api.AffectedFiles():
452 if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
453 continue
455 for line_num, line in f.ChangedContents():
456 if pattern.match(line):
457 problems.append(' %s:%d' % (f.LocalPath(), line_num))
459 if not problems:
460 return []
461 return [output_api.PresubmitPromptWarning(
462 'Please consider avoiding the "? true : false" pattern if possible.\n' +
463 '\n'.join(problems))]
466 def _CheckUnwantedDependencies(input_api, output_api):
467 """Runs checkdeps on #include statements added in this
468 change. Breaking - rules is an error, breaking ! rules is a
469 warning.
471 # We need to wait until we have an input_api object and use this
472 # roundabout construct to import checkdeps because this file is
473 # eval-ed and thus doesn't have __file__.
474 original_sys_path = sys.path
475 try:
476 sys.path = sys.path + [input_api.os_path.join(
477 input_api.PresubmitLocalPath(), 'tools', 'checkdeps')]
478 import checkdeps
479 from cpp_checker import CppChecker
480 from rules import Rule
481 finally:
482 # Restore sys.path to what it was before.
483 sys.path = original_sys_path
485 added_includes = []
486 for f in input_api.AffectedFiles():
487 if not CppChecker.IsCppFile(f.LocalPath()):
488 continue
490 changed_lines = [line for line_num, line in f.ChangedContents()]
491 added_includes.append([f.LocalPath(), changed_lines])
493 deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath())
495 error_descriptions = []
496 warning_descriptions = []
497 for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
498 added_includes):
499 description_with_path = '%s\n %s' % (path, rule_description)
500 if rule_type == Rule.DISALLOW:
501 error_descriptions.append(description_with_path)
502 else:
503 warning_descriptions.append(description_with_path)
505 results = []
506 if error_descriptions:
507 results.append(output_api.PresubmitError(
508 'You added one or more #includes that violate checkdeps rules.',
509 error_descriptions))
510 if warning_descriptions:
511 results.append(output_api.PresubmitPromptOrNotify(
512 'You added one or more #includes of files that are temporarily\n'
513 'allowed but being removed. Can you avoid introducing the\n'
514 '#include? See relevant DEPS file(s) for details and contacts.',
515 warning_descriptions))
516 return results
519 def _CheckFilePermissions(input_api, output_api):
520 """Check that all files have their permissions properly set."""
521 args = [sys.executable, 'tools/checkperms/checkperms.py', '--root',
522 input_api.change.RepositoryRoot()]
523 for f in input_api.AffectedFiles():
524 args += ['--file', f.LocalPath()]
525 errors = []
526 (errors, stderrdata) = subprocess.Popen(args).communicate()
528 results = []
529 if errors:
530 results.append(output_api.PresubmitError('checkperms.py failed.',
531 errors))
532 return results
535 def _CheckNoAuraWindowPropertyHInHeaders(input_api, output_api):
536 """Makes sure we don't include ui/aura/window_property.h
537 in header files.
539 pattern = input_api.re.compile(r'^#include\s*"ui/aura/window_property.h"')
540 errors = []
541 for f in input_api.AffectedFiles():
542 if not f.LocalPath().endswith('.h'):
543 continue
544 for line_num, line in f.ChangedContents():
545 if pattern.match(line):
546 errors.append(' %s:%d' % (f.LocalPath(), line_num))
548 results = []
549 if errors:
550 results.append(output_api.PresubmitError(
551 'Header files should not include ui/aura/window_property.h', errors))
552 return results
555 def _CheckIncludeOrderForScope(scope, input_api, file_path, changed_linenums):
556 """Checks that the lines in scope occur in the right order.
558 1. C system files in alphabetical order
559 2. C++ system files in alphabetical order
560 3. Project's .h files
563 c_system_include_pattern = input_api.re.compile(r'\s*#include <.*\.h>')
564 cpp_system_include_pattern = input_api.re.compile(r'\s*#include <.*>')
565 custom_include_pattern = input_api.re.compile(r'\s*#include ".*')
567 C_SYSTEM_INCLUDES, CPP_SYSTEM_INCLUDES, CUSTOM_INCLUDES = range(3)
569 state = C_SYSTEM_INCLUDES
571 previous_line = ''
572 previous_line_num = 0
573 problem_linenums = []
574 for line_num, line in scope:
575 if c_system_include_pattern.match(line):
576 if state != C_SYSTEM_INCLUDES:
577 problem_linenums.append((line_num, previous_line_num))
578 elif previous_line and previous_line > line:
579 problem_linenums.append((line_num, previous_line_num))
580 elif cpp_system_include_pattern.match(line):
581 if state == C_SYSTEM_INCLUDES:
582 state = CPP_SYSTEM_INCLUDES
583 elif state == CUSTOM_INCLUDES:
584 problem_linenums.append((line_num, previous_line_num))
585 elif previous_line and previous_line > line:
586 problem_linenums.append((line_num, previous_line_num))
587 elif custom_include_pattern.match(line):
588 if state != CUSTOM_INCLUDES:
589 state = CUSTOM_INCLUDES
590 elif previous_line and previous_line > line:
591 problem_linenums.append((line_num, previous_line_num))
592 else:
593 problem_linenums.append(line_num)
594 previous_line = line
595 previous_line_num = line_num
597 warnings = []
598 for (line_num, previous_line_num) in problem_linenums:
599 if line_num in changed_linenums or previous_line_num in changed_linenums:
600 warnings.append(' %s:%d' % (file_path, line_num))
601 return warnings
604 def _CheckIncludeOrderInFile(input_api, f, changed_linenums):
605 """Checks the #include order for the given file f."""
607 system_include_pattern = input_api.re.compile(r'\s*#include \<.*')
608 # Exclude the following includes from the check:
609 # 1) #include <.../...>, e.g., <sys/...> includes often need to appear in a
610 # specific order.
611 # 2) <atlbase.h>, "build/build_config.h"
612 excluded_include_pattern = input_api.re.compile(
613 r'\s*#include (\<.*/.*|\<atlbase\.h\>|"build/build_config.h")')
614 custom_include_pattern = input_api.re.compile(r'\s*#include "(?P<FILE>.*)"')
615 # Match the final or penultimate token if it is xxxtest so we can ignore it
616 # when considering the special first include.
617 test_file_tag_pattern = input_api.re.compile(
618 r'_[a-z]+test(?=(_[a-zA-Z0-9]+)?\.)')
619 if_pattern = input_api.re.compile(
620 r'\s*#\s*(if|elif|else|endif|define|undef).*')
621 # Some files need specialized order of includes; exclude such files from this
622 # check.
623 uncheckable_includes_pattern = input_api.re.compile(
624 r'\s*#include '
625 '("ipc/.*macros\.h"|<windows\.h>|".*gl.*autogen.h")\s*')
627 contents = f.NewContents()
628 warnings = []
629 line_num = 0
631 # Handle the special first include. If the first include file is
632 # some/path/file.h, the corresponding including file can be some/path/file.cc,
633 # some/other/path/file.cc, some/path/file_platform.cc, some/path/file-suffix.h
634 # etc. It's also possible that no special first include exists.
635 # If the included file is some/path/file_platform.h the including file could
636 # also be some/path/file_xxxtest_platform.h.
637 including_file_base_name = test_file_tag_pattern.sub(
638 '', input_api.os_path.basename(f.LocalPath()))
640 for line in contents:
641 line_num += 1
642 if system_include_pattern.match(line):
643 # No special first include -> process the line again along with normal
644 # includes.
645 line_num -= 1
646 break
647 match = custom_include_pattern.match(line)
648 if match:
649 match_dict = match.groupdict()
650 header_basename = test_file_tag_pattern.sub(
651 '', input_api.os_path.basename(match_dict['FILE'])).replace('.h', '')
653 if header_basename not in including_file_base_name:
654 # No special first include -> process the line again along with normal
655 # includes.
656 line_num -= 1
657 break
659 # Split into scopes: Each region between #if and #endif is its own scope.
660 scopes = []
661 current_scope = []
662 for line in contents[line_num:]:
663 line_num += 1
664 if uncheckable_includes_pattern.match(line):
665 return []
666 if if_pattern.match(line):
667 scopes.append(current_scope)
668 current_scope = []
669 elif ((system_include_pattern.match(line) or
670 custom_include_pattern.match(line)) and
671 not excluded_include_pattern.match(line)):
672 current_scope.append((line_num, line))
673 scopes.append(current_scope)
675 for scope in scopes:
676 warnings.extend(_CheckIncludeOrderForScope(scope, input_api, f.LocalPath(),
677 changed_linenums))
678 return warnings
681 def _CheckIncludeOrder(input_api, output_api):
682 """Checks that the #include order is correct.
684 1. The corresponding header for source files.
685 2. C system files in alphabetical order
686 3. C++ system files in alphabetical order
687 4. Project's .h files in alphabetical order
689 Each region separated by #if, #elif, #else, #endif, #define and #undef follows
690 these rules separately.
693 warnings = []
694 for f in input_api.AffectedFiles():
695 if f.LocalPath().endswith(('.cc', '.h')):
696 changed_linenums = set(line_num for line_num, _ in f.ChangedContents())
697 warnings.extend(_CheckIncludeOrderInFile(input_api, f, changed_linenums))
699 results = []
700 if warnings:
701 results.append(output_api.PresubmitPromptOrNotify(_INCLUDE_ORDER_WARNING,
702 warnings))
703 return results
706 def _CheckForVersionControlConflictsInFile(input_api, f):
707 pattern = input_api.re.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
708 errors = []
709 for line_num, line in f.ChangedContents():
710 if pattern.match(line):
711 errors.append(' %s:%d %s' % (f.LocalPath(), line_num, line))
712 return errors
715 def _CheckForVersionControlConflicts(input_api, output_api):
716 """Usually this is not intentional and will cause a compile failure."""
717 errors = []
718 for f in input_api.AffectedFiles():
719 errors.extend(_CheckForVersionControlConflictsInFile(input_api, f))
721 results = []
722 if errors:
723 results.append(output_api.PresubmitError(
724 'Version control conflict markers found, please resolve.', errors))
725 return results
728 def _CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api):
729 def FilterFile(affected_file):
730 """Filter function for use with input_api.AffectedSourceFiles,
731 below. This filters out everything except non-test files from
732 top-level directories that generally speaking should not hard-code
733 service URLs (e.g. src/android_webview/, src/content/ and others).
735 return input_api.FilterSourceFile(
736 affected_file,
737 white_list=(r'^(android_webview|base|content|net)[\\\/].*', ),
738 black_list=(_EXCLUDED_PATHS +
739 _TEST_CODE_EXCLUDED_PATHS +
740 input_api.DEFAULT_BLACK_LIST))
742 base_pattern = '"[^"]*google\.com[^"]*"'
743 comment_pattern = input_api.re.compile('//.*%s' % base_pattern)
744 pattern = input_api.re.compile(base_pattern)
745 problems = [] # items are (filename, line_number, line)
746 for f in input_api.AffectedSourceFiles(FilterFile):
747 for line_num, line in f.ChangedContents():
748 if not comment_pattern.search(line) and pattern.search(line):
749 problems.append((f.LocalPath(), line_num, line))
751 if problems:
752 return [output_api.PresubmitPromptOrNotify(
753 'Most layers below src/chrome/ should not hardcode service URLs.\n'
754 'Are you sure this is correct? (Contact: joi@chromium.org)',
755 [' %s:%d: %s' % (
756 problem[0], problem[1], problem[2]) for problem in problems])]
757 else:
758 return []
761 def _CheckNoAbbreviationInPngFileName(input_api, output_api):
762 """Makes sure there are no abbreviations in the name of PNG files.
764 pattern = input_api.re.compile(r'.*_[a-z]_.*\.png$|.*_[a-z]\.png$')
765 errors = []
766 for f in input_api.AffectedFiles(include_deletes=False):
767 if pattern.match(f.LocalPath()):
768 errors.append(' %s' % f.LocalPath())
770 results = []
771 if errors:
772 results.append(output_api.PresubmitError(
773 'The name of PNG files should not have abbreviations. \n'
774 'Use _hover.png, _center.png, instead of _h.png, _c.png.\n'
775 'Contact oshima@chromium.org if you have questions.', errors))
776 return results
779 def _DepsFilesToCheck(re, changed_lines):
780 """Helper method for _CheckAddedDepsHaveTargetApprovals. Returns
781 a set of DEPS entries that we should look up."""
782 # We ignore deps entries on auto-generated directories.
783 AUTO_GENERATED_DIRS = ['grit', 'jni']
785 # This pattern grabs the path without basename in the first
786 # parentheses, and the basename (if present) in the second. It
787 # relies on the simple heuristic that if there is a basename it will
788 # be a header file ending in ".h".
789 pattern = re.compile(
790 r"""['"]\+([^'"]+?)(/[a-zA-Z0-9_]+\.h)?['"].*""")
791 results = set()
792 for changed_line in changed_lines:
793 m = pattern.match(changed_line)
794 if m:
795 path = m.group(1)
796 if path.split('/')[0] not in AUTO_GENERATED_DIRS:
797 results.add('%s/DEPS' % m.group(1))
798 return results
801 def _CheckAddedDepsHaveTargetApprovals(input_api, output_api):
802 """When a dependency prefixed with + is added to a DEPS file, we
803 want to make sure that the change is reviewed by an OWNER of the
804 target file or directory, to avoid layering violations from being
805 introduced. This check verifies that this happens.
807 changed_lines = set()
808 for f in input_api.AffectedFiles():
809 filename = input_api.os_path.basename(f.LocalPath())
810 if filename == 'DEPS':
811 changed_lines |= set(line.strip()
812 for line_num, line
813 in f.ChangedContents())
814 if not changed_lines:
815 return []
817 virtual_depended_on_files = _DepsFilesToCheck(input_api.re, changed_lines)
818 if not virtual_depended_on_files:
819 return []
821 if input_api.is_committing:
822 if input_api.tbr:
823 return [output_api.PresubmitNotifyResult(
824 '--tbr was specified, skipping OWNERS check for DEPS additions')]
825 if not input_api.change.issue:
826 return [output_api.PresubmitError(
827 "DEPS approval by OWNERS check failed: this change has "
828 "no Rietveld issue number, so we can't check it for approvals.")]
829 output = output_api.PresubmitError
830 else:
831 output = output_api.PresubmitNotifyResult
833 owners_db = input_api.owners_db
834 owner_email, reviewers = input_api.canned_checks._RietveldOwnerAndReviewers(
835 input_api,
836 owners_db.email_regexp,
837 approval_needed=input_api.is_committing)
839 owner_email = owner_email or input_api.change.author_email
841 reviewers_plus_owner = set(reviewers)
842 if owner_email:
843 reviewers_plus_owner.add(owner_email)
844 missing_files = owners_db.files_not_covered_by(virtual_depended_on_files,
845 reviewers_plus_owner)
846 unapproved_dependencies = ["'+%s'," % path[:-len('/DEPS')]
847 for path in missing_files]
849 if unapproved_dependencies:
850 output_list = [
851 output('Missing LGTM from OWNERS of directories added to DEPS:\n %s' %
852 '\n '.join(sorted(unapproved_dependencies)))]
853 if not input_api.is_committing:
854 suggested_owners = owners_db.reviewers_for(missing_files, owner_email)
855 output_list.append(output(
856 'Suggested missing target path OWNERS:\n %s' %
857 '\n '.join(suggested_owners or [])))
858 return output_list
860 return []
863 def _CheckSpamLogging(input_api, output_api):
864 file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
865 black_list = (_EXCLUDED_PATHS +
866 _TEST_CODE_EXCLUDED_PATHS +
867 input_api.DEFAULT_BLACK_LIST +
868 (r"^base[\\\/]logging\.h$",
869 r"^chrome[\\\/]app[\\\/]chrome_main_delegate\.cc$",
870 r"^chrome[\\\/]browser[\\\/]chrome_browser_main\.cc$",
871 r"^chrome[\\\/]installer[\\\/]setup[\\\/].*",
872 r"^chrome[\\\/]renderer[\\\/]extensions[\\\/]"
873 r"logging_native_handler\.cc$",
874 r"^remoting[\\\/]base[\\\/]logging\.h$",
875 r"^sandbox[\\\/]linux[\\\/].*",))
876 source_file_filter = lambda x: input_api.FilterSourceFile(
877 x, white_list=(file_inclusion_pattern,), black_list=black_list)
879 log_info = []
880 printf = []
882 for f in input_api.AffectedSourceFiles(source_file_filter):
883 contents = input_api.ReadFile(f, 'rb')
884 if re.search(r"\bD?LOG\s*\(\s*INFO\s*\)", contents):
885 log_info.append(f.LocalPath())
886 elif re.search(r"\bD?LOG_IF\s*\(\s*INFO\s*,", contents):
887 log_info.append(f.LocalPath())
889 if re.search(r"\bprintf\(", contents):
890 printf.append(f.LocalPath())
891 elif re.search(r"\bfprintf\((stdout|stderr)", contents):
892 printf.append(f.LocalPath())
894 if log_info:
895 return [output_api.PresubmitError(
896 'These files spam the console log with LOG(INFO):',
897 items=log_info)]
898 if printf:
899 return [output_api.PresubmitError(
900 'These files spam the console log with printf/fprintf:',
901 items=printf)]
902 return []
905 def _CheckForAnonymousVariables(input_api, output_api):
906 """These types are all expected to hold locks while in scope and
907 so should never be anonymous (which causes them to be immediately
908 destroyed)."""
909 they_who_must_be_named = [
910 'base::AutoLock',
911 'base::AutoReset',
912 'base::AutoUnlock',
913 'SkAutoAlphaRestore',
914 'SkAutoBitmapShaderInstall',
915 'SkAutoBlitterChoose',
916 'SkAutoBounderCommit',
917 'SkAutoCallProc',
918 'SkAutoCanvasRestore',
919 'SkAutoCommentBlock',
920 'SkAutoDescriptor',
921 'SkAutoDisableDirectionCheck',
922 'SkAutoDisableOvalCheck',
923 'SkAutoFree',
924 'SkAutoGlyphCache',
925 'SkAutoHDC',
926 'SkAutoLockColors',
927 'SkAutoLockPixels',
928 'SkAutoMalloc',
929 'SkAutoMaskFreeImage',
930 'SkAutoMutexAcquire',
931 'SkAutoPathBoundsUpdate',
932 'SkAutoPDFRelease',
933 'SkAutoRasterClipValidate',
934 'SkAutoRef',
935 'SkAutoTime',
936 'SkAutoTrace',
937 'SkAutoUnref',
939 anonymous = r'(%s)\s*[({]' % '|'.join(they_who_must_be_named)
940 # bad: base::AutoLock(lock.get());
941 # not bad: base::AutoLock lock(lock.get());
942 bad_pattern = input_api.re.compile(anonymous)
943 # good: new base::AutoLock(lock.get())
944 good_pattern = input_api.re.compile(r'\bnew\s*' + anonymous)
945 errors = []
947 for f in input_api.AffectedFiles():
948 if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
949 continue
950 for linenum, line in f.ChangedContents():
951 if bad_pattern.search(line) and not good_pattern.search(line):
952 errors.append('%s:%d' % (f.LocalPath(), linenum))
954 if errors:
955 return [output_api.PresubmitError(
956 'These lines create anonymous variables that need to be named:',
957 items=errors)]
958 return []
961 def _CheckCygwinShell(input_api, output_api):
962 source_file_filter = lambda x: input_api.FilterSourceFile(
963 x, white_list=(r'.+\.(gyp|gypi)$',))
964 cygwin_shell = []
966 for f in input_api.AffectedSourceFiles(source_file_filter):
967 for linenum, line in f.ChangedContents():
968 if 'msvs_cygwin_shell' in line:
969 cygwin_shell.append(f.LocalPath())
970 break
972 if cygwin_shell:
973 return [output_api.PresubmitError(
974 'These files should not use msvs_cygwin_shell (the default is 0):',
975 items=cygwin_shell)]
976 return []
979 def _CommonChecks(input_api, output_api):
980 """Checks common to both upload and commit."""
981 results = []
982 results.extend(input_api.canned_checks.PanProjectChecks(
983 input_api, output_api, excluded_paths=_EXCLUDED_PATHS))
984 results.extend(_CheckAuthorizedAuthor(input_api, output_api))
985 results.extend(
986 _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
987 results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
988 results.extend(_CheckNoUNIT_TESTInSourceFiles(input_api, output_api))
989 results.extend(_CheckNoNewWStrings(input_api, output_api))
990 results.extend(_CheckNoDEPSGIT(input_api, output_api))
991 results.extend(_CheckNoBannedFunctions(input_api, output_api))
992 results.extend(_CheckNoPragmaOnce(input_api, output_api))
993 results.extend(_CheckNoTrinaryTrueFalse(input_api, output_api))
994 results.extend(_CheckUnwantedDependencies(input_api, output_api))
995 results.extend(_CheckFilePermissions(input_api, output_api))
996 results.extend(_CheckNoAuraWindowPropertyHInHeaders(input_api, output_api))
997 results.extend(_CheckIncludeOrder(input_api, output_api))
998 results.extend(_CheckForVersionControlConflicts(input_api, output_api))
999 results.extend(_CheckPatchFiles(input_api, output_api))
1000 results.extend(_CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api))
1001 results.extend(_CheckNoAbbreviationInPngFileName(input_api, output_api))
1002 results.extend(_CheckForInvalidOSMacros(input_api, output_api))
1003 results.extend(_CheckAddedDepsHaveTargetApprovals(input_api, output_api))
1004 results.extend(
1005 input_api.canned_checks.CheckChangeHasNoTabs(
1006 input_api,
1007 output_api,
1008 source_file_filter=lambda x: x.LocalPath().endswith('.grd')))
1009 results.extend(_CheckSpamLogging(input_api, output_api))
1010 results.extend(_CheckForAnonymousVariables(input_api, output_api))
1011 results.extend(_CheckCygwinShell(input_api, output_api))
1013 if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
1014 results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
1015 input_api, output_api,
1016 input_api.PresubmitLocalPath(),
1017 whitelist=[r'^PRESUBMIT_test\.py$']))
1018 return results
1021 def _CheckSubversionConfig(input_api, output_api):
1022 """Verifies the subversion config file is correctly setup.
1024 Checks that autoprops are enabled, returns an error otherwise.
1026 join = input_api.os_path.join
1027 if input_api.platform == 'win32':
1028 appdata = input_api.environ.get('APPDATA', '')
1029 if not appdata:
1030 return [output_api.PresubmitError('%APPDATA% is not configured.')]
1031 path = join(appdata, 'Subversion', 'config')
1032 else:
1033 home = input_api.environ.get('HOME', '')
1034 if not home:
1035 return [output_api.PresubmitError('$HOME is not configured.')]
1036 path = join(home, '.subversion', 'config')
1038 error_msg = (
1039 'Please look at http://dev.chromium.org/developers/coding-style to\n'
1040 'configure your subversion configuration file. This enables automatic\n'
1041 'properties to simplify the project maintenance.\n'
1042 'Pro-tip: just download and install\n'
1043 'http://src.chromium.org/viewvc/chrome/trunk/tools/build/slave/config\n')
1045 try:
1046 lines = open(path, 'r').read().splitlines()
1047 # Make sure auto-props is enabled and check for 2 Chromium standard
1048 # auto-prop.
1049 if (not '*.cc = svn:eol-style=LF' in lines or
1050 not '*.pdf = svn:mime-type=application/pdf' in lines or
1051 not 'enable-auto-props = yes' in lines):
1052 return [
1053 output_api.PresubmitNotifyResult(
1054 'It looks like you have not configured your subversion config '
1055 'file or it is not up-to-date.\n' + error_msg)
1057 except (OSError, IOError):
1058 return [
1059 output_api.PresubmitNotifyResult(
1060 'Can\'t find your subversion config file.\n' + error_msg)
1062 return []
1065 def _CheckAuthorizedAuthor(input_api, output_api):
1066 """For non-googler/chromites committers, verify the author's email address is
1067 in AUTHORS.
1069 # TODO(maruel): Add it to input_api?
1070 import fnmatch
1072 author = input_api.change.author_email
1073 if not author:
1074 input_api.logging.info('No author, skipping AUTHOR check')
1075 return []
1076 authors_path = input_api.os_path.join(
1077 input_api.PresubmitLocalPath(), 'AUTHORS')
1078 valid_authors = (
1079 input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
1080 for line in open(authors_path))
1081 valid_authors = [item.group(1).lower() for item in valid_authors if item]
1082 if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
1083 input_api.logging.info('Valid authors are %s', ', '.join(valid_authors))
1084 return [output_api.PresubmitPromptWarning(
1085 ('%s is not in AUTHORS file. If you are a new contributor, please visit'
1086 '\n'
1087 'http://www.chromium.org/developers/contributing-code and read the '
1088 '"Legal" section\n'
1089 'If you are a chromite, verify the contributor signed the CLA.') %
1090 author)]
1091 return []
1094 def _CheckPatchFiles(input_api, output_api):
1095 problems = [f.LocalPath() for f in input_api.AffectedFiles()
1096 if f.LocalPath().endswith(('.orig', '.rej'))]
1097 if problems:
1098 return [output_api.PresubmitError(
1099 "Don't commit .rej and .orig files.", problems)]
1100 else:
1101 return []
1104 def _DidYouMeanOSMacro(bad_macro):
1105 try:
1106 return {'A': 'OS_ANDROID',
1107 'B': 'OS_BSD',
1108 'C': 'OS_CHROMEOS',
1109 'F': 'OS_FREEBSD',
1110 'L': 'OS_LINUX',
1111 'M': 'OS_MACOSX',
1112 'N': 'OS_NACL',
1113 'O': 'OS_OPENBSD',
1114 'P': 'OS_POSIX',
1115 'S': 'OS_SOLARIS',
1116 'W': 'OS_WIN'}[bad_macro[3].upper()]
1117 except KeyError:
1118 return ''
1121 def _CheckForInvalidOSMacrosInFile(input_api, f):
1122 """Check for sensible looking, totally invalid OS macros."""
1123 preprocessor_statement = input_api.re.compile(r'^\s*#')
1124 os_macro = input_api.re.compile(r'defined\((OS_[^)]+)\)')
1125 results = []
1126 for lnum, line in f.ChangedContents():
1127 if preprocessor_statement.search(line):
1128 for match in os_macro.finditer(line):
1129 if not match.group(1) in _VALID_OS_MACROS:
1130 good = _DidYouMeanOSMacro(match.group(1))
1131 did_you_mean = ' (did you mean %s?)' % good if good else ''
1132 results.append(' %s:%d %s%s' % (f.LocalPath(),
1133 lnum,
1134 match.group(1),
1135 did_you_mean))
1136 return results
1139 def _CheckForInvalidOSMacros(input_api, output_api):
1140 """Check all affected files for invalid OS macros."""
1141 bad_macros = []
1142 for f in input_api.AffectedFiles():
1143 if not f.LocalPath().endswith(('.py', '.js', '.html', '.css')):
1144 bad_macros.extend(_CheckForInvalidOSMacrosInFile(input_api, f))
1146 if not bad_macros:
1147 return []
1149 return [output_api.PresubmitError(
1150 'Possibly invalid OS macro[s] found. Please fix your code\n'
1151 'or add your macro to src/PRESUBMIT.py.', bad_macros)]
1154 def CheckChangeOnUpload(input_api, output_api):
1155 results = []
1156 results.extend(_CommonChecks(input_api, output_api))
1157 return results
1160 def CheckChangeOnCommit(input_api, output_api):
1161 results = []
1162 results.extend(_CommonChecks(input_api, output_api))
1163 # TODO(thestig) temporarily disabled, doesn't work in third_party/
1164 #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
1165 # input_api, output_api, sources))
1166 # Make sure the tree is 'open'.
1167 results.extend(input_api.canned_checks.CheckTreeIsOpen(
1168 input_api,
1169 output_api,
1170 json_url='http://chromium-status.appspot.com/current?format=json'))
1171 results.extend(input_api.canned_checks.CheckRietveldTryJobExecution(input_api,
1172 output_api, 'http://codereview.chromium.org',
1173 ('win_rel', 'linux_rel', 'mac_rel, win:compile'),
1174 'tryserver@chromium.org'))
1176 results.extend(input_api.canned_checks.CheckChangeHasBugField(
1177 input_api, output_api))
1178 results.extend(input_api.canned_checks.CheckChangeHasDescription(
1179 input_api, output_api))
1180 results.extend(_CheckSubversionConfig(input_api, output_api))
1181 return results
1184 def GetPreferredTrySlaves(project, change):
1185 files = change.LocalPaths()
1187 if not files or all(re.search(r'[\\/]OWNERS$', f) for f in files):
1188 return []
1190 if all(re.search('\.(m|mm)$|(^|[/_])mac[/_.]', f) for f in files):
1191 return ['mac_rel', 'mac:compile']
1192 if all(re.search('(^|[/_])win[/_.]', f) for f in files):
1193 return ['win_rel', 'win:compile']
1194 if all(re.search('(^|[/_])android[/_.]', f) for f in files):
1195 return ['android_aosp', 'android_dbg', 'android_clang_dbg']
1196 if all(re.search('^native_client_sdk', f) for f in files):
1197 return ['linux_nacl_sdk', 'win_nacl_sdk', 'mac_nacl_sdk']
1198 if all(re.search('[/_]ios[/_.]', f) for f in files):
1199 return ['ios_rel_device', 'ios_dbg_simulator']
1201 trybots = [
1202 'android_clang_dbg',
1203 'android_dbg',
1204 'ios_dbg_simulator',
1205 'ios_rel_device',
1206 'linux_asan',
1207 'linux_aura',
1208 'linux_chromeos',
1209 'linux_clang:compile',
1210 'linux_rel',
1211 'mac_rel',
1212 'mac:compile',
1213 'win_rel',
1214 'win:compile',
1215 'win_x64_rel:base_unittests',
1218 # Match things like path/aura/file.cc and path/file_aura.cc.
1219 # Same for chromeos.
1220 if any(re.search('[/_](aura|chromeos)', f) for f in files):
1221 trybots += ['linux_chromeos_clang:compile', 'linux_chromeos_asan']
1223 # If there are gyp changes to base, build, or chromeos, run a full cros build
1224 # in addition to the shorter linux_chromeos build. Changes to high level gyp
1225 # files have a much higher chance of breaking the cros build, which is
1226 # differnt from the linux_chromeos build that most chrome developers test
1227 # with.
1228 if any(re.search('^(base|build|chromeos).*\.gypi?$', f) for f in files):
1229 trybots += ['cros_x86']
1231 # The AOSP bot doesn't build the chrome/ layer, so ignore any changes to it
1232 # unless they're .gyp(i) files as changes to those files can break the gyp
1233 # step on that bot.
1234 if (not all(re.search('^chrome', f) for f in files) or
1235 any(re.search('\.gypi?$', f) for f in files)):
1236 trybots += ['android_aosp']
1238 return trybots