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