1 # Copyright (c) 2013 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.
6 """Top-level presubmit script for Skia.
8 See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
9 for more details about the presubmit API built into gcl.
22 REVERT_CL_SUBJECT_PREFIX = 'Revert '
24 SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com'
26 # Please add the complete email address here (and not just 'xyz@' or 'xyz').
30 'bsalomon@chromium.org',
31 'bsalomon@google.com',
32 'djsollen@chromium.org',
33 'djsollen@google.com',
36 AUTHORS_FILE_NAME = 'AUTHORS'
38 DOCS_PREVIEW_URL = 'https://skia.org/?cl='
39 GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
41 # Path to CQ bots feature is described in https://bug.skia.org/4364
42 PATH_PREFIX_TO_EXTRA_TRYBOTS = {
43 # pylint: disable=line-too-long
44 'src/opts/': 'master.client.skia:Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD-Trybot',
46 'include/private/SkAtomics.h': ('master.client.skia:'
47 'Test-Ubuntu-Clang-GCE-CPU-AVX2-x86_64-Release-TSAN-Trybot,'
48 'Test-Ubuntu-Clang-Golo-GPU-GT610-x86_64-Release-TSAN-Trybot'
51 # Below are examples to show what is possible with this feature.
52 # 'src/svg/': 'master1:abc;master2:def',
53 # 'src/svg/parser/': 'master3:ghi,jkl;master4:mno',
54 # 'src/image/SkImage_Base.h': 'master5:pqr,stu;master1:abc1;master2:def',
58 def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
59 """Checks that files end with atleast one \n (LF)."""
61 for f in input_api.AffectedSourceFiles(source_file_filter):
62 contents = input_api.ReadFile(f, 'rb')
63 # Check that the file ends in atleast one newline character.
64 if len(contents) > 1 and contents[-1:] != '\n':
65 eof_files.append(f.LocalPath())
68 return [output_api.PresubmitPromptWarning(
69 'These files should end in a newline character:',
74 def _PythonChecks(input_api, output_api):
75 """Run checks on any modified Python files."""
76 pylint_disabled_warnings = (
77 'F0401', # Unable to import.
78 'E0611', # No name in module.
79 'W0232', # Class has no __init__ method.
80 'E1002', # Use of super on an old style class.
81 'W0403', # Relative import used.
82 'R0201', # Method could be a function.
83 'E1003', # Using class name in super.
84 'W0613', # Unused argument.
85 'W0105', # String statement has no effect.
87 # Run Pylint on only the modified python files. Unfortunately it still runs
88 # Pylint on the whole file instead of just the modified lines.
89 affected_python_files = []
90 for affected_file in input_api.AffectedSourceFiles(None):
91 affected_file_path = affected_file.LocalPath()
92 if affected_file_path.endswith('.py'):
93 affected_python_files.append(affected_file_path)
94 return input_api.canned_checks.RunPylint(
95 input_api, output_api,
96 disabled_warnings=pylint_disabled_warnings,
97 white_list=affected_python_files)
100 def _IfDefChecks(input_api, output_api):
101 """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
102 comment_block_start_pattern = re.compile('^\s*\/\*.*$')
103 comment_block_middle_pattern = re.compile('^\s+\*.*')
104 comment_block_end_pattern = re.compile('^\s+\*\/.*$')
105 single_line_comment_pattern = re.compile('^\s*//.*$')
106 def is_comment(line):
107 return (comment_block_start_pattern.match(line) or
108 comment_block_middle_pattern.match(line) or
109 comment_block_end_pattern.match(line) or
110 single_line_comment_pattern.match(line))
112 empty_line_pattern = re.compile('^\s*$')
113 def is_empty_line(line):
114 return empty_line_pattern.match(line)
117 for affected_file in input_api.AffectedSourceFiles(None):
118 affected_file_path = affected_file.LocalPath()
119 if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
120 f = open(affected_file_path)
121 for line in f.xreadlines():
122 if is_comment(line) or is_empty_line(line):
124 # The below will be the first real line after comments and newlines.
125 if line.startswith('#if 0 '):
127 elif line.startswith('#if ') or line.startswith('#ifdef '):
128 failing_files.append(affected_file_path)
134 output_api.PresubmitError(
135 'The following files have #if or #ifdef before includes:\n%s\n\n'
136 'See https://bug.skia.org/3362 for why this should be fixed.' %
137 '\n'.join(failing_files)))
141 def _CopyrightChecks(input_api, output_api, source_file_filter=None):
143 year_pattern = r'\d{4}'
144 year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
145 years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
146 copyright_pattern = (
147 r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
149 for affected_file in input_api.AffectedSourceFiles(source_file_filter):
150 if 'third_party' in affected_file.LocalPath():
152 contents = input_api.ReadFile(affected_file, 'rb')
153 if not re.search(copyright_pattern, contents):
154 results.append(output_api.PresubmitError(
155 '%s is missing a correct copyright header.' % affected_file))
159 def _ToolFlags(input_api, output_api):
160 """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
162 sources = lambda x: ('dm_flags.py' in x.LocalPath() or
163 'nanobench_flags.py' in x.LocalPath())
164 for f in input_api.AffectedSourceFiles(sources):
165 if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
166 results.append(output_api.PresubmitError('`python %s test` failed' % f))
170 def _RecipeSimulationTest(input_api, output_api):
171 """Run the recipe simulation test."""
173 if not any(f.LocalPath().startswith('infra')
174 for f in input_api.AffectedFiles()):
177 recipes_py = os.path.join('infra', 'bots', 'recipes.py')
178 cmd = ['python', recipes_py, 'simulation_test']
180 subprocess.check_output(cmd)
181 except subprocess.CalledProcessError as e:
182 results.append(output_api.PresubmitError(
183 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
187 def _GenTasksTest(input_api, output_api):
188 """Run gen_tasks.go test."""
190 if not any(f.LocalPath().startswith('infra')
191 for f in input_api.AffectedFiles()):
194 gen_tasks = os.path.join('infra', 'bots', 'gen_tasks.go')
195 cmd = ['go', 'run', gen_tasks, '--test']
197 subprocess.check_output(cmd)
198 except subprocess.CalledProcessError as e:
199 results.append(output_api.PresubmitError(
200 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
204 def _CheckGNFormatted(input_api, output_api):
205 """Make sure any .gn files we're changing have been formatted."""
207 for f in input_api.AffectedFiles():
208 if not f.LocalPath().endswith('.gn'):
211 cmd = ['gn', 'format', '--dry-run', f.LocalPath()]
213 subprocess.check_output(cmd)
214 except subprocess.CalledProcessError:
215 fix = 'gn format ' + f.LocalPath()
216 results.append(output_api.PresubmitError(
217 '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
221 def _CommonChecks(input_api, output_api):
222 """Presubmit checks common to upload and commit."""
224 sources = lambda x: (x.LocalPath().endswith('.h') or
225 x.LocalPath().endswith('.gypi') or
226 x.LocalPath().endswith('.gyp') or
227 x.LocalPath().endswith('.py') or
228 x.LocalPath().endswith('.sh') or
229 x.LocalPath().endswith('.m') or
230 x.LocalPath().endswith('.mm') or
231 x.LocalPath().endswith('.go') or
232 x.LocalPath().endswith('.c') or
233 x.LocalPath().endswith('.cc') or
234 x.LocalPath().endswith('.cpp'))
237 input_api, output_api, source_file_filter=sources))
238 results.extend(_PythonChecks(input_api, output_api))
239 results.extend(_IfDefChecks(input_api, output_api))
240 results.extend(_CopyrightChecks(input_api, output_api,
241 source_file_filter=sources))
242 results.extend(_ToolFlags(input_api, output_api))
246 def CheckChangeOnUpload(input_api, output_api):
247 """Presubmit checks for the change on upload.
249 The following are the presubmit checks:
250 * Check change has one and only one EOL.
253 results.extend(_CommonChecks(input_api, output_api))
254 # Run on upload, not commit, since the presubmit bot apparently doesn't have
255 # coverage or Go installed.
256 results.extend(_RecipeSimulationTest(input_api, output_api))
257 results.extend(_GenTasksTest(input_api, output_api))
259 results.extend(_CheckGNFormatted(input_api, output_api))
263 def _CheckTreeStatus(input_api, output_api, json_url):
264 """Check whether to allow commit.
267 input_api: input related apis.
268 output_api: output related apis.
269 json_url: url to download json style status.
271 tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
272 input_api, output_api, json_url=json_url)
273 if not tree_status_results:
274 # Check for caution state only if tree is not closed.
275 connection = input_api.urllib2.urlopen(json_url)
276 status = input_api.json.loads(connection.read())
278 if ('caution' in status['message'].lower() and
279 os.isatty(sys.stdout.fileno())):
280 # Display a prompt only if we are in an interactive shell. Without this
281 # check the commit queue behaves incorrectly because it considers
282 # prompts to be failures.
283 short_text = 'Tree state is: ' + status['general_state']
284 long_text = status['message'] + '\n' + json_url
285 tree_status_results.append(
286 output_api.PresubmitPromptWarning(
287 message=short_text, long_text=long_text))
289 # Tree status is closed. Put in message about contacting sheriff.
290 connection = input_api.urllib2.urlopen(
291 SKIA_TREE_STATUS_URL + '/current-sheriff')
292 sheriff_details = input_api.json.loads(connection.read())
294 tree_status_results[0]._message += (
295 '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
296 'to submit a build fix\nand do not know how to submit because the '
297 'tree is closed') % sheriff_details['username']
298 return tree_status_results
301 class CodeReview(object):
302 """Abstracts which codereview tool is used for the specified issue."""
304 def __init__(self, input_api):
305 self._issue = input_api.change.issue
306 self._gerrit = input_api.gerrit
307 self._rietveld_properties = None
309 self._rietveld_properties = input_api.rietveld.get_issue_properties(
310 issue=int(self._issue), messages=True)
312 def GetOwnerEmail(self):
314 return self._gerrit.GetChangeOwner(self._issue)
316 return self._rietveld_properties['owner_email']
318 def GetSubject(self):
320 return self._gerrit.GetChangeInfo(self._issue)['subject']
322 return self._rietveld_properties['subject']
324 def GetDescription(self):
326 return self._gerrit.GetChangeDescription(self._issue)
328 return self._rietveld_properties['description']
332 return self._gerrit.GetChangeInfo(
333 self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
335 return self._rietveld_properties['cq_dry_run']
337 def GetApprovers(self):
340 for m in self._gerrit.GetChangeInfo(
341 self._issue)['labels']['Code-Review']['all']:
342 if m.get("value") == 1:
343 approvers.append(m["email"])
345 for m in self._rietveld_properties.get('messages', []):
346 if 'lgtm' in m['text'].lower():
347 approvers.append(m['sender'])
351 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
353 if input_api.change.issue:
354 cr = CodeReview(input_api)
356 owner_email = cr.GetOwnerEmail()
359 for line in open(AUTHORS_FILE_NAME):
360 if not line.startswith('#'):
361 authors_content += line
362 email_fnmatches = re.findall('<(.*)>', authors_content)
363 for email_fnmatch in email_fnmatches:
364 if fnmatch.fnmatch(owner_email, email_fnmatch):
365 # Found a match, the user is in the AUTHORS file break out of the loop
369 output_api.PresubmitError(
370 'The email %s is not in Skia\'s AUTHORS file.\n'
371 'Issue owner, this CL must include an addition to the Skia AUTHORS '
375 # Do not fail if authors file cannot be found.
376 traceback.print_exc()
377 input_api.logging.error('AUTHORS file not found!')
382 def _CheckLGTMsForPublicAPI(input_api, output_api):
383 """Check LGTMs for public API changes.
385 For public API files make sure there is an LGTM from the list of owners in
389 requires_owner_check = False
390 for affected_file in input_api.AffectedFiles():
391 affected_file_path = affected_file.LocalPath()
392 file_path, file_ext = os.path.splitext(affected_file_path)
393 # We only care about files that end in .h and are under the top-level
394 # include dir, but not include/private.
395 if (file_ext == '.h' and
396 'include' == file_path.split(os.path.sep)[0] and
397 'private' not in file_path):
398 requires_owner_check = True
400 if not requires_owner_check:
403 lgtm_from_owner = False
404 if input_api.change.issue:
405 cr = CodeReview(input_api)
407 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
408 # It is a revert CL, ignore the public api owners check.
412 # Ignore public api owners check for dry run CLs since they are not
413 # going to be committed.
416 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
418 tbr_entries = match.group(1).strip().split(',')
419 for owner in PUBLIC_API_OWNERS:
420 if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
421 # If an owner is specified in the TBR= line then ignore the public
425 if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
426 # An owner created the CL that is an automatic LGTM.
427 lgtm_from_owner = True
429 for approver in cr.GetApprovers():
430 if approver in PUBLIC_API_OWNERS:
431 # Found an lgtm in a message from an owner.
432 lgtm_from_owner = True
435 if not lgtm_from_owner:
437 output_api.PresubmitError(
438 "If this CL adds to or changes Skia's public API, you need an LGTM "
439 "from any of %s. If this CL only removes from or doesn't change "
440 "Skia's public API, please add a short note to the CL saying so "
441 "and add one of those reviewers on a TBR= line. If you don't know "
442 "if this CL affects Skia's public API, treat it like it does."
443 % str(PUBLIC_API_OWNERS)))
447 def PostUploadHook(cl, change, output_api):
448 """git cl upload will call this hook after the issue is created/modified.
450 This hook does the following:
451 * Adds a link to the CL's Gold trybot results.
452 * Adds a link to preview docs changes if there are any docs changes in the CL.
453 * Adds 'NOTRY=true' if the CL contains only docs changes.
454 * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
455 need to be gated on the master branch's tree.
456 * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
458 * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
459 run the presubmit checks.
460 * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
464 atleast_one_docs_change = False
465 all_docs_changes = True
466 for affected_file in change.AffectedFiles():
467 affected_file_path = affected_file.LocalPath()
468 file_path, _ = os.path.splitext(affected_file_path)
469 if 'site' == file_path.split(os.path.sep)[0]:
470 atleast_one_docs_change = True
472 all_docs_changes = False
473 if atleast_one_docs_change and not all_docs_changes:
478 original_description = cl.GetDescription()
481 # Remove Change-Id from description and add it back at the end.
482 regex = re.compile(r'^(Change-Id: (\w+))(\n*)\Z', re.M | re.I)
483 changeIdLine = re.search(regex, original_description).group(0)
484 original_description = re.sub(regex, '', original_description)
485 original_description = re.sub('\n+\Z', '\n', original_description)
487 new_description = original_description
489 # Add GOLD_TRYBOT_URL if it does not exist yet.
490 if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
491 new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
493 output_api.PresubmitNotifyResult(
494 'Added link to Gold trybot runs to the CL\'s description.\n'
495 'Note: Results may take sometime to be populated after trybots '
498 # If the change includes only doc changes then add NOTRY=true in the
499 # CL's description if it does not exist yet.
500 if all_docs_changes and not re.search(
501 r'^NOTRY=true$', new_description, re.M | re.I):
502 new_description += '\nNOTRY=true'
504 output_api.PresubmitNotifyResult(
505 'This change has only doc changes. Automatically added '
506 '\'NOTRY=true\' to the CL\'s description'))
508 # If there is atleast one docs change then add preview link in the CL's
509 # description if it does not already exist there.
510 if atleast_one_docs_change and not re.search(
511 r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
512 # Automatically add a link to where the docs can be previewed.
513 new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
515 output_api.PresubmitNotifyResult(
516 'Automatically added a link to preview the docs changes to the '
517 'CL\'s description'))
519 # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
520 # to the CL's description if it does not already exist there.
521 target_ref = cl.GetRemoteBranch()[1]
522 if target_ref != 'refs/remotes/origin/master':
524 r'^NOTREECHECKS=true$', new_description, re.M | re.I):
525 new_description += "\nNOTREECHECKS=true"
527 output_api.PresubmitNotifyResult(
528 'Branch changes do not need to rely on the master branch\'s '
529 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
530 'CL\'s description'))
532 r'^NOTRY=true$', new_description, re.M | re.I):
533 new_description += "\nNOTRY=true"
535 output_api.PresubmitNotifyResult(
536 'Trybots do not yet work for non-master branches. '
537 'Automatically added \'NOTRY=true\' to the CL\'s description'))
539 r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
540 new_description += "\nNOPRESUBMIT=true"
542 output_api.PresubmitNotifyResult(
543 'Branch changes do not run the presubmit checks.'))
545 # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
546 # begin with the paths of interest.
547 cq_master_to_trybots = collections.defaultdict(set)
548 for affected_file in change.AffectedFiles():
549 affected_file_path = affected_file.LocalPath()
550 for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
551 if affected_file_path.startswith(path_prefix):
553 output_api.PresubmitNotifyResult(
554 'Your CL modifies the path %s.\nAutomatically adding %s to '
555 'the CL description.' % (affected_file_path, extra_bots)))
556 _MergeCQExtraTrybotsMaps(
557 cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
558 if cq_master_to_trybots:
559 new_description = _AddCQExtraTrybotsToDesc(
560 cq_master_to_trybots, new_description)
562 # If the description has changed update it.
563 if new_description != original_description:
565 # The Change-Id line must have two newlines before it.
566 new_description += '\n\n' + changeIdLine
567 cl.UpdateDescription(new_description)
572 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
573 """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
575 If the keyword already exists in the description then it appends to it only
576 if the specified values do not already exist.
577 If the keyword does not exist then it creates a new section in the
580 match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
582 original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
583 _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
584 new_description = description.replace(
585 match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
587 new_description = description + "\n%s" % (
588 _GetCQExtraTrybotsStr(cq_master_to_trybots))
589 return new_description
592 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
593 """Merges two maps of masters to trybots into one."""
594 for master, trybots in map_to_be_consumed.iteritems():
595 dest_map[master].update(trybots)
599 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
600 """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
601 cq_master_to_trybots = collections.defaultdict(set)
602 for section in cq_extra_trybots_str.split(';'):
604 master, bots = section.split(':')
605 cq_master_to_trybots[master].update(bots.split(','))
606 return cq_master_to_trybots
609 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
610 """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
612 for master, trybots in cq_master_to_trybots.iteritems():
613 sections.append('%s:%s' % (master, ','.join(trybots)))
614 return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
617 def CheckChangeOnCommit(input_api, output_api):
618 """Presubmit checks for the change on commit.
620 The following are the presubmit checks:
621 * Check change has one and only one EOL.
622 * Ensures that the Skia tree is open in
623 http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
624 state and an error if it is in 'Closed' state.
627 results.extend(_CommonChecks(input_api, output_api))
629 _CheckTreeStatus(input_api, output_api, json_url=(
630 SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
631 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
632 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))