Add CSV export, suitable for use with "pivot tables" in spreadsheets.

tools/telemetry/telemetry/results/results_options.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 optparse
 import os
 import sys
 
 from telemetry.core import util
 from telemetry.results import buildbot_output_formatter
 from telemetry.results import chart_json_output_formatter
 from telemetry.results import csv_output_formatter
+from telemetry.results import csv_pivot_table_output_formatter
 from telemetry.results import gtest_progress_reporter
 from telemetry.results import html_output_formatter
 from telemetry.results import json_output_formatter
 from telemetry.results import page_test_results
 from telemetry.results import progress_reporter
 
 # Allowed output formats. The default is the first item in the list.
 _OUTPUT_FORMAT_CHOICES = ('html', 'buildbot', 'block', 'csv', 'gtest', 'json',
-    'chartjson', 'none')
+    'chartjson', 'csv-pivot-table', 'none')
 
 
 def AddResultsOptions(parser):
   group = optparse.OptionGroup(parser, 'Results options')
   group.add_option('--chartjson', action='store_true',
                    help='Output Chart JSON. Ignores --output-format.')
   group.add_option('--output-format', action='append', dest='output_formats',
                     choices=_OUTPUT_FORMAT_CHOICES, default=[],
                     help='Output format. Defaults to "%%default". '
                     'Can be %s.' % ', '.join(_OUTPUT_FORMAT_CHOICES))

[nednguyen, 2014/10/09 17:05:14]

How would telemetry users know that --output-trace-tag can be used with
--cvs-pivot-table as described in csv_pivot_table_output_formatter.py? 

Can you improve the help string here?

[vogelheim, 2014/10/10 11:27:43]

Done. (I think...)

I've added the description to the --output-trace-tag help string, not to this
one. I only mentioned the formats the trace tag can be used with but not the
specifics of csv-pivot-table, since 1, I guess the help string should be
reasonably brief, and 2, it's really a way of saying a value with an embedded
comma works fine.

I thought the code to accomplish in the csv_pivot_table_output_formatter looks a
bit non-obvious, which is why I put in an explanation there. For a user I'd
think this was a fairly natural way of handling this.

   group.add_option('-o', '--output',
                     dest='output_file',
                     default=None,
                     help='Redirects output to a file. Defaults to stdout.')
   group.add_option('--output-trace-tag',
                     default='',
                     help='Append a tag to the key of each result trace.')
   group.add_option('--reset-results', action='store_true',
                     help='Delete all stored results.')
   group.add_option('--upload-results', action='store_true',
@@ skipping 48 matching lines @@
 
   output_formatters = []
   for output_format in options.output_formats:
     if output_format == 'none' or output_format == "gtest" or options.chartjson:
       continue
 
     output_stream = _GetOutputStream(output_format, options.output_file)
     if output_format == 'csv':
       output_formatters.append(csv_output_formatter.CsvOutputFormatter(
           output_stream))
+    elif output_format == 'csv-pivot-table':
+      output_formatters.append(
+          csv_pivot_table_output_formatter.CsvPivotTableOutputFormatter(
+              output_stream, trace_tag=options.output_trace_tag))
     elif output_format == 'buildbot':
       output_formatters.append(
           buildbot_output_formatter.BuildbotOutputFormatter(
               output_stream, trace_tag=options.output_trace_tag))
     elif output_format == 'html':
       # TODO(chrishenry): We show buildbot output so that users can grep
       # through the results easily without needing to open the html
       # file.  Another option for this is to output the results directly
       # in gtest-style results (via some sort of progress reporter),
       # as we plan to enable gtest-style output for all output formatters.
@@ skipping 18 matching lines @@
 
   # TODO(chrishenry): This is here to not change the output of
   # gtest. Let's try enabling skipped tests summary for gtest test
   # results too (in a separate patch), and see if we break anything.
   output_skipped_tests_summary = 'gtest' in options.output_formats
 
   reporter = _GetProgressReporter(output_skipped_tests_summary,
                                   options.suppress_gtest_report)
   return page_test_results.PageTestResults(
       output_formatters=output_formatters, progress_reporter=reporter)