annotations: change meaning of STEP_TEXT

scripts/master/chromium_step.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.
 
 """Subclasses of various slave command classes."""
 
 from datetime import datetime
 import copy
 import errno
 import json
@@ skipping 29 matching lines @@
 
 def updateText(section):
   # Reflect step status in text2.
   if section['status'] == builder.EXCEPTION:
     result = ['exception', section['name']]
   elif section['status'] == builder.FAILURE:
     result = ['failed', section['name']]
   else:
     result = []
 
-  section['step'].setText([section['name']] + section['step_text'])
+  step_text = ['<br>%s' % line for line in section['step_text']]

[Ryan Tseng, 2016/06/22 22:44:24]

I think we the first line of step_text to be on the same line, right?

[nodir, 2016/06/22 22:47:21]

Dunno. Note that it will get mixed with step name. It was always confusing to
me, why does buildbot display "<step name again> <step text>" on the same line. 

we could remove step name too. wdyt?

[Ryan Tseng, 2016/06/22 22:50:08]

yeah removing step name sounds good to me, i'm savvy.

[nodir, 2016/06/22 22:56:19]

Done. http://imgur.com/BWUWRbH

+  section['step'].setText([section['name']] + step_text)
   section['step'].setText2(result + section['step_summary_text'])
 
 
 # derived from addCompleteLog in process/buildstep.py
 def addLogToStep(step, name, text):
   """Add a complete log to a step."""
   loog = step.addLog(name)
   size = loog.chunkSize
   for start in range(0, len(text), size):
     loog.addStdout(text[start:start+size])
@@ skipping 474 matching lines @@
   @@@STEP_LOG_END_PERF@<label>@@@
   Same as STEP_LOG_END, but signifies that this is a perf log and should be
   saved to the master.
 
   @@@STEP_CLEAR@@@
   Reset the text description of the current step.
 
   @@@STEP_SUMMARY_CLEAR@@@
   Reset the text summary of the current step.
 
-  @@@STEP_TEXT@<msg>@@@
-  Append <msg> to the current step text.
+  @@@STEP_TEXT@<msg line>@@@
+  Append <msg line> to the current step text.
 
-  @@@SEED_STEP_TEXT@step@<msg>@@@
-  Append <msg> to the specified seeded step.
+  @@@SEED_STEP_TEXT@step@<msg line>@@@
+  Append <msg line> to the specified seeded step.
 
   @@@STEP_SUMMARY_TEXT@<msg>@@@
   Append <msg> to the step summary (appears on top of the waterfall).
 
   @@@STEP_NEST_LEVEL@<level>@@@
   Set the nesting level of the current step. Steps at level n are assumed to
   be nested under the most recent step of level n-1.
 
   @@@HALT_ON_FAILURE@@@
   Halt if exception or failure steps are encountered (default is not).
@@ skipping 378 matching lines @@
       section['started'] = util.now()
       # parent step already has its logging set up by buildbot
       if section != self.sections[0]:
         stdio = step.addLog('stdio')
         section['log'] = stdio
 
   def addSection(self, step_name, step=None, legacy=False):
     """Adds a new section to annotator sections, does not change cursor."""
     if not step:
       step = self.command.step_status.getBuild().addStepWithName(step_name)
-      step.setText([step_name])
+      step.setText([])
     self.sections.append({
         'name': step_name,
         'step': step,
         'closed': False,
         'log': None,
         'annotated_logs': {},
         'finished_logs': [],
         'status': builder.SUCCESS,
         'links': [],
         'step_summary_text': [],
+        # step_text is a list of lines that will printed after step name.
         'step_text': [],
         'started': None,
         'async_ops': [],
         'legacy': legacy,
     })
 
     return self.sections[-1]
 
   def _PerfStepMappings(self, show_results, perf_id, test_name, suffix=None):
     """Looks up test IDs in PERF_TEST_MAPPINGS and returns test info."""
@@ skipping 613 matching lines @@
       and starts to wait for remaining steps to finish. Returns command_result
       as Deferred."""
       self.scriptComplete(command_result)
       steps_d = self.script_observer.waitForSteps()
       # Ignore the waitForSteps' result and return the original result,
       # so the caller of runCommand receives command_result.
       steps_d.addCallback(lambda *_: command_result)
       return steps_d
     d.addCallback(onCommandFinished)
     return d