Fix "extra_args" property forwarding.

scripts/master/cros_try_job_git.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 import base64
 import json
 import os
 import re
 import shutil
 import zlib
@@ skipping 14 matching lines @@
 
 from twisted.internet import defer, reactor, utils
 from twisted.mail.smtp import SMTPSenderFactory
 from twisted.python import log
 
 from common.twisted_util.response import StringResponse
 from master import gitiles_poller
 from master.try_job_base import BadJobfile
 
 
+def compress_extra_args(extra_args):
+  """Returns (str): Compressed notation for "extra_args" field.
+
+  This notation is implemented in the "cros/cbuildbot_tryjob" recipe. Basically,
+  if the "cbb_extra_args" field begins with "z:", the remainder is a
+  GZIP-compressed string containing the JSON-encoded "extra_args" list.
+
+  The motivation for compressing this parameter is that it will occasionally be
+  too long to store in BulidBot's database.
+
+  Args:
+    extra_args (list): The extra_args parameter.
+  """
+  return 'z:' + base64.b64encode(zlib.compress(json.dumps(extra_args)))
+
+
 class CbuildbotConfigs(object):
 
   # Valid 'etc' builder targets. Specifically, this ensures:
   # - The build name doesn't begin with a flag ('--')
   # - The build name doesn't contain spaces (to spill into extra args).
   _ETC_TARGET_RE = re.compile(r'^[a-zA-Z][\w-]+\w$')
 
   def __init__(self, configs, etc_builder=None):
     """Holds base state of the master's try job related configuration.
 
@@ skipping 12 matching lines @@
     mapping it based on its config.
 
     If an 'etc' builder is configured and the config name is unknown, it will be
     mapped to the 'etc' builder if possible.
 
     A tryserver BuildBucket build takes the form:
     - Empty `builder_name` parameter. If one is supplied, it will be ignored.
     - BuildBot changes can be added by including one or more BuildBucket
       `changes` parameters: [{'author': {'email': 'author@google.com'}}].
     - `cbb_config` property must be set to the build's cbuildbot config target.
-    - `extra_args` property (optional) may be a JSON list of additional
-      parameters to pass to the tryjob.
-    - `slaves_request` property (optional) may be a JSON list of slaves on which
-      this build may run.
+    - `cbb_extra_args` property (optional) may be a JSON-encoded list of
+      additional parameters to pass to the tryjob.
+    - `slaves_request` property (optional) may be a JSON-encoded list of slaves
+      on which this build may run.
     - Additional BuildBot properties may be added.
 
     NOTE: Internally, all of these parameters are converted to BuildBot
     properties and referenced as such in other areas of code. The Git poller
     also constructs the same property set, so code paths converge.
     """
     def params_hook(params, _build):
       # Map `cbb_config` to a builder name.
-      properties = params.get('properties', {})
+      properties = params.get('properties', {}).copy()
       config_name = properties.get('cbb_config')
       if not config_name:
         raise ValueError('Missing required `cbb_config` property.')
       params['builder_name'] = self.GetBuilderForConfig(config_name)
 
-      # Validate other fields.
-      if not isinstance(properties.get('extra_args', []), list):
-        raise ValueError('`extra_args` property is not a list.')
+      # If "cbb_extra_args" is present and a list, convert this to a compressed
+      # JSON string for the recipe.
+      extra_args = properties.get('cbb_extra_args')
+      if extra_args and isinstance(extra_args, list):
+        properties['cbb_extra_args'] = compress_extra_args(extra_args)
+
+      # The "slaves_request" field must be a list, if present.
       if not isinstance(properties.get('slaves_request', []), list):
         raise ValueError('`slaves_request` is not a list.')
 
       # Add mandatory properties to build.
       params['properties'] = properties
     c['buildbucket_params_hook'] = params_hook
 
   def GetBuilderForConfig(self, config_name):
     config = self.configs.get(config_name)
     if config:
@@ skipping 136 matching lines @@
 
     props.setProperty('slaves_request', options.get('slaves_request', []),
                       self._PROPERTY_SOURCE)
     props.setProperty('cbb_config', config, self._PROPERTY_SOURCE)
 
     extra_args = options.get('extra_args')
     if extra_args:
       # This field can be quite large, and exceed BuildBot property limits.
       # Compress it, Base64 encode it, and prefix it with "z:" so the consumer
       # knows its size.
-      extra_args = 'z:' + base64.b64encode(zlib.compress(json.dumps(
-        extra_args)))
-      props.setProperty('cbb_extra_args', extra_args,
+      props.setProperty('cbb_extra_args', compress_extra_args(extra_args),
                         self._PROPERTY_SOURCE)
     return props
 
   def create_buildset(self, ssid, parsed_job):
     """Overriding base class method."""
     dlist = []
     buildset_name = '%s:%s' % (parsed_job['user'], parsed_job['name'])
     for bot in parsed_job['bot']:
       builder_name = self.cbb.GetBuilderForConfig(bot)
       log.msg("Creating '%s' try job(s) %s for %s" % (builder_name, ssid, bot))
@@ skipping 83 matching lines @@
 
     # Load the contents of the modified file.
     path = self._GITILES_PATH_TMPL % {
         'repo': poller.repo_path,
         'revision': change.revision,
         'path': change.files[0],
     }
     contents_b64 = yield poller.agent.request('GET', path, retry=5,
                                               protocol=StringResponse.Get)
     defer.returnValue(base64.b64decode(contents_b64))