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 _InfraTests(input_api, output_api):
171 """Run the infra tests."""
173 if not any(f.LocalPath().startswith('infra')
174 for f in input_api.AffectedFiles()):
177 cmd = ['python', os.path.join('infra', 'bots', 'infra_tests.py')]
179 subprocess.check_output(cmd)
180 except subprocess.CalledProcessError as e:
181 results.append(output_api.PresubmitError(
182 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
186 def _CheckGNFormatted(input_api, output_api):
187 """Make sure any .gn files we're changing have been formatted."""
189 for f in input_api.AffectedFiles():
190 if (not f.LocalPath().endswith('.gn') and
191 not f.LocalPath().endswith('.gni')):
194 gn = 'gn.bat' if 'win32' in sys.platform else 'gn'
195 cmd = [gn, 'format', '--dry-run', f.LocalPath()]
197 subprocess.check_output(cmd)
198 except subprocess.CalledProcessError:
199 fix = 'gn format ' + f.LocalPath()
200 results.append(output_api.PresubmitError(
201 '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
205 def _CommonChecks(input_api, output_api):
206 """Presubmit checks common to upload and commit."""
208 sources = lambda x: (x.LocalPath().endswith('.h') or
209 x.LocalPath().endswith('.gypi') or
210 x.LocalPath().endswith('.gyp') or
211 x.LocalPath().endswith('.py') or
212 x.LocalPath().endswith('.sh') or
213 x.LocalPath().endswith('.m') or
214 x.LocalPath().endswith('.mm') or
215 x.LocalPath().endswith('.go') or
216 x.LocalPath().endswith('.c') or
217 x.LocalPath().endswith('.cc') or
218 x.LocalPath().endswith('.cpp'))
221 input_api, output_api, source_file_filter=sources))
222 results.extend(_PythonChecks(input_api, output_api))
223 results.extend(_IfDefChecks(input_api, output_api))
224 results.extend(_CopyrightChecks(input_api, output_api,
225 source_file_filter=sources))
226 results.extend(_ToolFlags(input_api, output_api))
230 def CheckChangeOnUpload(input_api, output_api):
231 """Presubmit checks for the change on upload.
233 The following are the presubmit checks:
234 * Check change has one and only one EOL.
237 results.extend(_CommonChecks(input_api, output_api))
238 # Run on upload, not commit, since the presubmit bot apparently doesn't have
239 # coverage or Go installed.
240 results.extend(_InfraTests(input_api, output_api))
242 results.extend(_CheckGNFormatted(input_api, output_api))
246 def _CheckTreeStatus(input_api, output_api, json_url):
247 """Check whether to allow commit.
250 input_api: input related apis.
251 output_api: output related apis.
252 json_url: url to download json style status.
254 tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
255 input_api, output_api, json_url=json_url)
256 if not tree_status_results:
257 # Check for caution state only if tree is not closed.
258 connection = input_api.urllib2.urlopen(json_url)
259 status = input_api.json.loads(connection.read())
261 if ('caution' in status['message'].lower() and
262 os.isatty(sys.stdout.fileno())):
263 # Display a prompt only if we are in an interactive shell. Without this
264 # check the commit queue behaves incorrectly because it considers
265 # prompts to be failures.
266 short_text = 'Tree state is: ' + status['general_state']
267 long_text = status['message'] + '\n' + json_url
268 tree_status_results.append(
269 output_api.PresubmitPromptWarning(
270 message=short_text, long_text=long_text))
272 # Tree status is closed. Put in message about contacting sheriff.
273 connection = input_api.urllib2.urlopen(
274 SKIA_TREE_STATUS_URL + '/current-sheriff')
275 sheriff_details = input_api.json.loads(connection.read())
277 tree_status_results[0]._message += (
278 '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
279 'to submit a build fix\nand do not know how to submit because the '
280 'tree is closed') % sheriff_details['username']
281 return tree_status_results
284 class CodeReview(object):
285 """Abstracts which codereview tool is used for the specified issue."""
287 def __init__(self, input_api):
288 self._issue = input_api.change.issue
289 self._gerrit = input_api.gerrit
290 self._rietveld_properties = None
292 self._rietveld_properties = input_api.rietveld.get_issue_properties(
293 issue=int(self._issue), messages=True)
295 def GetOwnerEmail(self):
297 return self._gerrit.GetChangeOwner(self._issue)
299 return self._rietveld_properties['owner_email']
301 def GetSubject(self):
303 return self._gerrit.GetChangeInfo(self._issue)['subject']
305 return self._rietveld_properties['subject']
307 def GetDescription(self):
309 return self._gerrit.GetChangeDescription(self._issue)
311 return self._rietveld_properties['description']
315 return self._gerrit.GetChangeInfo(
316 self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
318 return self._rietveld_properties['cq_dry_run']
320 def GetReviewers(self):
322 code_review_label = (
323 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
324 return [r['email'] for r in code_review_label.get('all', [])]
326 return self._rietveld_properties['reviewers']
328 def GetApprovers(self):
331 code_review_label = (
332 self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
333 for m in code_review_label.get('all', []):
334 if m.get("value") == 1:
335 approvers.append(m["email"])
337 for m in self._rietveld_properties.get('messages', []):
338 if 'lgtm' in m['text'].lower():
339 approvers.append(m['sender'])
343 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
345 if input_api.change.issue:
346 cr = CodeReview(input_api)
348 owner_email = cr.GetOwnerEmail()
351 for line in open(AUTHORS_FILE_NAME):
352 if not line.startswith('#'):
353 authors_content += line
354 email_fnmatches = re.findall('<(.*)>', authors_content)
355 for email_fnmatch in email_fnmatches:
356 if fnmatch.fnmatch(owner_email, email_fnmatch):
357 # Found a match, the user is in the AUTHORS file break out of the loop
361 output_api.PresubmitError(
362 'The email %s is not in Skia\'s AUTHORS file.\n'
363 'Issue owner, this CL must include an addition to the Skia AUTHORS '
367 # Do not fail if authors file cannot be found.
368 traceback.print_exc()
369 input_api.logging.error('AUTHORS file not found!')
374 def _CheckLGTMsForPublicAPI(input_api, output_api):
375 """Check LGTMs for public API changes.
377 For public API files make sure there is an LGTM from the list of owners in
381 requires_owner_check = False
382 for affected_file in input_api.AffectedFiles():
383 affected_file_path = affected_file.LocalPath()
384 file_path, file_ext = os.path.splitext(affected_file_path)
385 # We only care about files that end in .h and are under the top-level
386 # include dir, but not include/private.
387 if (file_ext == '.h' and
388 'include' == file_path.split(os.path.sep)[0] and
389 'private' not in file_path):
390 requires_owner_check = True
392 if not requires_owner_check:
395 lgtm_from_owner = False
396 if input_api.change.issue:
397 cr = CodeReview(input_api)
399 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
400 # It is a revert CL, ignore the public api owners check.
404 # Ignore public api owners check for dry run CLs since they are not
405 # going to be committed.
409 for reviewer in cr.GetReviewers():
410 if reviewer in PUBLIC_API_OWNERS:
411 # If an owner is specified as an reviewer in Gerrit then ignore the
412 # public api owners check.
415 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
417 tbr_section = match.group(1).strip().split(' ')[0]
418 tbr_entries = tbr_section.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 "Add one of the owners as a reviewer to your CL. For Rietveld CLs "
442 "you also need to add one of those owners on a TBR= line. If you "
443 "don't know if this CL affects Skia's public API, treat it like it "
444 "does." % str(PUBLIC_API_OWNERS)))
448 def PostUploadHook(cl, change, output_api):
449 """git cl upload will call this hook after the issue is created/modified.
451 This hook does the following:
452 * Adds a link to the CL's Gold trybot results.
453 * Adds a link to preview docs changes if there are any docs changes in the CL.
454 * Adds 'NOTRY=true' if the CL contains only docs changes.
455 * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
456 need to be gated on the master branch's tree.
457 * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
459 * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
460 run the presubmit checks.
461 * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
465 atleast_one_docs_change = False
466 all_docs_changes = True
467 for affected_file in change.AffectedFiles():
468 affected_file_path = affected_file.LocalPath()
469 file_path, _ = os.path.splitext(affected_file_path)
470 if 'site' == file_path.split(os.path.sep)[0]:
471 atleast_one_docs_change = True
473 all_docs_changes = False
474 if atleast_one_docs_change and not all_docs_changes:
479 original_description = cl.GetDescription()
482 # Remove Change-Id from description and add it back at the end.
483 regex = re.compile(r'^(Change-Id: (\w+))(\n*)\Z', re.M | re.I)
484 changeIdLine = re.search(regex, original_description).group(0)
485 original_description = re.sub(regex, '', original_description)
486 original_description = re.sub('\n+\Z', '\n', original_description)
488 new_description = original_description
490 # Add GOLD_TRYBOT_URL if it does not exist yet.
491 if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
492 new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
494 output_api.PresubmitNotifyResult(
495 'Added link to Gold trybot runs to the CL\'s description.\n'
496 'Note: Results may take sometime to be populated after trybots '
499 # If the change includes only doc changes then add NOTRY=true in the
500 # CL's description if it does not exist yet.
501 if all_docs_changes and not re.search(
502 r'^NOTRY=true$', new_description, re.M | re.I):
503 new_description += '\nNOTRY=true'
505 output_api.PresubmitNotifyResult(
506 'This change has only doc changes. Automatically added '
507 '\'NOTRY=true\' to the CL\'s description'))
509 # If there is atleast one docs change then add preview link in the CL's
510 # description if it does not already exist there.
511 if atleast_one_docs_change and not re.search(
512 r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
513 # Automatically add a link to where the docs can be previewed.
514 new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
516 output_api.PresubmitNotifyResult(
517 'Automatically added a link to preview the docs changes to the '
518 'CL\'s description'))
520 # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
521 # to the CL's description if it does not already exist there.
522 target_ref = cl.GetRemoteBranch()[1]
523 if target_ref != 'refs/remotes/origin/master':
525 r'^NOTREECHECKS=true$', new_description, re.M | re.I):
526 new_description += "\nNOTREECHECKS=true"
528 output_api.PresubmitNotifyResult(
529 'Branch changes do not need to rely on the master branch\'s '
530 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
531 'CL\'s description'))
533 r'^NOTRY=true$', new_description, re.M | re.I):
534 new_description += "\nNOTRY=true"
536 output_api.PresubmitNotifyResult(
537 'Trybots do not yet work for non-master branches. '
538 'Automatically added \'NOTRY=true\' to the CL\'s description'))
540 r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
541 new_description += "\nNOPRESUBMIT=true"
543 output_api.PresubmitNotifyResult(
544 'Branch changes do not run the presubmit checks.'))
546 # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
547 # begin with the paths of interest.
548 cq_master_to_trybots = collections.defaultdict(set)
549 for affected_file in change.AffectedFiles():
550 affected_file_path = affected_file.LocalPath()
551 for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
552 if affected_file_path.startswith(path_prefix):
554 output_api.PresubmitNotifyResult(
555 'Your CL modifies the path %s.\nAutomatically adding %s to '
556 'the CL description.' % (affected_file_path, extra_bots)))
557 _MergeCQExtraTrybotsMaps(
558 cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
559 if cq_master_to_trybots:
560 new_description = _AddCQExtraTrybotsToDesc(
561 cq_master_to_trybots, new_description)
563 # If the description has changed update it.
564 if new_description != original_description:
566 # The Change-Id line must have two newlines before it.
567 new_description += '\n\n' + changeIdLine
568 cl.UpdateDescription(new_description)
573 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
574 """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
576 If the keyword already exists in the description then it appends to it only
577 if the specified values do not already exist.
578 If the keyword does not exist then it creates a new section in the
581 match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
583 original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
584 _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
585 new_description = description.replace(
586 match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
588 new_description = description + "\n%s" % (
589 _GetCQExtraTrybotsStr(cq_master_to_trybots))
590 return new_description
593 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
594 """Merges two maps of masters to trybots into one."""
595 for master, trybots in map_to_be_consumed.iteritems():
596 dest_map[master].update(trybots)
600 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
601 """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
602 cq_master_to_trybots = collections.defaultdict(set)
603 for section in cq_extra_trybots_str.split(';'):
605 master, bots = section.split(':')
606 cq_master_to_trybots[master].update(bots.split(','))
607 return cq_master_to_trybots
610 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
611 """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
613 for master, trybots in cq_master_to_trybots.iteritems():
614 sections.append('%s:%s' % (master, ','.join(trybots)))
615 return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
618 def CheckChangeOnCommit(input_api, output_api):
619 """Presubmit checks for the change on commit.
621 The following are the presubmit checks:
622 * Check change has one and only one EOL.
623 * Ensures that the Skia tree is open in
624 http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
625 state and an error if it is in 'Closed' state.
628 results.extend(_CommonChecks(input_api, output_api))
630 _CheckTreeStatus(input_api, output_api, json_url=(
631 SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
632 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
633 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))