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/': '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',
  47
  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'
  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 _RecipeSimulationTest(input_api, output_api):
 173   """Run the recipe simulation test."""
 174   results = []
 175   if not any(f.LocalPath().startswith('infra')
 176              for f in input_api.AffectedFiles()):
 177     return results
 178
 179   recipes_py = os.path.join('infra', 'bots', 'recipes.py')
 180   cmd = ['python', recipes_py, 'simulation_test']
 181   try:
 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)))
 186   return results
 187
 188 def _CheckGNFormatted(input_api, output_api):
 189   """Make sure any .gn files we're changing have been formatted."""
 190   results = []
 191   for f in input_api.AffectedFiles():
 192     if not f.LocalPath().endswith('.gn'):
 193       continue
 194
 195     cmd = ['gn', 'format', '--dry-run', f.LocalPath()]
 196     try:
 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)))
 202   return results
 203
 204
 205 def _CommonChecks(input_api, output_api):
 206   """Presubmit checks common to upload and commit."""
 207   results = []
 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'))
 219   results.extend(
 220       _CheckChangeHasEol(
 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))
 227   return results
 228
 229
 230 def CheckChangeOnUpload(input_api, output_api):
 231   """Presubmit checks for the change on upload.
 232
 233   The following are the presubmit checks:
 234   * Check change has one and only one EOL.
 235   """
 236   results = []
 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))
 242   return results
 243
 244
 245 def _CheckTreeStatus(input_api, output_api, json_url):
 246   """Check whether to allow commit.
 247
 248   Args:
 249     input_api: input related apis.
 250     output_api: output related apis.
 251     json_url: url to download json style status.
 252   """
 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())
 259     connection.close()
 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))
 270   else:
 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())
 275     if sheriff_details:
 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
 281
 282
 283 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
 284   results = []
 285   issue = input_api.change.issue
 286   if issue and input_api.rietveld:
 287     issue_properties = input_api.rietveld.get_issue_properties(
 288         issue=int(issue), messages=False)
 289     owner_email = issue_properties['owner_email']
 290
 291     try:
 292       authors_content = ''
 293       for line in open(AUTHORS_FILE_NAME):
 294         if not line.startswith('#'):
 295           authors_content += line
 296       email_fnmatches = re.findall('<(.*)>', authors_content)
 297       for email_fnmatch in email_fnmatches:
 298         if fnmatch.fnmatch(owner_email, email_fnmatch):
 299           # Found a match, the user is in the AUTHORS file break out of the loop
 300           break
 301       else:
 302         results.append(
 303           output_api.PresubmitError(
 304             'The email %s is not in Skia\'s AUTHORS file.\n'
 305             'Issue owner, this CL must include an addition to the Skia AUTHORS '
 306             'file.'
 307             % owner_email))
 308     except IOError:
 309       # Do not fail if authors file cannot be found.
 310       traceback.print_exc()
 311       input_api.logging.error('AUTHORS file not found!')
 312
 313   return results
 314
 315
 316 def _CheckLGTMsForPublicAPI(input_api, output_api):
 317   """Check LGTMs for public API changes.
 318
 319   For public API files make sure there is an LGTM from the list of owners in
 320   PUBLIC_API_OWNERS.
 321   """
 322   results = []
 323   requires_owner_check = False
 324   for affected_file in input_api.AffectedFiles():
 325     affected_file_path = affected_file.LocalPath()
 326     file_path, file_ext = os.path.splitext(affected_file_path)
 327     # We only care about files that end in .h and are under the top-level
 328     # include dir, but not include/private.
 329     if (file_ext == '.h' and
 330         'include' == file_path.split(os.path.sep)[0] and
 331         'private' not in file_path):
 332       requires_owner_check = True
 333
 334   if not requires_owner_check:
 335     return results
 336
 337   lgtm_from_owner = False
 338   issue = input_api.change.issue
 339   if issue and input_api.rietveld:
 340     issue_properties = input_api.rietveld.get_issue_properties(
 341         issue=int(issue), messages=True)
 342     if re.match(REVERT_CL_SUBJECT_PREFIX, issue_properties['subject'], re.I):
 343       # It is a revert CL, ignore the public api owners check.
 344       return results
 345
 346     if issue_properties['cq_dry_run']:
 347       # Ignore public api owners check for dry run CLs since they are not
 348       # going to be committed.
 349       return results
 350
 351     match = re.search(r'^TBR=(.*)$', issue_properties['description'], re.M)
 352     if match:
 353       tbr_entries = match.group(1).strip().split(',')
 354       for owner in PUBLIC_API_OWNERS:
 355         if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
 356           # If an owner is specified in the TBR= line then ignore the public
 357           # api owners check.
 358           return results
 359
 360     if issue_properties['owner_email'] in PUBLIC_API_OWNERS:
 361       # An owner created the CL that is an automatic LGTM.
 362       lgtm_from_owner = True
 363
 364     messages = issue_properties.get('messages')
 365     if messages:
 366       for message in messages:
 367         if (message['sender'] in PUBLIC_API_OWNERS and
 368             'lgtm' in message['text'].lower()):
 369           # Found an lgtm in a message from an owner.
 370           lgtm_from_owner = True
 371           break
 372
 373   if not lgtm_from_owner:
 374     results.append(
 375         output_api.PresubmitError(
 376             "If this CL adds to or changes Skia's public API, you need an LGTM "
 377             "from any of %s.  If this CL only removes from or doesn't change "
 378             "Skia's public API, please add a short note to the CL saying so "
 379             "and add one of those reviewers on a TBR= line.  If you don't know "
 380             "if this CL affects Skia's public API, treat it like it does."
 381             % str(PUBLIC_API_OWNERS)))
 382   return results
 383
 384
 385 def PostUploadHook(cl, change, output_api):
 386   """git cl upload will call this hook after the issue is created/modified.
 387
 388   This hook does the following:
 389   * Adds a link to the CL's Gold trybot results.
 390   * Adds a link to preview docs changes if there are any docs changes in the CL.
 391   * Adds 'NOTRY=true' if the CL contains only docs changes.
 392   * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
 393     need to be gated on the master branch's tree.
 394   * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
 395     work on them.
 396   * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
 397     run the presubmit checks.
 398   * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
 399   """
 400
 401   results = []
 402   atleast_one_docs_change = False
 403   all_docs_changes = True
 404   for affected_file in change.AffectedFiles():
 405     affected_file_path = affected_file.LocalPath()
 406     file_path, _ = os.path.splitext(affected_file_path)
 407     if 'site' == file_path.split(os.path.sep)[0]:
 408       atleast_one_docs_change = True
 409     else:
 410       all_docs_changes = False
 411     if atleast_one_docs_change and not all_docs_changes:
 412       break
 413
 414   issue = cl.issue
 415   rietveld_obj = cl.RpcServer()
 416   if issue and rietveld_obj:
 417     original_description = rietveld_obj.get_description(issue)
 418     new_description = original_description
 419
 420     # Add GOLD_TRYBOT_URL if it does not exist yet.
 421     if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
 422       new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
 423       results.append(
 424           output_api.PresubmitNotifyResult(
 425               'Added link to Gold trybot runs to the CL\'s description.\n'
 426               'Note: Results may take sometime to be populated after trybots '
 427               'complete.'))
 428
 429     # If the change includes only doc changes then add NOTRY=true in the
 430     # CL's description if it does not exist yet.
 431     if all_docs_changes and not re.search(
 432         r'^NOTRY=true$', new_description, re.M | re.I):
 433       new_description += '\nNOTRY=true'
 434       results.append(
 435           output_api.PresubmitNotifyResult(
 436               'This change has only doc changes. Automatically added '
 437               '\'NOTRY=true\' to the CL\'s description'))
 438
 439     # If there is atleast one docs change then add preview link in the CL's
 440     # description if it does not already exist there.
 441     if atleast_one_docs_change and not re.search(
 442         r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
 443       # Automatically add a link to where the docs can be previewed.
 444       new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
 445       results.append(
 446           output_api.PresubmitNotifyResult(
 447               'Automatically added a link to preview the docs changes to the '
 448               'CL\'s description'))
 449
 450     # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
 451     # to the CL's description if it does not already exist there.
 452     target_ref = rietveld_obj.get_issue_properties(issue, False).get(
 453         'target_ref', '')
 454     if target_ref != 'refs/heads/master':
 455       if not re.search(
 456           r'^NOTREECHECKS=true$', new_description, re.M | re.I):
 457         new_description += "\nNOTREECHECKS=true"
 458         results.append(
 459             output_api.PresubmitNotifyResult(
 460                 'Branch changes do not need to rely on the master branch\'s '
 461                 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
 462                 'CL\'s description'))
 463       if not re.search(
 464           r'^NOTRY=true$', new_description, re.M | re.I):
 465         new_description += "\nNOTRY=true"
 466         results.append(
 467             output_api.PresubmitNotifyResult(
 468                 'Trybots do not yet work for non-master branches. '
 469                 'Automatically added \'NOTRY=true\' to the CL\'s description'))
 470       if not re.search(
 471           r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
 472         new_description += "\nNOPRESUBMIT=true"
 473         results.append(
 474             output_api.PresubmitNotifyResult(
 475                 'Branch changes do not run the presubmit checks.'))
 476
 477     # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
 478     # begin with the paths of interest.
 479     cq_master_to_trybots = collections.defaultdict(set)
 480     for affected_file in change.AffectedFiles():
 481       affected_file_path = affected_file.LocalPath()
 482       for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
 483         if affected_file_path.startswith(path_prefix):
 484           results.append(
 485               output_api.PresubmitNotifyResult(
 486                   'Your CL modifies the path %s.\nAutomatically adding %s to '
 487                   'the CL description.' % (affected_file_path, extra_bots)))
 488           _MergeCQExtraTrybotsMaps(
 489               cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
 490     if cq_master_to_trybots:
 491       new_description = _AddCQExtraTrybotsToDesc(
 492           cq_master_to_trybots, new_description)
 493
 494     # If the description has changed update it.
 495     if new_description != original_description:
 496       rietveld_obj.update_description(issue, new_description)
 497
 498     return results
 499
 500
 501 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
 502   """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
 503
 504   If the keyword already exists in the description then it appends to it only
 505   if the specified values do not already exist.
 506   If the keyword does not exist then it creates a new section in the
 507   description.
 508   """
 509   match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
 510   if match:
 511     original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
 512     _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
 513     new_description = description.replace(
 514         match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
 515   else:
 516     new_description = description + "\n%s" % (
 517         _GetCQExtraTrybotsStr(cq_master_to_trybots))
 518   return new_description
 519
 520
 521 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
 522   """Merges two maps of masters to trybots into one."""
 523   for master, trybots in map_to_be_consumed.iteritems():
 524     dest_map[master].update(trybots)
 525   return dest_map
 526
 527
 528 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
 529   """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
 530   cq_master_to_trybots = collections.defaultdict(set)
 531   for section in cq_extra_trybots_str.split(';'):
 532     if section:
 533       master, bots = section.split(':')
 534       cq_master_to_trybots[master].update(bots.split(','))
 535   return cq_master_to_trybots
 536
 537
 538 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
 539   """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
 540   sections = []
 541   for master, trybots in cq_master_to_trybots.iteritems():
 542     sections.append('%s:%s' % (master, ','.join(trybots)))
 543   return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
 544
 545
 546 def CheckChangeOnCommit(input_api, output_api):
 547   """Presubmit checks for the change on commit.
 548
 549   The following are the presubmit checks:
 550   * Check change has one and only one EOL.
 551   * Ensures that the Skia tree is open in
 552     http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
 553     state and an error if it is in 'Closed' state.
 554   """
 555   results = []
 556   results.extend(_CommonChecks(input_api, output_api))
 557   results.extend(
 558       _CheckTreeStatus(input_api, output_api, json_url=(
 559           SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
 560   results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
 561   results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
 562   return results