Make output placeholders like json.output index-able by name.

recipe_engine/step_runner.py

 # Copyright (c) 2013-2015 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 cStringIO
 import collections
 import contextlib
 import datetime
 import json
 import os
@@ skipping 430 matching lines @@
     step: The step to render.
     step_test: The test data json dictionary for this step, if any.
                Passed through unaltered to each placeholder.
 
   Returns the rendered step and a Placeholders object representing any
   placeholder instances that were found while rendering.
   """
   rendered_step = dict(step)
 
   # Process 'cmd', rendering placeholders there.
-  placeholders = collections.defaultdict(lambda: collections.defaultdict(list))
+  placeholders = collections.defaultdict(
+      lambda: collections.defaultdict(collections.OrderedDict))
   new_cmd = []
   for item in step.get('cmd', []):
     if isinstance(item, util.Placeholder):
       module_name, placeholder_name = item.name_pieces
-      tdata = step_test.pop_placeholder(item.name_pieces)
+      tdata = step_test.pop_placeholder(module_name, placeholder_name, item.id)
       new_cmd.extend(item.render(tdata))
-      placeholders[module_name][placeholder_name].append((item, tdata))
+      # TODO(http://crbug.com/593198): enable this assert when all recipes and
+      # recipe modules are updated.
+      #assert item.id not in placeholders[module_name][placeholder_name], (
+      #    'You have multiple place holders of %s.%s, please specify different '
+      #    'ids for them.' % (module_name, placeholder_name))
+      placeholders[module_name][placeholder_name][item.id] = (item, tdata)
     else:
       new_cmd.append(item)
   rendered_step['cmd'] = new_cmd
 
   # Process 'stdout', 'stderr' and 'stdin' placeholders, if given.
   stdio_placeholders = {}
   for key in ('stdout', 'stderr', 'stdin'):
     placeholder = step.get(key)
     tdata = None
     if placeholder:
@@ skipping 19 matching lines @@
   class BlankObject(object):
     pass
 
   # Placeholders inside step |cmd|.
   for module_name, pholders in placeholders.cmd.iteritems():
     assert not hasattr(step_result, module_name)
     o = BlankObject()
     setattr(step_result, module_name, o)
 
     for placeholder_name, items in pholders.iteritems():
-      lst = [ph.result(step_result.presentation, td) for ph, td in items]
-      setattr(o, placeholder_name+"_all", lst)
+      named_results = {}
+      lst = []
+      for _, (ph, td) in items.iteritems():
+        result = ph.result(step_result.presentation, td)
+        lst.append(result)
+        named_results[ph.id] = result
+      setattr(o, placeholder_name + "s", named_results)
+      setattr(o, placeholder_name + "_all", lst)

[iannucci, 2016/03/10 03:17:42]

so, actually, because of the way the recipe pinning works, you don't need to
support both:
  * prepare this CL to be the new world (e.g. foos instead of foo_all)
  * simulate it's roll into build and build_internal (I can show you how this is
done, I don't have a great document to point you at right now)
  * prepare CLs for build and build_internal as the result of that simulation
(i.e. rewrite them to use foos instead of foo_all), we'll +1 those
  * we'll +1 this
  * land this
  * update the downstream CLs to include the committed version of this in their
recipe.cfg pins
  * land the downstream CLs

We have a bug on file to automate the majority of this process, but we've done
this manually 1-2 times now and it works pretty well. It allows you to see the
full effect of the change downstream, and doesn't leave you in a weird
intermediate state where both interfaces are supported.

[stgao, 2016/03/10 20:34:23]

Sounds good. Let's go with this approach then.

       setattr(o, placeholder_name, lst[0])
 
   # Placeholders that are used with IO redirection.
   for key in ('stdout', 'stderr', 'stdin'):
     assert not hasattr(step_result, key)
     ph, td = getattr(placeholders, key)
     result = ph.result(step_result.presentation, td) if ph else None
     setattr(step_result, key, result)
 
   return step_result
@@ skipping 48 matching lines @@
   supplied command, and only uses the |env| kwarg for modifying the environment
   of the child process.
   """
   saved_path = os.environ['PATH']
   try:
     if path is not None:
       os.environ['PATH'] = path
     yield
   finally:
     os.environ['PATH'] = saved_path