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 _InfraTests(input_api, output_api):
 171   """Run the infra tests."""
 172   results = []
 173   if not any(f.LocalPath().startswith('infra')
 174              for f in input_api.AffectedFiles()):
 175     return results
 176
 177   cmd = ['python', os.path.join('infra', 'bots', 'infra_tests.py')]
 178   try:
 179     subprocess.check_output(cmd)
 180   except subprocess.CalledProcessError as e:
 181     results.append(output_api.PresubmitError(
 182         '`%s` failed:\n%s' % (' '.join(cmd), e.output)))
 183   return results
 184
 185
 186 def _CheckGNFormatted(input_api, output_api):
 187   """Make sure any .gn files we're changing have been formatted."""
 188   results = []
 189   for f in input_api.AffectedFiles():
 190     if not f.LocalPath().endswith('.gn'):
 191       continue
 192
 193     gn = 'gn.bat' if 'win32' in sys.platform else 'gn'
 194     cmd = [gn, 'format', '--dry-run', f.LocalPath()]
 195     try:
 196       subprocess.check_output(cmd)
 197     except subprocess.CalledProcessError:
 198       fix = 'gn format ' + f.LocalPath()
 199       results.append(output_api.PresubmitError(
 200           '`%s` failed, try\n\t%s' % (' '.join(cmd), fix)))
 201   return results
 202
 203
 204 def _CommonChecks(input_api, output_api):
 205   """Presubmit checks common to upload and commit."""
 206   results = []
 207   sources = lambda x: (x.LocalPath().endswith('.h') or
 208                        x.LocalPath().endswith('.gypi') or
 209                        x.LocalPath().endswith('.gyp') or
 210                        x.LocalPath().endswith('.py') or
 211                        x.LocalPath().endswith('.sh') or
 212                        x.LocalPath().endswith('.m') or
 213                        x.LocalPath().endswith('.mm') or
 214                        x.LocalPath().endswith('.go') or
 215                        x.LocalPath().endswith('.c') or
 216                        x.LocalPath().endswith('.cc') or
 217                        x.LocalPath().endswith('.cpp'))
 218   results.extend(
 219       _CheckChangeHasEol(
 220           input_api, output_api, source_file_filter=sources))
 221   results.extend(_PythonChecks(input_api, output_api))
 222   results.extend(_IfDefChecks(input_api, output_api))
 223   results.extend(_CopyrightChecks(input_api, output_api,
 224                                   source_file_filter=sources))
 225   results.extend(_ToolFlags(input_api, output_api))
 226   return results
 227
 228
 229 def CheckChangeOnUpload(input_api, output_api):
 230   """Presubmit checks for the change on upload.
 231
 232   The following are the presubmit checks:
 233   * Check change has one and only one EOL.
 234   """
 235   results = []
 236   results.extend(_CommonChecks(input_api, output_api))
 237   # Run on upload, not commit, since the presubmit bot apparently doesn't have
 238   # coverage or Go installed.
 239   results.extend(_InfraTests(input_api, output_api))
 240
 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 class CodeReview(object):
 284   """Abstracts which codereview tool is used for the specified issue."""
 285
 286   def __init__(self, input_api):
 287     self._issue = input_api.change.issue
 288     self._gerrit = input_api.gerrit
 289     self._rietveld_properties = None
 290     if not self._gerrit:
 291       self._rietveld_properties = input_api.rietveld.get_issue_properties(
 292           issue=int(self._issue), messages=True)
 293
 294   def GetOwnerEmail(self):
 295     if self._gerrit:
 296       return self._gerrit.GetChangeOwner(self._issue)
 297     else:
 298       return self._rietveld_properties['owner_email']
 299
 300   def GetSubject(self):
 301     if self._gerrit:
 302       return self._gerrit.GetChangeInfo(self._issue)['subject']
 303     else:
 304       return self._rietveld_properties['subject']
 305
 306   def GetDescription(self):
 307     if self._gerrit:
 308       return self._gerrit.GetChangeDescription(self._issue)
 309     else:
 310       return self._rietveld_properties['description']
 311
 312   def IsDryRun(self):
 313     if self._gerrit:
 314       return self._gerrit.GetChangeInfo(
 315           self._issue)['labels']['Commit-Queue'].get('value', 0) == 1
 316     else:
 317       return self._rietveld_properties['cq_dry_run']
 318
 319   def GetReviewers(self):
 320     if self._gerrit:
 321       code_review_label = (
 322           self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
 323       return [r['email'] for r in code_review_label.get('all', [])]
 324     else:
 325       return self._rietveld_properties['reviewers']
 326
 327   def GetApprovers(self):
 328     approvers = []
 329     if self._gerrit:
 330       code_review_label = (
 331           self._gerrit.GetChangeInfo(self._issue)['labels']['Code-Review'])
 332       for m in code_review_label.get('all', []):
 333         if m.get("value") == 1:
 334           approvers.append(m["email"])
 335     else:
 336       for m in self._rietveld_properties.get('messages', []):
 337         if 'lgtm' in m['text'].lower():
 338           approvers.append(m['sender'])
 339     return approvers
 340
 341
 342 def _CheckOwnerIsInAuthorsFile(input_api, output_api):
 343   results = []
 344   if input_api.change.issue:
 345     cr = CodeReview(input_api)
 346
 347     owner_email = cr.GetOwnerEmail()
 348     try:
 349       authors_content = ''
 350       for line in open(AUTHORS_FILE_NAME):
 351         if not line.startswith('#'):
 352           authors_content += line
 353       email_fnmatches = re.findall('<(.*)>', authors_content)
 354       for email_fnmatch in email_fnmatches:
 355         if fnmatch.fnmatch(owner_email, email_fnmatch):
 356           # Found a match, the user is in the AUTHORS file break out of the loop
 357           break
 358       else:
 359         results.append(
 360           output_api.PresubmitError(
 361             'The email %s is not in Skia\'s AUTHORS file.\n'
 362             'Issue owner, this CL must include an addition to the Skia AUTHORS '
 363             'file.'
 364             % owner_email))
 365     except IOError:
 366       # Do not fail if authors file cannot be found.
 367       traceback.print_exc()
 368       input_api.logging.error('AUTHORS file not found!')
 369
 370   return results
 371
 372
 373 def _CheckLGTMsForPublicAPI(input_api, output_api):
 374   """Check LGTMs for public API changes.
 375
 376   For public API files make sure there is an LGTM from the list of owners in
 377   PUBLIC_API_OWNERS.
 378   """
 379   results = []
 380   requires_owner_check = False
 381   for affected_file in input_api.AffectedFiles():
 382     affected_file_path = affected_file.LocalPath()
 383     file_path, file_ext = os.path.splitext(affected_file_path)
 384     # We only care about files that end in .h and are under the top-level
 385     # include dir, but not include/private.
 386     if (file_ext == '.h' and
 387         'include' == file_path.split(os.path.sep)[0] and
 388         'private' not in file_path):
 389       requires_owner_check = True
 390
 391   if not requires_owner_check:
 392     return results
 393
 394   lgtm_from_owner = False
 395   if input_api.change.issue:
 396     cr = CodeReview(input_api)
 397
 398     if re.match(REVERT_CL_SUBJECT_PREFIX, cr.GetSubject(), re.I):
 399       # It is a revert CL, ignore the public api owners check.
 400       return results
 401
 402     if cr.IsDryRun():
 403       # Ignore public api owners check for dry run CLs since they are not
 404       # going to be committed.
 405       return results
 406
 407     if input_api.gerrit:
 408       for reviewer in cr.GetReviewers():
 409         if reviewer in PUBLIC_API_OWNERS:
 410           # If an owner is specified as an reviewer in Gerrit then ignore the
 411           # public api owners check.
 412           return results
 413     else:
 414       match = re.search(r'^TBR=(.*)$', cr.GetDescription(), re.M)
 415       if match:
 416         tbr_section = match.group(1).strip().split(' ')[0]
 417         tbr_entries = tbr_section.split(',')
 418         for owner in PUBLIC_API_OWNERS:
 419           if owner in tbr_entries or owner.split('@')[0] in tbr_entries:
 420             # If an owner is specified in the TBR= line then ignore the public
 421             # api owners check.
 422             return results
 423
 424     if cr.GetOwnerEmail() in PUBLIC_API_OWNERS:
 425       # An owner created the CL that is an automatic LGTM.
 426       lgtm_from_owner = True
 427
 428     for approver in cr.GetApprovers():
 429       if approver in PUBLIC_API_OWNERS:
 430         # Found an lgtm in a message from an owner.
 431         lgtm_from_owner = True
 432         break
 433
 434   if not lgtm_from_owner:
 435     results.append(
 436         output_api.PresubmitError(
 437             "If this CL adds to or changes Skia's public API, you need an LGTM "
 438             "from any of %s.  If this CL only removes from or doesn't change "
 439             "Skia's public API, please add a short note to the CL saying so. "
 440             "Add one of the owners as a reviewer to your CL. For Rietveld CLs "
 441             "you also need to add one of those owners on a TBR= line.  If you "
 442             "don't know if this CL affects Skia's public API, treat it like it "
 443             "does." % str(PUBLIC_API_OWNERS)))
 444   return results
 445
 446
 447 def PostUploadHook(cl, change, output_api):
 448   """git cl upload will call this hook after the issue is created/modified.
 449
 450   This hook does the following:
 451   * Adds a link to the CL's Gold trybot results.
 452   * Adds a link to preview docs changes if there are any docs changes in the CL.
 453   * Adds 'NOTRY=true' if the CL contains only docs changes.
 454   * Adds 'NOTREECHECKS=true' for non master branch changes since they do not
 455     need to be gated on the master branch's tree.
 456   * Adds 'NOTRY=true' for non master branch changes since trybots do not yet
 457     work on them.
 458   * Adds 'NOPRESUBMIT=true' for non master branch changes since those don't
 459     run the presubmit checks.
 460   * Adds extra trybots for the paths defined in PATH_TO_EXTRA_TRYBOTS.
 461   """
 462
 463   results = []
 464   atleast_one_docs_change = False
 465   all_docs_changes = True
 466   for affected_file in change.AffectedFiles():
 467     affected_file_path = affected_file.LocalPath()
 468     file_path, _ = os.path.splitext(affected_file_path)
 469     if 'site' == file_path.split(os.path.sep)[0]:
 470       atleast_one_docs_change = True
 471     else:
 472       all_docs_changes = False
 473     if atleast_one_docs_change and not all_docs_changes:
 474       break
 475
 476   issue = cl.issue
 477   if issue:
 478     original_description = cl.GetDescription()
 479     changeIdLine = None
 480     if cl.IsGerrit():
 481       # Remove Change-Id from description and add it back at the end.
 482       regex = re.compile(r'^(Change-Id: (\w+))(\n*)\Z', re.M | re.I)
 483       changeIdLine = re.search(regex, original_description).group(0)
 484       original_description = re.sub(regex, '', original_description)
 485       original_description = re.sub('\n+\Z', '\n', original_description)
 486
 487     new_description = original_description
 488
 489     # Add GOLD_TRYBOT_URL if it does not exist yet.
 490     if not re.search(r'^GOLD_TRYBOT_URL=', new_description, re.M | re.I):
 491       new_description += '\nGOLD_TRYBOT_URL= %s%s' % (GOLD_TRYBOT_URL, issue)
 492       results.append(
 493           output_api.PresubmitNotifyResult(
 494               'Added link to Gold trybot runs to the CL\'s description.\n'
 495               'Note: Results may take sometime to be populated after trybots '
 496               'complete.'))
 497
 498     # If the change includes only doc changes then add NOTRY=true in the
 499     # CL's description if it does not exist yet.
 500     if all_docs_changes and not re.search(
 501         r'^NOTRY=true$', new_description, re.M | re.I):
 502       new_description += '\nNOTRY=true'
 503       results.append(
 504           output_api.PresubmitNotifyResult(
 505               'This change has only doc changes. Automatically added '
 506               '\'NOTRY=true\' to the CL\'s description'))
 507
 508     # If there is atleast one docs change then add preview link in the CL's
 509     # description if it does not already exist there.
 510     if atleast_one_docs_change and not re.search(
 511         r'^DOCS_PREVIEW=.*', new_description, re.M | re.I):
 512       # Automatically add a link to where the docs can be previewed.
 513       new_description += '\nDOCS_PREVIEW= %s%s' % (DOCS_PREVIEW_URL, issue)
 514       results.append(
 515           output_api.PresubmitNotifyResult(
 516               'Automatically added a link to preview the docs changes to the '
 517               'CL\'s description'))
 518
 519     # If the target ref is not master then add NOTREECHECKS=true and NOTRY=true
 520     # to the CL's description if it does not already exist there.
 521     target_ref = cl.GetRemoteBranch()[1]
 522     if target_ref != 'refs/remotes/origin/master':
 523       if not re.search(
 524           r'^NOTREECHECKS=true$', new_description, re.M | re.I):
 525         new_description += "\nNOTREECHECKS=true"
 526         results.append(
 527             output_api.PresubmitNotifyResult(
 528                 'Branch changes do not need to rely on the master branch\'s '
 529                 'tree status. Automatically added \'NOTREECHECKS=true\' to the '
 530                 'CL\'s description'))
 531       if not re.search(
 532           r'^NOTRY=true$', new_description, re.M | re.I):
 533         new_description += "\nNOTRY=true"
 534         results.append(
 535             output_api.PresubmitNotifyResult(
 536                 'Trybots do not yet work for non-master branches. '
 537                 'Automatically added \'NOTRY=true\' to the CL\'s description'))
 538       if not re.search(
 539           r'^NOPRESUBMIT=true$', new_description, re.M | re.I):
 540         new_description += "\nNOPRESUBMIT=true"
 541         results.append(
 542             output_api.PresubmitNotifyResult(
 543                 'Branch changes do not run the presubmit checks.'))
 544
 545     # Automatically set CQ_INCLUDE_TRYBOTS if any of the changed files here
 546     # begin with the paths of interest.
 547     cq_master_to_trybots = collections.defaultdict(set)
 548     for affected_file in change.AffectedFiles():
 549       affected_file_path = affected_file.LocalPath()
 550       for path_prefix, extra_bots in PATH_PREFIX_TO_EXTRA_TRYBOTS.iteritems():
 551         if affected_file_path.startswith(path_prefix):
 552           results.append(
 553               output_api.PresubmitNotifyResult(
 554                   'Your CL modifies the path %s.\nAutomatically adding %s to '
 555                   'the CL description.' % (affected_file_path, extra_bots)))
 556           _MergeCQExtraTrybotsMaps(
 557               cq_master_to_trybots, _GetCQExtraTrybotsMap(extra_bots))
 558     if cq_master_to_trybots:
 559       new_description = _AddCQExtraTrybotsToDesc(
 560           cq_master_to_trybots, new_description)
 561
 562     # If the description has changed update it.
 563     if new_description != original_description:
 564       if changeIdLine:
 565         # The Change-Id line must have two newlines before it.
 566         new_description += '\n\n' + changeIdLine
 567       cl.UpdateDescription(new_description)
 568
 569     return results
 570
 571
 572 def _AddCQExtraTrybotsToDesc(cq_master_to_trybots, description):
 573   """Adds the specified master and trybots to the CQ_INCLUDE_TRYBOTS keyword.
 574
 575   If the keyword already exists in the description then it appends to it only
 576   if the specified values do not already exist.
 577   If the keyword does not exist then it creates a new section in the
 578   description.
 579   """
 580   match = re.search(r'^CQ_INCLUDE_TRYBOTS=(.*)$', description, re.M | re.I)
 581   if match:
 582     original_trybots_map = _GetCQExtraTrybotsMap(match.group(1))
 583     _MergeCQExtraTrybotsMaps(cq_master_to_trybots, original_trybots_map)
 584     new_description = description.replace(
 585         match.group(0), _GetCQExtraTrybotsStr(cq_master_to_trybots))
 586   else:
 587     new_description = description + "\n%s" % (
 588         _GetCQExtraTrybotsStr(cq_master_to_trybots))
 589   return new_description
 590
 591
 592 def _MergeCQExtraTrybotsMaps(dest_map, map_to_be_consumed):
 593   """Merges two maps of masters to trybots into one."""
 594   for master, trybots in map_to_be_consumed.iteritems():
 595     dest_map[master].update(trybots)
 596   return dest_map
 597
 598
 599 def _GetCQExtraTrybotsMap(cq_extra_trybots_str):
 600   """Parses CQ_INCLUDE_TRYBOTS str and returns a map of masters to trybots."""
 601   cq_master_to_trybots = collections.defaultdict(set)
 602   for section in cq_extra_trybots_str.split(';'):
 603     if section:
 604       master, bots = section.split(':')
 605       cq_master_to_trybots[master].update(bots.split(','))
 606   return cq_master_to_trybots
 607
 608
 609 def _GetCQExtraTrybotsStr(cq_master_to_trybots):
 610   """Constructs the CQ_INCLUDE_TRYBOTS str from a map of masters to trybots."""
 611   sections = []
 612   for master, trybots in cq_master_to_trybots.iteritems():
 613     sections.append('%s:%s' % (master, ','.join(trybots)))
 614   return 'CQ_INCLUDE_TRYBOTS=%s' % ';'.join(sections)
 615
 616
 617 def CheckChangeOnCommit(input_api, output_api):
 618   """Presubmit checks for the change on commit.
 619
 620   The following are the presubmit checks:
 621   * Check change has one and only one EOL.
 622   * Ensures that the Skia tree is open in
 623     http://skia-tree-status.appspot.com/. Shows a warning if it is in 'Caution'
 624     state and an error if it is in 'Closed' state.
 625   """
 626   results = []
 627   results.extend(_CommonChecks(input_api, output_api))
 628   results.extend(
 629       _CheckTreeStatus(input_api, output_api, json_url=(
 630           SKIA_TREE_STATUS_URL + '/banner-status?format=json')))
 631   results.extend(_CheckLGTMsForPublicAPI(input_api, output_api))
 632   results.extend(_CheckOwnerIsInAuthorsFile(input_api, output_api))
 633   return results