Split up Each Swarm Test into Two Steps

scripts/slave/get_swarm_results.py

+#!/usr/bin/env python
+# 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.
+# get_swarm_results.py: Retrieves and output swarm test results for a given
+# test request name.
+
+import json # pylint: disable=F0401

[M-A Ruel, 2012/04/17 20:16:00]

You shouldn't need to disable the pylint warning, it was just an issue in python
2.5 days.

[csharp, 2012/04/18 18:20:29]

Done.

+import optparse
+import sys
+import time
+import urllib
+import urllib2
+
+DESCRIPTION = """This script takes in a test name and retrives all the output

[M-A Ruel, 2012/04/17 20:16:00]

Make that a docstring, e.g. move it around line 7. No need for "This script",
just
"""Takes a test name and ..."""

[csharp, 2012/04/18 18:20:29]

Done.

+that the swarm server has produced for tests with that name. This is expected to
+be called as a build step."""
+

[M-A Ruel, 2012/04/17 20:16:00]

2 lines between file level symbols

[csharp, 2012/04/18 18:20:29]

Done.

+def _get_first_number(line):
+  for part in line.split():
+    if part.isdigit():
+      return int(part)
+
+  print 'No number in :'
+  print line
+  return 0
+
+class TestSummary(object):
+  def __init__(self):
+    self.test_passed_count = 0
+    self.failed_tests = []
+    self.disabled_test_count  = 0
+    self.ignored_test_count = 0
+
+  def AddSummaryData(self, buf):
+    lines = buf.splitlines()
+
+    for line in lines:
+      if '[  PASSED  ]' in line:
+        self.test_passed_count += _get_first_number(line)
+      elif '[  FAILED  ]' in line:
+        if ', listed below' not in line:
+          self.failed_tests.append(line)
+      elif 'DISABLED' in line:
+        self.disabled_test_count += _get_first_number(line)
+      elif 'failures' in line:
+        self.ignored_test_count += _get_first_number(line)
+
+  def Output(self):
+    output = []
+
+    output.append('[  PASSED  ] %i tests.' % self.test_passed_count)
+    if self.failed_tests:
+      output.append('[  FAILED  ] failed tests listed below:')
+      output.extend(self.failed_tests)
+      output.append('%i FAILED TESTS' % len(self.failed_tests))
+
+    if self.disabled_test_count:
+      output.append('%i DISABLED TESTS' % self.disabled_test_count)
+
+    if self.ignored_test_count:
+      output.append('%i tests with ignored failures (FAILS prefix)' %
+                    self.ignored_test_count)
+
+    return output
+
+
+# TODO(csharp) The sharing_supervisor.py also has test parsing code, they should
+# be shared.
+def TestRunOutput(output):
+  """Go through the given output and only return the output from the Test Run
+     Step.
+  """
+  test_run_output = []
+
+  in_step = False
+  step_name = ''
+  for line in output.splitlines():
+    if in_step:
+      if '[       OK ] ' + step_name in line:
+        break
+      else:
+        test_run_output.append(line)
+    elif '[ RUN      ] ' in line and 'Run Test' in line:
+      in_step = True
+      i = len('[ RUN      ] ')
+      step_name = line[i:]
+
+  return '\n'.join(test_run_output)

[M-A Ruel, 2012/04/17 20:16:00]

Technically, it's better to use splitlines(True) and use
''.join(test_run_output) so the ending '\n' is kept. No big deal.

[csharp, 2012/04/18 18:20:29]

Done.

+
+
+def main():
+  """Retrieve the given swarm test results from the swarm server and print it
+  to stdout.
+
+  Args:
+    test_name: The name of the test to retrieve output for.
+  """
+  # Parses arguments
+  parser = optparse.OptionParser(usage='%prog [options] test_name',
+                                 description=DESCRIPTION)

[M-A Ruel, 2012/04/17 20:16:00]

description=sys.modules[__name__].__doc__

[csharp, 2012/04/18 18:20:29]

Done.

+  parser.add_option('-n', '--hostname', default='localhost',
+                    help='Specify the hostname of the Swarm server. '
+                    'Defaults to %default')
+  parser.add_option('-p', '--port', type='int', default=8080,
+                    help='Specify the port of the Swarm server. '
+                    'Defaults to %default')
+  parser.add_option('-v', '--verbose', action='store_true',
+                    help='Print verbose logging')
+  (options, args) = parser.parse_args()
+  if not args:
+    parser.error('Must specify one test name.')
+  elif len(args) > 1:
+    parser.error('Must specify only one test name.')
+  test_name = args[0]
+
+  swarm_base_url = 'http://%s:%d' % (options.hostname, options.port)
+  key_data = urllib.urlencode([('name', test_name)])
+  test_keys_url = '%s/get_matching_test_cases?%s' % (swarm_base_url,
+                                                     key_data)
+  result = urllib2.urlopen(test_keys_url).read()
+
+  if 'No matching' in result:
+    print('Error: Unable to find any tests with the name, %s, on swarm server',
+          test_name)
+    return 1
+
+  test_keys = result.split()

[M-A Ruel, 2012/04/17 20:16:00]

Oh, I guess eventually it'd make sense to use a proper format like json but it's
fine for now.

[csharp, 2012/04/18 18:20:29]

TODO added

+
+  # Get the swarm results.

[M-A Ruel, 2012/04/17 20:16:00]

Can you move that out of main into it's own function? At least in theory it'd
make unit testing easier.

[csharp, 2012/04/18 18:20:29]

Done.

+  summary_total = TestSummary()
+  hostnames = ['unknown'] * len(test_keys)
+  exit_codes = [1] * len(test_keys)
+  for index in range(len(test_keys)):
+    result_url = '%s/get_result?r=%s' % (swarm_base_url, test_keys[index])
+    while True:
+      output = None
+      try:
+        output = urllib2.urlopen(result_url).read()
+      except urllib2.HTTPError, e:
+        print 'Calling %s threw %s' % (result_url, e)
+        break
+
+      try:
+        test_outputs = json.loads(output)
+      except (ValueError, TypeError), e:
+        print 'Unable to get results for shard  %d' % index
+        print e
+        break
+
+      if test_outputs['output']:
+        test_exit_codes = test_outputs['exit_codes'].split(',')
+        exit_codes[index] = int(max(test_exit_codes))
+        hostnames[index] = test_outputs['hostname']
+
+        print
+        print '================================================================'
+        print 'Begin output from shard index %s (%s)' % (index,
+                                                         hostnames[index])
+        print '================================================================'
+        print
+
+        cleaned_output = TestRunOutput(test_outputs['output'])
+        summary_index = cleaned_output.rfind('[  PASSED  ]')
+        summary_total.AddSummaryData(cleaned_output[summary_index:])
+        sys.stdout.write(cleaned_output[:summary_index - 1])
+
+        print
+        print '================================================================'
+        print 'End output from shard index %s (%s). Return %d' % (
+            index, hostnames[index], exit_codes[index])
+        print '================================================================'
+        print
+
+        if exit_codes[index] == 0:
+          # If the test passed, delete the key since it is no longer needed.
+          remove_key_url = '%s/cleanup_results' % swarm_base_url
+          key_encoding = urllib.urlencode([('r', test_keys[index])])
+          urllib2.urlopen(remove_key_url,
+                          key_encoding)
+        break
+      else:
+        # Test is not yet done, wait a bit before checking again.
+        time.sleep(0.5)
+
+  print '\n'.join(summary_total.Output())
+  print
+
+  if options.verbose:
+    print 'All tests completed:'
+    for i in range(options.num_shards):
+      print 'Shard index %s (%s): Exit code: %d' % (i,
+          hostnames[i], exit_codes[i])
+
+  return max(exit_codes)
+
+if __name__ == '__main__':
+  sys.exit(main())