Color by default only if TTY stdout. Recurse into results directories.

src/scripts/generate_test_report

 #!/usr/bin/python
 # Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 
 """Parses and displays the contents of one or more autoserv result directories.
 
 This script parses the contents of one or more autoserv results folders and
 generates test reports.
 """
 
 
 import glob
 import optparse
 import os
 import re
 import sys
 
 
+_STDOUT_IS_TTY = hasattr(sys.stdout, 'isatty') and sys.stdout.isatty()
+
+
 class Color(object):
   """Conditionally wraps text in ANSI color escape sequences."""
   BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)
   BOLD = -1
   COLOR_START = '\033[1;%dm'
   BOLD_START = '\033[1m'
   RESET = '\033[0m'
 
   def __init__(self, enabled=True):
     self._enabled = enabled
@@ skipping 17 matching lines @@
       start = self.COLOR_START % (color + 30)
     return start + text + self.RESET
 
 
 def Die(message):
   """Emits a red error message and halts execution.
 
   Args:
     message: The message to be emitted before exiting.
   """
-  print Color().Color(Color.RED, '\nERROR: ' + message)
+  print Color(_STDOUT_IS_TTY).Color(Color.RED, '\nERROR: ' + message)
   sys.exit(1)
 
 
 class ReportGenerator(object):
   """Collects and displays data from autoserv results directories.
 
   This class collects status and performance data from one or more autoserv
   result directories and generates test reports.
   """
 
@@ skipping 72 matching lines @@
       status = 'PASS'
 
     perf = self._CollectPerf(testdir)
 
     if testdir.startswith(self._options.strip):
       testdir = testdir.replace(self._options.strip, '', 1)
 
     self._results[testdir] = {'status': status,
                               'perf': perf}
 
+  def _CollectResultsRec(self, resdir):
+    """Recursively collect results into the self._results dictionary.
+
+    Args:
+      resdir: results/test directory to parse results from and recurse into.
+    """
+
+    self._CollectResult(resdir)
+    for testdir in glob.glob(os.path.join(resdir, '*')):
+      self._CollectResultsRec(testdir)
+
   def _CollectResults(self):
     """Parses results into the self._results dictionary.
 
     Initializes a dictionary (self._results) with test folders as keys and
     result data (status, perf keyvals) as values.
     """
     self._results = {}
     for resdir in self._args:
       if not os.path.isdir(resdir):
         Die('\'%s\' does not exist' % resdir)
-
-      # Check the top level result directory, in case the control file or
-      # autoserv have signalled failures. Then check subdirectories.
-      self._CollectResult(resdir)
-      for testdir in glob.glob(os.path.join(resdir, '*')):
-        self._CollectResult(testdir)
+      self._CollectResultsRec(resdir)
 
     if not self._results:
       Die('no test directories found')
 
   def GetTestColumnWidth(self):
     """Returns the test column width based on the test data.
 
     Aligns the test results by formatting the test directory entry based on
     the longest test directory or perf key string stored in the self._results
     dictionary.
@@ skipping 51 matching lines @@
         print perf_key_entry + perf_value_entry
 
     print line
 
     total_tests = len(tests)
     percent_pass = 100 * tests_pass / total_tests
     pass_str = '%d/%d (%d%%)' % (tests_pass, total_tests, percent_pass)
     print 'Total PASS: ' + self._color.Color(Color.BOLD, pass_str)
 
   def Run(self):
-    """Run report generation."""
+    """Runs report generation."""
     self._CollectResults()
     self._GenerateReportText()
 
 
 def main():
   usage = 'Usage: %prog [options] result-directories...'
   parser = optparse.OptionParser(usage=usage)
   parser.add_option('--color', dest='color', action='store_true',
-                    default=True,
-                    help='Use color for text reports [default]')
+                    default=_STDOUT_IS_TTY,
+                    help='Use color for text reports [default if TTY stdout]')
   parser.add_option('--no-color', dest='color', action='store_false',
                     help='Don\'t use color for text reports')
   parser.add_option('--perf', dest='perf', action='store_true',
                     default=True,
                     help='Include perf keyvals in the report [default]')
   parser.add_option('--no-perf', dest='perf', action='store_false',
                     help='Don\'t include perf keyvals in the report')
   parser.add_option('--strip', dest='strip', type='string', action='store',
                     default='results.',
                     help='Strip a prefix from test directory names'
                     ' [default: \'%default\']')
   parser.add_option('--no-strip', dest='strip', const='', action='store_const',
                     help='Don\'t strip a prefix from test directory names')
   (options, args) = parser.parse_args()
 
   if not args:
     parser.print_help()
     Die('no result directories provided')
 
   generator = ReportGenerator(options, args)
   generator.Run()
 
 
 if __name__ == '__main__':
   main()