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.
14 r
"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_rules.py",
15 r
"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_simple.py",
16 r
"^native_client_sdk[\\\/]src[\\\/]tools[\\\/].*.mk",
17 r
"^net[\\\/]tools[\\\/]spdyshark[\\\/].*",
22 r
".+[\\\/]pnacl_shim\.c$",
23 r
"^gpu[\\\/]config[\\\/].*_list_json\.cc$",
24 r
"^chrome[\\\/]browser[\\\/]resources[\\\/]pdf[\\\/]index.js"
27 # The NetscapePlugIn library is excluded from pan-project as it will soon
28 # be deleted together with the rest of the NPAPI and it's not worthwhile to
29 # update the coding style until then.
31 r
"^content[\\\/]shell[\\\/]tools[\\\/]plugin[\\\/].*",
34 # Fragment of a regular expression that matches C++ and Objective-C++
35 # implementation files.
36 _IMPLEMENTATION_EXTENSIONS
= r
'\.(cc|cpp|cxx|mm)$'
38 # Regular expression that matches code only used for test binaries
40 _TEST_CODE_EXCLUDED_PATHS
= (
41 r
'.*[\\\/](fake_|test_|mock_).+%s' % _IMPLEMENTATION_EXTENSIONS
,
42 r
'.+_test_(base|support|util)%s' % _IMPLEMENTATION_EXTENSIONS
,
43 r
'.+_(api|browser|kif|perf|pixel|unit|ui)?test(_[a-z]+)?%s' %
44 _IMPLEMENTATION_EXTENSIONS
,
45 r
'.+profile_sync_service_harness%s' % _IMPLEMENTATION_EXTENSIONS
,
46 r
'.*[\\\/](test|tool(s)?)[\\\/].*',
47 # content_shell is used for running layout tests.
48 r
'content[\\\/]shell[\\\/].*',
49 # At request of folks maintaining this folder.
50 r
'chrome[\\\/]browser[\\\/]automation[\\\/].*',
51 # Non-production example code.
52 r
'mojo[\\\/]examples[\\\/].*',
53 # Launcher for running iOS tests on the simulator.
54 r
'testing[\\\/]iossim[\\\/]iossim\.mm$',
57 _TEST_ONLY_WARNING
= (
58 'You might be calling functions intended only for testing from\n'
59 'production code. It is OK to ignore this warning if you know what\n'
60 'you are doing, as the heuristics used to detect the situation are\n'
61 'not perfect. The commit queue will not block on this warning.')
64 _INCLUDE_ORDER_WARNING
= (
65 'Your #include order seems to be broken. Send mail to\n'
66 'marja@chromium.org if this is not the case.')
69 _BANNED_OBJC_FUNCTIONS
= (
73 'The use of -[NSView addTrackingRect:owner:userData:assumeInside:] is'
74 'prohibited. Please use CrTrackingArea instead.',
75 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
82 'The use of NSTrackingAreas is prohibited. Please use CrTrackingArea',
84 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
89 'convertPointFromBase:',
91 'The use of -[NSView convertPointFromBase:] is almost certainly wrong.',
92 'Please use |convertPoint:(point) fromView:nil| instead.',
93 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
98 'convertPointToBase:',
100 'The use of -[NSView convertPointToBase:] is almost certainly wrong.',
101 'Please use |convertPoint:(point) toView:nil| instead.',
102 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
107 'convertRectFromBase:',
109 'The use of -[NSView convertRectFromBase:] is almost certainly wrong.',
110 'Please use |convertRect:(point) fromView:nil| instead.',
111 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
116 'convertRectToBase:',
118 'The use of -[NSView convertRectToBase:] is almost certainly wrong.',
119 'Please use |convertRect:(point) toView:nil| instead.',
120 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
125 'convertSizeFromBase:',
127 'The use of -[NSView convertSizeFromBase:] is almost certainly wrong.',
128 'Please use |convertSize:(point) fromView:nil| instead.',
129 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
134 'convertSizeToBase:',
136 'The use of -[NSView convertSizeToBase:] is almost certainly wrong.',
137 'Please use |convertSize:(point) toView:nil| instead.',
138 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
145 _BANNED_CPP_FUNCTIONS
= (
146 # Make sure that gtest's FRIEND_TEST() macro is not used; the
147 # FRIEND_TEST_ALL_PREFIXES() macro from base/gtest_prod_util.h should be
148 # used instead since that allows for FLAKY_ and DISABLED_ prefixes.
152 'Chromium code should not use gtest\'s FRIEND_TEST() macro. Include',
153 'base/gtest_prod_util.h and use FRIEND_TEST_ALL_PREFIXES() instead.',
161 'New code should not use ScopedAllowIO. Post a task to the blocking',
162 'pool or the FILE thread instead.',
166 r
"^base[\\\/]process[\\\/]process_metrics_linux\.cc$",
167 r
"^chrome[\\\/]browser[\\\/]chromeos[\\\/]boot_times_recorder\.cc$",
168 r
"^chrome[\\\/]browser[\\\/]chromeos[\\\/]"
169 "customization_document_browsertest\.cc$",
170 r
"^components[\\\/]crash[\\\/]app[\\\/]breakpad_mac\.mm$",
171 r
"^content[\\\/]shell[\\\/]browser[\\\/]shell_browser_main\.cc$",
172 r
"^content[\\\/]shell[\\\/]browser[\\\/]shell_message_filter\.cc$",
173 r
"^mojo[\\\/]edk[\\\/]embedder[\\\/]" +
174 r
"simple_platform_shared_buffer_posix\.cc$",
175 r
"^net[\\\/]disk_cache[\\\/]cache_util\.cc$",
176 r
"^net[\\\/]url_request[\\\/]test_url_fetcher_factory\.cc$",
182 'The use of SkRefPtr is prohibited. ',
183 'Please use skia::RefPtr instead.'
191 'The indirect use of SkRefPtr via SkAutoRef is prohibited. ',
192 'Please use skia::RefPtr instead.'
200 'The use of SkAutoTUnref is dangerous because it implicitly ',
201 'converts to a raw pointer. Please use skia::RefPtr instead.'
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.'
217 r
'/HANDLE_EINTR\(.*close',
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'
228 r
'/IGNORE_EINTR\((?!.*close)',
230 'IGNORE_EINTR is only valid when wrapping close. To wrap other system',
231 'calls, use HANDLE_EINTR. See http://crbug.com/269623',
235 # Files that #define IGNORE_EINTR.
236 r
'^base[\\\/]posix[\\\/]eintr_wrapper\.h$',
237 r
'^ppapi[\\\/]tests[\\\/]test_broker\.cc$',
243 'Do not introduce new v8::Extensions into the code base, use',
244 'gin::Wrappable instead. See http://crbug.com/334679',
248 r
'extensions[\\\/]renderer[\\\/]safe_builtins\.*',
253 _IPC_ENUM_TRAITS_DEPRECATED
= (
254 'You are using IPC_ENUM_TRAITS() in your code. It has been deprecated.\n'
255 'See http://www.chromium.org/Home/chromium-security/education/security-tips-for-ipc')
259 # Please keep sorted.
263 'OS_CAT', # For testing.
280 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api
, output_api
):
281 """Attempts to prevent use of functions intended only for testing in
282 non-testing code. For now this is just a best-effort implementation
283 that ignores header files and may have some false positives. A
284 better implementation would probably need a proper C++ parser.
286 # We only scan .cc files and the like, as the declaration of
287 # for-testing functions in header files are hard to distinguish from
288 # calls to such functions without a proper C++ parser.
289 file_inclusion_pattern
= r
'.+%s' % _IMPLEMENTATION_EXTENSIONS
291 base_function_pattern
= r
'[ :]test::[^\s]+|ForTest(ing)?|for_test(ing)?'
292 inclusion_pattern
= input_api
.re
.compile(r
'(%s)\s*\(' % base_function_pattern
)
293 comment_pattern
= input_api
.re
.compile(r
'//.*(%s)' % base_function_pattern
)
294 exclusion_pattern
= input_api
.re
.compile(
295 r
'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
296 base_function_pattern
, base_function_pattern
))
298 def FilterFile(affected_file
):
299 black_list
= (_EXCLUDED_PATHS
+
300 _TEST_CODE_EXCLUDED_PATHS
+
301 input_api
.DEFAULT_BLACK_LIST
)
302 return input_api
.FilterSourceFile(
304 white_list
=(file_inclusion_pattern
, ),
305 black_list
=black_list
)
308 for f
in input_api
.AffectedSourceFiles(FilterFile
):
309 local_path
= f
.LocalPath()
310 for line_number
, line
in f
.ChangedContents():
311 if (inclusion_pattern
.search(line
) and
312 not comment_pattern
.search(line
) and
313 not exclusion_pattern
.search(line
)):
315 '%s:%d\n %s' % (local_path
, line_number
, line
.strip()))
318 return [output_api
.PresubmitPromptOrNotify(_TEST_ONLY_WARNING
, problems
)]
323 def _CheckNoIOStreamInHeaders(input_api
, output_api
):
324 """Checks to make sure no .h files include <iostream>."""
326 pattern
= input_api
.re
.compile(r
'^#include\s*<iostream>',
327 input_api
.re
.MULTILINE
)
328 for f
in input_api
.AffectedSourceFiles(input_api
.FilterSourceFile
):
329 if not f
.LocalPath().endswith('.h'):
331 contents
= input_api
.ReadFile(f
)
332 if pattern
.search(contents
):
336 return [ output_api
.PresubmitError(
337 'Do not #include <iostream> in header files, since it inserts static '
338 'initialization into every file including the header. Instead, '
339 '#include <ostream>. See http://crbug.com/94794',
344 def _CheckNoUNIT_TESTInSourceFiles(input_api
, output_api
):
345 """Checks to make sure no source files use UNIT_TEST"""
347 for f
in input_api
.AffectedFiles():
348 if (not f
.LocalPath().endswith(('.cc', '.mm'))):
351 for line_num
, line
in f
.ChangedContents():
352 if 'UNIT_TEST ' in line
or line
.endswith('UNIT_TEST'):
353 problems
.append(' %s:%d' % (f
.LocalPath(), line_num
))
357 return [output_api
.PresubmitPromptWarning('UNIT_TEST is only for headers.\n' +
358 '\n'.join(problems
))]
361 def _CheckNoNewWStrings(input_api
, output_api
):
362 """Checks to make sure we don't introduce use of wstrings."""
364 for f
in input_api
.AffectedFiles():
365 if (not f
.LocalPath().endswith(('.cc', '.h')) or
366 f
.LocalPath().endswith(('test.cc', '_win.cc', '_win.h')) or
367 '/win/' in f
.LocalPath()):
371 for line_num
, line
in f
.ChangedContents():
372 if 'presubmit: allow wstring' in line
:
374 elif not allowWString
and 'wstring' in line
:
375 problems
.append(' %s:%d' % (f
.LocalPath(), line_num
))
382 return [output_api
.PresubmitPromptWarning('New code should not use wstrings.'
383 ' If you are calling a cross-platform API that accepts a wstring, '
385 '\n'.join(problems
))]
388 def _CheckNoDEPSGIT(input_api
, output_api
):
389 """Make sure .DEPS.git is never modified manually."""
390 if any(f
.LocalPath().endswith('.DEPS.git') for f
in
391 input_api
.AffectedFiles()):
392 return [output_api
.PresubmitError(
393 'Never commit changes to .DEPS.git. This file is maintained by an\n'
394 'automated system based on what\'s in DEPS and your changes will be\n'
396 'See https://sites.google.com/a/chromium.org/dev/developers/how-tos/get-the-code#Rolling_DEPS\n'
397 'for more information')]
401 def _CheckValidHostsInDEPS(input_api
, output_api
):
402 """Checks that DEPS file deps are from allowed_hosts."""
403 # Run only if DEPS file has been modified to annoy fewer bystanders.
404 if all(f
.LocalPath() != 'DEPS' for f
in input_api
.AffectedFiles()):
406 # Outsource work to gclient verify
408 input_api
.subprocess
.check_output(['gclient', 'verify'])
410 except input_api
.subprocess
.CalledProcessError
, error
:
411 return [output_api
.PresubmitError(
412 'DEPS file must have only git dependencies.',
413 long_text
=error
.output
)]
416 def _CheckNoBannedFunctions(input_api
, output_api
):
417 """Make sure that banned functions are not used."""
421 file_filter
= lambda f
: f
.LocalPath().endswith(('.mm', '.m', '.h'))
422 for f
in input_api
.AffectedFiles(file_filter
=file_filter
):
423 for line_num
, line
in f
.ChangedContents():
424 for func_name
, message
, error
in _BANNED_OBJC_FUNCTIONS
:
426 if func_name
[0:1] == '/':
427 regex
= func_name
[1:]
428 if input_api
.re
.search(regex
, line
):
430 elif func_name
in line
:
436 problems
.append(' %s:%d:' % (f
.LocalPath(), line_num
))
437 for message_line
in message
:
438 problems
.append(' %s' % message_line
)
440 file_filter
= lambda f
: f
.LocalPath().endswith(('.cc', '.mm', '.h'))
441 for f
in input_api
.AffectedFiles(file_filter
=file_filter
):
442 for line_num
, line
in f
.ChangedContents():
443 for func_name
, message
, error
, excluded_paths
in _BANNED_CPP_FUNCTIONS
:
444 def IsBlacklisted(affected_file
, blacklist
):
445 local_path
= affected_file
.LocalPath()
446 for item
in blacklist
:
447 if input_api
.re
.match(item
, local_path
):
450 if IsBlacklisted(f
, excluded_paths
):
453 if func_name
[0:1] == '/':
454 regex
= func_name
[1:]
455 if input_api
.re
.search(regex
, line
):
457 elif func_name
in line
:
463 problems
.append(' %s:%d:' % (f
.LocalPath(), line_num
))
464 for message_line
in message
:
465 problems
.append(' %s' % message_line
)
469 result
.append(output_api
.PresubmitPromptWarning(
470 'Banned functions were used.\n' + '\n'.join(warnings
)))
472 result
.append(output_api
.PresubmitError(
473 'Banned functions were used.\n' + '\n'.join(errors
)))
477 def _CheckNoPragmaOnce(input_api
, output_api
):
478 """Make sure that banned functions are not used."""
480 pattern
= input_api
.re
.compile(r
'^#pragma\s+once',
481 input_api
.re
.MULTILINE
)
482 for f
in input_api
.AffectedSourceFiles(input_api
.FilterSourceFile
):
483 if not f
.LocalPath().endswith('.h'):
485 contents
= input_api
.ReadFile(f
)
486 if pattern
.search(contents
):
490 return [output_api
.PresubmitError(
491 'Do not use #pragma once in header files.\n'
492 'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
497 def _CheckNoTrinaryTrueFalse(input_api
, output_api
):
498 """Checks to make sure we don't introduce use of foo ? true : false."""
500 pattern
= input_api
.re
.compile(r
'\?\s*(true|false)\s*:\s*(true|false)')
501 for f
in input_api
.AffectedFiles():
502 if not f
.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
505 for line_num
, line
in f
.ChangedContents():
506 if pattern
.match(line
):
507 problems
.append(' %s:%d' % (f
.LocalPath(), line_num
))
511 return [output_api
.PresubmitPromptWarning(
512 'Please consider avoiding the "? true : false" pattern if possible.\n' +
513 '\n'.join(problems
))]
516 def _CheckUnwantedDependencies(input_api
, output_api
):
517 """Runs checkdeps on #include statements added in this
518 change. Breaking - rules is an error, breaking ! rules is a
522 # We need to wait until we have an input_api object and use this
523 # roundabout construct to import checkdeps because this file is
524 # eval-ed and thus doesn't have __file__.
525 original_sys_path
= sys
.path
527 sys
.path
= sys
.path
+ [input_api
.os_path
.join(
528 input_api
.PresubmitLocalPath(), 'buildtools', 'checkdeps')]
530 from cpp_checker
import CppChecker
531 from rules
import Rule
533 # Restore sys.path to what it was before.
534 sys
.path
= original_sys_path
537 for f
in input_api
.AffectedFiles():
538 if not CppChecker
.IsCppFile(f
.LocalPath()):
541 changed_lines
= [line
for line_num
, line
in f
.ChangedContents()]
542 added_includes
.append([f
.LocalPath(), changed_lines
])
544 deps_checker
= checkdeps
.DepsChecker(input_api
.PresubmitLocalPath())
546 error_descriptions
= []
547 warning_descriptions
= []
548 for path
, rule_type
, rule_description
in deps_checker
.CheckAddedCppIncludes(
550 description_with_path
= '%s\n %s' % (path
, rule_description
)
551 if rule_type
== Rule
.DISALLOW
:
552 error_descriptions
.append(description_with_path
)
554 warning_descriptions
.append(description_with_path
)
557 if error_descriptions
:
558 results
.append(output_api
.PresubmitError(
559 'You added one or more #includes that violate checkdeps rules.',
561 if warning_descriptions
:
562 results
.append(output_api
.PresubmitPromptOrNotify(
563 'You added one or more #includes of files that are temporarily\n'
564 'allowed but being removed. Can you avoid introducing the\n'
565 '#include? See relevant DEPS file(s) for details and contacts.',
566 warning_descriptions
))
570 def _CheckFilePermissions(input_api
, output_api
):
571 """Check that all files have their permissions properly set."""
572 if input_api
.platform
== 'win32':
574 args
= [input_api
.python_executable
, 'tools/checkperms/checkperms.py',
575 '--root', input_api
.change
.RepositoryRoot()]
576 for f
in input_api
.AffectedFiles():
577 args
+= ['--file', f
.LocalPath()]
578 checkperms
= input_api
.subprocess
.Popen(args
,
579 stdout
=input_api
.subprocess
.PIPE
)
580 errors
= checkperms
.communicate()[0].strip()
582 return [output_api
.PresubmitError('checkperms.py failed.',
583 errors
.splitlines())]
587 def _CheckNoAuraWindowPropertyHInHeaders(input_api
, output_api
):
588 """Makes sure we don't include ui/aura/window_property.h
591 pattern
= input_api
.re
.compile(r
'^#include\s*"ui/aura/window_property.h"')
593 for f
in input_api
.AffectedFiles():
594 if not f
.LocalPath().endswith('.h'):
596 for line_num
, line
in f
.ChangedContents():
597 if pattern
.match(line
):
598 errors
.append(' %s:%d' % (f
.LocalPath(), line_num
))
602 results
.append(output_api
.PresubmitError(
603 'Header files should not include ui/aura/window_property.h', errors
))
607 def _CheckIncludeOrderForScope(scope
, input_api
, file_path
, changed_linenums
):
608 """Checks that the lines in scope occur in the right order.
610 1. C system files in alphabetical order
611 2. C++ system files in alphabetical order
612 3. Project's .h files
615 c_system_include_pattern
= input_api
.re
.compile(r
'\s*#include <.*\.h>')
616 cpp_system_include_pattern
= input_api
.re
.compile(r
'\s*#include <.*>')
617 custom_include_pattern
= input_api
.re
.compile(r
'\s*#include ".*')
619 C_SYSTEM_INCLUDES
, CPP_SYSTEM_INCLUDES
, CUSTOM_INCLUDES
= range(3)
621 state
= C_SYSTEM_INCLUDES
624 previous_line_num
= 0
625 problem_linenums
= []
626 for line_num
, line
in scope
:
627 if c_system_include_pattern
.match(line
):
628 if state
!= C_SYSTEM_INCLUDES
:
629 problem_linenums
.append((line_num
, previous_line_num
))
630 elif previous_line
and previous_line
> line
:
631 problem_linenums
.append((line_num
, previous_line_num
))
632 elif cpp_system_include_pattern
.match(line
):
633 if state
== C_SYSTEM_INCLUDES
:
634 state
= CPP_SYSTEM_INCLUDES
635 elif state
== CUSTOM_INCLUDES
:
636 problem_linenums
.append((line_num
, previous_line_num
))
637 elif previous_line
and previous_line
> line
:
638 problem_linenums
.append((line_num
, previous_line_num
))
639 elif custom_include_pattern
.match(line
):
640 if state
!= CUSTOM_INCLUDES
:
641 state
= CUSTOM_INCLUDES
642 elif previous_line
and previous_line
> line
:
643 problem_linenums
.append((line_num
, previous_line_num
))
645 problem_linenums
.append(line_num
)
647 previous_line_num
= line_num
650 for (line_num
, previous_line_num
) in problem_linenums
:
651 if line_num
in changed_linenums
or previous_line_num
in changed_linenums
:
652 warnings
.append(' %s:%d' % (file_path
, line_num
))
656 def _CheckIncludeOrderInFile(input_api
, f
, changed_linenums
):
657 """Checks the #include order for the given file f."""
659 system_include_pattern
= input_api
.re
.compile(r
'\s*#include \<.*')
660 # Exclude the following includes from the check:
661 # 1) #include <.../...>, e.g., <sys/...> includes often need to appear in a
663 # 2) <atlbase.h>, "build/build_config.h"
664 excluded_include_pattern
= input_api
.re
.compile(
665 r
'\s*#include (\<.*/.*|\<atlbase\.h\>|"build/build_config.h")')
666 custom_include_pattern
= input_api
.re
.compile(r
'\s*#include "(?P<FILE>.*)"')
667 # Match the final or penultimate token if it is xxxtest so we can ignore it
668 # when considering the special first include.
669 test_file_tag_pattern
= input_api
.re
.compile(
670 r
'_[a-z]+test(?=(_[a-zA-Z0-9]+)?\.)')
671 if_pattern
= input_api
.re
.compile(
672 r
'\s*#\s*(if|elif|else|endif|define|undef).*')
673 # Some files need specialized order of includes; exclude such files from this
675 uncheckable_includes_pattern
= input_api
.re
.compile(
677 '("ipc/.*macros\.h"|<windows\.h>|".*gl.*autogen.h")\s*')
679 contents
= f
.NewContents()
683 # Handle the special first include. If the first include file is
684 # some/path/file.h, the corresponding including file can be some/path/file.cc,
685 # some/other/path/file.cc, some/path/file_platform.cc, some/path/file-suffix.h
686 # etc. It's also possible that no special first include exists.
687 # If the included file is some/path/file_platform.h the including file could
688 # also be some/path/file_xxxtest_platform.h.
689 including_file_base_name
= test_file_tag_pattern
.sub(
690 '', input_api
.os_path
.basename(f
.LocalPath()))
692 for line
in contents
:
694 if system_include_pattern
.match(line
):
695 # No special first include -> process the line again along with normal
699 match
= custom_include_pattern
.match(line
)
701 match_dict
= match
.groupdict()
702 header_basename
= test_file_tag_pattern
.sub(
703 '', input_api
.os_path
.basename(match_dict
['FILE'])).replace('.h', '')
705 if header_basename
not in including_file_base_name
:
706 # No special first include -> process the line again along with normal
711 # Split into scopes: Each region between #if and #endif is its own scope.
714 for line
in contents
[line_num
:]:
716 if uncheckable_includes_pattern
.match(line
):
718 if if_pattern
.match(line
):
719 scopes
.append(current_scope
)
721 elif ((system_include_pattern
.match(line
) or
722 custom_include_pattern
.match(line
)) and
723 not excluded_include_pattern
.match(line
)):
724 current_scope
.append((line_num
, line
))
725 scopes
.append(current_scope
)
728 warnings
.extend(_CheckIncludeOrderForScope(scope
, input_api
, f
.LocalPath(),
733 def _CheckIncludeOrder(input_api
, output_api
):
734 """Checks that the #include order is correct.
736 1. The corresponding header for source files.
737 2. C system files in alphabetical order
738 3. C++ system files in alphabetical order
739 4. Project's .h files in alphabetical order
741 Each region separated by #if, #elif, #else, #endif, #define and #undef follows
742 these rules separately.
744 def FileFilterIncludeOrder(affected_file
):
745 black_list
= (_EXCLUDED_PATHS
+ input_api
.DEFAULT_BLACK_LIST
)
746 return input_api
.FilterSourceFile(affected_file
, black_list
=black_list
)
749 for f
in input_api
.AffectedFiles(file_filter
=FileFilterIncludeOrder
):
750 if f
.LocalPath().endswith(('.cc', '.h')):
751 changed_linenums
= set(line_num
for line_num
, _
in f
.ChangedContents())
752 warnings
.extend(_CheckIncludeOrderInFile(input_api
, f
, changed_linenums
))
756 results
.append(output_api
.PresubmitPromptOrNotify(_INCLUDE_ORDER_WARNING
,
761 def _CheckForVersionControlConflictsInFile(input_api
, f
):
762 pattern
= input_api
.re
.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
764 for line_num
, line
in f
.ChangedContents():
765 if pattern
.match(line
):
766 errors
.append(' %s:%d %s' % (f
.LocalPath(), line_num
, line
))
770 def _CheckForVersionControlConflicts(input_api
, output_api
):
771 """Usually this is not intentional and will cause a compile failure."""
773 for f
in input_api
.AffectedFiles():
774 errors
.extend(_CheckForVersionControlConflictsInFile(input_api
, f
))
778 results
.append(output_api
.PresubmitError(
779 'Version control conflict markers found, please resolve.', errors
))
783 def _CheckHardcodedGoogleHostsInLowerLayers(input_api
, output_api
):
784 def FilterFile(affected_file
):
785 """Filter function for use with input_api.AffectedSourceFiles,
786 below. This filters out everything except non-test files from
787 top-level directories that generally speaking should not hard-code
788 service URLs (e.g. src/android_webview/, src/content/ and others).
790 return input_api
.FilterSourceFile(
792 white_list
=(r
'^(android_webview|base|content|net)[\\\/].*', ),
793 black_list
=(_EXCLUDED_PATHS
+
794 _TEST_CODE_EXCLUDED_PATHS
+
795 input_api
.DEFAULT_BLACK_LIST
))
797 base_pattern
= '"[^"]*google\.com[^"]*"'
798 comment_pattern
= input_api
.re
.compile('//.*%s' % base_pattern
)
799 pattern
= input_api
.re
.compile(base_pattern
)
800 problems
= [] # items are (filename, line_number, line)
801 for f
in input_api
.AffectedSourceFiles(FilterFile
):
802 for line_num
, line
in f
.ChangedContents():
803 if not comment_pattern
.search(line
) and pattern
.search(line
):
804 problems
.append((f
.LocalPath(), line_num
, line
))
807 return [output_api
.PresubmitPromptOrNotify(
808 'Most layers below src/chrome/ should not hardcode service URLs.\n'
809 'Are you sure this is correct?',
811 problem
[0], problem
[1], problem
[2]) for problem
in problems
])]
816 def _CheckNoAbbreviationInPngFileName(input_api
, output_api
):
817 """Makes sure there are no abbreviations in the name of PNG files.
818 The native_client_sdk directory is excluded because it has auto-generated PNG
819 files for documentation.
822 white_list
= (r
'.*_[a-z]_.*\.png$|.*_[a-z]\.png$',)
823 black_list
= (r
'^native_client_sdk[\\\/]',)
824 file_filter
= lambda f
: input_api
.FilterSourceFile(
825 f
, white_list
=white_list
, black_list
=black_list
)
826 for f
in input_api
.AffectedFiles(include_deletes
=False,
827 file_filter
=file_filter
):
828 errors
.append(' %s' % f
.LocalPath())
832 results
.append(output_api
.PresubmitError(
833 'The name of PNG files should not have abbreviations. \n'
834 'Use _hover.png, _center.png, instead of _h.png, _c.png.\n'
835 'Contact oshima@chromium.org if you have questions.', errors
))
839 def _FilesToCheckForIncomingDeps(re
, changed_lines
):
840 """Helper method for _CheckAddedDepsHaveTargetApprovals. Returns
841 a set of DEPS entries that we should look up.
843 For a directory (rather than a specific filename) we fake a path to
844 a specific filename by adding /DEPS. This is chosen as a file that
845 will seldom or never be subject to per-file include_rules.
847 # We ignore deps entries on auto-generated directories.
848 AUTO_GENERATED_DIRS
= ['grit', 'jni']
850 # This pattern grabs the path without basename in the first
851 # parentheses, and the basename (if present) in the second. It
852 # relies on the simple heuristic that if there is a basename it will
853 # be a header file ending in ".h".
854 pattern
= re
.compile(
855 r
"""['"]\+([^'"]+?)(/[a-zA-Z0-9_]+\.h)?['"].*""")
857 for changed_line
in changed_lines
:
858 m
= pattern
.match(changed_line
)
861 if path
.split('/')[0] not in AUTO_GENERATED_DIRS
:
863 results
.add('%s%s' % (path
, m
.group(2)))
865 results
.add('%s/DEPS' % path
)
869 def _CheckAddedDepsHaveTargetApprovals(input_api
, output_api
):
870 """When a dependency prefixed with + is added to a DEPS file, we
871 want to make sure that the change is reviewed by an OWNER of the
872 target file or directory, to avoid layering violations from being
873 introduced. This check verifies that this happens.
875 changed_lines
= set()
876 for f
in input_api
.AffectedFiles():
877 filename
= input_api
.os_path
.basename(f
.LocalPath())
878 if filename
== 'DEPS':
879 changed_lines |
= set(line
.strip()
881 in f
.ChangedContents())
882 if not changed_lines
:
885 virtual_depended_on_files
= _FilesToCheckForIncomingDeps(input_api
.re
,
887 if not virtual_depended_on_files
:
890 if input_api
.is_committing
:
892 return [output_api
.PresubmitNotifyResult(
893 '--tbr was specified, skipping OWNERS check for DEPS additions')]
894 if not input_api
.change
.issue
:
895 return [output_api
.PresubmitError(
896 "DEPS approval by OWNERS check failed: this change has "
897 "no Rietveld issue number, so we can't check it for approvals.")]
898 output
= output_api
.PresubmitError
900 output
= output_api
.PresubmitNotifyResult
902 owners_db
= input_api
.owners_db
903 owner_email
, reviewers
= input_api
.canned_checks
._RietveldOwnerAndReviewers
(
905 owners_db
.email_regexp
,
906 approval_needed
=input_api
.is_committing
)
908 owner_email
= owner_email
or input_api
.change
.author_email
910 reviewers_plus_owner
= set(reviewers
)
912 reviewers_plus_owner
.add(owner_email
)
913 missing_files
= owners_db
.files_not_covered_by(virtual_depended_on_files
,
914 reviewers_plus_owner
)
916 # We strip the /DEPS part that was added by
917 # _FilesToCheckForIncomingDeps to fake a path to a file in a
920 start_deps
= path
.rfind('/DEPS')
922 return path
[:start_deps
]
925 unapproved_dependencies
= ["'+%s'," % StripDeps(path
)
926 for path
in missing_files
]
928 if unapproved_dependencies
:
930 output('Missing LGTM from OWNERS of dependencies added to DEPS:\n %s' %
931 '\n '.join(sorted(unapproved_dependencies
)))]
932 if not input_api
.is_committing
:
933 suggested_owners
= owners_db
.reviewers_for(missing_files
, owner_email
)
934 output_list
.append(output(
935 'Suggested missing target path OWNERS:\n %s' %
936 '\n '.join(suggested_owners
or [])))
942 def _CheckSpamLogging(input_api
, output_api
):
943 file_inclusion_pattern
= r
'.+%s' % _IMPLEMENTATION_EXTENSIONS
944 black_list
= (_EXCLUDED_PATHS
+
945 _TEST_CODE_EXCLUDED_PATHS
+
946 input_api
.DEFAULT_BLACK_LIST
+
947 (r
"^base[\\\/]logging\.h$",
948 r
"^base[\\\/]logging\.cc$",
949 r
"^chrome[\\\/]app[\\\/]chrome_main_delegate\.cc$",
950 r
"^chrome[\\\/]browser[\\\/]chrome_browser_main\.cc$",
951 r
"^chrome[\\\/]browser[\\\/]ui[\\\/]startup[\\\/]"
952 r
"startup_browser_creator\.cc$",
953 r
"^chrome[\\\/]installer[\\\/]setup[\\\/].*",
954 r
"chrome[\\\/]browser[\\\/]diagnostics[\\\/]" +
955 r
"diagnostics_writer\.cc$",
956 r
"^chrome_elf[\\\/]dll_hash[\\\/]dll_hash_main\.cc$",
957 r
"^chromecast[\\\/]",
958 r
"^cloud_print[\\\/]",
959 r
"^content[\\\/]common[\\\/]gpu[\\\/]client[\\\/]"
960 r
"gl_helper_benchmark\.cc$",
961 r
"^courgette[\\\/]courgette_tool\.cc$",
962 r
"^extensions[\\\/]renderer[\\\/]logging_native_handler\.cc$",
963 r
"^ipc[\\\/]ipc_logging\.cc$",
964 r
"^native_client_sdk[\\\/]",
965 r
"^remoting[\\\/]base[\\\/]logging\.h$",
966 r
"^remoting[\\\/]host[\\\/].*",
967 r
"^sandbox[\\\/]linux[\\\/].*",
969 r
"^ui[\\\/]aura[\\\/]bench[\\\/]bench_main\.cc$",
970 r
"^storage[\\\/]browser[\\\/]fileapi[\\\/]" +
971 r
"dump_file_system.cc$",))
972 source_file_filter
= lambda x
: input_api
.FilterSourceFile(
973 x
, white_list
=(file_inclusion_pattern
,), black_list
=black_list
)
978 for f
in input_api
.AffectedSourceFiles(source_file_filter
):
979 contents
= input_api
.ReadFile(f
, 'rb')
980 if input_api
.re
.search(r
"\bD?LOG\s*\(\s*INFO\s*\)", contents
):
981 log_info
.append(f
.LocalPath())
982 elif input_api
.re
.search(r
"\bD?LOG_IF\s*\(\s*INFO\s*,", contents
):
983 log_info
.append(f
.LocalPath())
985 if input_api
.re
.search(r
"\bprintf\(", contents
):
986 printf
.append(f
.LocalPath())
987 elif input_api
.re
.search(r
"\bfprintf\((stdout|stderr)", contents
):
988 printf
.append(f
.LocalPath())
991 return [output_api
.PresubmitError(
992 'These files spam the console log with LOG(INFO):',
995 return [output_api
.PresubmitError(
996 'These files spam the console log with printf/fprintf:',
1001 def _CheckForAnonymousVariables(input_api
, output_api
):
1002 """These types are all expected to hold locks while in scope and
1003 so should never be anonymous (which causes them to be immediately
1005 they_who_must_be_named
= [
1009 'SkAutoAlphaRestore',
1010 'SkAutoBitmapShaderInstall',
1011 'SkAutoBlitterChoose',
1012 'SkAutoBounderCommit',
1014 'SkAutoCanvasRestore',
1015 'SkAutoCommentBlock',
1017 'SkAutoDisableDirectionCheck',
1018 'SkAutoDisableOvalCheck',
1025 'SkAutoMaskFreeImage',
1026 'SkAutoMutexAcquire',
1027 'SkAutoPathBoundsUpdate',
1029 'SkAutoRasterClipValidate',
1035 anonymous
= r
'(%s)\s*[({]' % '|'.join(they_who_must_be_named
)
1036 # bad: base::AutoLock(lock.get());
1037 # not bad: base::AutoLock lock(lock.get());
1038 bad_pattern
= input_api
.re
.compile(anonymous
)
1039 # good: new base::AutoLock(lock.get())
1040 good_pattern
= input_api
.re
.compile(r
'\bnew\s*' + anonymous
)
1043 for f
in input_api
.AffectedFiles():
1044 if not f
.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
1046 for linenum
, line
in f
.ChangedContents():
1047 if bad_pattern
.search(line
) and not good_pattern
.search(line
):
1048 errors
.append('%s:%d' % (f
.LocalPath(), linenum
))
1051 return [output_api
.PresubmitError(
1052 'These lines create anonymous variables that need to be named:',
1057 def _CheckCygwinShell(input_api
, output_api
):
1058 source_file_filter
= lambda x
: input_api
.FilterSourceFile(
1059 x
, white_list
=(r
'.+\.(gyp|gypi)$',))
1062 for f
in input_api
.AffectedSourceFiles(source_file_filter
):
1063 for linenum
, line
in f
.ChangedContents():
1064 if 'msvs_cygwin_shell' in line
:
1065 cygwin_shell
.append(f
.LocalPath())
1069 return [output_api
.PresubmitError(
1070 'These files should not use msvs_cygwin_shell (the default is 0):',
1071 items
=cygwin_shell
)]
1075 def _CheckUserActionUpdate(input_api
, output_api
):
1076 """Checks if any new user action has been added."""
1077 if any('actions.xml' == input_api
.os_path
.basename(f
) for f
in
1078 input_api
.LocalPaths()):
1079 # If actions.xml is already included in the changelist, the PRESUBMIT
1080 # for actions.xml will do a more complete presubmit check.
1083 file_filter
= lambda f
: f
.LocalPath().endswith(('.cc', '.mm'))
1084 action_re
= r
'[^a-zA-Z]UserMetricsAction\("([^"]*)'
1085 current_actions
= None
1086 for f
in input_api
.AffectedFiles(file_filter
=file_filter
):
1087 for line_num
, line
in f
.ChangedContents():
1088 match
= input_api
.re
.search(action_re
, line
)
1090 # Loads contents in tools/metrics/actions/actions.xml to memory. It's
1092 if not current_actions
:
1093 with
open('tools/metrics/actions/actions.xml') as actions_f
:
1094 current_actions
= actions_f
.read()
1095 # Search for the matched user action name in |current_actions|.
1096 for action_name
in match
.groups():
1097 action
= 'name="{0}"'.format(action_name
)
1098 if action
not in current_actions
:
1099 return [output_api
.PresubmitPromptWarning(
1100 'File %s line %d: %s is missing in '
1101 'tools/metrics/actions/actions.xml. Please run '
1102 'tools/metrics/actions/extract_actions.py to update.'
1103 % (f
.LocalPath(), line_num
, action_name
))]
1107 def _GetJSONParseError(input_api
, filename
, eat_comments
=True):
1109 contents
= input_api
.ReadFile(filename
)
1111 json_comment_eater
= input_api
.os_path
.join(
1112 input_api
.PresubmitLocalPath(),
1113 'tools', 'json_comment_eater', 'json_comment_eater.py')
1114 process
= input_api
.subprocess
.Popen(
1115 [input_api
.python_executable
, json_comment_eater
],
1116 stdin
=input_api
.subprocess
.PIPE
,
1117 stdout
=input_api
.subprocess
.PIPE
,
1118 universal_newlines
=True)
1119 (contents
, _
) = process
.communicate(input=contents
)
1121 input_api
.json
.loads(contents
)
1122 except ValueError as e
:
1127 def _GetIDLParseError(input_api
, filename
):
1129 contents
= input_api
.ReadFile(filename
)
1130 idl_schema
= input_api
.os_path
.join(
1131 input_api
.PresubmitLocalPath(),
1132 'tools', 'json_schema_compiler', 'idl_schema.py')
1133 process
= input_api
.subprocess
.Popen(
1134 [input_api
.python_executable
, idl_schema
],
1135 stdin
=input_api
.subprocess
.PIPE
,
1136 stdout
=input_api
.subprocess
.PIPE
,
1137 stderr
=input_api
.subprocess
.PIPE
,
1138 universal_newlines
=True)
1139 (_
, error
) = process
.communicate(input=contents
)
1140 return error
or None
1141 except ValueError as e
:
1145 def _CheckParseErrors(input_api
, output_api
):
1146 """Check that IDL and JSON files do not contain syntax errors."""
1148 '.idl': _GetIDLParseError
,
1149 '.json': _GetJSONParseError
,
1151 # These paths contain test data and other known invalid JSON files.
1152 excluded_patterns
= [
1153 r
'test[\\\/]data[\\\/]',
1154 r
'^components[\\\/]policy[\\\/]resources[\\\/]policy_templates\.json$',
1156 # Most JSON files are preprocessed and support comments, but these do not.
1157 json_no_comments_patterns
= [
1160 # Only run IDL checker on files in these directories.
1161 idl_included_patterns
= [
1162 r
'^chrome[\\\/]common[\\\/]extensions[\\\/]api[\\\/]',
1163 r
'^extensions[\\\/]common[\\\/]api[\\\/]',
1166 def get_action(affected_file
):
1167 filename
= affected_file
.LocalPath()
1168 return actions
.get(input_api
.os_path
.splitext(filename
)[1])
1170 def MatchesFile(patterns
, path
):
1171 for pattern
in patterns
:
1172 if input_api
.re
.search(pattern
, path
):
1176 def FilterFile(affected_file
):
1177 action
= get_action(affected_file
)
1180 path
= affected_file
.LocalPath()
1182 if MatchesFile(excluded_patterns
, path
):
1185 if (action
== _GetIDLParseError
and
1186 not MatchesFile(idl_included_patterns
, path
)):
1191 for affected_file
in input_api
.AffectedFiles(
1192 file_filter
=FilterFile
, include_deletes
=False):
1193 action
= get_action(affected_file
)
1195 if (action
== _GetJSONParseError
and
1196 MatchesFile(json_no_comments_patterns
, affected_file
.LocalPath())):
1197 kwargs
['eat_comments'] = False
1198 parse_error
= action(input_api
,
1199 affected_file
.AbsoluteLocalPath(),
1202 results
.append(output_api
.PresubmitError('%s could not be parsed: %s' %
1203 (affected_file
.LocalPath(), parse_error
)))
1207 def _CheckJavaStyle(input_api
, output_api
):
1208 """Runs checkstyle on changed java files and returns errors if any exist."""
1210 original_sys_path
= sys
.path
1212 sys
.path
= sys
.path
+ [input_api
.os_path
.join(
1213 input_api
.PresubmitLocalPath(), 'tools', 'android', 'checkstyle')]
1216 # Restore sys.path to what it was before.
1217 sys
.path
= original_sys_path
1219 return checkstyle
.RunCheckstyle(
1220 input_api
, output_api
, 'tools/android/checkstyle/chromium-style-5.0.xml',
1221 black_list
=_EXCLUDED_PATHS
)
1224 def _CheckForCopyrightedCode(input_api
, output_api
):
1225 """Verifies that newly added code doesn't contain copyrighted material
1226 and is properly licensed under the standard Chromium license.
1228 As there can be false positives, we maintain a whitelist file. This check
1229 also verifies that the whitelist file is up to date.
1232 original_sys_path
= sys
.path
1234 sys
.path
= sys
.path
+ [input_api
.os_path
.join(
1235 input_api
.PresubmitLocalPath(), 'android_webview', 'tools')]
1236 import copyright_scanner
1238 # Restore sys.path to what it was before.
1239 sys
.path
= original_sys_path
1241 return copyright_scanner
.ScanAtPresubmit(input_api
, output_api
)
1246 ( "-webkit-box", "flex" ),
1247 ( "-webkit-inline-box", "inline-flex" ),
1248 ( "-webkit-flex", "flex" ),
1249 ( "-webkit-inline-flex", "inline-flex" ),
1250 ( "-webkit-min-content", "min-content" ),
1251 ( "-webkit-max-content", "max-content" ),
1254 ( "-webkit-background-clip", "background-clip" ),
1255 ( "-webkit-background-origin", "background-origin" ),
1256 ( "-webkit-background-size", "background-size" ),
1257 ( "-webkit-box-shadow", "box-shadow" ),
1260 ( "-webkit-gradient", "gradient" ),
1261 ( "-webkit-repeating-gradient", "repeating-gradient" ),
1262 ( "-webkit-linear-gradient", "linear-gradient" ),
1263 ( "-webkit-repeating-linear-gradient", "repeating-linear-gradient" ),
1264 ( "-webkit-radial-gradient", "radial-gradient" ),
1265 ( "-webkit-repeating-radial-gradient", "repeating-radial-gradient" ),
1268 def _CheckNoDeprecatedCSS(input_api
, output_api
):
1269 """ Make sure that we don't use deprecated CSS
1270 properties, functions or values. Our external
1271 documentation is ignored by the hooks as it
1272 needs to be consumed by WebKit. """
1274 file_inclusion_pattern
= (r
".+\.css$",)
1275 black_list
= (_EXCLUDED_PATHS
+
1276 _TEST_CODE_EXCLUDED_PATHS
+
1277 input_api
.DEFAULT_BLACK_LIST
+
1278 (r
"^chrome/common/extensions/docs",
1280 r
"^native_client_sdk"))
1281 file_filter
= lambda f
: input_api
.FilterSourceFile(
1282 f
, white_list
=file_inclusion_pattern
, black_list
=black_list
)
1283 for fpath
in input_api
.AffectedFiles(file_filter
=file_filter
):
1284 for line_num
, line
in fpath
.ChangedContents():
1285 for (deprecated_value
, value
) in _DEPRECATED_CSS
:
1286 if deprecated_value
in line
:
1287 results
.append(output_api
.PresubmitError(
1288 "%s:%d: Use of deprecated CSS %s, use %s instead" %
1289 (fpath
.LocalPath(), line_num
, deprecated_value
, value
)))
1294 ( "__lookupGetter__", "Object.getOwnPropertyDescriptor" ),
1295 ( "__defineGetter__", "Object.defineProperty" ),
1296 ( "__defineSetter__", "Object.defineProperty" ),
1299 def _CheckNoDeprecatedJS(input_api
, output_api
):
1300 """Make sure that we don't use deprecated JS in Chrome code."""
1302 file_inclusion_pattern
= (r
".+\.js$",) # TODO(dbeam): .html?
1303 black_list
= (_EXCLUDED_PATHS
+ _TEST_CODE_EXCLUDED_PATHS
+
1304 input_api
.DEFAULT_BLACK_LIST
)
1305 file_filter
= lambda f
: input_api
.FilterSourceFile(
1306 f
, white_list
=file_inclusion_pattern
, black_list
=black_list
)
1307 for fpath
in input_api
.AffectedFiles(file_filter
=file_filter
):
1308 for lnum
, line
in fpath
.ChangedContents():
1309 for (deprecated
, replacement
) in _DEPRECATED_JS
:
1310 if deprecated
in line
:
1311 results
.append(output_api
.PresubmitError(
1312 "%s:%d: Use of deprecated JS %s, use %s instead" %
1313 (fpath
.LocalPath(), lnum
, deprecated
, replacement
)))
1317 def _CommonChecks(input_api
, output_api
):
1318 """Checks common to both upload and commit."""
1320 results
.extend(input_api
.canned_checks
.PanProjectChecks(
1321 input_api
, output_api
,
1322 excluded_paths
=_EXCLUDED_PATHS
+ _TESTRUNNER_PATHS
))
1323 results
.extend(_CheckAuthorizedAuthor(input_api
, output_api
))
1325 _CheckNoProductionCodeUsingTestOnlyFunctions(input_api
, output_api
))
1326 results
.extend(_CheckNoIOStreamInHeaders(input_api
, output_api
))
1327 results
.extend(_CheckNoUNIT_TESTInSourceFiles(input_api
, output_api
))
1328 results
.extend(_CheckNoNewWStrings(input_api
, output_api
))
1329 results
.extend(_CheckNoDEPSGIT(input_api
, output_api
))
1330 results
.extend(_CheckNoBannedFunctions(input_api
, output_api
))
1331 results
.extend(_CheckNoPragmaOnce(input_api
, output_api
))
1332 results
.extend(_CheckNoTrinaryTrueFalse(input_api
, output_api
))
1333 results
.extend(_CheckUnwantedDependencies(input_api
, output_api
))
1334 results
.extend(_CheckFilePermissions(input_api
, output_api
))
1335 results
.extend(_CheckNoAuraWindowPropertyHInHeaders(input_api
, output_api
))
1336 results
.extend(_CheckIncludeOrder(input_api
, output_api
))
1337 results
.extend(_CheckForVersionControlConflicts(input_api
, output_api
))
1338 results
.extend(_CheckPatchFiles(input_api
, output_api
))
1339 results
.extend(_CheckHardcodedGoogleHostsInLowerLayers(input_api
, output_api
))
1340 results
.extend(_CheckNoAbbreviationInPngFileName(input_api
, output_api
))
1341 results
.extend(_CheckForInvalidOSMacros(input_api
, output_api
))
1342 results
.extend(_CheckForInvalidIfDefinedMacros(input_api
, output_api
))
1343 # TODO(danakj): Remove this when base/move.h is removed.
1344 results
.extend(_CheckForUsingSideEffectsOfPass(input_api
, output_api
))
1345 results
.extend(_CheckAddedDepsHaveTargetApprovals(input_api
, output_api
))
1347 input_api
.canned_checks
.CheckChangeHasNoTabs(
1350 source_file_filter
=lambda x
: x
.LocalPath().endswith('.grd')))
1351 results
.extend(_CheckSpamLogging(input_api
, output_api
))
1352 results
.extend(_CheckForAnonymousVariables(input_api
, output_api
))
1353 results
.extend(_CheckCygwinShell(input_api
, output_api
))
1354 results
.extend(_CheckUserActionUpdate(input_api
, output_api
))
1355 results
.extend(_CheckNoDeprecatedCSS(input_api
, output_api
))
1356 results
.extend(_CheckNoDeprecatedJS(input_api
, output_api
))
1357 results
.extend(_CheckParseErrors(input_api
, output_api
))
1358 results
.extend(_CheckForIPCRules(input_api
, output_api
))
1359 results
.extend(_CheckForCopyrightedCode(input_api
, output_api
))
1360 results
.extend(_CheckForWindowsLineEndings(input_api
, output_api
))
1362 if any('PRESUBMIT.py' == f
.LocalPath() for f
in input_api
.AffectedFiles()):
1363 results
.extend(input_api
.canned_checks
.RunUnitTestsInDirectory(
1364 input_api
, output_api
,
1365 input_api
.PresubmitLocalPath(),
1366 whitelist
=[r
'^PRESUBMIT_test\.py$']))
1370 def _CheckAuthorizedAuthor(input_api
, output_api
):
1371 """For non-googler/chromites committers, verify the author's email address is
1374 # TODO(maruel): Add it to input_api?
1377 author
= input_api
.change
.author_email
1379 input_api
.logging
.info('No author, skipping AUTHOR check')
1381 authors_path
= input_api
.os_path
.join(
1382 input_api
.PresubmitLocalPath(), 'AUTHORS')
1384 input_api
.re
.match(r
'[^#]+\s+\<(.+?)\>\s*$', line
)
1385 for line
in open(authors_path
))
1386 valid_authors
= [item
.group(1).lower() for item
in valid_authors
if item
]
1387 if not any(fnmatch
.fnmatch(author
.lower(), valid
) for valid
in valid_authors
):
1388 input_api
.logging
.info('Valid authors are %s', ', '.join(valid_authors
))
1389 return [output_api
.PresubmitPromptWarning(
1390 ('%s is not in AUTHORS file. If you are a new contributor, please visit'
1392 'http://www.chromium.org/developers/contributing-code and read the '
1394 'If you are a chromite, verify the contributor signed the CLA.') %
1399 def _CheckPatchFiles(input_api
, output_api
):
1400 problems
= [f
.LocalPath() for f
in input_api
.AffectedFiles()
1401 if f
.LocalPath().endswith(('.orig', '.rej'))]
1403 return [output_api
.PresubmitError(
1404 "Don't commit .rej and .orig files.", problems
)]
1409 def _DidYouMeanOSMacro(bad_macro
):
1411 return {'A': 'OS_ANDROID',
1421 'W': 'OS_WIN'}[bad_macro
[3].upper()]
1426 def _CheckForInvalidOSMacrosInFile(input_api
, f
):
1427 """Check for sensible looking, totally invalid OS macros."""
1428 preprocessor_statement
= input_api
.re
.compile(r
'^\s*#')
1429 os_macro
= input_api
.re
.compile(r
'defined\((OS_[^)]+)\)')
1431 for lnum
, line
in f
.ChangedContents():
1432 if preprocessor_statement
.search(line
):
1433 for match
in os_macro
.finditer(line
):
1434 if not match
.group(1) in _VALID_OS_MACROS
:
1435 good
= _DidYouMeanOSMacro(match
.group(1))
1436 did_you_mean
= ' (did you mean %s?)' % good
if good
else ''
1437 results
.append(' %s:%d %s%s' % (f
.LocalPath(),
1444 def _CheckForInvalidOSMacros(input_api
, output_api
):
1445 """Check all affected files for invalid OS macros."""
1447 for f
in input_api
.AffectedFiles():
1448 if not f
.LocalPath().endswith(('.py', '.js', '.html', '.css')):
1449 bad_macros
.extend(_CheckForInvalidOSMacrosInFile(input_api
, f
))
1454 return [output_api
.PresubmitError(
1455 'Possibly invalid OS macro[s] found. Please fix your code\n'
1456 'or add your macro to src/PRESUBMIT.py.', bad_macros
)]
1459 def _CheckForInvalidIfDefinedMacrosInFile(input_api
, f
):
1460 """Check all affected files for invalid "if defined" macros."""
1461 ALWAYS_DEFINED_MACROS
= (
1470 "TARGET_IPHONE_SIMULATOR",
1471 "TARGET_OS_EMBEDDED",
1477 ifdef_macro
= input_api
.re
.compile(r
'^\s*#.*(?:ifdef\s|defined\()([^\s\)]+)')
1479 for lnum
, line
in f
.ChangedContents():
1480 for match
in ifdef_macro
.finditer(line
):
1481 if match
.group(1) in ALWAYS_DEFINED_MACROS
:
1482 always_defined
= ' %s is always defined. ' % match
.group(1)
1483 did_you_mean
= 'Did you mean \'#if %s\'?' % match
.group(1)
1484 results
.append(' %s:%d %s\n\t%s' % (f
.LocalPath(),
1491 def _CheckForInvalidIfDefinedMacros(input_api
, output_api
):
1492 """Check all affected files for invalid "if defined" macros."""
1494 for f
in input_api
.AffectedFiles():
1495 if f
.LocalPath().endswith(('.h', '.c', '.cc', '.m', '.mm')):
1496 bad_macros
.extend(_CheckForInvalidIfDefinedMacrosInFile(input_api
, f
))
1501 return [output_api
.PresubmitError(
1502 'Found ifdef check on always-defined macro[s]. Please fix your code\n'
1503 'or check the list of ALWAYS_DEFINED_MACROS in src/PRESUBMIT.py.',
1507 def _CheckForUsingSideEffectsOfPass(input_api
, output_api
):
1508 """Check all affected files for using side effects of Pass."""
1510 for f
in input_api
.AffectedFiles():
1511 if f
.LocalPath().endswith(('.h', '.c', '.cc', '.m', '.mm')):
1512 for lnum
, line
in f
.ChangedContents():
1513 # Disallow Foo(*my_scoped_thing.Pass()); See crbug.com/418297.
1514 if input_api
.re
.search(r
'\*[a-zA-Z0-9_]+\.Pass\(\)', line
):
1515 errors
.append(output_api
.PresubmitError(
1516 ('%s:%d uses *foo.Pass() to delete the contents of scoped_ptr. ' +
1517 'See crbug.com/418297.') % (f
.LocalPath(), lnum
)))
1521 def _CheckForIPCRules(input_api
, output_api
):
1522 """Check for same IPC rules described in
1523 http://www.chromium.org/Home/chromium-security/education/security-tips-for-ipc
1525 base_pattern
= r
'IPC_ENUM_TRAITS\('
1526 inclusion_pattern
= input_api
.re
.compile(r
'(%s)' % base_pattern
)
1527 comment_pattern
= input_api
.re
.compile(r
'//.*(%s)' % base_pattern
)
1530 for f
in input_api
.AffectedSourceFiles(None):
1531 local_path
= f
.LocalPath()
1532 if not local_path
.endswith('.h'):
1534 for line_number
, line
in f
.ChangedContents():
1535 if inclusion_pattern
.search(line
) and not comment_pattern
.search(line
):
1537 '%s:%d\n %s' % (local_path
, line_number
, line
.strip()))
1540 return [output_api
.PresubmitPromptWarning(
1541 _IPC_ENUM_TRAITS_DEPRECATED
, problems
)]
1546 def _CheckForWindowsLineEndings(input_api
, output_api
):
1547 """Check source code and known ascii text files for Windows style line
1550 known_text_files
= r
'.*\.(txt|html|htm|mhtml|py)$'
1552 file_inclusion_pattern
= (
1554 r
'.+%s' % _IMPLEMENTATION_EXTENSIONS
1557 filter = lambda f
: input_api
.FilterSourceFile(
1558 f
, white_list
=file_inclusion_pattern
, black_list
=None)
1559 files
= [f
.LocalPath() for f
in
1560 input_api
.AffectedSourceFiles(filter)]
1565 fp
= open(file, 'r')
1567 if line
.endswith('\r\n'):
1568 problems
.append(file)
1573 return [output_api
.PresubmitPromptWarning('Are you sure that you want '
1574 'these files to contain Windows style line endings?\n' +
1575 '\n'.join(problems
))]
1580 def CheckChangeOnUpload(input_api
, output_api
):
1582 results
.extend(_CommonChecks(input_api
, output_api
))
1583 results
.extend(_CheckValidHostsInDEPS(input_api
, output_api
))
1584 results
.extend(_CheckJavaStyle(input_api
, output_api
))
1586 input_api
.canned_checks
.CheckGNFormatted(input_api
, output_api
))
1590 def GetTryServerMasterForBot(bot
):
1591 """Returns the Try Server master for the given bot.
1593 It tries to guess the master from the bot name, but may still fail
1594 and return None. There is no longer a default master.
1596 # Potentially ambiguous bot names are listed explicitly.
1598 'linux_gpu': 'tryserver.chromium.gpu',
1599 'win_gpu': 'tryserver.chromium.gpu',
1600 'chromium_presubmit': 'tryserver.chromium.linux',
1601 'blink_presubmit': 'tryserver.chromium.linux',
1602 'tools_build_presubmit': 'tryserver.chromium.linux',
1604 master
= master_map
.get(bot
)
1607 master
= 'tryserver.chromium.gpu'
1608 elif 'linux' in bot
or 'android' in bot
or 'presubmit' in bot
:
1609 master
= 'tryserver.chromium.linux'
1611 master
= 'tryserver.chromium.win'
1612 elif 'mac' in bot
or 'ios' in bot
:
1613 master
= 'tryserver.chromium.mac'
1617 def GetDefaultTryConfigs(bots
):
1618 """Returns a list of ('bot', set(['tests']), filtered by [bots].
1621 builders_and_tests
= dict((bot
, set(['defaulttests'])) for bot
in bots
)
1623 # Build up the mapping from tryserver master to bot/test.
1625 for bot
, tests
in builders_and_tests
.iteritems():
1626 out
.setdefault(GetTryServerMasterForBot(bot
), {})[bot
] = tests
1630 def CheckChangeOnCommit(input_api
, output_api
):
1632 results
.extend(_CommonChecks(input_api
, output_api
))
1633 # TODO(thestig) temporarily disabled, doesn't work in third_party/
1634 #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
1635 # input_api, output_api, sources))
1636 # Make sure the tree is 'open'.
1637 results
.extend(input_api
.canned_checks
.CheckTreeIsOpen(
1640 json_url
='http://chromium-status.appspot.com/current?format=json'))
1642 results
.extend(input_api
.canned_checks
.CheckChangeHasBugField(
1643 input_api
, output_api
))
1644 results
.extend(input_api
.canned_checks
.CheckChangeHasDescription(
1645 input_api
, output_api
))
1649 def GetPreferredTryMasters(project
, change
):
1651 files
= change
.LocalPaths()
1653 if not files
or all(re
.search(r
'[\\\/]OWNERS$', f
) for f
in files
):
1656 if all(re
.search(r
'\.(m|mm)$|(^|[\\\/_])mac[\\\/_.]', f
) for f
in files
):
1657 return GetDefaultTryConfigs([
1658 'mac_chromium_compile_dbg_ng',
1659 'mac_chromium_rel_ng',
1661 if all(re
.search('(^|[/_])win[/_.]', f
) for f
in files
):
1662 return GetDefaultTryConfigs([
1663 'win8_chromium_rel',
1664 'win_chromium_rel_ng',
1665 'win_chromium_x64_rel_ng',
1667 if all(re
.search(r
'(^|[\\\/_])android[\\\/_.]', f
) and
1668 not re
.search(r
'(^|[\\\/_])devtools[\\\/_.]', f
) for f
in files
):
1669 return GetDefaultTryConfigs([
1671 'android_dbg_tests_recipe',
1673 if all(re
.search(r
'[\\\/_]ios[\\\/_.]', f
) for f
in files
):
1674 return GetDefaultTryConfigs(['ios_rel_device', 'ios_dbg_simulator'])
1678 with
open(os
.path
.join(
1679 change
.RepositoryRoot(), 'testing', 'commit_queue', 'config.json')) as f
:
1680 cq_config
= json
.load(f
)
1681 cq_trybots
= cq_config
.get('trybots', {})
1682 builders
= cq_trybots
.get('launched', {})
1683 for master
, master_config
in cq_trybots
.get('triggered', {}).iteritems():
1684 for triggered_bot
in master_config
:
1685 builders
.get(master
, {}).pop(triggered_bot
, None)
1687 # Explicitly iterate over copies of dicts since we mutate them.
1688 for master
in builders
.keys():
1689 for builder
in builders
[master
].keys():
1690 # Do not trigger presubmit builders, since they're likely to fail
1691 # (e.g. OWNERS checks before finished code review), and we're
1692 # running local presubmit anyway.
1693 if 'presubmit' in builder
:
1694 builders
[master
].pop(builder
)
1696 # Match things like path/aura/file.cc and path/file_aura.cc.
1697 # Same for chromeos.
1698 if any(re
.search(r
'[\\\/_](aura|chromeos)', f
) for f
in files
):
1699 tryserver_linux
= builders
.setdefault('tryserver.chromium.linux', {})
1700 tryserver_linux
['linux_chromium_chromeos_asan_rel_ng'] = ['defaulttests']