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