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 csv
  13 import fnmatch
  14 import os
  15 import re
  16 import subprocess
  17 import sys
  18 import traceback
  19
  20
  21 REVERT_CL_SUBJECT_PREFIX = 'Revert '
  22
  23 SKIA_TREE_STATUS_URL = 'http://skia-tree-status.appspot.com'
  24
  25 CQ_KEYWORDS_THAT_NEED_APPENDING = ('CQ_INCLUDE_TRYBOTS', 'CQ_EXTRA_TRYBOTS',
  26                                    'CQ_EXCLUDE_TRYBOTS', 'CQ_TRYBOTS')
  27
  28 # Please add the complete email address here (and not just 'xyz@' or 'xyz').
  29 PUBLIC_API_OWNERS = (
  30     'reed@chromium.org',
  31     'reed@google.com',
  32     'bsalomon@chromium.org',
  33     'bsalomon@google.com',
  34     'djsollen@chromium.org',
  35     'djsollen@google.com',
  36 )
  37
  38 AUTHORS_FILE_NAME = 'AUTHORS'
  39
  40 DOCS_PREVIEW_URL = 'https://skia.org/?cl='
  41
  42
  43 def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
  44   """Checks that files end with atleast one \n (LF)."""
  45   eof_files = []
  46   for f in input_api.AffectedSourceFiles(source_file_filter):
  47     contents = input_api.ReadFile(f, 'rb')
  48     # Check that the file ends in atleast one newline character.
  49     if len(contents) > 1 and contents[-1:] != '\n':
  50       eof_files.append(f.LocalPath())
  51
  52   if eof_files:
  53     return [output_api.PresubmitPromptWarning(
  54       'These files should end in a newline character:',
  55       items=eof_files)]
  56   return []
  57
  58
  59 def _PythonChecks(input_api, output_api):
  60   """Run checks on any modified Python files."""
  61   pylint_disabled_warnings = (
  62       'F0401',  # Unable to import.
  63       'E0611',  # No name in module.
  64       'W0232',  # Class has no __init__ method.
  65       'E1002',  # Use of super on an old style class.
  66       'W0403',  # Relative import used.
  67       'R0201',  # Method could be a function.
  68       'E1003',  # Using class name in super.
  69       'W0613',  # Unused argument.
  70   )
  71   # Run Pylint on only the modified python files. Unfortunately it still runs
  72   # Pylint on the whole file instead of just the modified lines.
  73   affected_python_files = []
  74   for affected_file in input_api.AffectedSourceFiles(None):
  75     affected_file_path = affected_file.LocalPath()
  76     if affected_file_path.endswith('.py'):
  77       affected_python_files.append(affected_file_path)
  78   return input_api.canned_checks.RunPylint(
  79       input_api, output_api,
  80       disabled_warnings=pylint_disabled_warnings,
  81       white_list=affected_python_files)
  82
  83
  84 def _IfDefChecks(input_api, output_api):
  85   """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
  86   comment_block_start_pattern = re.compile('^\s*\/\*.*$')
  87   comment_block_middle_pattern = re.compile('^\s+\*.*')
  88   comment_block_end_pattern = re.compile('^\s+\*\/.*$')
  89   single_line_comment_pattern = re.compile('^\s*//.*$')
  90   def is_comment(line):
  91     return (comment_block_start_pattern.match(line) or
  92             comment_block_middle_pattern.match(line) or
  93             comment_block_end_pattern.match(line) or
  94             single_line_comment_pattern.match(line))
  95
  96   empty_line_pattern = re.compile('^\s*$')
  97   def is_empty_line(line):
  98     return empty_line_pattern.match(line)
  99
 100   failing_files = []
 101   for affected_file in input_api.AffectedSourceFiles(None):
 102     affected_file_path = affected_file.LocalPath()
 103     if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
 104       f = open(affected_file_path)
 105       for line in f.xreadlines():
 106         if is_comment(line) or is_empty_line(line):
 107           continue
 108         # The below will be the first real line after comments and newlines.
 109         if line.startswith('#if 0 '):
 110           pass
 111         elif line.startswith('#if ') or line.startswith('#ifdef '):
 112           failing_files.append(affected_file_path)
 113         break
 114
 115   results = []
 116   if failing_files:
 117     results.append(
 118         output_api.PresubmitError(
 119             'The following files have #if or #ifdef before includes:\n%s\n\n'
 120             'See skbug.com/3362 for why this should be fixed.' %
 121                 '\n'.join(failing_files)))
 122   return results
 123
 124
 125 def _CopyrightChecks(input_api, output_api, source_file_filter=None):
 126   results = []
 127   year_pattern = r'\d{4}'
 128   year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
 129   years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
 130   copyright_pattern = (
 131       r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
 132
 133   for affected_file in input_api.AffectedSourceFiles(source_file_filter):
 134     if 'third_party' in affected_file.LocalPath():
 135       continue
 136     contents = input_api.ReadFile(affected_file, 'rb')
 137     if not re.search(copyright_pattern, contents):
 138       results.append(output_api.PresubmitError(
 139           '%s is missing a correct copyright header.' % affected_file))
 140   return results
 141
 142
 143 def _ToolFlags(input_api, output_api):
 144   """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
 145   results = []
 146   sources = lambda x: ('dm_flags.py'        in x.LocalPath() or
 147                        'nanobench_flags.py' in x.LocalPath())
 148   for f in input_api.AffectedSourceFiles(sources):
 149     if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
 150       results.append(output_api.PresubmitError('`python %s test` failed' % f))
 151   return results
 152
 153
 154 def _CommonChecks(input_api, output_api):
 155   """Presubmit checks common to upload and commit."""
 156   results = []
 157   sources = lambda x: (x.LocalPath().endswith('.h') or
 158                        x.LocalPath().endswith('.gypi') or
 159                        x.LocalPath().endswith('.gyp') or
 160                        x.LocalPath().endswith('.py') or
 161                        x.LocalPath().endswith('.sh') or
 162                        x.LocalPath().endswith('.m') or
 163                        x.LocalPath().endswith('.mm') or
 164                        x.LocalPath().endswith('.go') or
 165                        x.LocalPath().endswith('.c') or
 166                        x.LocalPath().endswith('.cc') or
 167                        x.LocalPath().endswith('.cpp'))
 168   results.extend(
 169       _CheckChangeHasEol(
 170           input_api, output_api, source_file_filter=sources))
 171   results.extend(_PythonChecks(input_api, output_api))
 172   results.extend(_IfDefChecks(input_api, output_api))
 173   results.extend(_CopyrightChecks(input_api, output_api,
 174                                   source_file_filter=sources))
 175   results.extend(_ToolFlags(input_api, output_api))
 176   return results
 177
 178
 179 def CheckChangeOnUpload(input_api, output_api):
 180   """Presubmit checks for the change on upload.
 181
 182   The following are the presubmit checks:
 183   * Check change has one and only one EOL.
 184   """
 185   results = []
 186   results.extend(_CommonChecks(input_api, output_api))
 187   return results
 188
 189
 190 def _CheckTreeStatus(input_api, output_api, json_url):
 191   """Check whether to allow commit.
 192
 193   Args:
 194     input_api: input related apis.
 195     output_api: output related apis.
 196     json_url: url to download json style status.
 197   """
 198   tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
 199       input_api, output_api, json_url=json_url)
 200   if not tree_status_results:
 201     # Check for caution state only if tree is not closed.
 202     connection = input_api.urllib2.urlopen(json_url)
 203     status = input_api.json.loads(connection.read())
 204     connection.close()
 205     if ('caution' in status['message'].lower() and
 206         os.isatty(sys.stdout.fileno())):
 207       # Display a prompt only if we are in an interactive shell. Without this
 208       # check the commit queue behaves incorrectly because it considers
 209       # prompts to be failures.
 210       short_text = 'Tree state is: ' + status['general_state']
 211       long_text = status['message'] + '\n' + json_url
 212       tree_status_results.append(
 213           output_api.PresubmitPromptWarning(
 214               message=short_text, long_text=long_text))
 215   else:
 216     # Tree status is closed. Put in message about contacting sheriff.
 217     connection = input_api.urllib2.urlopen(
 218         SKIA_TREE_STATUS_URL + '/current-sheriff')
 219     sheriff_details = input_api.json.loads(connection.read())
 220     if sheriff_details:
 221       tree_status_results[0]._message += (
 222           '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
 223           'to submit a build fix\nand do not know how to submit because the '
 224           'tree is closed') % sheriff_details['username']
 225   return tree_status_results
 226
 227
 228 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
 229   results = []
 230   issue = input_api.change.issue
 231   if issue and input_api.rietveld:
 232     issue_properties = input_api.rietveld.get_issue_properties(
 233         issue=int(issue), messages=False)
 234     owner_email = issue_properties['owner_email']
 235
 236     try:
 237       authors_content = ''
 238       for line in open(AUTHORS_FILE_NAME):
 239         if not line.startswith('#'):
 240           authors_content += line
 241       email_fnmatches = re.findall('<(.*)>', authors_content)
 242       for email_fnmatch in email_fnmatches:
 243         if fnmatch.fnmatch(owner_email, email_fnmatch):
 244           # Found a match, the user is in the AUTHORS file break out of the loop
 245           break
 246       else:
 247         results.append(
 248           output_api.PresubmitError(
 249             'The email %s is not in Skia\'s AUTHORS file.\n'
 250             'Issue owner, this CL must include an addition to the Skia AUTHORS '
 251             'file.'
 252             % owner_email))
 253     except IOError:
 254       # Do not fail if authors file cannot be found.
 255       traceback.print_exc()
 256       input_api.logging.error('AUTHORS file not found!')
 257
 258   return results
 259
 260
 261 def _CheckLGTMsForPublicAPI(input_api, output_api):
 262   """Check LGTMs for public API changes.
 263
 264   For public API files make sure there is an LGTM from the list of owners in
 265   PUBLIC_API_OWNERS.
 266   """
 267   results = []
 268   requires_owner_check = False
 269   for affected_file in input_api.AffectedFiles():
 270     affected_file_path = affected_file.LocalPath()
 271     file_path, file_ext = os.path.splitext(affected_file_path)
 272     # We only care about files that end in .h and are under the top-level
 273     # include dir, but not include/private.
 274     if (file_ext == '.h' and
 275         'include' == file_path.split(os.path.sep)[0] and
 276         'private' not in file_path):
 277       requires_owner_check = True
 278
 279   if not requires_owner_check:
 280     return results
 281
 282   lgtm_from_owner = False
 283   issue = input_api.change.issue
 284   if issue and input_api.rietveld:
 285     issue_properties = input_api.rietveld.get_issue_properties(
 286         issue=int(issue), messages=True)
 287     if re.match(REVERT_CL_SUBJECT_PREFIX, issue_properties['subject'], re.I):
 288       # It is a revert CL, ignore the public api owners check.
 289       return results
 290
 291     if issue_properties['cq_dry_run']:
 292       # Ignore public api owners check for dry run CLs since they are not
 293       # going to be committed.
 294       return results
 295
 296     match = re.search(r'^TBR=(.*)$', issue_properties['description'], re.M)
 297     if match:
 298       tbr_entries = match.group(1).strip().split(',')
 299       for owner in PUBLIC_API_OWNERS:
 300         if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
 301           # If an owner is specified in the TBR= line then ignore the public
 302           # api owners check.
 303           return results
 304
 305     if issue_properties['owner_email'] in PUBLIC_API_OWNERS:
 306       # An owner created the CL that is an automatic LGTM.
 307       lgtm_from_owner = True
 308
 309     messages = issue_properties.get('messages')
 310     if messages:
 311       for message in messages:
 312         if (message['sender'] in PUBLIC_API_OWNERS and
 313             'lgtm' in message['text'].lower()):
 314           # Found an lgtm in a message from an owner.
 315           lgtm_from_owner = True
 316           break
 317
 318   if not lgtm_from_owner:
 319     results.append(
 320         output_api.PresubmitError(
 321             "If this CL adds to or changes Skia's public API, you need an LGTM "
 322             "from any of %s.  If this CL only removes from or doesn't change "
 323             "Skia's public API, please add a short note to the CL saying so "
 324             "and add one of those reviewers on a TBR= line.  If you don't know "
 325             "if this CL affects Skia's public API, treat it like it does."
 326             % str(PUBLIC_API_OWNERS)))
 327   return results
 328
 329
 330 def PostUploadHook(cl, change, output_api):
 331   """git cl upload will call this hook after the issue is created/modified.
 332
 333   This hook does the following:
 334   * Adds a link to preview docs changes if there are any docs changes in the CL.
 335   * Adds 'NOTRY=true' if the CL contains only docs changes.
 336   * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
 337     need to be gated on the master branch's tree.
 338   * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
 339     work on them.
 340   * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
 341     run the presubmit checks.
 342   """
 343
 344   results = []
 345   atleast_one_docs_change = False
 346   all_docs_changes = True
 347   for affected_file in change.AffectedFiles():
 348     affected_file_path = affected_file.LocalPath()
 349     file_path, _ = os.path.splitext(affected_file_path)
 350     if 'site' == file_path.split(os.path.sep)[0]:
 351       atleast_one_docs_change = True
 352     else:
 353       all_docs_changes = False
 354     if atleast_one_docs_change and not all_docs_changes:
 355       break
 356
 357   issue = cl.issue
 358   rietveld_obj = cl.RpcServer()
 359   if issue and rietveld_obj:
 360     original_description = rietveld_obj.get_description(issue)
 361     new_description = original_description
 362
 363     # If the change includes only doc changes then add NOTRY=true in the
 364     # CL's description if it does not exist yet.
 365     if all_docs_changes and not re.search(
 366         r'^NOTRY=true$', new_description, re.M | re.I):
 367       new_description += '\nNOTRY=true'
 368       results.append(
 369           output_api.PresubmitNotifyResult(
 370               'This change has only doc changes. Automatically added '
 371               '\'NOTRY=true\' to the CL\'s description'))
 372
 373     # If there is atleast one docs change then add preview link in the CL's
 374     # description if it does not already exist there.
 375     if atleast_one_docs_change and not re.search(
 376         r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
 377       # Automatically add a link to where the docs can be previewed.
 378       new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
 379       results.append(
 380           output_api.PresubmitNotifyResult(
 381               'Automatically added a link to preview the docs changes to the '
 382               'CL\'s description'))
 383
 384     # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
 385     # to the CL's description if it does not already exist there.
 386     target_ref = rietveld_obj.get_issue_properties(issue, False).get(
 387         'target_ref', '')
 388     if target_ref != 'refs/heads/master':
 389       if not re.search(
 390           r'^NOTREECHECKS=true$', new_description, re.M | re.I):
 391         new_description += "\nNOTREECHECKS=true"
 392         results.append(
 393             output_api.PresubmitNotifyResult(
 394                 'Branch changes do not need to rely on the master branch\'s '
 395                 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
 396                 'CL\'s description'))
 397       if not re.search(
 398           r'^NOTRY=true$', new_description, re.M | re.I):
 399         new_description += "\nNOTRY=true"
 400         results.append(
 401             output_api.PresubmitNotifyResult(
 402                 'Trybots do not yet work for non-master branches. '
 403                 'Automatically added \'NOTRY=true\' to the CL\'s description'))
 404       if not re.search(
 405           r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
 406         new_description += "\nNOPRESUBMIT=true"
 407         results.append(
 408             output_api.PresubmitNotifyResult(
 409                 'Branch changes do not run the presubmit checks.'))
 410
 411     # Read and process the HASHTAGS file.
 412     hashtags_fullpath = os.path.join(change._local_root, 'HASHTAGS')
 413     with open(hashtags_fullpath, 'rb') as hashtags_csv:
 414       hashtags_reader = csv.reader(hashtags_csv, delimiter=',')
 415       for row in hashtags_reader:
 416         if not row or row[0].startswith('#'):
 417           # Ignore empty lines and comments
 418           continue
 419         hashtag = row[0]
 420         # Search for the hashtag in the description.
 421         if re.search('#%s' % hashtag, new_description, re.M | re.I):
 422           for mapped_text in row[1:]:
 423             # Special case handling for CQ_KEYWORDS_THAT_NEED_APPENDING.
 424             appended_description = _HandleAppendingCQKeywords(
 425                 hashtag, mapped_text, new_description, results, output_api)
 426             if appended_description:
 427               new_description = appended_description
 428               continue
 429
 430             # Add the mapped text if it does not already exist in the
 431             # CL's description.
 432             if not re.search(
 433                 r'^%s$' % mapped_text, new_description, re.M | re.I):
 434               new_description += '\n%s' % mapped_text
 435               results.append(
 436                   output_api.PresubmitNotifyResult(
 437                       'Found \'#%s\', automatically added \'%s\' to the CL\'s '
 438                       'description' % (hashtag, mapped_text)))
 439
 440     # If the description has changed update it.
 441     if new_description != original_description:
 442       rietveld_obj.update_description(issue, new_description)
 443
 444     return results
 445
 446
 447 def _HandleAppendingCQKeywords(hashtag, keyword_and_value, description,
 448                                results, output_api):
 449   """Handles the CQ keywords that need appending if specified in hashtags."""
 450   keyword = keyword_and_value.split('=')[0]
 451   if keyword in CQ_KEYWORDS_THAT_NEED_APPENDING:
 452     # If the keyword is already in the description then append to it.
 453     match = re.search(
 454         r'^%s=(.*)$' % keyword, description, re.M | re.I)
 455     if match:
 456       old_values = match.group(1).split(';')
 457       new_value = keyword_and_value.split('=')[1]
 458       if new_value in old_values:
 459         # Do not need to do anything here.
 460         return description
 461       # Update the description with the new values.
 462       new_description = description.replace(
 463           match.group(0), "%s;%s" % (match.group(0), new_value))
 464       results.append(
 465           output_api.PresubmitNotifyResult(
 466           'Found \'#%s\', automatically appended \'%s\' to %s in '
 467           'the CL\'s description' % (hashtag, new_value, keyword)))
 468       return new_description
 469   return None
 470
 471
 472 def CheckChangeOnCommit(input_api, output_api):
 473   """Presubmit checks for the change on commit.
 474
 475   The following are the presubmit checks:
 476   * Check change has one and only one EOL.
 477   * Ensures that the Skia tree is open in
 478     http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
 479     state and an error if it is in 'Closed' state.
 480   """
 481   results = []
 482   results.extend(_CommonChecks(input_api, output_api))
 483   results.extend(
 484       _CheckTreeStatus(input_api, output_api, json_url=(
 485           SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
 486   results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
 487   results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
 488   return results