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

recipe_engine/util.py

 # Copyright 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 contextlib
 import functools
 import os
 import sys
 import traceback
 import urllib
@@ skipping 18 matching lines @@
         "RecipeApi has no dependency %r. (Add it to DEPS?)" % (key,))
     else:
       raise ModuleInjectionError(
         "Recipe Module %r has no dependency %r. (Add it to __init__.py:DEPS?)"
         % (self.owner_module.name, key))
 
 
 class Placeholder(object):
   """Base class for command line argument placeholders. Do not use directly."""
   def __init__(self):
-    self.name_pieces = None
+    self.namespaces = None
 
   @property
   def backing_file(self):  # pragma: no cover
     """Return path to a temp file that holds or receives the data.
 
     Valid only after 'render' has been called.
     """
     raise NotImplementedError
 
   def render(self, test):  # pragma: no cover
     """Return [cmd items]*"""
     raise NotImplementedError
 
   def result(self, presentation, test):
     """Called after step completion.
 
     Args:
       presentation (StepPresentation) - for the current step.
       test (PlaceholderTestData) - test data for this placeholder.
 
     May optionally modify presentation as a side-effect.
     """
     pass
 
   @property
-  def name(self):
-    assert self.name_pieces
-    return "%s.%s" % self.name_pieces
+  def namespace(self):
+    assert self.namespaces
+    return "%s.%s" % self.namespaces

[iannucci, 2016/03/12 03:43:55]

should we consider a format like "json.output[label]", where if label is
default, it's omitted? I'm thinking about things like step links for json.output
right now; ideally we could preserve the current appearance of json.output links
on the waterfall when there's only out output, but nicely distinguish them if
there are multiple.

[stgao, 2016/03/22 05:58:04]

This is handled by the full_name below. Moved it up here instead and changed log
name to json.output[name].

Currently, if there is more than one output, only the last one will show up on
the buildbot UI. That's a bug which motivated my idea for this CL :)

 
 
 class InputPlaceholder(Placeholder):
   """Base class for json/raw_io input placeholders. Do not use directly."""
   def result(self, presentation, test):
     """Returned value will be discarded."""
     pass
   result.__doc__ = Placeholder.result.__doc__
 
 
 class OutputPlaceholder(Placeholder):
   """Base class for json/raw_io output placeholders. Do not use directly."""
+
+  def __init__(self, name=None):
+    if name is not None:
+      assert isinstance(name, basestring)
+    self.name = name
+    super(OutputPlaceholder, self).__init__()
+
   def result(self, presentation, test):
     """Returned value will be added to the step result."""
     pass
   result.__doc__ = Placeholder.result.__doc__
 
+  @property
+  def full_name(self):
+    if self.name is None:
+      return super(OutputPlaceholder, self).namespace
+    else:
+      return "%s.%s" % (self.name, super(OutputPlaceholder, self).namespace)
+
 
 def static_wraps(func):
   wrapped_fn = func
   if isinstance(func, staticmethod):
     # __get__(obj) is the way to get the function contained in the staticmethod.
     # python 2.7+ has a __func__ member, but previous to this the attribute
     # doesn't exist. It doesn't matter what the obj is, as long as it's not
     # None.
     wrapped_fn = func.__get__(object)
   return functools.wraps(wrapped_fn)
@@ skipping 11 matching lines @@
     return func.__get__(obj).__name__
   else:
     return func.__name__
 
 
 def returns_placeholder(func):
   @static_wraps(func)
   def inner(self, *args, **kwargs):
     ret = static_call(self, func, *args, **kwargs)
     assert isinstance(ret, Placeholder)
-    ret.name_pieces = (self.name, static_name(self, func))
+    ret.namespaces = (self.name, static_name(self, func))
     return ret
   # prevent this placeholder-returning function from becoming a composite_step.
   inner._non_step = True # pylint: disable=protected-access
   return inner
 
 
 def scan_directory(path, predicate):
   """Recursively scans a directory and yields paths that match predicate."""
   for root, _dirs, files in os.walk(path):
     for file_name in (f for f in files if predicate(f)):
@@ skipping 51 matching lines @@
         self.lines[-1].write(s)
         break
       self.lines[-1].write(s[:i])
       self.lines[-1] = self.lines[-1].getvalue()
       self.lines.append(StringIO())
       s = s[i+1:]
 
   def close(self):
     if not isinstance(self.lines[-1], basestring):
       self.lines[-1] = self.lines[-1].getvalue()