From 2368b41ea869a6904ae8320ad69f1b8b9a9a3714 Mon Sep 17 00:00:00 2001
From: George Burgess IV <gbiv@google.com>
Date: Thu, 25 Aug 2016 11:29:09 -0700
Subject: crosperf: Make results_report more general.

The goal of this patch is to allow us to use results_report to generate
non-ChromeOS-specific results reports. It's meant to be a nop for
regular crosperf runs (except that, in HTML report generation,
whitespace in the HTML itself will look a bit different.)

Moreover, results_report used to shuffle Experiments around, each of
which, unsurprisingly, contained *tons* of data about an experiment.
So, part of this patch was reducing results_report's reliance on
Experiments, in favor of a new type, BenchmarkResult.

Some parts of results_report still rely on Experiments, but only to
provide *extra* data. The minimum amount of data needed to make a
results report is contained in a BenchmarkResult, and there's a
convenient API we can use to make a BenchmarkResult out of an
Experiment.

This patch also does a massive refactor of results_report, because lots
of the code was mildly more icky than it is with this patch applied.
The refactor-for-prettiness and refactor-for-BenchmarkResults kind of
go hand-in-hand, so it's really hard to split them out. The only part
that's not so difficult to split out is the refactor to
results_report_templates, but the value of splitting that out is
questionable (to me).

Speaking of which, all HTML magicks that were in results_report is now
in results_report_templates, and now use *actual* Templates. It -- and
HTMLReportGenerator -- are hopefully more readable as a result.

Next, this makes JSONRsultsReport's GetReport() return a string
containing JSON data, rather than calling a callback to write
that string to a file.

Finally, this includes a change to perf_table. Namely, its removal. It
was otherwise unused, and I couldn't get it to even work, so I cleaned
it up, made a perf report parser (because I couldn't get the cros_utils
one to work, either...), and made sure it functions. If we're able to
produce perf reports that cros_utils can parse, I'm happy to back my
new parser out; I was primarily using it so I could be sure I didn't
break HTML report generation.

BUG=chromium:641098
TEST=./run_tests.sh passes

Change-Id: I437de9eb39e00c9dd5c223ecd27feaaab544a6fd
Reviewed-on: https://chrome-internal-review.googlesource.com/282217
Commit-Ready: George Burgess <gbiv@google.com>
Tested-by: George Burgess <gbiv@google.com>
Reviewed-by: Caroline Tice <cmtice@google.com>
---
 crosperf/results_report_templates.py | 196 +++++++++++++++++++++++++++++++++++
 1 file changed, 196 insertions(+)
 create mode 100644 crosperf/results_report_templates.py

(limited to 'crosperf/results_report_templates.py')

diff --git a/crosperf/results_report_templates.py b/crosperf/results_report_templates.py
new file mode 100644
index 00000000..827649fd
--- /dev/null
+++ b/crosperf/results_report_templates.py
@@ -0,0 +1,196 @@
+# Copyright 2016 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.
+"""Text templates used by various parts of results_report."""
+from __future__ import print_function
+
+import cgi
+from string import Template
+
+_TabMenuTemplate = Template("""
+<div class='tab-menu'>
+  <a href="javascript:switchTab('$table_name', 'html')">HTML</a>
+  <a href="javascript:switchTab('$table_name', 'text')">Text</a>
+  <a href="javascript:switchTab('$table_name', 'tsv')">TSV</a>
+</div>""")
+
+def _GetTabMenuHTML(table_name):
+  # N.B. cgi.escape does some very basic HTML escaping. Nothing more.
+  escaped = cgi.escape(table_name, quote=True)
+  return _TabMenuTemplate.substitute(table_name=escaped)
+
+
+_ExperimentFileHTML = """
+<div class='results-section'>
+  <div class='results-section-title'>Experiment File</div>
+  <div class='results-section-content'>
+    <pre>%s</pre>
+</div>
+"""
+
+def _GetExperimentFileHTML(experiment_file_text):
+  if not experiment_file_text:
+    return ''
+  return _ExperimentFileHTML % (cgi.escape(experiment_file_text), )
+
+
+_ResultsSectionHTML = Template("""
+<div class='results-section'>
+  <div class='results-section-title'>$sect_name</div>
+  <div class='results-section-content'>
+    <div id='${short_name}-html'>$html_table</div>
+    <div id='${short_name}-text'><pre>$text_table</pre></div>
+    <div id='${short_name}-tsv'><pre>$tsv_table</pre></div>
+  </div>
+  $tab_menu
+</div>
+""")
+
+def _GetResultsSectionHTML(print_table, table_name, data):
+  first_word = table_name.strip().split()[0]
+  short_name = first_word.lower()
+  return _ResultsSectionHTML.substitute(sect_name=table_name,
+                                        html_table=print_table(data, 'HTML'),
+                                        text_table=print_table(data, 'PLAIN'),
+                                        tsv_table=print_table(data, 'TSV'),
+                                        tab_menu=_GetTabMenuHTML(short_name),
+                                        short_name=short_name)
+
+
+
+_MainHTML = Template("""
+<html>
+<head>
+  <style type="text/css">
+    body {
+      font-family: "Lucida Sans Unicode", "Lucida Grande", Sans-Serif;
+      font-size: 12px;
+    }
+
+    pre {
+      margin: 10px;
+      color: #039;
+      font-size: 14px;
+    }
+
+    .chart {
+      display: inline;
+    }
+
+    .hidden {
+      visibility: hidden;
+    }
+
+    .results-section {
+      border: 1px solid #b9c9fe;
+      margin: 10px;
+    }
+
+    .results-section-title {
+      background-color: #b9c9fe;
+      color: #039;
+      padding: 7px;
+      font-size: 14px;
+      width: 200px;
+    }
+
+    .results-section-content {
+      margin: 10px;
+      padding: 10px;
+      overflow:auto;
+    }
+
+    #box-table-a {
+      font-size: 12px;
+      width: 480px;
+      text-align: left;
+      border-collapse: collapse;
+    }
+
+    #box-table-a th {
+      padding: 6px;
+      background: #b9c9fe;
+      border-right: 1px solid #fff;
+      border-bottom: 1px solid #fff;
+      color: #039;
+      text-align: center;
+    }
+
+    #box-table-a td {
+      padding: 4px;
+      background: #e8edff;
+      border-bottom: 1px solid #fff;
+      border-right: 1px solid #fff;
+      color: #669;
+      border-top: 1px solid transparent;
+    }
+
+    #box-table-a tr:hover td {
+      background: #d0dafd;
+      color: #339;
+    }
+
+  </style>
+  <script type='text/javascript' src='https://www.google.com/jsapi'></script>
+  <script type='text/javascript'>
+    google.load('visualization', '1', {packages:['corechart']});
+    google.setOnLoadCallback(init);
+    function init() {
+      switchTab('summary', 'html');
+      ${perf_init};
+      switchTab('full', 'html');
+      drawTable();
+    }
+    function drawTable() {
+      ${chart_js};
+    }
+    function switchTab(table, tab) {
+      document.getElementById(table + '-html').style.display = 'none';
+      document.getElementById(table + '-text').style.display = 'none';
+      document.getElementById(table + '-tsv').style.display = 'none';
+      document.getElementById(table + '-' + tab).style.display = 'block';
+    }
+  </script>
+</head>
+
+<body>
+  $summary_table
+  $perf_html
+  <div class='results-section'>
+    <div class='results-section-title'>Charts</div>
+    <div class='results-section-content'>$chart_divs</div>
+  </div>
+  $full_table
+  $experiment_file
+</body>
+</html>
+""")
+
+# It's a bit ugly that we take some HTML things, and some non-HTML things, but I
+# need to balance prettiness with time spent making things pretty.
+def GenerateHTMLPage(perf_table, chart_js, summary_table, print_table,
+                     chart_divs, full_table, experiment_file):
+  """Generates a crosperf HTML page from the given arguments.
+
+  print_table is a two-arg function called like: print_table(t, f)
+    t is one of [summary_table, print_table, full_table]; it's the table we want
+      to format.
+    f is one of ['TSV', 'HTML', 'PLAIN']; it's the type of format we want.
+  """
+  summary_table_html = _GetResultsSectionHTML(print_table, 'Summary Table',
+                                              summary_table)
+  if perf_table:
+    perf_html = _GetResultsSectionHTML(print_table, 'Perf Table', perf_table)
+    perf_init = "switchTab('perf', 'html')"
+  else:
+    perf_html = ''
+    perf_init = ''
+
+  full_table_html = _GetResultsSectionHTML(print_table, 'Full Table',
+                                           full_table)
+  experiment_file_html = _GetExperimentFileHTML(experiment_file)
+  return _MainHTML.substitute(perf_init=perf_init, chart_js=chart_js,
+                              summary_table=summary_table_html,
+                              perf_html=perf_html, chart_divs=chart_divs,
+                              full_table=full_table_html,
+                              experiment_file=experiment_file_html)
-- 
cgit v1.2.3