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