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     'src/opts/': 'master.client.skia:Test-Ubuntu-GCC-GCE-CPU-AVX2-x86_64-Release-SKNX_NO_SIMD-Trybot',
  45
  46     'include/private/SkAtomics.h': ('master.client.skia:'
  47       'Test-Ubuntu-Clang-GCE-CPU-AVX2-x86_64-Release-TSAN-Trybot,'
  48       'Test-Ubuntu-Clang-Golo-GPU-GT610-x86_64-Release-TSAN-Trybot'
  49     ),
  50
  51     # Below are examples to show what is possible with this feature.
  52     # 'src/svg/': 'master1:abc;master2:def',
  53     # 'src/svg/parser/': 'master3:ghi,jkl;master4:mno',
  54     # 'src/image/SkImage_Base.h': 'master5:pqr,stu;master1:abc1;master2:def',
  55 }
  56
  57
  58 def _CheckChangeHasEol(input_api, output_api, source_file_filter=None):
  59   """Checks that files end with atleast one \n (LF)."""
  60   eof_files = []
  61   for f in input_api.AffectedSourceFiles(source_file_filter):
  62     contents = input_api.ReadFile(f, 'rb')
  63     # Check that the file ends in atleast one newline character.
  64     if len(contents) > 1 and contents[-1:] != '\n':
  65       eof_files.append(f.LocalPath())
  66
  67   if eof_files:
  68     return [output_api.PresubmitPromptWarning(
  69       'These files should end in a newline character:',
  70       items=eof_files)]
  71   return []
  72
  73
  74 def _PythonChecks(input_api, output_api):
  75   """Run checks on any modified Python files."""
  76   pylint_disabled_warnings = (
  77       'F0401',  # Unable to import.
  78       'E0611',  # No name in module.
  79       'W0232',  # Class has no __init__ method.
  80       'E1002',  # Use of super on an old style class.
  81       'W0403',  # Relative import used.
  82       'R0201',  # Method could be a function.
  83       'E1003',  # Using class name in super.
  84       'W0613',  # Unused argument.
  85       'W0105',  # String statement has no effect.
  86   )
  87   # Run Pylint on only the modified python files. Unfortunately it still runs
  88   # Pylint on the whole file instead of just the modified lines.
  89   affected_python_files = []
  90   for affected_file in input_api.AffectedSourceFiles(None):
  91     affected_file_path = affected_file.LocalPath()
  92     if affected_file_path.endswith('.py'):
  93       affected_python_files.append(affected_file_path)
  94   return input_api.canned_checks.RunPylint(
  95       input_api, output_api,
  96       disabled_warnings=pylint_disabled_warnings,
  97       white_list=affected_python_files)
  98
  99
 100 def _IfDefChecks(input_api, output_api):
 101   """Ensures if/ifdef are not before includes. See skbug/3362 for details."""
 102   comment_block_start_pattern = re.compile('^\s*\/\*.*$')
 103   comment_block_middle_pattern = re.compile('^\s+\*.*')
 104   comment_block_end_pattern = re.compile('^\s+\*\/.*$')
 105   single_line_comment_pattern = re.compile('^\s*//.*$')
 106   def is_comment(line):
 107     return (comment_block_start_pattern.match(line) or
 108             comment_block_middle_pattern.match(line) or
 109             comment_block_end_pattern.match(line) or
 110             single_line_comment_pattern.match(line))
 111
 112   empty_line_pattern = re.compile('^\s*$')
 113   def is_empty_line(line):
 114     return empty_line_pattern.match(line)
 115
 116   failing_files = []
 117   for affected_file in input_api.AffectedSourceFiles(None):
 118     affected_file_path = affected_file.LocalPath()
 119     if affected_file_path.endswith('.cpp') or affected_file_path.endswith('.h'):
 120       f = open(affected_file_path)
 121       for line in f.xreadlines():
 122         if is_comment(line) or is_empty_line(line):
 123           continue
 124         # The below will be the first real line after comments and newlines.
 125         if line.startswith('#if 0 '):
 126           pass
 127         elif line.startswith('#if ') or line.startswith('#ifdef '):
 128           failing_files.append(affected_file_path)
 129         break
 130
 131   results = []
 132   if failing_files:
 133     results.append(
 134         output_api.PresubmitError(
 135             'The following files have #if or #ifdef before includes:\n%s\n\n'
 136             'See https://bug.skia.org/3362 for why this should be fixed.' %
 137                 '\n'.join(failing_files)))
 138   return results
 139
 140
 141 def _CopyrightChecks(input_api, output_api, source_file_filter=None):
 142   results = []
 143   year_pattern = r'\d{4}'
 144   year_range_pattern = r'%s(-%s)?' % (year_pattern, year_pattern)
 145   years_pattern = r'%s(,%s)*,?' % (year_range_pattern, year_range_pattern)
 146   copyright_pattern = (
 147       r'Copyright (\([cC]\) )?%s \w+' % years_pattern)
 148
 149   for affected_file in input_api.AffectedSourceFiles(source_file_filter):
 150     if 'third_party' in affected_file.LocalPath():
 151       continue
 152     contents = input_api.ReadFile(affected_file, 'rb')
 153     if not re.search(copyright_pattern, contents):
 154       results.append(output_api.PresubmitError(
 155           '%s is missing a correct copyright header.' % affected_file))
 156   return results
 157
 158
 159 def _ToolFlags(input_api, output_api):
 160   """Make sure `{dm,nanobench}_flags.py test` passes if modified."""
 161   results = []
 162   sources = lambda x: ('dm_flags.py'        in x.LocalPath() or
 163                        'nanobench_flags.py' in x.LocalPath())
 164   for f in input_api.AffectedSourceFiles(sources):
 165     if 0 != subprocess.call(['python', f.LocalPath(), 'test']):
 166       results.append(output_api.PresubmitError('`python %s test` failed' % f))
 167   return results
 168
 169
 170 def _RecipeSimulationTest(input_api, output_api):
 171   """Run the recipe simulation test."""
 172   results = []
 173   if not any(f.LocalPath().startswith('infra')
 174              for f in input_api.AffectedFiles()):
 175     return results
 176
 177   recipes_py = os.path.join('infra', 'bots', 'recipes.py')
 178   cmd = ['python', recipes_py, 'simulation_test']
 179   try:
 180     subprocess.check_output(cmd)
 181   except subprocess.CalledProcessError as e:
 182     results.append(output_api.PresubmitError(
 183         '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
 184   return results
 185
 186
 187 def _GenTasksTest(input_api, output_api):
 188   """Run gen_tasks.go test."""
 189   results = []
 190   if not any(f.LocalPath().startswith('infra')
 191              for f in input_api.AffectedFiles()):
 192     return results
 193
 194   gen_tasks = os.path.join('infra', 'bots', 'gen_tasks.go')
 195   cmd = ['go', 'run', gen_tasks, '--test']
 196   try:
 197     subprocess.check_output(cmd)
 198   except subprocess.CalledProcessError as e:
 199     results.append(output_api.PresubmitError(
 200         '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
 201   return results
 202
 203
 204 def _CheckGNFormatted(input_api, output_api):
 205   """Make sure any .gn files we're changing have been formatted."""
 206   results = []
 207   for f in input_api.AffectedFiles():
 208     if not f.LocalPath().endswith('.gn'):
 209       continue
 210
 211     cmd = ['gn', 'format', '--dry-run', f.LocalPath()]
 212     try:
 213       subprocess.check_output(cmd)
 214     except subprocess.CalledProcessError:
 215       fix = 'gn format ' + f.LocalPath()
 216       results.append(output_api.PresubmitError(
 217           '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
 218   return results
 219
 220
 221 def _CommonChecks(input_api, output_api):
 222   """Presubmit checks common to upload and commit."""
 223   results = []
 224   sources = lambda x: (x.LocalPath().endswith('.h') or
 225                        x.LocalPath().endswith('.gypi') or
 226                        x.LocalPath().endswith('.gyp') or
 227                        x.LocalPath().endswith('.py') or
 228                        x.LocalPath().endswith('.sh') or
 229                        x.LocalPath().endswith('.m') or
 230                        x.LocalPath().endswith('.mm') or
 231                        x.LocalPath().endswith('.go') or
 232                        x.LocalPath().endswith('.c') or
 233                        x.LocalPath().endswith('.cc') or
 234                        x.LocalPath().endswith('.cpp'))
 235   results.extend(
 236       _CheckChangeHasEol(
 237           input_api, output_api, source_file_filter=sources))
 238   results.extend(_PythonChecks(input_api, output_api))
 239   results.extend(_IfDefChecks(input_api, output_api))
 240   results.extend(_CopyrightChecks(input_api, output_api,
 241                                   source_file_filter=sources))
 242   results.extend(_ToolFlags(input_api, output_api))
 243   return results
 244
 245
 246 def CheckChangeOnUpload(input_api, output_api):
 247   """Presubmit checks for the change on upload.
 248
 249   The following are the presubmit checks:
 250   * Check change has one and only one EOL.
 251   """
 252   results = []
 253   results.extend(_CommonChecks(input_api, output_api))
 254   # Run on upload, not commit, since the presubmit bot apparently doesn't have
 255   # coverage or Go installed.
 256   results.extend(_RecipeSimulationTest(input_api, output_api))
 257   results.extend(_GenTasksTest(input_api, output_api))
 258
 259   results.extend(_CheckGNFormatted(input_api, output_api))
 260   return results
 261
 262
 263 def _CheckTreeStatus(input_api, output_api, json_url):
 264   """Check whether to allow commit.
 265
 266   Args:
 267     input_api: input related apis.
 268     output_api: output related apis.
 269     json_url: url to download json style status.
 270   """
 271   tree_status_results = input_api.canned_checks.CheckTreeIsOpen(
 272       input_api, output_api, json_url=json_url)
 273   if not tree_status_results:
 274     # Check for caution state only if tree is not closed.
 275     connection = input_api.urllib2.urlopen(json_url)
 276     status = input_api.json.loads(connection.read())
 277     connection.close()
 278     if ('caution' in status['message'].lower() and
 279         os.isatty(sys.stdout.fileno())):
 280       # Display a prompt only if we are in an interactive shell. Without this
 281       # check the commit queue behaves incorrectly because it considers
 282       # prompts to be failures.
 283       short_text = 'Tree state is: ' + status['general_state']
 284       long_text = status['message'] + '\n' + json_url
 285       tree_status_results.append(
 286           output_api.PresubmitPromptWarning(
 287               message=short_text, long_text=long_text))
 288   else:
 289     # Tree status is closed. Put in message about contacting sheriff.
 290     connection = input_api.urllib2.urlopen(
 291         SKIA_TREE_STATUS_URL + '/current-sheriff')
 292     sheriff_details = input_api.json.loads(connection.read())
 293     if sheriff_details:
 294       tree_status_results[0]._message += (
 295           '\n\nPlease contact the current Skia sheriff (%s) if you are trying '
 296           'to submit a build fix\nand do not know how to submit because the '
 297           'tree is closed') % sheriff_details['username']
 298   return tree_status_results
 299
 300
 301 class CodeReview(object):
 302   """Abstracts which codereview tool is used for the specified issue."""
 303
 304   def __init__(self, input_api):
 305     self._issue = input_api.change.issue
 306     self._gerrit = input_api.gerrit
 307     self._rietveld_properties = None
 308     if not self._gerrit:
 309       self._rietveld_properties = input_api.rietveld.get_issue_properties(
 310           issue=int(self._issue), messages=True)
 311
 312   def GetOwnerEmail(self):
 313     if self._gerrit:
 314       return self._gerrit.GetChangeOwner(self._issue)
 315     else:
 316       return self._rietveld_properties['owner_email']
 317
 318   def GetSubject(self):
 319     if self._gerrit:
 320       return self._gerrit.GetChangeInfo(self._issue)['subject']
 321     else:
 322       return self._rietveld_properties['subject']
 323
 324   def GetDescription(self):
 325     if self._gerrit:
 326       return self._gerrit.GetChangeDescription(self._issue)
 327     else:
 328       return self._rietveld_properties['description']
 329
 330   def IsDryRun(self):
 331     if self._gerrit:
 332       return self._gerrit.GetChangeInfo(
 333           self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
 334     else:
 335       return self._rietveld_properties['cq_dry_run']
 336
 337   def GetReviewers(self):
 338     if self._gerrit:
 339       code_review_label = (
 340           self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
 341       return [r['email'] for r in code_review_label.get('all', [])]
 342     else:
 343       return self._rietveld_properties['reviewers']
 344
 345   def GetApprovers(self):
 346     approvers = []
 347     if self._gerrit:
 348       code_review_label = (
 349           self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
 350       for m in code_review_label.get('all', []):
 351         if m.get("value") == 1:
 352           approvers.append(m["email"])
 353     else:
 354       for m in self._rietveld_properties.get('messages', []):
 355         if 'lgtm' in m['text'].lower():
 356           approvers.append(m['sender'])
 357     return approvers
 358
 359
 360 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
 361   results = []
 362   if input_api.change.issue:
 363     cr = CodeReview(input_api)
 364
 365     owner_email = cr.GetOwnerEmail()
 366     try:
 367       authors_content = ''
 368       for line in open(AUTHORS_FILE_NAME):
 369         if not line.startswith('#'):
 370           authors_content += line
 371       email_fnmatches = re.findall('<(.*)>', authors_content)
 372       for email_fnmatch in email_fnmatches:
 373         if fnmatch.fnmatch(owner_email, email_fnmatch):
 374           # Found a match, the user is in the AUTHORS file break out of the loop
 375           break
 376       else:
 377         results.append(
 378           output_api.PresubmitError(
 379             'The email %s is not in Skia\'s AUTHORS file.\n'
 380             'Issue owner, this CL must include an addition to the Skia AUTHORS '
 381             'file.'
 382             % owner_email))
 383     except IOError:
 384       # Do not fail if authors file cannot be found.
 385       traceback.print_exc()
 386       input_api.logging.error('AUTHORS file not found!')
 387
 388   return results
 389
 390
 391 def _CheckLGTMsForPublicAPI(input_api, output_api):
 392   """Check LGTMs for public API changes.
 393
 394   For public API files make sure there is an LGTM from the list of owners in
 395   PUBLIC_API_OWNERS.
 396   """
 397   results = []
 398   requires_owner_check = False
 399   for affected_file in input_api.AffectedFiles():
 400     affected_file_path = affected_file.LocalPath()
 401     file_path, file_ext = os.path.splitext(affected_file_path)
 402     # We only care about files that end in .h and are under the top-level
 403     # include dir, but not include/private.
 404     if (file_ext == '.h' and
 405         'include' == file_path.split(os.path.sep)[0] and
 406         'private' not in file_path):
 407       requires_owner_check = True
 408
 409   if not requires_owner_check:
 410     return results
 411
 412   lgtm_from_owner = False
 413   if input_api.change.issue:
 414     cr = CodeReview(input_api)
 415
 416     if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
 417       # It is a revert CL, ignore the public api owners check.
 418       return results
 419
 420     if cr.IsDryRun():
 421       # Ignore public api owners check for dry run CLs since they are not
 422       # going to be committed.
 423       return results
 424
 425     if input_api.gerrit:
 426       for reviewer in cr.GetReviewers():
 427         if reviewer in PUBLIC_API_OWNERS:
 428           # If an owner is specified as an reviewer in Gerrit then ignore the
 429           # public api owners check.
 430           return results
 431     else:
 432       match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
 433       if match:
 434         tbr_section = match.group(1).strip().split(' ')[0]
 435         tbr_entries = tbr_section.split(',')
 436         for owner in PUBLIC_API_OWNERS:
 437           if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
 438             # If an owner is specified in the TBR= line then ignore the public
 439             # api owners check.
 440             return results
 441
 442     if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
 443       # An owner created the CL that is an automatic LGTM.
 444       lgtm_from_owner = True
 445
 446     for approver in cr.GetApprovers():
 447       if approver in PUBLIC_API_OWNERS:
 448         # Found an lgtm in a message from an owner.
 449         lgtm_from_owner = True
 450         break
 451
 452   if not lgtm_from_owner:
 453     results.append(
 454         output_api.PresubmitError(
 455             "If this CL adds to or changes Skia's public API, you need an LGTM "
 456             "from any of %s.  If this CL only removes from or doesn't change "
 457             "Skia's public API, please add a short note to the CL saying so. "
 458             "Add one of the owners as a reviewer to your CL. For Rietveld CLs "
 459             "you also need to add one of those owners on a TBR= line.  If you "
 460             "don't know if this CL affects Skia's public API, treat it like it "
 461             "does." % str(PUBLIC_API_OWNERS)))
 462   return results
 463
 464
 465 def PostUploadHook(cl, change, output_api):
 466   """git cl upload will call this hook after the issue is created/modified.
 467
 468   This hook does the following:
 469   * Adds a link to the CL's Gold trybot results.
 470   * Adds a link to preview docs changes if there are any docs changes in the CL.
 471   * Adds 'NOTRY=true' if the CL contains only docs changes.
 472   * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
 473     need to be gated on the master branch's tree.
 474   * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
 475     work on them.
 476   * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
 477     run the presubmit checks.
 478   * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
 479   """
 480
 481   results = []
 482   atleast_one_docs_change = False
 483   all_docs_changes = True
 484   for affected_file in change.AffectedFiles():
 485     affected_file_path = affected_file.LocalPath()
 486     file_path, _ = os.path.splitext(affected_file_path)
 487     if 'site' == file_path.split(os.path.sep)[0]:
 488       atleast_one_docs_change = True
 489     else:
 490       all_docs_changes = False
 491     if atleast_one_docs_change and not all_docs_changes:
 492       break
 493
 494   issue = cl.issue
 495   if issue:
 496     original_description = cl.GetDescription()
 497     changeIdLine = None
 498     if cl.IsGerrit():
 499       # Remove Change-Id from description and add it back at the end.
 500       regex = re.compile(r'^(Change-Id: (\w+))(\n*)\Z', re.M | re.I)
 501       changeIdLine = re.search(regex, original_description).group(0)
 502       original_description = re.sub(regex, '', original_description)
 503       original_description = re.sub('\n+\Z', '\n', original_description)
 504
 505     new_description = original_description
 506
 507     # Add GOLD_TRYBOT_URL if it does not exist yet.
 508     if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
 509       new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
 510       results.append(
 511           output_api.PresubmitNotifyResult(
 512               'Added link to Gold trybot runs to the CL\'s description.\n'
 513               'Note: Results may take sometime to be populated after trybots '
 514               'complete.'))
 515
 516     # If the change includes only doc changes then add NOTRY=true in the
 517     # CL's description if it does not exist yet.
 518     if all_docs_changes and not re.search(
 519         r'^NOTRY=true$', new_description, re.M | re.I):
 520       new_description += '\nNOTRY=true'
 521       results.append(
 522           output_api.PresubmitNotifyResult(
 523               'This change has only doc changes. Automatically added '
 524               '\'NOTRY=true\' to the CL\'s description'))
 525
 526     # If there is atleast one docs change then add preview link in the CL's
 527     # description if it does not already exist there.
 528     if atleast_one_docs_change and not re.search(
 529         r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
 530       # Automatically add a link to where the docs can be previewed.
 531       new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
 532       results.append(
 533           output_api.PresubmitNotifyResult(
 534               'Automatically added a link to preview the docs changes to the '
 535               'CL\'s description'))
 536
 537     # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
 538     # to the CL's description if it does not already exist there.
 539     target_ref = cl.GetRemoteBranch()[1]
 540     if target_ref != 'refs/remotes/origin/master':
 541       if not re.search(
 542           r'^NOTREECHECKS=true$', new_description, re.M | re.I):
 543         new_description += "\nNOTREECHECKS=true"
 544         results.append(
 545             output_api.PresubmitNotifyResult(
 546                 'Branch changes do not need to rely on the master branch\'s '
 547                 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
 548                 'CL\'s description'))
 549       if not re.search(
 550           r'^NOTRY=true$', new_description, re.M | re.I):
 551         new_description += "\nNOTRY=true"
 552         results.append(
 553             output_api.PresubmitNotifyResult(
 554                 'Trybots do not yet work for non-master branches. '
 555                 'Automatically added \'NOTRY=true\' to the CL\'s description'))
 556       if not re.search(
 557           r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
 558         new_description += "\nNOPRESUBMIT=true"
 559         results.append(
 560             output_api.PresubmitNotifyResult(
 561                 'Branch changes do not run the presubmit checks.'))
 562
 563     # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
 564     # begin with the paths of interest.
 565     cq_master_to_trybots = collections.defaultdict(set)
 566     for affected_file in change.AffectedFiles():
 567       affected_file_path = affected_file.LocalPath()
 568       for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
 569         if affected_file_path.startswith(path_prefix):
 570           results.append(
 571               output_api.PresubmitNotifyResult(
 572                   'Your CL modifies the path %s.\nAutomatically adding %s to '
 573                   'the CL description.' % (affected_file_path, extra_bots)))
 574           _MergeCQExtraTrybotsMaps(
 575               cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
 576     if cq_master_to_trybots:
 577       new_description = _AddCQExtraTrybotsToDesc(
 578           cq_master_to_trybots, new_description)
 579
 580     # If the description has changed update it.
 581     if new_description != original_description:
 582       if changeIdLine:
 583         # The Change-Id line must have two newlines before it.
 584         new_description += '\n\n' + changeIdLine
 585       cl.UpdateDescription(new_description)
 586
 587     return results
 588
 589
 590 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
 591   """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
 592
 593   If the keyword already exists in the description then it appends to it only
 594   if the specified values do not already exist.
 595   If the keyword does not exist then it creates a new section in the
 596   description.
 597   """
 598   match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
 599   if match:
 600     original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
 601     _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
 602     new_description = description.replace(
 603         match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
 604   else:
 605     new_description = description + "\n%s" % (
 606         _GetCQExtraTrybotsStr(cq_master_to_trybots))
 607   return new_description
 608
 609
 610 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
 611   """Merges two maps of masters to trybots into one."""
 612   for master, trybots in map_to_be_consumed.iteritems():
 613     dest_map[master].update(trybots)
 614   return dest_map
 615
 616
 617 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
 618   """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
 619   cq_master_to_trybots = collections.defaultdict(set)
 620   for section in cq_extra_trybots_str.split(';'):
 621     if section:
 622       master, bots = section.split(':')
 623       cq_master_to_trybots[master].update(bots.split(','))
 624   return cq_master_to_trybots
 625
 626
 627 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
 628   """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
 629   sections = []
 630   for master, trybots in cq_master_to_trybots.iteritems():
 631     sections.append('%s:%s' % (master, ','.join(trybots)))
 632   return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
 633
 634
 635 def CheckChangeOnCommit(input_api, output_api):
 636   """Presubmit checks for the change on commit.
 637
 638   The following are the presubmit checks:
 639   * Check change has one and only one EOL.
 640   * Ensures that the Skia tree is open in
 641     http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
 642     state and an error if it is in 'Closed' state.
 643   """
 644   results = []
 645   results.extend(_CommonChecks(input_api, output_api))
 646   results.extend(
 647       _CheckTreeStatus(input_api, output_api, json_url=(
 648           SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
 649   results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
 650   results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
 651   return results