PRESUBMIT.py

   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.
   4
   5
   6 """Top-level presubmit script for Skia.
   7
   8 See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
   9 for more details about the presubmit API built into gcl.
  10 """
  11
  12 import collections
  13 import csv
  14 import fnmatch
  15 import os
  16 import re
  17 import subprocess
  18 import sys
  19 import traceback
  20
  21
  22 REVERT_CL_SUBJECT_PREFIX = 'Revert '
  23
  24 SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com'
  25
  26 # Please add the complete email address here (and not just 'xyz@' or 'xyz').
  27 PUBLIC_API_OWNERS = (
  28     'reed@chromium.org',
  29     'reed@google.com',
  30     'bsalomon@chromium.org',
  31     'bsalomon@google.com',
  32     'djsollen@chromium.org',
  33     'djsollen@google.com',
  34 )
  35
  36 AUTHORS_FILE_NAME = 'AUTHORS'
  37
  38 DOCS_PREVIEW_URL = 'https://skia.org/?cl='
  39 GOLD_TRYBOT_URL = 'https://gold.skia.org/search?issue='
  40
  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/': '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/': 'client.skia:Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD-Trybot',
  47
  48     'include/private/SkAtomics.h': ('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'
  51     ),
  52
  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',
  57 }
  58
  59
  60 def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
  61   """Checks that files end with atleast one \n (LF)."""
  62   eof_files = []
  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())
  68
  69   if eof_files:
  70     return [output_api.PresubmitPromptWarning(
  71       'These files should end in a newline character:',
  72       items=eof_files)]
  73   return []
  74
  75
  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.
  88   )
  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)
 100
 101
 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))
 113
 114   empty_line_pattern = re.compile('^\s*$')
 115   def is_empty_line(line):
 116     return empty_line_pattern.match(line)
 117
 118   failing_files = []
 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):
 125           continue
 126         # The below will be the first real line after comments and newlines.
 127         if line.startswith('#if 0 '):
 128           pass
 129         elif line.startswith('#if ') or line.startswith('#ifdef '):
 130           failing_files.append(affected_file_path)
 131         break
 132
 133   results = []
 134   if failing_files:
 135     results.append(
 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)))
 140   return results
 141
 142
 143 def _CopyrightChecks(input_api, output_api, source_file_filter=None):
 144   results = []
 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)
 150
 151   for affected_file in input_api.AffectedSourceFiles(source_file_filter):
 152     if 'third_party' in affected_file.LocalPath():
 153       continue
 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))
 158   return results
 159
 160
 161 def _ToolFlags(input_api, output_api):
 162   """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
 163   results = []
 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))
 169   return results
 170
 171
 172 def _CommonChecks(input_api, output_api):
 173   """Presubmit checks common to upload and commit."""
 174   results = []
 175   sources = lambda x: (x.LocalPath().endswith('.h') or
 176                        x.LocalPath().endswith('.gypi') or
 177                        x.LocalPath().endswith('.gyp') or
 178                        x.LocalPath().endswith('.py') or
 179                        x.LocalPath().endswith('.sh') or
 180                        x.LocalPath().endswith('.m') or
 181                        x.LocalPath().endswith('.mm') or
 182                        x.LocalPath().endswith('.go') or
 183                        x.LocalPath().endswith('.c') or
 184                        x.LocalPath().endswith('.cc') or
 185                        x.LocalPath().endswith('.cpp'))
 186   results.extend(
 187       _CheckChangeHasEol(
 188           input_api, output_api, source_file_filter=sources))
 189   results.extend(_PythonChecks(input_api, output_api))
 190   results.extend(_IfDefChecks(input_api, output_api))
 191   results.extend(_CopyrightChecks(input_api, output_api,
 192                                   source_file_filter=sources))
 193   results.extend(_ToolFlags(input_api, output_api))
 194   return results
 195
 196
 197 def CheckChangeOnUpload(input_api, output_api):
 198   """Presubmit checks for the change on upload.
 199
 200   The following are the presubmit checks:
 201   * Check change has one and only one EOL.
 202   """
 203   results = []
 204   results.extend(_CommonChecks(input_api, output_api))
 205   return results
 206
 207
 208 def _CheckTreeStatus(input_api, output_api, json_url):
 209   """Check whether to allow commit.
 210
 211   Args:
 212     input_api: input related apis.
 213     output_api: output related apis.
 214     json_url: url to download json style status.
 215   """
 216   tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
 217       input_api, output_api, json_url=json_url)
 218   if not tree_status_results:
 219     # Check for caution state only if tree is not closed.
 220     connection = input_api.urllib2.urlopen(json_url)
 221     status = input_api.json.loads(connection.read())
 222     connection.close()
 223     if ('caution' in status['message'].lower() and
 224         os.isatty(sys.stdout.fileno())):
 225       # Display a prompt only if we are in an interactive shell. Without this
 226       # check the commit queue behaves incorrectly because it considers
 227       # prompts to be failures.
 228       short_text = 'Tree state is: ' + status['general_state']
 229       long_text = status['message'] + '\n' + json_url
 230       tree_status_results.append(
 231           output_api.PresubmitPromptWarning(
 232               message=short_text, long_text=long_text))
 233   else:
 234     # Tree status is closed. Put in message about contacting sheriff.
 235     connection = input_api.urllib2.urlopen(
 236         SKIA_TREE_STATUS_URL + '/current-sheriff')
 237     sheriff_details = input_api.json.loads(connection.read())
 238     if sheriff_details:
 239       tree_status_results[0]._message += (
 240           '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
 241           'to submit a build fix\nand do not know how to submit because the '
 242           'tree is closed') % sheriff_details['username']
 243   return tree_status_results
 244
 245
 246 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
 247   results = []
 248   issue = input_api.change.issue
 249   if issue and input_api.rietveld:
 250     issue_properties = input_api.rietveld.get_issue_properties(
 251         issue=int(issue), messages=False)
 252     owner_email = issue_properties['owner_email']
 253
 254     try:
 255       authors_content = ''
 256       for line in open(AUTHORS_FILE_NAME):
 257         if not line.startswith('#'):
 258           authors_content += line
 259       email_fnmatches = re.findall('<(.*)>', authors_content)
 260       for email_fnmatch in email_fnmatches:
 261         if fnmatch.fnmatch(owner_email, email_fnmatch):
 262           # Found a match, the user is in the AUTHORS file break out of the loop
 263           break
 264       else:
 265         results.append(
 266           output_api.PresubmitError(
 267             'The email %s is not in Skia\'s AUTHORS file.\n'
 268             'Issue owner, this CL must include an addition to the Skia AUTHORS '
 269             'file.'
 270             % owner_email))
 271     except IOError:
 272       # Do not fail if authors file cannot be found.
 273       traceback.print_exc()
 274       input_api.logging.error('AUTHORS file not found!')
 275
 276   return results
 277
 278
 279 def _CheckLGTMsForPublicAPI(input_api, output_api):
 280   """Check LGTMs for public API changes.
 281
 282   For public API files make sure there is an LGTM from the list of owners in
 283   PUBLIC_API_OWNERS.
 284   """
 285   results = []
 286   requires_owner_check = False
 287   for affected_file in input_api.AffectedFiles():
 288     affected_file_path = affected_file.LocalPath()
 289     file_path, file_ext = os.path.splitext(affected_file_path)
 290     # We only care about files that end in .h and are under the top-level
 291     # include dir, but not include/private.
 292     if (file_ext == '.h' and
 293         'include' == file_path.split(os.path.sep)[0] and
 294         'private' not in file_path):
 295       requires_owner_check = True
 296
 297   if not requires_owner_check:
 298     return results
 299
 300   lgtm_from_owner = False
 301   issue = input_api.change.issue
 302   if issue and input_api.rietveld:
 303     issue_properties = input_api.rietveld.get_issue_properties(
 304         issue=int(issue), messages=True)
 305     if re.match(REVERT_CL_SUBJECT_PREFIX, issue_properties['subject'], re.I):
 306       # It is a revert CL, ignore the public api owners check.
 307       return results
 308
 309     if issue_properties['cq_dry_run']:
 310       # Ignore public api owners check for dry run CLs since they are not
 311       # going to be committed.
 312       return results
 313
 314     match = re.search(r'^TBR=(.*)$', issue_properties['description'], re.M)
 315     if match:
 316       tbr_entries = match.group(1).strip().split(',')
 317       for owner in PUBLIC_API_OWNERS:
 318         if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
 319           # If an owner is specified in the TBR= line then ignore the public
 320           # api owners check.
 321           return results
 322
 323     if issue_properties['owner_email'] in PUBLIC_API_OWNERS:
 324       # An owner created the CL that is an automatic LGTM.
 325       lgtm_from_owner = True
 326
 327     messages = issue_properties.get('messages')
 328     if messages:
 329       for message in messages:
 330         if (message['sender'] in PUBLIC_API_OWNERS and
 331             'lgtm' in message['text'].lower()):
 332           # Found an lgtm in a message from an owner.
 333           lgtm_from_owner = True
 334           break
 335
 336   if not lgtm_from_owner:
 337     results.append(
 338         output_api.PresubmitError(
 339             "If this CL adds to or changes Skia's public API, you need an LGTM "
 340             "from any of %s.  If this CL only removes from or doesn't change "
 341             "Skia's public API, please add a short note to the CL saying so "
 342             "and add one of those reviewers on a TBR= line.  If you don't know "
 343             "if this CL affects Skia's public API, treat it like it does."
 344             % str(PUBLIC_API_OWNERS)))
 345   return results
 346
 347
 348 def PostUploadHook(cl, change, output_api):
 349   """git cl upload will call this hook after the issue is created/modified.
 350
 351   This hook does the following:
 352   * Adds a link to the CL's Gold trybot results.
 353   * Adds a link to preview docs changes if there are any docs changes in the CL.
 354   * Adds 'NOTRY=true' if the CL contains only docs changes.
 355   * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
 356     need to be gated on the master branch's tree.
 357   * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
 358     work on them.
 359   * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
 360     run the presubmit checks.
 361   * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
 362   """
 363
 364   results = []
 365   atleast_one_docs_change = False
 366   all_docs_changes = True
 367   for affected_file in change.AffectedFiles():
 368     affected_file_path = affected_file.LocalPath()
 369     file_path, _ = os.path.splitext(affected_file_path)
 370     if 'site' == file_path.split(os.path.sep)[0]:
 371       atleast_one_docs_change = True
 372     else:
 373       all_docs_changes = False
 374     if atleast_one_docs_change and not all_docs_changes:
 375       break
 376
 377   issue = cl.issue
 378   rietveld_obj = cl.RpcServer()
 379   if issue and rietveld_obj:
 380     original_description = rietveld_obj.get_description(issue)
 381     new_description = original_description
 382
 383     # Add GOLD_TRYBOT_URL if it does not exist yet.
 384     if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
 385       new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
 386       results.append(
 387           output_api.PresubmitNotifyResult(
 388               'Added link to Gold trybot runs to the CL\'s description.\n'
 389               'Note: Results may take sometime to be populated after trybots '
 390               'complete.'))
 391
 392     # If the change includes only doc changes then add NOTRY=true in the
 393     # CL's description if it does not exist yet.
 394     if all_docs_changes and not re.search(
 395         r'^NOTRY=true$', new_description, re.M | re.I):
 396       new_description += '\nNOTRY=true'
 397       results.append(
 398           output_api.PresubmitNotifyResult(
 399               'This change has only doc changes. Automatically added '
 400               '\'NOTRY=true\' to the CL\'s description'))
 401
 402     # If there is atleast one docs change then add preview link in the CL's
 403     # description if it does not already exist there.
 404     if atleast_one_docs_change and not re.search(
 405         r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
 406       # Automatically add a link to where the docs can be previewed.
 407       new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
 408       results.append(
 409           output_api.PresubmitNotifyResult(
 410               'Automatically added a link to preview the docs changes to the '
 411               'CL\'s description'))
 412
 413     # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
 414     # to the CL's description if it does not already exist there.
 415     target_ref = rietveld_obj.get_issue_properties(issue, False).get(
 416         'target_ref', '')
 417     if target_ref != 'refs/heads/master':
 418       if not re.search(
 419           r'^NOTREECHECKS=true$', new_description, re.M | re.I):
 420         new_description += "\nNOTREECHECKS=true"
 421         results.append(
 422             output_api.PresubmitNotifyResult(
 423                 'Branch changes do not need to rely on the master branch\'s '
 424                 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
 425                 'CL\'s description'))
 426       if not re.search(
 427           r'^NOTRY=true$', new_description, re.M | re.I):
 428         new_description += "\nNOTRY=true"
 429         results.append(
 430             output_api.PresubmitNotifyResult(
 431                 'Trybots do not yet work for non-master branches. '
 432                 'Automatically added \'NOTRY=true\' to the CL\'s description'))
 433       if not re.search(
 434           r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
 435         new_description += "\nNOPRESUBMIT=true"
 436         results.append(
 437             output_api.PresubmitNotifyResult(
 438                 'Branch changes do not run the presubmit checks.'))
 439
 440     # Automatically set CQ_EXTRA_TRYBOTS if any of the changed files here begin
 441     # with the paths of interest.
 442     cq_master_to_trybots = collections.defaultdict(set)
 443     for affected_file in change.AffectedFiles():
 444       affected_file_path = affected_file.LocalPath()
 445       for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
 446         if affected_file_path.startswith(path_prefix):
 447           results.append(
 448               output_api.PresubmitNotifyResult(
 449                   'Your CL modifies the path %s.\nAutomatically adding %s to '
 450                   'the CL description.' % (affected_file_path, extra_bots)))
 451           _MergeCQExtraTrybotsMaps(
 452               cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
 453     if cq_master_to_trybots:
 454       new_description = _AddCQExtraTrybotsToDesc(
 455           cq_master_to_trybots, new_description)
 456
 457     # If the description has changed update it.
 458     if new_description != original_description:
 459       rietveld_obj.update_description(issue, new_description)
 460
 461     return results
 462
 463
 464 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
 465   """Adds the specified master and trybots to the CQ_EXTRA_TRYBOTS keyword.
 466
 467   If the keyword already exists in the description then it appends to it only
 468   if the specified values do not already exist.
 469   If the keyword does not exist then it creates a new section in the
 470   description.
 471   """
 472   match = re.search(r'^CQ_EXTRA_TRYBOTS=(.*)$', description, re.M | re.I)
 473   if match:
 474     original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
 475     _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
 476     new_description = description.replace(
 477         match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
 478   else:
 479     new_description = description + "\n%s" % (
 480         _GetCQExtraTrybotsStr(cq_master_to_trybots))
 481   return new_description
 482
 483
 484 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
 485   """Merges two maps of masters to trybots into one."""
 486   for master, trybots in map_to_be_consumed.iteritems():
 487     dest_map[master].update(trybots)
 488   return dest_map
 489
 490
 491 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
 492   """Parses the CQ_EXTRA_TRYBOTS str and returns a map of masters to trybots."""
 493   cq_master_to_trybots = collections.defaultdict(set)
 494   for section in cq_extra_trybots_str.split(';'):
 495     if section:
 496       master, bots = section.split(':')
 497       cq_master_to_trybots[master].update(bots.split(','))
 498   return cq_master_to_trybots
 499
 500
 501 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
 502   """Constructs the CQ_EXTRA_TRYBOTS str from a map of masters to trybots."""
 503   sections = []
 504   for master, trybots in cq_master_to_trybots.iteritems():
 505     sections.append('%s:%s' % (master, ','.join(trybots)))
 506   return 'CQ_EXTRA_TRYBOTS=%s' % ';'.join(sections)
 507
 508
 509 def CheckChangeOnCommit(input_api, output_api):
 510   """Presubmit checks for the change on commit.
 511
 512   The following are the presubmit checks:
 513   * Check change has one and only one EOL.
 514   * Ensures that the Skia tree is open in
 515     http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
 516     state and an error if it is in 'Closed' state.
 517   """
 518   results = []
 519   results.extend(_CommonChecks(input_api, output_api))
 520   results.extend(
 521       _CheckTreeStatus(input_api, output_api, json_url=(
 522           SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
 523   results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
 524   results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
 525   return results