generate_stat_html.py

#!/usr/bin/env python3
import json
from html import escape
from collections import defaultdict
from datetime import timedelta
from difflib import SequenceMatcher
from typing import IO, List, Sequence

try:
    import plotly.offline as py
    import plotly.graph_objs as go
    CHARTS_SUPPORTED = True
except ImportError:
    CHARTS_SUPPORTED = False

HEADER = """
<!DOCTYPE html>
<html lang="en">
<head>
  <title>Detailed Statistics</title>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/css/bootstrap.min.css"
        integrity="sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh"
        crossorigin="anonymous">
  <script src="https://code.jquery.com/jquery-3.4.1.slim.min.js"
          integrity="sha384-J6qa4849blE2+poT4WnyKhv5vZF5SrPo0iEjwBvKU7imGFAV0wwj1yYfoRSJoZ+n"
          crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js"
          integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo"
          crossorigin="anonymous"></script>
  <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.4.1/js/bootstrap.min.js"
          integrity="sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6"
          crossorigin="anonymous"></script>
  <script src="https://cdn.plot.ly/plotly-latest.min.js"></script>
  <script>
      // Reload Poltly graphs on tab change.
      $(document).ready(function () {
          $('a[data-toggle="tab"]').on('shown.bs.tab', function (e) {
              var target = $(e.target).attr("href");
              var toRemove = [];
              var toAppend = [];
              $(target).find("SCRIPT").each(function (index, element) {
                  var script = document.createElement('script');
                  script.text = element.text
                  toRemove.push(element);
                  toAppend.push(script);
              });
              toRemove.forEach(function (item) {
                  item.remove();
              });
              toAppend.forEach(function (item) {
                  $(target).append(item);
              });
              $(target).find("DIV").each(function (index, element) {
                   if (element.className.includes("plotly-graph-div")) {
                       Plotly.relayout(element, {height: 500});
                   }
               });
          })
      });
  </script>
  <style> .tab-content { padding: 10px; } </style>
</head>
<body>
<div class="jumbotron text-center">
  <h1>Detailed Static Analyzer Statistics</h1>
</div>
<div class="container">
"""

FOOTER = """
</div>
</div>
<footer class="page-footer">
  <div class="container-fluid bg-light p-3 mb-2">
    <span class="text-muted">This report is created by the
      <a href="https://github.com/Xazax-hun/csa-testbench">CSA-Testbench</a> toolset.</span>
  </div>
</footer>
</body>
</html>
"""


def longest_match(a: Sequence, b: Sequence) -> int:
    return SequenceMatcher(None, a, b).\
        find_longest_match(0, len(a), 0, len(b)).size


def sort_keys_by_similarity(keys: Sequence[str]) -> List[str]:
    """
    Sort keys by similarity. This is an approximation of the
    optimal order. For each insertion to an intermediate list we
    calculate a score and choose the best insertion. The score also
    have a penalty part if the insertion reduces the similarity of
    the neighbors.
    """
    result = []
    for key in keys:
        index = 0
        max_score = -1000
        for j in range(len(result)+1):
            score = 0
            if j < len(result):
                score += longest_match(key, result[j])
            if j > 0:
                score += longest_match(key, result[j-1])
            if 0 < j < len(result):
                score -= longest_match(result[j], result[j-1])
            if score > max_score:
                max_score = score
                index = j
        result.insert(index, key)
    return result


# FIXME: Escape strings.
class HTMLPrinter:

    def __init__(self, path: str, config: dict):
        self.html_path = path
        self.charts = config.get("charts", ["Duration", "Result count"])
        self.excludes = ["TU times"]
        self.as_comment = ["Analyzer version"]
        self.projects = {}
        with open(self.html_path, 'w') as stat_html:
            stat_html.write(HEADER)
            try:
                stat_html.write("<!-- %s -->\n" %
                                escape(json.dumps(config)))
            except Exception:
                stat_html.write("<!-- JSON encoding of config failed -->\n")
            # Generate nav bar.
            stat_html.write('<nav>\n<div class="nav nav-tabs" '
                            'id="nav-tab" role="tablist">\n')
            active = "active"
            for project in config["projects"]:
                name = escape(project["name"])
                text = '<a class="nav-item nav-link {0}" id="nav-{1}-tab"' \
                       ' data-toggle="tab" href="#nav-{1}" role="tab"' \
                       ' aria-controls="nav-{1}" aria-selected="{2}">{1}</a>' \
                    .format(active, name, "true" if active != "" else "false")
                stat_html.write(text)
                active = ""
            text = '<a class="nav-item nav-link" id="nav-charts-tab"' \
                   ' data-toggle="tab" href="#nav-charts" role="tab"' \
                   ' aria-controls="nav-charts" aria-selected="false">' \
                   'Charts</a>'
            stat_html.write(text)
            stat_html.write('</div>\n</nav>\n')
            stat_html.write('<div class="tab-content" id="nav-tabContent">\n')

    def finish(self) -> None:
        with open(self.html_path, 'a') as stat_html:
            self._generate_charts(stat_html)
            stat_html.write(FOOTER)

    def __enter__(self):
        return self

    def __exit__(self, type, value, traceback):
        self.finish()

    def extend_with_project(self, name: str, data: dict,
                            extra_charts: dict) -> None:
        first = len(self.projects) == 0
        self.projects[name] = data
        stat_html = open(self.html_path, 'a')
        keys = set()
        configurations = set()
        for configuration, val in data.items():
            configurations.add(configuration)
            for stat_name in val:
                keys.add(stat_name)
        keys = sort_keys_by_similarity(keys)

        tab = '<div class="tab-pane fade {0}" ' \
              'id="nav-{1}" role="tabpanel" aria-labelledby="nav-{1}-tab">\n'\
            .format("show active" if first else "", escape(name))
        stat_html.write(tab)
        stat_html.write('<table class="table table-bordered '
                        'table-striped table-sm">\n')
        stat_html.write('<thead class="thead-dark">')
        stat_html.write("<tr>\n")
        stat_html.write("<th>Statistic Name</th>")
        for conf in configurations:
            stat_html.write("<th>%s</th>" % escape(conf))
        stat_html.write("</tr>\n")
        stat_html.write('</thead>\n')
        stat_html.write('<tbody>\n')

        for stat_name in keys:
            if stat_name in self.excludes or \
               stat_name in self.as_comment:
                continue
            stat_html.write("<tr>\n")
            stat_html.write("<td>%s</td>" % escape(stat_name))
            for conf in configurations:
                val = str(data[conf].get(stat_name, '-'))
                stat_html.write("<td>%s</td>" % val)
            stat_html.write("</tr>\n")
        stat_html.write('</tbody>\n')
        stat_html.write("</table>\n\n")

        # Output some values as comments.
        for stat_name in self.as_comment:
            for conf in configurations:
                val = str(data[conf].get(stat_name, '-'))
                stat_html.write("<!-- %s[%s]=%s -->\n" %
                                (escape(conf), escape(stat_name), escape(val)))

        HTMLPrinter._generate_time_histogram(stat_html, configurations, data)

        # Write additional charts.
        if extra_charts:
            stat_html.write("<h2>Project-specific charts</h2>")
            for title, figure in extra_charts.items():
                div = py.plot(figure, show_link=False, include_plotlyjs=False,
                              output_type='div', auto_open=False)
                stat_html.write("<h3>%s</h3>" % escape(title))
                stat_html.write(div)

        stat_html.write('</div>\n')
        stat_html.close()

    @staticmethod
    def _generate_time_histogram(stat_html: IO, configurations: set,
                                 data: dict) -> None:
        if not CHARTS_SUPPORTED:
            return
        traces = []
        for conf in configurations:
            if "TU times" in data[conf]:
                if not data[conf]["TU times"]:
                    continue
                traces.append(go.Histogram(x=data[conf]["TU times"],
                                           name=conf))
        if not traces:
            return
        layout = go.Layout(barmode='overlay')
        fig = go.Figure(data=traces, layout=layout)
        div = py.plot(fig, show_link=False, include_plotlyjs=False,
                      output_type='div', auto_open=False)
        stat_html.write("<h3>Time per TU histogram</h3>\n")
        stat_html.write(div)

    def _generate_charts(self, stat_html: IO) -> None:
        stat_html.write('<div class="tab-pane fade" id="nav-charts"'
                        ' role="tabpanel" aria-labelledby="nav-charts-tab">\n')
        if not CHARTS_SUPPORTED:
            stat_html.write("<p>Charts not supported."
                            "Install Plotly python library.</p>\n</div>\n")
            return
        layout = go.Layout(barmode='group')
        for chart in self.charts:
            names = defaultdict(list)
            values = defaultdict(list)
            for project, data in self.projects.items():
                for configuration, stats in data.items():
                    values[configuration].append(
                        HTMLPrinter._get_chart_value(stats.get(chart, 0)))
                    names[configuration].append(project)

            # Skip empty charts.
            if all([all([x == 0 for x in values[conf]]) for conf in names]):
                continue

            bars = []
            for conf in names:
                bar = go.Bar(x=names[conf], y=values[conf], name=conf)
                bars.append(bar)

            fig = go.Figure(data=bars, layout=layout)
            div = py.plot(fig, show_link=False, include_plotlyjs=False,
                          output_type='div', auto_open=False)
            stat_html.write("<h2>%s</h2>\n" % escape(chart))
            stat_html.write(div)

        stat_html.write("</div>\n")

    @staticmethod
    def _get_chart_value(value):
        if isinstance(value, timedelta):
            return value.seconds
        return float(value)