[safe_browsing] Remove unused ContainsBrowseUrl() parameter.
[chromium-blink-merge.git] / PRESUBMIT.py
blob67d55784370af84d31bed60125693639449c3d1f
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 sys
16 _EXCLUDED_PATHS = (
17 r"^breakpad[\\\/].*",
18 r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_rules.py",
19 r"^native_client_sdk[\\\/]src[\\\/]build_tools[\\\/]make_simple.py",
20 r"^native_client_sdk[\\\/]src[\\\/]tools[\\\/].*.mk",
21 r"^net[\\\/]tools[\\\/]spdyshark[\\\/].*",
22 r"^skia[\\\/].*",
23 r"^v8[\\\/].*",
24 r".*MakeFile$",
25 r".+_autogen\.h$",
26 r".+[\\\/]pnacl_shim\.c$",
27 r"^gpu[\\\/]config[\\\/].*_list_json\.cc$",
28 r"^chrome[\\\/]browser[\\\/]resources[\\\/]pdf[\\\/]index.js"
31 # TestRunner and NetscapePlugIn library is temporarily excluded from pan-project
32 # checks until it's transitioned to chromium coding style.
33 _TESTRUNNER_PATHS = (
34 r"^content[\\\/]shell[\\\/]renderer[\\\/]test_runner[\\\/].*",
35 r"^content[\\\/]shell[\\\/]tools[\\\/]plugin[\\\/].*",
38 # Fragment of a regular expression that matches C++ and Objective-C++
39 # implementation files.
40 _IMPLEMENTATION_EXTENSIONS = r'\.(cc|cpp|cxx|mm)$'
42 # Regular expression that matches code only used for test binaries
43 # (best effort).
44 _TEST_CODE_EXCLUDED_PATHS = (
45 r'.*[/\\](fake_|test_|mock_).+%s' % _IMPLEMENTATION_EXTENSIONS,
46 r'.+_test_(base|support|util)%s' % _IMPLEMENTATION_EXTENSIONS,
47 r'.+_(api|browser|kif|perf|pixel|unit|ui)?test(_[a-z]+)?%s' %
48 _IMPLEMENTATION_EXTENSIONS,
49 r'.+profile_sync_service_harness%s' % _IMPLEMENTATION_EXTENSIONS,
50 r'.*[/\\](test|tool(s)?)[/\\].*',
51 # content_shell is used for running layout tests.
52 r'content[/\\]shell[/\\].*',
53 # At request of folks maintaining this folder.
54 r'chrome[/\\]browser[/\\]automation[/\\].*',
55 # Non-production example code.
56 r'mojo[/\\]examples[/\\].*',
59 _TEST_ONLY_WARNING = (
60 'You might be calling functions intended only for testing from\n'
61 'production code. It is OK to ignore this warning if you know what\n'
62 'you are doing, as the heuristics used to detect the situation are\n'
63 'not perfect. The commit queue will not block on this warning.')
66 _INCLUDE_ORDER_WARNING = (
67 'Your #include order seems to be broken. Send mail to\n'
68 'marja@chromium.org if this is not the case.')
71 _BANNED_OBJC_FUNCTIONS = (
73 'addTrackingRect:',
75 'The use of -[NSView addTrackingRect:owner:userData:assumeInside:] is'
76 'prohibited. Please use CrTrackingArea instead.',
77 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
79 False,
82 r'/NSTrackingArea\W',
84 'The use of NSTrackingAreas is prohibited. Please use CrTrackingArea',
85 'instead.',
86 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
88 False,
91 'convertPointFromBase:',
93 'The use of -[NSView convertPointFromBase:] is almost certainly wrong.',
94 'Please use |convertPoint:(point) fromView:nil| instead.',
95 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
97 True,
100 'convertPointToBase:',
102 'The use of -[NSView convertPointToBase:] is almost certainly wrong.',
103 'Please use |convertPoint:(point) toView:nil| instead.',
104 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
106 True,
109 'convertRectFromBase:',
111 'The use of -[NSView convertRectFromBase:] is almost certainly wrong.',
112 'Please use |convertRect:(point) fromView:nil| instead.',
113 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
115 True,
118 'convertRectToBase:',
120 'The use of -[NSView convertRectToBase:] is almost certainly wrong.',
121 'Please use |convertRect:(point) toView:nil| instead.',
122 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
124 True,
127 'convertSizeFromBase:',
129 'The use of -[NSView convertSizeFromBase:] is almost certainly wrong.',
130 'Please use |convertSize:(point) fromView:nil| instead.',
131 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
133 True,
136 'convertSizeToBase:',
138 'The use of -[NSView convertSizeToBase:] is almost certainly wrong.',
139 'Please use |convertSize:(point) toView:nil| instead.',
140 'http://dev.chromium.org/developers/coding-style/cocoa-dos-and-donts',
142 True,
147 _BANNED_CPP_FUNCTIONS = (
148 # Make sure that gtest's FRIEND_TEST() macro is not used; the
149 # FRIEND_TEST_ALL_PREFIXES() macro from base/gtest_prod_util.h should be
150 # used instead since that allows for FLAKY_ and DISABLED_ prefixes.
152 'FRIEND_TEST(',
154 'Chromium code should not use gtest\'s FRIEND_TEST() macro. Include',
155 'base/gtest_prod_util.h and use FRIEND_TEST_ALL_PREFIXES() instead.',
157 False,
161 'ScopedAllowIO',
163 'New code should not use ScopedAllowIO. Post a task to the blocking',
164 'pool or the FILE thread instead.',
166 True,
168 r"^components[\\\/]breakpad[\\\/]app[\\\/]breakpad_mac\.mm$",
169 r"^content[\\\/]shell[\\\/]browser[\\\/]shell_browser_main\.cc$",
170 r"^content[\\\/]shell[\\\/]browser[\\\/]shell_message_filter\.cc$",
171 r"^mojo[\\\/]system[\\\/]raw_shared_buffer_posix\.cc$",
172 r"^net[\\\/]disk_cache[\\\/]cache_util\.cc$",
176 'SkRefPtr',
178 'The use of SkRefPtr is prohibited. ',
179 'Please use skia::RefPtr instead.'
181 True,
185 'SkAutoRef',
187 'The indirect use of SkRefPtr via SkAutoRef is prohibited. ',
188 'Please use skia::RefPtr instead.'
190 True,
194 'SkAutoTUnref',
196 'The use of SkAutoTUnref is dangerous because it implicitly ',
197 'converts to a raw pointer. Please use skia::RefPtr instead.'
199 True,
203 'SkAutoUnref',
205 'The indirect use of SkAutoTUnref through SkAutoUnref is dangerous ',
206 'because it implicitly converts to a raw pointer. ',
207 'Please use skia::RefPtr instead.'
209 True,
213 r'/HANDLE_EINTR\(.*close',
215 'HANDLE_EINTR(close) is invalid. If close fails with EINTR, the file',
216 'descriptor will be closed, and it is incorrect to retry the close.',
217 'Either call close directly and ignore its return value, or wrap close',
218 'in IGNORE_EINTR to use its return value. See http://crbug.com/269623'
220 True,
224 r'/IGNORE_EINTR\((?!.*close)',
226 'IGNORE_EINTR is only valid when wrapping close. To wrap other system',
227 'calls, use HANDLE_EINTR. See http://crbug.com/269623',
229 True,
231 # Files that #define IGNORE_EINTR.
232 r'^base[\\\/]posix[\\\/]eintr_wrapper\.h$',
233 r'^ppapi[\\\/]tests[\\\/]test_broker\.cc$',
237 r'/v8::Extension\(',
239 'Do not introduce new v8::Extensions into the code base, use',
240 'gin::Wrappable instead. See http://crbug.com/334679',
242 True,
244 r'extensions[/\\]renderer[/\\]safe_builtins\.*',
250 _VALID_OS_MACROS = (
251 # Please keep sorted.
252 'OS_ANDROID',
253 'OS_ANDROID_HOST',
254 'OS_BSD',
255 'OS_CAT', # For testing.
256 'OS_CHROMEOS',
257 'OS_FREEBSD',
258 'OS_IOS',
259 'OS_LINUX',
260 'OS_MACOSX',
261 'OS_NACL',
262 'OS_OPENBSD',
263 'OS_POSIX',
264 'OS_QNX',
265 'OS_SOLARIS',
266 'OS_WIN',
270 def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
271 """Attempts to prevent use of functions intended only for testing in
272 non-testing code. For now this is just a best-effort implementation
273 that ignores header files and may have some false positives. A
274 better implementation would probably need a proper C++ parser.
276 # We only scan .cc files and the like, as the declaration of
277 # for-testing functions in header files are hard to distinguish from
278 # calls to such functions without a proper C++ parser.
279 file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
281 base_function_pattern = r'ForTest(ing)?|for_test(ing)?'
282 inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
283 comment_pattern = input_api.re.compile(r'//.*%s' % base_function_pattern)
284 exclusion_pattern = input_api.re.compile(
285 r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
286 base_function_pattern, base_function_pattern))
288 def FilterFile(affected_file):
289 black_list = (_EXCLUDED_PATHS +
290 _TEST_CODE_EXCLUDED_PATHS +
291 input_api.DEFAULT_BLACK_LIST)
292 return input_api.FilterSourceFile(
293 affected_file,
294 white_list=(file_inclusion_pattern, ),
295 black_list=black_list)
297 problems = []
298 for f in input_api.AffectedSourceFiles(FilterFile):
299 local_path = f.LocalPath()
300 for line_number, line in f.ChangedContents():
301 if (inclusion_pattern.search(line) and
302 not comment_pattern.search(line) and
303 not exclusion_pattern.search(line)):
304 problems.append(
305 '%s:%d\n %s' % (local_path, line_number, line.strip()))
307 if problems:
308 return [output_api.PresubmitPromptOrNotify(_TEST_ONLY_WARNING, problems)]
309 else:
310 return []
313 def _CheckNoIOStreamInHeaders(input_api, output_api):
314 """Checks to make sure no .h files include <iostream>."""
315 files = []
316 pattern = input_api.re.compile(r'^#include\s*<iostream>',
317 input_api.re.MULTILINE)
318 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
319 if not f.LocalPath().endswith('.h'):
320 continue
321 contents = input_api.ReadFile(f)
322 if pattern.search(contents):
323 files.append(f)
325 if len(files):
326 return [ output_api.PresubmitError(
327 'Do not #include <iostream> in header files, since it inserts static '
328 'initialization into every file including the header. Instead, '
329 '#include <ostream>. See http://crbug.com/94794',
330 files) ]
331 return []
334 def _CheckNoUNIT_TESTInSourceFiles(input_api, output_api):
335 """Checks to make sure no source files use UNIT_TEST"""
336 problems = []
337 for f in input_api.AffectedFiles():
338 if (not f.LocalPath().endswith(('.cc', '.mm'))):
339 continue
341 for line_num, line in f.ChangedContents():
342 if 'UNIT_TEST ' in line or line.endswith('UNIT_TEST'):
343 problems.append(' %s:%d' % (f.LocalPath(), line_num))
345 if not problems:
346 return []
347 return [output_api.PresubmitPromptWarning('UNIT_TEST is only for headers.\n' +
348 '\n'.join(problems))]
351 def _CheckNoNewWStrings(input_api, output_api):
352 """Checks to make sure we don't introduce use of wstrings."""
353 problems = []
354 for f in input_api.AffectedFiles():
355 if (not f.LocalPath().endswith(('.cc', '.h')) or
356 f.LocalPath().endswith(('test.cc', '_win.cc', '_win.h'))):
357 continue
359 allowWString = False
360 for line_num, line in f.ChangedContents():
361 if 'presubmit: allow wstring' in line:
362 allowWString = True
363 elif not allowWString and 'wstring' in line:
364 problems.append(' %s:%d' % (f.LocalPath(), line_num))
365 allowWString = False
366 else:
367 allowWString = False
369 if not problems:
370 return []
371 return [output_api.PresubmitPromptWarning('New code should not use wstrings.'
372 ' If you are calling a cross-platform API that accepts a wstring, '
373 'fix the API.\n' +
374 '\n'.join(problems))]
377 def _CheckNoDEPSGIT(input_api, output_api):
378 """Make sure .DEPS.git is never modified manually."""
379 if any(f.LocalPath().endswith('.DEPS.git') for f in
380 input_api.AffectedFiles()):
381 return [output_api.PresubmitError(
382 'Never commit changes to .DEPS.git. This file is maintained by an\n'
383 'automated system based on what\'s in DEPS and your changes will be\n'
384 'overwritten.\n'
385 'See http://code.google.com/p/chromium/wiki/UsingNewGit#Rolling_DEPS\n'
386 'for more information')]
387 return []
390 def _CheckNoBannedFunctions(input_api, output_api):
391 """Make sure that banned functions are not used."""
392 warnings = []
393 errors = []
395 file_filter = lambda f: f.LocalPath().endswith(('.mm', '.m', '.h'))
396 for f in input_api.AffectedFiles(file_filter=file_filter):
397 for line_num, line in f.ChangedContents():
398 for func_name, message, error in _BANNED_OBJC_FUNCTIONS:
399 matched = False
400 if func_name[0:1] == '/':
401 regex = func_name[1:]
402 if input_api.re.search(regex, line):
403 matched = True
404 elif func_name in line:
405 matched = True
406 if matched:
407 problems = warnings;
408 if error:
409 problems = errors;
410 problems.append(' %s:%d:' % (f.LocalPath(), line_num))
411 for message_line in message:
412 problems.append(' %s' % message_line)
414 file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm', '.h'))
415 for f in input_api.AffectedFiles(file_filter=file_filter):
416 for line_num, line in f.ChangedContents():
417 for func_name, message, error, excluded_paths in _BANNED_CPP_FUNCTIONS:
418 def IsBlacklisted(affected_file, blacklist):
419 local_path = affected_file.LocalPath()
420 for item in blacklist:
421 if input_api.re.match(item, local_path):
422 return True
423 return False
424 if IsBlacklisted(f, excluded_paths):
425 continue
426 matched = False
427 if func_name[0:1] == '/':
428 regex = func_name[1:]
429 if input_api.re.search(regex, line):
430 matched = True
431 elif func_name in line:
432 matched = True
433 if matched:
434 problems = warnings;
435 if error:
436 problems = errors;
437 problems.append(' %s:%d:' % (f.LocalPath(), line_num))
438 for message_line in message:
439 problems.append(' %s' % message_line)
441 result = []
442 if (warnings):
443 result.append(output_api.PresubmitPromptWarning(
444 'Banned functions were used.\n' + '\n'.join(warnings)))
445 if (errors):
446 result.append(output_api.PresubmitError(
447 'Banned functions were used.\n' + '\n'.join(errors)))
448 return result
451 def _CheckNoPragmaOnce(input_api, output_api):
452 """Make sure that banned functions are not used."""
453 files = []
454 pattern = input_api.re.compile(r'^#pragma\s+once',
455 input_api.re.MULTILINE)
456 for f in input_api.AffectedSourceFiles(input_api.FilterSourceFile):
457 if not f.LocalPath().endswith('.h'):
458 continue
459 contents = input_api.ReadFile(f)
460 if pattern.search(contents):
461 files.append(f)
463 if files:
464 return [output_api.PresubmitError(
465 'Do not use #pragma once in header files.\n'
466 'See http://www.chromium.org/developers/coding-style#TOC-File-headers',
467 files)]
468 return []
471 def _CheckNoTrinaryTrueFalse(input_api, output_api):
472 """Checks to make sure we don't introduce use of foo ? true : false."""
473 problems = []
474 pattern = input_api.re.compile(r'\?\s*(true|false)\s*:\s*(true|false)')
475 for f in input_api.AffectedFiles():
476 if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
477 continue
479 for line_num, line in f.ChangedContents():
480 if pattern.match(line):
481 problems.append(' %s:%d' % (f.LocalPath(), line_num))
483 if not problems:
484 return []
485 return [output_api.PresubmitPromptWarning(
486 'Please consider avoiding the "? true : false" pattern if possible.\n' +
487 '\n'.join(problems))]
490 def _CheckUnwantedDependencies(input_api, output_api):
491 """Runs checkdeps on #include statements added in this
492 change. Breaking - rules is an error, breaking ! rules is a
493 warning.
495 # We need to wait until we have an input_api object and use this
496 # roundabout construct to import checkdeps because this file is
497 # eval-ed and thus doesn't have __file__.
498 original_sys_path = sys.path
499 try:
500 sys.path = sys.path + [input_api.os_path.join(
501 input_api.PresubmitLocalPath(), 'tools', 'checkdeps')]
502 import checkdeps
503 from cpp_checker import CppChecker
504 from rules import Rule
505 finally:
506 # Restore sys.path to what it was before.
507 sys.path = original_sys_path
509 added_includes = []
510 for f in input_api.AffectedFiles():
511 if not CppChecker.IsCppFile(f.LocalPath()):
512 continue
514 changed_lines = [line for line_num, line in f.ChangedContents()]
515 added_includes.append([f.LocalPath(), changed_lines])
517 deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath())
519 error_descriptions = []
520 warning_descriptions = []
521 for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
522 added_includes):
523 description_with_path = '%s\n %s' % (path, rule_description)
524 if rule_type == Rule.DISALLOW:
525 error_descriptions.append(description_with_path)
526 else:
527 warning_descriptions.append(description_with_path)
529 results = []
530 if error_descriptions:
531 results.append(output_api.PresubmitError(
532 'You added one or more #includes that violate checkdeps rules.',
533 error_descriptions))
534 if warning_descriptions:
535 results.append(output_api.PresubmitPromptOrNotify(
536 'You added one or more #includes of files that are temporarily\n'
537 'allowed but being removed. Can you avoid introducing the\n'
538 '#include? See relevant DEPS file(s) for details and contacts.',
539 warning_descriptions))
540 return results
543 def _CheckFilePermissions(input_api, output_api):
544 """Check that all files have their permissions properly set."""
545 if input_api.platform == 'win32':
546 return []
547 args = [sys.executable, 'tools/checkperms/checkperms.py', '--root',
548 input_api.change.RepositoryRoot()]
549 for f in input_api.AffectedFiles():
550 args += ['--file', f.LocalPath()]
551 checkperms = input_api.subprocess.Popen(args,
552 stdout=input_api.subprocess.PIPE)
553 errors = checkperms.communicate()[0].strip()
554 if errors:
555 return [output_api.PresubmitError('checkperms.py failed.',
556 errors.splitlines())]
557 return []
560 def _CheckNoAuraWindowPropertyHInHeaders(input_api, output_api):
561 """Makes sure we don't include ui/aura/window_property.h
562 in header files.
564 pattern = input_api.re.compile(r'^#include\s*"ui/aura/window_property.h"')
565 errors = []
566 for f in input_api.AffectedFiles():
567 if not f.LocalPath().endswith('.h'):
568 continue
569 for line_num, line in f.ChangedContents():
570 if pattern.match(line):
571 errors.append(' %s:%d' % (f.LocalPath(), line_num))
573 results = []
574 if errors:
575 results.append(output_api.PresubmitError(
576 'Header files should not include ui/aura/window_property.h', errors))
577 return results
580 def _CheckIncludeOrderForScope(scope, input_api, file_path, changed_linenums):
581 """Checks that the lines in scope occur in the right order.
583 1. C system files in alphabetical order
584 2. C++ system files in alphabetical order
585 3. Project's .h files
588 c_system_include_pattern = input_api.re.compile(r'\s*#include <.*\.h>')
589 cpp_system_include_pattern = input_api.re.compile(r'\s*#include <.*>')
590 custom_include_pattern = input_api.re.compile(r'\s*#include ".*')
592 C_SYSTEM_INCLUDES, CPP_SYSTEM_INCLUDES, CUSTOM_INCLUDES = range(3)
594 state = C_SYSTEM_INCLUDES
596 previous_line = ''
597 previous_line_num = 0
598 problem_linenums = []
599 for line_num, line in scope:
600 if c_system_include_pattern.match(line):
601 if state != C_SYSTEM_INCLUDES:
602 problem_linenums.append((line_num, previous_line_num))
603 elif previous_line and previous_line > line:
604 problem_linenums.append((line_num, previous_line_num))
605 elif cpp_system_include_pattern.match(line):
606 if state == C_SYSTEM_INCLUDES:
607 state = CPP_SYSTEM_INCLUDES
608 elif state == CUSTOM_INCLUDES:
609 problem_linenums.append((line_num, previous_line_num))
610 elif previous_line and previous_line > line:
611 problem_linenums.append((line_num, previous_line_num))
612 elif custom_include_pattern.match(line):
613 if state != CUSTOM_INCLUDES:
614 state = CUSTOM_INCLUDES
615 elif previous_line and previous_line > line:
616 problem_linenums.append((line_num, previous_line_num))
617 else:
618 problem_linenums.append(line_num)
619 previous_line = line
620 previous_line_num = line_num
622 warnings = []
623 for (line_num, previous_line_num) in problem_linenums:
624 if line_num in changed_linenums or previous_line_num in changed_linenums:
625 warnings.append(' %s:%d' % (file_path, line_num))
626 return warnings
629 def _CheckIncludeOrderInFile(input_api, f, changed_linenums):
630 """Checks the #include order for the given file f."""
632 system_include_pattern = input_api.re.compile(r'\s*#include \<.*')
633 # Exclude the following includes from the check:
634 # 1) #include <.../...>, e.g., <sys/...> includes often need to appear in a
635 # specific order.
636 # 2) <atlbase.h>, "build/build_config.h"
637 excluded_include_pattern = input_api.re.compile(
638 r'\s*#include (\<.*/.*|\<atlbase\.h\>|"build/build_config.h")')
639 custom_include_pattern = input_api.re.compile(r'\s*#include "(?P<FILE>.*)"')
640 # Match the final or penultimate token if it is xxxtest so we can ignore it
641 # when considering the special first include.
642 test_file_tag_pattern = input_api.re.compile(
643 r'_[a-z]+test(?=(_[a-zA-Z0-9]+)?\.)')
644 if_pattern = input_api.re.compile(
645 r'\s*#\s*(if|elif|else|endif|define|undef).*')
646 # Some files need specialized order of includes; exclude such files from this
647 # check.
648 uncheckable_includes_pattern = input_api.re.compile(
649 r'\s*#include '
650 '("ipc/.*macros\.h"|<windows\.h>|".*gl.*autogen.h")\s*')
652 contents = f.NewContents()
653 warnings = []
654 line_num = 0
656 # Handle the special first include. If the first include file is
657 # some/path/file.h, the corresponding including file can be some/path/file.cc,
658 # some/other/path/file.cc, some/path/file_platform.cc, some/path/file-suffix.h
659 # etc. It's also possible that no special first include exists.
660 # If the included file is some/path/file_platform.h the including file could
661 # also be some/path/file_xxxtest_platform.h.
662 including_file_base_name = test_file_tag_pattern.sub(
663 '', input_api.os_path.basename(f.LocalPath()))
665 for line in contents:
666 line_num += 1
667 if system_include_pattern.match(line):
668 # No special first include -> process the line again along with normal
669 # includes.
670 line_num -= 1
671 break
672 match = custom_include_pattern.match(line)
673 if match:
674 match_dict = match.groupdict()
675 header_basename = test_file_tag_pattern.sub(
676 '', input_api.os_path.basename(match_dict['FILE'])).replace('.h', '')
678 if header_basename not in including_file_base_name:
679 # No special first include -> process the line again along with normal
680 # includes.
681 line_num -= 1
682 break
684 # Split into scopes: Each region between #if and #endif is its own scope.
685 scopes = []
686 current_scope = []
687 for line in contents[line_num:]:
688 line_num += 1
689 if uncheckable_includes_pattern.match(line):
690 continue
691 if if_pattern.match(line):
692 scopes.append(current_scope)
693 current_scope = []
694 elif ((system_include_pattern.match(line) or
695 custom_include_pattern.match(line)) and
696 not excluded_include_pattern.match(line)):
697 current_scope.append((line_num, line))
698 scopes.append(current_scope)
700 for scope in scopes:
701 warnings.extend(_CheckIncludeOrderForScope(scope, input_api, f.LocalPath(),
702 changed_linenums))
703 return warnings
706 def _CheckIncludeOrder(input_api, output_api):
707 """Checks that the #include order is correct.
709 1. The corresponding header for source files.
710 2. C system files in alphabetical order
711 3. C++ system files in alphabetical order
712 4. Project's .h files in alphabetical order
714 Each region separated by #if, #elif, #else, #endif, #define and #undef follows
715 these rules separately.
718 warnings = []
719 for f in input_api.AffectedFiles():
720 if f.LocalPath().endswith(('.cc', '.h')):
721 changed_linenums = set(line_num for line_num, _ in f.ChangedContents())
722 warnings.extend(_CheckIncludeOrderInFile(input_api, f, changed_linenums))
724 results = []
725 if warnings:
726 results.append(output_api.PresubmitPromptOrNotify(_INCLUDE_ORDER_WARNING,
727 warnings))
728 return results
731 def _CheckForVersionControlConflictsInFile(input_api, f):
732 pattern = input_api.re.compile('^(?:<<<<<<<|>>>>>>>) |^=======$')
733 errors = []
734 for line_num, line in f.ChangedContents():
735 if pattern.match(line):
736 errors.append(' %s:%d %s' % (f.LocalPath(), line_num, line))
737 return errors
740 def _CheckForVersionControlConflicts(input_api, output_api):
741 """Usually this is not intentional and will cause a compile failure."""
742 errors = []
743 for f in input_api.AffectedFiles():
744 errors.extend(_CheckForVersionControlConflictsInFile(input_api, f))
746 results = []
747 if errors:
748 results.append(output_api.PresubmitError(
749 'Version control conflict markers found, please resolve.', errors))
750 return results
753 def _CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api):
754 def FilterFile(affected_file):
755 """Filter function for use with input_api.AffectedSourceFiles,
756 below. This filters out everything except non-test files from
757 top-level directories that generally speaking should not hard-code
758 service URLs (e.g. src/android_webview/, src/content/ and others).
760 return input_api.FilterSourceFile(
761 affected_file,
762 white_list=(r'^(android_webview|base|content|net)[\\\/].*', ),
763 black_list=(_EXCLUDED_PATHS +
764 _TEST_CODE_EXCLUDED_PATHS +
765 input_api.DEFAULT_BLACK_LIST))
767 base_pattern = '"[^"]*google\.com[^"]*"'
768 comment_pattern = input_api.re.compile('//.*%s' % base_pattern)
769 pattern = input_api.re.compile(base_pattern)
770 problems = [] # items are (filename, line_number, line)
771 for f in input_api.AffectedSourceFiles(FilterFile):
772 for line_num, line in f.ChangedContents():
773 if not comment_pattern.search(line) and pattern.search(line):
774 problems.append((f.LocalPath(), line_num, line))
776 if problems:
777 return [output_api.PresubmitPromptOrNotify(
778 'Most layers below src/chrome/ should not hardcode service URLs.\n'
779 'Are you sure this is correct?',
780 [' %s:%d: %s' % (
781 problem[0], problem[1], problem[2]) for problem in problems])]
782 else:
783 return []
786 def _CheckNoAbbreviationInPngFileName(input_api, output_api):
787 """Makes sure there are no abbreviations in the name of PNG files.
789 pattern = input_api.re.compile(r'.*_[a-z]_.*\.png$|.*_[a-z]\.png$')
790 errors = []
791 for f in input_api.AffectedFiles(include_deletes=False):
792 if pattern.match(f.LocalPath()):
793 errors.append(' %s' % f.LocalPath())
795 results = []
796 if errors:
797 results.append(output_api.PresubmitError(
798 'The name of PNG files should not have abbreviations. \n'
799 'Use _hover.png, _center.png, instead of _h.png, _c.png.\n'
800 'Contact oshima@chromium.org if you have questions.', errors))
801 return results
804 def _FilesToCheckForIncomingDeps(re, changed_lines):
805 """Helper method for _CheckAddedDepsHaveTargetApprovals. Returns
806 a set of DEPS entries that we should look up.
808 For a directory (rather than a specific filename) we fake a path to
809 a specific filename by adding /DEPS. This is chosen as a file that
810 will seldom or never be subject to per-file include_rules.
812 # We ignore deps entries on auto-generated directories.
813 AUTO_GENERATED_DIRS = ['grit', 'jni']
815 # This pattern grabs the path without basename in the first
816 # parentheses, and the basename (if present) in the second. It
817 # relies on the simple heuristic that if there is a basename it will
818 # be a header file ending in ".h".
819 pattern = re.compile(
820 r"""['"]\+([^'"]+?)(/[a-zA-Z0-9_]+\.h)?['"].*""")
821 results = set()
822 for changed_line in changed_lines:
823 m = pattern.match(changed_line)
824 if m:
825 path = m.group(1)
826 if path.split('/')[0] not in AUTO_GENERATED_DIRS:
827 if m.group(2):
828 results.add('%s%s' % (path, m.group(2)))
829 else:
830 results.add('%s/DEPS' % path)
831 return results
834 def _CheckAddedDepsHaveTargetApprovals(input_api, output_api):
835 """When a dependency prefixed with + is added to a DEPS file, we
836 want to make sure that the change is reviewed by an OWNER of the
837 target file or directory, to avoid layering violations from being
838 introduced. This check verifies that this happens.
840 changed_lines = set()
841 for f in input_api.AffectedFiles():
842 filename = input_api.os_path.basename(f.LocalPath())
843 if filename == 'DEPS':
844 changed_lines |= set(line.strip()
845 for line_num, line
846 in f.ChangedContents())
847 if not changed_lines:
848 return []
850 virtual_depended_on_files = _FilesToCheckForIncomingDeps(input_api.re,
851 changed_lines)
852 if not virtual_depended_on_files:
853 return []
855 if input_api.is_committing:
856 if input_api.tbr:
857 return [output_api.PresubmitNotifyResult(
858 '--tbr was specified, skipping OWNERS check for DEPS additions')]
859 if not input_api.change.issue:
860 return [output_api.PresubmitError(
861 "DEPS approval by OWNERS check failed: this change has "
862 "no Rietveld issue number, so we can't check it for approvals.")]
863 output = output_api.PresubmitError
864 else:
865 output = output_api.PresubmitNotifyResult
867 owners_db = input_api.owners_db
868 owner_email, reviewers = input_api.canned_checks._RietveldOwnerAndReviewers(
869 input_api,
870 owners_db.email_regexp,
871 approval_needed=input_api.is_committing)
873 owner_email = owner_email or input_api.change.author_email
875 reviewers_plus_owner = set(reviewers)
876 if owner_email:
877 reviewers_plus_owner.add(owner_email)
878 missing_files = owners_db.files_not_covered_by(virtual_depended_on_files,
879 reviewers_plus_owner)
881 # We strip the /DEPS part that was added by
882 # _FilesToCheckForIncomingDeps to fake a path to a file in a
883 # directory.
884 def StripDeps(path):
885 start_deps = path.rfind('/DEPS')
886 if start_deps != -1:
887 return path[:start_deps]
888 else:
889 return path
890 unapproved_dependencies = ["'+%s'," % StripDeps(path)
891 for path in missing_files]
893 if unapproved_dependencies:
894 output_list = [
895 output('Missing LGTM from OWNERS of dependencies added to DEPS:\n %s' %
896 '\n '.join(sorted(unapproved_dependencies)))]
897 if not input_api.is_committing:
898 suggested_owners = owners_db.reviewers_for(missing_files, owner_email)
899 output_list.append(output(
900 'Suggested missing target path OWNERS:\n %s' %
901 '\n '.join(suggested_owners or [])))
902 return output_list
904 return []
907 def _CheckSpamLogging(input_api, output_api):
908 file_inclusion_pattern = r'.+%s' % _IMPLEMENTATION_EXTENSIONS
909 black_list = (_EXCLUDED_PATHS +
910 _TEST_CODE_EXCLUDED_PATHS +
911 input_api.DEFAULT_BLACK_LIST +
912 (r"^base[\\\/]logging\.h$",
913 r"^base[\\\/]logging\.cc$",
914 r"^cloud_print[\\\/]",
915 r"^chrome_elf[\\\/]dll_hash[\\\/]dll_hash_main\.cc$",
916 r"^chrome[\\\/]app[\\\/]chrome_main_delegate\.cc$",
917 r"^chrome[\\\/]browser[\\\/]chrome_browser_main\.cc$",
918 r"^chrome[\\\/]browser[\\\/]ui[\\\/]startup[\\\/]"
919 r"startup_browser_creator\.cc$",
920 r"^chrome[\\\/]installer[\\\/]setup[\\\/].*",
921 r"^extensions[\\\/]renderer[\\\/]logging_native_handler\.cc$",
922 r"^content[\\\/]common[\\\/]gpu[\\\/]client[\\\/]"
923 r"gl_helper_benchmark\.cc$",
924 r"^native_client_sdk[\\\/]",
925 r"^remoting[\\\/]base[\\\/]logging\.h$",
926 r"^remoting[\\\/]host[\\\/].*",
927 r"^sandbox[\\\/]linux[\\\/].*",
928 r"^tools[\\\/]",
929 r"^ui[\\\/]aura[\\\/]bench[\\\/]bench_main\.cc$",))
930 source_file_filter = lambda x: input_api.FilterSourceFile(
931 x, white_list=(file_inclusion_pattern,), black_list=black_list)
933 log_info = []
934 printf = []
936 for f in input_api.AffectedSourceFiles(source_file_filter):
937 contents = input_api.ReadFile(f, 'rb')
938 if re.search(r"\bD?LOG\s*\(\s*INFO\s*\)", contents):
939 log_info.append(f.LocalPath())
940 elif re.search(r"\bD?LOG_IF\s*\(\s*INFO\s*,", contents):
941 log_info.append(f.LocalPath())
943 if re.search(r"\bprintf\(", contents):
944 printf.append(f.LocalPath())
945 elif re.search(r"\bfprintf\((stdout|stderr)", contents):
946 printf.append(f.LocalPath())
948 if log_info:
949 return [output_api.PresubmitError(
950 'These files spam the console log with LOG(INFO):',
951 items=log_info)]
952 if printf:
953 return [output_api.PresubmitError(
954 'These files spam the console log with printf/fprintf:',
955 items=printf)]
956 return []
959 def _CheckForAnonymousVariables(input_api, output_api):
960 """These types are all expected to hold locks while in scope and
961 so should never be anonymous (which causes them to be immediately
962 destroyed)."""
963 they_who_must_be_named = [
964 'base::AutoLock',
965 'base::AutoReset',
966 'base::AutoUnlock',
967 'SkAutoAlphaRestore',
968 'SkAutoBitmapShaderInstall',
969 'SkAutoBlitterChoose',
970 'SkAutoBounderCommit',
971 'SkAutoCallProc',
972 'SkAutoCanvasRestore',
973 'SkAutoCommentBlock',
974 'SkAutoDescriptor',
975 'SkAutoDisableDirectionCheck',
976 'SkAutoDisableOvalCheck',
977 'SkAutoFree',
978 'SkAutoGlyphCache',
979 'SkAutoHDC',
980 'SkAutoLockColors',
981 'SkAutoLockPixels',
982 'SkAutoMalloc',
983 'SkAutoMaskFreeImage',
984 'SkAutoMutexAcquire',
985 'SkAutoPathBoundsUpdate',
986 'SkAutoPDFRelease',
987 'SkAutoRasterClipValidate',
988 'SkAutoRef',
989 'SkAutoTime',
990 'SkAutoTrace',
991 'SkAutoUnref',
993 anonymous = r'(%s)\s*[({]' % '|'.join(they_who_must_be_named)
994 # bad: base::AutoLock(lock.get());
995 # not bad: base::AutoLock lock(lock.get());
996 bad_pattern = input_api.re.compile(anonymous)
997 # good: new base::AutoLock(lock.get())
998 good_pattern = input_api.re.compile(r'\bnew\s*' + anonymous)
999 errors = []
1001 for f in input_api.AffectedFiles():
1002 if not f.LocalPath().endswith(('.cc', '.h', '.inl', '.m', '.mm')):
1003 continue
1004 for linenum, line in f.ChangedContents():
1005 if bad_pattern.search(line) and not good_pattern.search(line):
1006 errors.append('%s:%d' % (f.LocalPath(), linenum))
1008 if errors:
1009 return [output_api.PresubmitError(
1010 'These lines create anonymous variables that need to be named:',
1011 items=errors)]
1012 return []
1015 def _CheckCygwinShell(input_api, output_api):
1016 source_file_filter = lambda x: input_api.FilterSourceFile(
1017 x, white_list=(r'.+\.(gyp|gypi)$',))
1018 cygwin_shell = []
1020 for f in input_api.AffectedSourceFiles(source_file_filter):
1021 for linenum, line in f.ChangedContents():
1022 if 'msvs_cygwin_shell' in line:
1023 cygwin_shell.append(f.LocalPath())
1024 break
1026 if cygwin_shell:
1027 return [output_api.PresubmitError(
1028 'These files should not use msvs_cygwin_shell (the default is 0):',
1029 items=cygwin_shell)]
1030 return []
1033 def _CheckUserActionUpdate(input_api, output_api):
1034 """Checks if any new user action has been added."""
1035 if any('actions.xml' == input_api.os_path.basename(f) for f in
1036 input_api.LocalPaths()):
1037 # If actions.xml is already included in the changelist, the PRESUBMIT
1038 # for actions.xml will do a more complete presubmit check.
1039 return []
1041 file_filter = lambda f: f.LocalPath().endswith(('.cc', '.mm'))
1042 action_re = r'[^a-zA-Z]UserMetricsAction\("([^"]*)'
1043 current_actions = None
1044 for f in input_api.AffectedFiles(file_filter=file_filter):
1045 for line_num, line in f.ChangedContents():
1046 match = input_api.re.search(action_re, line)
1047 if match:
1048 # Loads contents in tools/metrics/actions/actions.xml to memory. It's
1049 # loaded only once.
1050 if not current_actions:
1051 with open('tools/metrics/actions/actions.xml') as actions_f:
1052 current_actions = actions_f.read()
1053 # Search for the matched user action name in |current_actions|.
1054 for action_name in match.groups():
1055 action = 'name="{0}"'.format(action_name)
1056 if action not in current_actions:
1057 return [output_api.PresubmitPromptWarning(
1058 'File %s line %d: %s is missing in '
1059 'tools/metrics/actions/actions.xml. Please run '
1060 'tools/metrics/actions/extract_actions.py to update.'
1061 % (f.LocalPath(), line_num, action_name))]
1062 return []
1065 def _CheckJavaStyle(input_api, output_api):
1066 """Runs checkstyle on changed java files and returns errors if any exist."""
1067 original_sys_path = sys.path
1068 try:
1069 sys.path = sys.path + [input_api.os_path.join(
1070 input_api.PresubmitLocalPath(), 'tools', 'android', 'checkstyle')]
1071 import checkstyle
1072 finally:
1073 # Restore sys.path to what it was before.
1074 sys.path = original_sys_path
1076 return checkstyle.RunCheckstyle(
1077 input_api, output_api, 'tools/android/checkstyle/chromium-style-5.0.xml')
1080 def _CommonChecks(input_api, output_api):
1081 """Checks common to both upload and commit."""
1082 results = []
1083 results.extend(input_api.canned_checks.PanProjectChecks(
1084 input_api, output_api,
1085 excluded_paths=_EXCLUDED_PATHS + _TESTRUNNER_PATHS))
1086 results.extend(_CheckAuthorizedAuthor(input_api, output_api))
1087 results.extend(
1088 _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
1089 results.extend(_CheckNoIOStreamInHeaders(input_api, output_api))
1090 results.extend(_CheckNoUNIT_TESTInSourceFiles(input_api, output_api))
1091 results.extend(_CheckNoNewWStrings(input_api, output_api))
1092 results.extend(_CheckNoDEPSGIT(input_api, output_api))
1093 results.extend(_CheckNoBannedFunctions(input_api, output_api))
1094 results.extend(_CheckNoPragmaOnce(input_api, output_api))
1095 results.extend(_CheckNoTrinaryTrueFalse(input_api, output_api))
1096 results.extend(_CheckUnwantedDependencies(input_api, output_api))
1097 results.extend(_CheckFilePermissions(input_api, output_api))
1098 results.extend(_CheckNoAuraWindowPropertyHInHeaders(input_api, output_api))
1099 results.extend(_CheckIncludeOrder(input_api, output_api))
1100 results.extend(_CheckForVersionControlConflicts(input_api, output_api))
1101 results.extend(_CheckPatchFiles(input_api, output_api))
1102 results.extend(_CheckHardcodedGoogleHostsInLowerLayers(input_api, output_api))
1103 results.extend(_CheckNoAbbreviationInPngFileName(input_api, output_api))
1104 results.extend(_CheckForInvalidOSMacros(input_api, output_api))
1105 results.extend(_CheckAddedDepsHaveTargetApprovals(input_api, output_api))
1106 results.extend(
1107 input_api.canned_checks.CheckChangeHasNoTabs(
1108 input_api,
1109 output_api,
1110 source_file_filter=lambda x: x.LocalPath().endswith('.grd')))
1111 results.extend(_CheckSpamLogging(input_api, output_api))
1112 results.extend(_CheckForAnonymousVariables(input_api, output_api))
1113 results.extend(_CheckCygwinShell(input_api, output_api))
1114 results.extend(_CheckUserActionUpdate(input_api, output_api))
1116 if any('PRESUBMIT.py' == f.LocalPath() for f in input_api.AffectedFiles()):
1117 results.extend(input_api.canned_checks.RunUnitTestsInDirectory(
1118 input_api, output_api,
1119 input_api.PresubmitLocalPath(),
1120 whitelist=[r'^PRESUBMIT_test\.py$']))
1121 return results
1124 def _CheckSubversionConfig(input_api, output_api):
1125 """Verifies the subversion config file is correctly setup.
1127 Checks that autoprops are enabled, returns an error otherwise.
1129 join = input_api.os_path.join
1130 if input_api.platform == 'win32':
1131 appdata = input_api.environ.get('APPDATA', '')
1132 if not appdata:
1133 return [output_api.PresubmitError('%APPDATA% is not configured.')]
1134 path = join(appdata, 'Subversion', 'config')
1135 else:
1136 home = input_api.environ.get('HOME', '')
1137 if not home:
1138 return [output_api.PresubmitError('$HOME is not configured.')]
1139 path = join(home, '.subversion', 'config')
1141 error_msg = (
1142 'Please look at http://dev.chromium.org/developers/coding-style to\n'
1143 'configure your subversion configuration file. This enables automatic\n'
1144 'properties to simplify the project maintenance.\n'
1145 'Pro-tip: just download and install\n'
1146 'http://src.chromium.org/viewvc/chrome/trunk/tools/build/slave/config\n')
1148 try:
1149 lines = open(path, 'r').read().splitlines()
1150 # Make sure auto-props is enabled and check for 2 Chromium standard
1151 # auto-prop.
1152 if (not '*.cc = svn:eol-style=LF' in lines or
1153 not '*.pdf = svn:mime-type=application/pdf' in lines or
1154 not 'enable-auto-props = yes' in lines):
1155 return [
1156 output_api.PresubmitNotifyResult(
1157 'It looks like you have not configured your subversion config '
1158 'file or it is not up-to-date.\n' + error_msg)
1160 except (OSError, IOError):
1161 return [
1162 output_api.PresubmitNotifyResult(
1163 'Can\'t find your subversion config file.\n' + error_msg)
1165 return []
1168 def _CheckAuthorizedAuthor(input_api, output_api):
1169 """For non-googler/chromites committers, verify the author's email address is
1170 in AUTHORS.
1172 # TODO(maruel): Add it to input_api?
1173 import fnmatch
1175 author = input_api.change.author_email
1176 if not author:
1177 input_api.logging.info('No author, skipping AUTHOR check')
1178 return []
1179 authors_path = input_api.os_path.join(
1180 input_api.PresubmitLocalPath(), 'AUTHORS')
1181 valid_authors = (
1182 input_api.re.match(r'[^#]+\s+\<(.+?)\>\s*$', line)
1183 for line in open(authors_path))
1184 valid_authors = [item.group(1).lower() for item in valid_authors if item]
1185 if not any(fnmatch.fnmatch(author.lower(), valid) for valid in valid_authors):
1186 input_api.logging.info('Valid authors are %s', ', '.join(valid_authors))
1187 return [output_api.PresubmitPromptWarning(
1188 ('%s is not in AUTHORS file. If you are a new contributor, please visit'
1189 '\n'
1190 'http://www.chromium.org/developers/contributing-code and read the '
1191 '"Legal" section\n'
1192 'If you are a chromite, verify the contributor signed the CLA.') %
1193 author)]
1194 return []
1197 def _CheckPatchFiles(input_api, output_api):
1198 problems = [f.LocalPath() for f in input_api.AffectedFiles()
1199 if f.LocalPath().endswith(('.orig', '.rej'))]
1200 if problems:
1201 return [output_api.PresubmitError(
1202 "Don't commit .rej and .orig files.", problems)]
1203 else:
1204 return []
1207 def _DidYouMeanOSMacro(bad_macro):
1208 try:
1209 return {'A': 'OS_ANDROID',
1210 'B': 'OS_BSD',
1211 'C': 'OS_CHROMEOS',
1212 'F': 'OS_FREEBSD',
1213 'L': 'OS_LINUX',
1214 'M': 'OS_MACOSX',
1215 'N': 'OS_NACL',
1216 'O': 'OS_OPENBSD',
1217 'P': 'OS_POSIX',
1218 'S': 'OS_SOLARIS',
1219 'W': 'OS_WIN'}[bad_macro[3].upper()]
1220 except KeyError:
1221 return ''
1224 def _CheckForInvalidOSMacrosInFile(input_api, f):
1225 """Check for sensible looking, totally invalid OS macros."""
1226 preprocessor_statement = input_api.re.compile(r'^\s*#')
1227 os_macro = input_api.re.compile(r'defined\((OS_[^)]+)\)')
1228 results = []
1229 for lnum, line in f.ChangedContents():
1230 if preprocessor_statement.search(line):
1231 for match in os_macro.finditer(line):
1232 if not match.group(1) in _VALID_OS_MACROS:
1233 good = _DidYouMeanOSMacro(match.group(1))
1234 did_you_mean = ' (did you mean %s?)' % good if good else ''
1235 results.append(' %s:%d %s%s' % (f.LocalPath(),
1236 lnum,
1237 match.group(1),
1238 did_you_mean))
1239 return results
1242 def _CheckForInvalidOSMacros(input_api, output_api):
1243 """Check all affected files for invalid OS macros."""
1244 bad_macros = []
1245 for f in input_api.AffectedFiles():
1246 if not f.LocalPath().endswith(('.py', '.js', '.html', '.css')):
1247 bad_macros.extend(_CheckForInvalidOSMacrosInFile(input_api, f))
1249 if not bad_macros:
1250 return []
1252 return [output_api.PresubmitError(
1253 'Possibly invalid OS macro[s] found. Please fix your code\n'
1254 'or add your macro to src/PRESUBMIT.py.', bad_macros)]
1257 def CheckChangeOnUpload(input_api, output_api):
1258 results = []
1259 results.extend(_CommonChecks(input_api, output_api))
1260 results.extend(_CheckJavaStyle(input_api, output_api))
1261 return results
1264 def GetTryServerMasterForBot(bot):
1265 """Returns the Try Server master for the given bot.
1267 Assumes that most Try Servers are on the tryserver.chromium master."""
1268 non_default_master_map = {
1269 'linux_gpu': 'tryserver.chromium.gpu',
1271 return non_default_master_map.get(bot, 'tryserver.chromium')
1274 def GetDefaultTryConfigs(bots=None):
1275 """Returns a list of ('bot', set(['tests']), optionally filtered by [bots].
1277 To add tests to this list, they MUST be in the the corresponding master's
1278 gatekeeper config. For example, anything on master.chromium would be closed by
1279 tools/build/masters/master.chromium/master_gatekeeper_cfg.py.
1281 If 'bots' is specified, will only return configurations for bots in that list.
1284 standard_tests = [
1285 'base_unittests',
1286 'browser_tests',
1287 'cacheinvalidation_unittests',
1288 'check_deps',
1289 'check_deps2git',
1290 'content_browsertests',
1291 'content_unittests',
1292 'crypto_unittests',
1293 'gpu_unittests',
1294 'interactive_ui_tests',
1295 'ipc_tests',
1296 'jingle_unittests',
1297 'media_unittests',
1298 'net_unittests',
1299 'ppapi_unittests',
1300 'printing_unittests',
1301 'sql_unittests',
1302 'sync_unit_tests',
1303 'unit_tests',
1304 # Broken in release.
1305 #'url_unittests',
1306 #'webkit_unit_tests',
1309 builders_and_tests = {
1310 # TODO(maruel): Figure out a way to run 'sizes' where people can
1311 # effectively update the perf expectation correctly. This requires a
1312 # clobber=True build running 'sizes'. 'sizes' is not accurate with
1313 # incremental build. Reference:
1314 # http://chromium.org/developers/tree-sheriffs/perf-sheriffs.
1315 # TODO(maruel): An option would be to run 'sizes' but not count a failure
1316 # of this step as a try job failure.
1317 'android_aosp': ['compile'],
1318 'android_clang_dbg': ['slave_steps'],
1319 'android_dbg': ['slave_steps'],
1320 'cros_x86': ['defaulttests'],
1321 'ios_dbg_simulator': [
1322 'compile',
1323 'base_unittests',
1324 'content_unittests',
1325 'crypto_unittests',
1326 'url_unittests',
1327 'net_unittests',
1328 'sql_unittests',
1329 'ui_unittests',
1331 'ios_rel_device': ['compile'],
1332 'linux_asan': ['compile'],
1333 'mac_asan': ['compile'],
1334 #TODO(stip): Change the name of this builder to reflect that it's release.
1335 'linux_gtk': standard_tests,
1336 'linux_chromeos_asan': ['compile'],
1337 'linux_chromium_chromeos_clang_dbg': ['defaulttests'],
1338 'linux_chromium_chromeos_rel': ['defaulttests'],
1339 'linux_chromium_compile_dbg': ['defaulttests'],
1340 'linux_chromium_rel': ['defaulttests'],
1341 'linux_chromium_clang_dbg': ['defaulttests'],
1342 'linux_gpu': ['defaulttests'],
1343 'linux_nacl_sdk_build': ['compile'],
1344 'linux_rel': [
1345 'telemetry_perf_unittests',
1346 'telemetry_unittests',
1348 'mac_chromium_compile_dbg': ['defaulttests'],
1349 'mac_chromium_rel': ['defaulttests'],
1350 'mac_nacl_sdk_build': ['compile'],
1351 'mac_rel': [
1352 'telemetry_perf_unittests',
1353 'telemetry_unittests',
1355 'win': ['compile'],
1356 'win_chromium_compile_dbg': ['defaulttests'],
1357 'win_chromium_dbg': ['defaulttests'],
1358 'win_chromium_rel': ['defaulttests'],
1359 'win_chromium_x64_rel': ['defaulttests'],
1360 'win_nacl_sdk_build': ['compile'],
1361 'win_rel': standard_tests + [
1362 'app_list_unittests',
1363 'ash_unittests',
1364 'aura_unittests',
1365 'cc_unittests',
1366 'chrome_elf_unittests',
1367 'chromedriver_unittests',
1368 'components_unittests',
1369 'compositor_unittests',
1370 'events_unittests',
1371 'gfx_unittests',
1372 'google_apis_unittests',
1373 'installer_util_unittests',
1374 'mini_installer_test',
1375 'nacl_integration',
1376 'remoting_unittests',
1377 'sync_integration_tests',
1378 'telemetry_perf_unittests',
1379 'telemetry_unittests',
1380 'views_unittests',
1382 'win_x64_rel': [
1383 'base_unittests',
1387 swarm_enabled_builders = (
1388 # http://crbug.com/354263
1389 # 'linux_rel',
1390 # 'mac_rel',
1391 # 'win_rel',
1394 swarm_enabled_tests = (
1395 'base_unittests',
1396 'browser_tests',
1397 'interactive_ui_tests',
1398 'net_unittests',
1399 'unit_tests',
1402 for bot in builders_and_tests:
1403 if bot in swarm_enabled_builders:
1404 builders_and_tests[bot] = [x + '_swarm' if x in swarm_enabled_tests else x
1405 for x in builders_and_tests[bot]]
1407 if bots:
1408 filtered_builders_and_tests = dict((bot, set(builders_and_tests[bot]))
1409 for bot in bots)
1410 else:
1411 filtered_builders_and_tests = dict(
1412 (bot, set(tests))
1413 for bot, tests in builders_and_tests.iteritems())
1415 # Build up the mapping from tryserver master to bot/test.
1416 out = dict()
1417 for bot, tests in filtered_builders_and_tests.iteritems():
1418 out.setdefault(GetTryServerMasterForBot(bot), {})[bot] = tests
1419 return out
1422 def CheckChangeOnCommit(input_api, output_api):
1423 results = []
1424 results.extend(_CommonChecks(input_api, output_api))
1425 # TODO(thestig) temporarily disabled, doesn't work in third_party/
1426 #results.extend(input_api.canned_checks.CheckSvnModifiedDirectories(
1427 # input_api, output_api, sources))
1428 # Make sure the tree is 'open'.
1429 results.extend(input_api.canned_checks.CheckTreeIsOpen(
1430 input_api,
1431 output_api,
1432 json_url='http://chromium-status.appspot.com/current?format=json'))
1434 results.extend(input_api.canned_checks.CheckChangeHasBugField(
1435 input_api, output_api))
1436 results.extend(input_api.canned_checks.CheckChangeHasDescription(
1437 input_api, output_api))
1438 results.extend(_CheckSubversionConfig(input_api, output_api))
1439 return results
1442 def GetPreferredTryMasters(project, change):
1443 files = change.LocalPaths()
1445 if not files or all(re.search(r'[\\/]OWNERS$', f) for f in files):
1446 return {}
1448 if all(re.search('\.(m|mm)$|(^|[/_])mac[/_.]', f) for f in files):
1449 return GetDefaultTryConfigs([
1450 'mac_chromium_compile_dbg',
1451 'mac_chromium_rel',
1453 if all(re.search('(^|[/_])win[/_.]', f) for f in files):
1454 return GetDefaultTryConfigs(['win_chromium_dbg', 'win_chromium_rel'])
1455 if all(re.search('(^|[/_])android[/_.]', f) for f in files):
1456 return GetDefaultTryConfigs([
1457 'android_aosp',
1458 'android_clang_dbg',
1459 'android_dbg',
1461 if all(re.search('[/_]ios[/_.]', f) for f in files):
1462 return GetDefaultTryConfigs(['ios_rel_device', 'ios_dbg_simulator'])
1464 builders = [
1465 'android_clang_dbg',
1466 'android_dbg',
1467 'ios_dbg_simulator',
1468 'ios_rel_device',
1469 'linux_chromium_chromeos_rel',
1470 'linux_chromium_clang_dbg',
1471 'linux_chromium_rel',
1472 'linux_gpu',
1473 'mac_chromium_compile_dbg',
1474 'mac_chromium_rel',
1475 'win_chromium_compile_dbg',
1476 'win_chromium_rel',
1477 'win_chromium_x64_rel',
1480 # Match things like path/aura/file.cc and path/file_aura.cc.
1481 # Same for chromeos.
1482 if any(re.search('[/_](aura|chromeos)', f) for f in files):
1483 builders.extend([
1484 'linux_chromeos_asan',
1485 'linux_chromium_chromeos_clang_dbg'
1488 # If there are gyp changes to base, build, or chromeos, run a full cros build
1489 # in addition to the shorter linux_chromeos build. Changes to high level gyp
1490 # files have a much higher chance of breaking the cros build, which is
1491 # differnt from the linux_chromeos build that most chrome developers test
1492 # with.
1493 if any(re.search('^(base|build|chromeos).*\.gypi?$', f) for f in files):
1494 builders.extend(['cros_x86'])
1496 # The AOSP bot doesn't build the chrome/ layer, so ignore any changes to it
1497 # unless they're .gyp(i) files as changes to those files can break the gyp
1498 # step on that bot.
1499 if (not all(re.search('^chrome', f) for f in files) or
1500 any(re.search('\.gypi?$', f) for f in files)):
1501 builders.extend(['android_aosp'])
1503 return GetDefaultTryConfigs(builders)