[swarming/api] Add text in to indicate whether a shard is failing

scripts/slave/recipe_modules/swarming/api.py

 # Copyright 2014 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 logging
 import datetime
 import functools
 
 from recipe_engine import recipe_api
 
@@ skipping 829 matching lines @@
             step_result.raw_io.output_dir['summary.json'])
         if any(shard['internal_failure'] for shard in summary['shards']):
           raise recipe_api.InfraFailure('Internal swarming failure.')
 
         # Always show the shards' links in the collect step. (It looks
         # like show_isolated_out_in_collect_step is false by default
         # in recipe runs.)
         links = step_result.presentation.links
         for index in xrange(task.shards):
           url = task.get_shard_view_url(index)
+          if summary['shards'][index].get('exit_code', 0) != 0:

[nednguyen, 2016/09/22 15:54:40]

I get to know this by looking at an example summary.json output, i.e:
python swarming.py collect -S https://chromium-swarm.appspot.com
--task-output-dir=foo 30bc1911e6720a10

cat foo/summary.json

Do we have documentation/code pointer about what summary.json is supposed to
contain somewhere?

[M-A Ruel, 2016/09/22 16:05:02]

No. :/

[Vadim Sh., 2016/09/22 17:36:30]

Please also handle a case when summary['shards'][index] is None. 

I think it can happen if Swarming client has trouble collecting the results
(e.g. network timeouts). Though maybe dying with AttributeError is good enough
in this case...

On 2016/09/22 16:05:02, M-A Ruel wrote:
I believe each dict in 'shards' list has the structure of TaskResult protorpc
message:
https://github.com/luci/luci-py/blob/master/appengine/swarming/swarming_rpcs....

(based on https://github.com/luci/luci-py/blob/master/client/swarming.py#L547)

[nednguyen, 2016/09/22 21:03:54]

Done. However I am missing the code coverage. You have any suggestion how to add
test to cover the case a shard return None?

+            display_text = 'shard #%d (failed)' % index
+          else:
+            display_text = 'shard #%d' % index
           if url:
-            links['shard #%d' % index] = url
+            links[display_text] = url
 
         step_result.isolated_script_results = \
           self._merge_isolated_script_shards(task, step_result)
 
         # Obtain chartjson results if present
         step_result.isolated_script_chartjson_results = \
           self._merge_isolated_script_chartjson_ouput_shards(task, step_result)
 
         self._display_pending(summary, step_result.presentation)
       except Exception as e:
@@ skipping 185 matching lines @@
 
   def get_shard_view_url(self, index):
     """Returns URL of HTML page with shard details or None if not available.
 
     Works only after the task has been successfully triggered.
     """
     if self._trigger_output and self._trigger_output.get('tasks'):
       for shard_dict in self._trigger_output['tasks'].itervalues():
         if shard_dict['shard_index'] == index:
           return shard_dict['view_url']