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 'cmake/': 'master.client.skia.compile:Build-Mac-Clang-x86_64-Release-CMake-Trybot,Build-Ubuntu-GCC-x86_64-Release-CMake-Trybot',
45 # pylint: disable=line-too-long
46 'src/opts/': 'master.client.skia:Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD-Trybot',
48 'include/private/SkAtomics.h': ('master.client.skia:'
49 'Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-TSAN-Trybot,'
50 'Test-Ubuntu-GCC-Golo-GPU-GT610-x86_64-Release-TSAN-Trybot'
53 # Below are examples to show what is possible with this feature.
54 # 'src/svg/': 'master1:abc;master2:def',
55 # 'src/svg/parser/': 'master3:ghi,jkl;master4:mno',
56 # 'src/image/SkImage_Base.h': 'master5:pqr,stu;master1:abc1;master2:def',
60 def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
61 """Checks that files end with atleast one \n (LF)."""
63 for f in input_api.AffectedSourceFiles(source_file_filter):
64 contents = input_api.ReadFile(f, 'rb')
65 # Check that the file ends in atleast one newline character.
66 if len(contents) > 1 and contents[-1:] != '\n':
67 eof_files.append(f.LocalPath())
70 return [output_api.PresubmitPromptWarning(
71 'These files should end in a newline character:',
76 def _PythonChecks(input_api, output_api):
77 """Run checks on any modified Python files."""
78 pylint_disabled_warnings = (
79 'F0401', # Unable to import.
80 'E0611', # No name in module.
81 'W0232', # Class has no __init__ method.
82 'E1002', # Use of super on an old style class.
83 'W0403', # Relative import used.
84 'R0201', # Method could be a function.
85 'E1003', # Using class name in super.
86 'W0613', # Unused argument.
87 'W0105', # String statement has no effect.
89 # Run Pylint on only the modified python files. Unfortunately it still runs
90 # Pylint on the whole file instead of just the modified lines.
91 affected_python_files = []
92 for affected_file in input_api.AffectedSourceFiles(None):
93 affected_file_path = affected_file.LocalPath()
94 if affected_file_path.endswith('.py'):
95 affected_python_files.append(affected_file_path)
96 return input_api.canned_checks.RunPylint(
97 input_api, output_api,
98 disabled_warnings=pylint_disabled_warnings,
99 white_list=affected_python_files)
102 def _IfDefChecks(input_api, output_api):
103 """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
104 comment_block_start_pattern = re.compile('^\s*\/\*.*$')
105 comment_block_middle_pattern = re.compile('^\s+\*.*')
106 comment_block_end_pattern = re.compile('^\s+\*\/.*$')
107 single_line_comment_pattern = re.compile('^\s*//.*$')
108 def is_comment(line):
109 return (comment_block_start_pattern.match(line) or
110 comment_block_middle_pattern.match(line) or
111 comment_block_end_pattern.match(line) or
112 single_line_comment_pattern.match(line))
114 empty_line_pattern = re.compile('^\s*$')
115 def is_empty_line(line):
116 return empty_line_pattern.match(line)
119 for affected_file in input_api.AffectedSourceFiles(None):
120 affected_file_path = affected_file.LocalPath()
121 if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
122 f = open(affected_file_path)
123 for line in f.xreadlines():
124 if is_comment(line) or is_empty_line(line):
126 # The below will be the first real line after comments and newlines.
127 if line.startswith('#if 0 '):
129 elif line.startswith('#if ') or line.startswith('#ifdef '):
130 failing_files.append(affected_file_path)
136 output_api.PresubmitError(
137 'The following files have #if or #ifdef before includes:\n%s\n\n'
138 'See https://bug.skia.org/3362 for why this should be fixed.' %
139 '\n'.join(failing_files)))
143 def _CopyrightChecks(input_api, output_api, source_file_filter=None):
145 year_pattern = r'\d{4}'
146 year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
147 years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
148 copyright_pattern = (
149 r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
151 for affected_file in input_api.AffectedSourceFiles(source_file_filter):
152 if 'third_party' in affected_file.LocalPath():
154 contents = input_api.ReadFile(affected_file, 'rb')
155 if not re.search(copyright_pattern, contents):
156 results.append(output_api.PresubmitError(
157 '%s is missing a correct copyright header.' % affected_file))
161 def _ToolFlags(input_api, output_api):
162 """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
164 sources = lambda x: ('dm_flags.py' in x.LocalPath() or
165 'nanobench_flags.py' in x.LocalPath())
166 for f in input_api.AffectedSourceFiles(sources):
167 if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
168 results.append(output_api.PresubmitError('`python %s test` failed' % f))
172 def _RecipeSimulationTest(input_api, output_api):
173 """Run the recipe simulation test."""
175 if not any(f.LocalPath().startswith('infra')
176 for f in input_api.AffectedFiles()):
179 recipes_py = os.path.join('infra', 'bots', 'recipes.py')
180 cmd = ['python', recipes_py, 'simulation_test']
182 subprocess.check_output(cmd)
183 except subprocess.CalledProcessError as e:
184 results.append(output_api.PresubmitError(
185 '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
188 def _CheckGNFormatted(input_api, output_api):
189 """Make sure any .gn files we're changing have been formatted."""
191 for f in input_api.AffectedFiles():
192 if not f.LocalPath().endswith('.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 installed.
240 results.extend(_RecipeSimulationTest(input_api, output_api))
241 results.extend(_CheckGNFormatted(input_api, output_api))
245 def _CheckTreeStatus(input_api, output_api, json_url):
246 """Check whether to allow commit.
249 input_api: input related apis.
250 output_api: output related apis.
251 json_url: url to download json style status.
253 tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
254 input_api, output_api, json_url=json_url)
255 if not tree_status_results:
256 # Check for caution state only if tree is not closed.
257 connection = input_api.urllib2.urlopen(json_url)
258 status = input_api.json.loads(connection.read())
260 if ('caution' in status['message'].lower() and
261 os.isatty(sys.stdout.fileno())):
262 # Display a prompt only if we are in an interactive shell. Without this
263 # check the commit queue behaves incorrectly because it considers
264 # prompts to be failures.
265 short_text = 'Tree state is: ' + status['general_state']
266 long_text = status['message'] + '\n' + json_url
267 tree_status_results.append(
268 output_api.PresubmitPromptWarning(
269 message=short_text, long_text=long_text))
271 # Tree status is closed. Put in message about contacting sheriff.
272 connection = input_api.urllib2.urlopen(
273 SKIA_TREE_STATUS_URL + '/current-sheriff')
274 sheriff_details = input_api.json.loads(connection.read())
276 tree_status_results[0]._message += (
277 '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
278 'to submit a build fix\nand do not know how to submit because the '
279 'tree is closed') % sheriff_details['username']
280 return tree_status_results
283 class CodeReview(object):
284 """Abstracts which codereview tool is used for the specified issue."""
286 def __init__(self, input_api):
287 self._issue = input_api.change.issue
288 self._gerrit = input_api.gerrit
289 self._rietveld_properties = None
291 self._rietveld_properties = input_api.rietveld.get_issue_properties(
292 issue=int(self._issue), messages=True)
294 def GetOwnerEmail(self):
296 return self._gerrit.GetChangeOwner(self._issue)
298 return self._rietveld_properties['owner_email']
300 def GetSubject(self):
302 return self._gerrit.GetChangeInfo(self._issue)['subject']
304 return self._rietveld_properties['subject']
306 def GetDescription(self):
308 return self._gerrit.GetChangeDescription(self._issue)
310 return self._rietveld_properties['description']
314 return self._gerrit.GetChangeInfo(
315 self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
317 return self._rietveld_properties['cq_dry_run']
319 def GetApprovers(self):
322 for m in self._gerrit.GetChangeInfo(
323 self._issue)['labels']['Code-Review']['all']:
324 if m.get("value") == 1:
325 approvers.append(m["email"])
327 for m in self._rietveld_properties.get('messages', []):
328 if 'lgtm' in m['text'].lower():
329 approvers.append(m['sender'])
333 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
335 if input_api.change.issue:
336 cr = CodeReview(input_api)
338 owner_email = cr.GetOwnerEmail()
341 for line in open(AUTHORS_FILE_NAME):
342 if not line.startswith('#'):
343 authors_content += line
344 email_fnmatches = re.findall('<(.*)>', authors_content)
345 for email_fnmatch in email_fnmatches:
346 if fnmatch.fnmatch(owner_email, email_fnmatch):
347 # Found a match, the user is in the AUTHORS file break out of the loop
351 output_api.PresubmitError(
352 'The email %s is not in Skia\'s AUTHORS file.\n'
353 'Issue owner, this CL must include an addition to the Skia AUTHORS '
357 # Do not fail if authors file cannot be found.
358 traceback.print_exc()
359 input_api.logging.error('AUTHORS file not found!')
364 def _CheckLGTMsForPublicAPI(input_api, output_api):
365 """Check LGTMs for public API changes.
367 For public API files make sure there is an LGTM from the list of owners in
371 requires_owner_check = False
372 for affected_file in input_api.AffectedFiles():
373 affected_file_path = affected_file.LocalPath()
374 file_path, file_ext = os.path.splitext(affected_file_path)
375 # We only care about files that end in .h and are under the top-level
376 # include dir, but not include/private.
377 if (file_ext == '.h' and
378 'include' == file_path.split(os.path.sep)[0] and
379 'private' not in file_path):
380 requires_owner_check = True
382 if not requires_owner_check:
385 lgtm_from_owner = False
386 if input_api.change.issue:
387 cr = CodeReview(input_api)
389 if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
390 # It is a revert CL, ignore the public api owners check.
394 # Ignore public api owners check for dry run CLs since they are not
395 # going to be committed.
398 match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
400 tbr_entries = match.group(1).strip().split(',')
401 for owner in PUBLIC_API_OWNERS:
402 if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
403 # If an owner is specified in the TBR= line then ignore the public
407 if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
408 # An owner created the CL that is an automatic LGTM.
409 lgtm_from_owner = True
411 for approver in cr.GetApprovers():
412 if approver in PUBLIC_API_OWNERS:
413 # Found an lgtm in a message from an owner.
414 lgtm_from_owner = True
417 if not lgtm_from_owner:
419 output_api.PresubmitError(
420 "If this CL adds to or changes Skia's public API, you need an LGTM "
421 "from any of %s. If this CL only removes from or doesn't change "
422 "Skia's public API, please add a short note to the CL saying so "
423 "and add one of those reviewers on a TBR= line. If you don't know "
424 "if this CL affects Skia's public API, treat it like it does."
425 % str(PUBLIC_API_OWNERS)))
429 def PostUploadHook(cl, change, output_api):
430 """git cl upload will call this hook after the issue is created/modified.
432 This hook does the following:
433 * Adds a link to the CL's Gold trybot results.
434 * Adds a link to preview docs changes if there are any docs changes in the CL.
435 * Adds 'NOTRY=true' if the CL contains only docs changes.
436 * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
437 need to be gated on the master branch's tree.
438 * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
440 * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
441 run the presubmit checks.
442 * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
448 output_api.PresubmitNotifyResult(
449 'Post upload hooks are not yet supported for Gerrit CLs'))
452 atleast_one_docs_change = False
453 all_docs_changes = True
454 for affected_file in change.AffectedFiles():
455 affected_file_path = affected_file.LocalPath()
456 file_path, _ = os.path.splitext(affected_file_path)
457 if 'site' == file_path.split(os.path.sep)[0]:
458 atleast_one_docs_change = True
460 all_docs_changes = False
461 if atleast_one_docs_change and not all_docs_changes:
465 rietveld_obj = cl.RpcServer()
466 if issue and rietveld_obj:
467 original_description = rietveld_obj.get_description(issue)
468 new_description = original_description
470 # Add GOLD_TRYBOT_URL if it does not exist yet.
471 if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
472 new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
474 output_api.PresubmitNotifyResult(
475 'Added link to Gold trybot runs to the CL\'s description.\n'
476 'Note: Results may take sometime to be populated after trybots '
479 # If the change includes only doc changes then add NOTRY=true in the
480 # CL's description if it does not exist yet.
481 if all_docs_changes and not re.search(
482 r'^NOTRY=true$', new_description, re.M | re.I):
483 new_description += '\nNOTRY=true'
485 output_api.PresubmitNotifyResult(
486 'This change has only doc changes. Automatically added '
487 '\'NOTRY=true\' to the CL\'s description'))
489 # If there is atleast one docs change then add preview link in the CL's
490 # description if it does not already exist there.
491 if atleast_one_docs_change and not re.search(
492 r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
493 # Automatically add a link to where the docs can be previewed.
494 new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
496 output_api.PresubmitNotifyResult(
497 'Automatically added a link to preview the docs changes to the '
498 'CL\'s description'))
500 # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
501 # to the CL's description if it does not already exist there.
502 target_ref = rietveld_obj.get_issue_properties(issue, False).get(
504 if target_ref != 'refs/heads/master':
506 r'^NOTREECHECKS=true$', new_description, re.M | re.I):
507 new_description += "\nNOTREECHECKS=true"
509 output_api.PresubmitNotifyResult(
510 'Branch changes do not need to rely on the master branch\'s '
511 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
512 'CL\'s description'))
514 r'^NOTRY=true$', new_description, re.M | re.I):
515 new_description += "\nNOTRY=true"
517 output_api.PresubmitNotifyResult(
518 'Trybots do not yet work for non-master branches. '
519 'Automatically added \'NOTRY=true\' to the CL\'s description'))
521 r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
522 new_description += "\nNOPRESUBMIT=true"
524 output_api.PresubmitNotifyResult(
525 'Branch changes do not run the presubmit checks.'))
527 # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
528 # begin with the paths of interest.
529 cq_master_to_trybots = collections.defaultdict(set)
530 for affected_file in change.AffectedFiles():
531 affected_file_path = affected_file.LocalPath()
532 for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
533 if affected_file_path.startswith(path_prefix):
535 output_api.PresubmitNotifyResult(
536 'Your CL modifies the path %s.\nAutomatically adding %s to '
537 'the CL description.' % (affected_file_path, extra_bots)))
538 _MergeCQExtraTrybotsMaps(
539 cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
540 if cq_master_to_trybots:
541 new_description = _AddCQExtraTrybotsToDesc(
542 cq_master_to_trybots, new_description)
544 # If the description has changed update it.
545 if new_description != original_description:
546 rietveld_obj.update_description(issue, new_description)
551 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
552 """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
554 If the keyword already exists in the description then it appends to it only
555 if the specified values do not already exist.
556 If the keyword does not exist then it creates a new section in the
559 match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
561 original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
562 _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
563 new_description = description.replace(
564 match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
566 new_description = description + "\n%s" % (
567 _GetCQExtraTrybotsStr(cq_master_to_trybots))
568 return new_description
571 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
572 """Merges two maps of masters to trybots into one."""
573 for master, trybots in map_to_be_consumed.iteritems():
574 dest_map[master].update(trybots)
578 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
579 """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
580 cq_master_to_trybots = collections.defaultdict(set)
581 for section in cq_extra_trybots_str.split(';'):
583 master, bots = section.split(':')
584 cq_master_to_trybots[master].update(bots.split(','))
585 return cq_master_to_trybots
588 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
589 """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
591 for master, trybots in cq_master_to_trybots.iteritems():
592 sections.append('%s:%s' % (master, ','.join(trybots)))
593 return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
596 def CheckChangeOnCommit(input_api, output_api):
597 """Presubmit checks for the change on commit.
599 The following are the presubmit checks:
600 * Check change has one and only one EOL.
601 * Ensures that the Skia tree is open in
602 http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
603 state and an error if it is in 'Closed' state.
606 results.extend(_CommonChecks(input_api, output_api))
608 _CheckTreeStatus(input_api, output_api, json_url=(
609 SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
610 results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
611 results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))