io.deephaven.benchmark.run.SvgSummary Maven / Gradle / Ivy
/* Copyright (c) 2022-2023 Deephaven Data Labs and Patent Pending */
package io.deephaven.benchmark.run;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.*;
import java.util.regex.Pattern;
import java.time.format.DateTimeFormatter;
import java.time.LocalDateTime;
import java.util.stream.IntStream;
import io.deephaven.benchmark.util.Filer;
import io.deephaven.benchmark.util.Numbers;
/**
* Generates an SVG file from a template that contains variables (e.g. ${My Agg=>op_duration}) referencing
* benchmark data from the benchmark result produced by the {@code ResultSummary}. If the benchmark results summary
* contains more than one run, the values for the newest run are used.
*
* Note: This class is used to transform the specific template format defined in {@code benchmark-summary.template.svg}
* against the {@code benchmark-results.csv} file. It is not general-purpose nor bulletproof.
*
* @see {@code benchmark-summary.template.svg} for an example of a template that works.
*/
class SvgSummary {
final String varRegex = "\\$\\{([^}]+)\\}";
final Map benchmarks;
final Map platformProps;
final String svgTemplate;
final Path outputDir;
final Path svgFile;
/**
* Configure this generator to correlate benchmark data with a summary template
*
* @param benchmarkCsv the benchmark result data referenced by the template
* @param svgTemplate the template containing references to the benchmark data
* @param svgFile the svg file path to produce
*/
SvgSummary(URL platformCsv, URL benchmarkCsv, URL svgTemplate, Path svgFile) {
this.benchmarks = readSummaryCsv(benchmarkCsv, "benchmark_name");
this.platformProps = readSummaryCsv(platformCsv, "origin", "name");
this.svgTemplate = Filer.getURLText(svgTemplate);
this.outputDir = svgFile.getParent();
this.svgFile = svgFile;
}
/**
* Generate SVG files based on benchmark results CSV applied to a template
*/
void summarize() {
if (!Files.exists(outputDir)) {
System.out.println("Skipping SVG summary because of missing output directory: " + outputDir);
return;
}
var template = replacePlatformVars(svgTemplate);
var out = Pattern.compile(varRegex).matcher(template).replaceAll(match -> {
var split = match.group(1).split("=>");
if (split.length < 2)
return "$0";
var lookupName = split[0].trim();
var columnName = split[1].trim();
var platformProp = platformProps.get(lookupName);
var benchmark = benchmarks.get(lookupName);
if (platformProp != null)
return platformProp.getValue(columnName);
if (benchmark != null)
return Numbers.formatNumber(benchmark.getValue(columnName));
return "$0";
});
Filer.putFileText(svgFile, out);
}
private Map readSummaryCsv(URL csv, String... nameColumns) {
var header = new HashMap();
var benchmarks = new HashMap();
var csvLines = Filer.getURLText(csv).lines().toList();
for (int i = 0, n = csvLines.size(); i < n; i++) {
String[] values = csvLines.get(i).split(",");
if (i == 0) {
IntStream.range(0, values.length).forEach(pos -> header.put(values[pos], pos));
} else {
var next = new Row(header, values, nameColumns);
var existing = benchmarks.get(next.getName());
if (next.isNewerThan(existing))
benchmarks.put(next.getName(), next);
}
}
return benchmarks;
}
private String replacePlatformVars(String str) {
DateTimeFormatter dtf = DateTimeFormatter.ofPattern("yyyy-MM-dd");
str = str.replace("${run_date}", dtf.format(LocalDateTime.now()));
str = str.replace("${os_name}", "Ubuntu 22.04.1 LTS".toLowerCase().replace(" ", "-"));
return str.replace("${benchmark_count}", "" + benchmarks.size());
}
record PlatformProp(Map header, String[] values) {
String getValue(String colName) {
Integer index = header.get(colName);
if (index == null)
throw new RuntimeException("Undefined platform column name: " + colName);
return values[index].trim();
}
}
record Row(Map header, String[] values, String... lookupColumns) {
String getValue(String colName) {
Integer index = header.get(colName);
if (index == null)
throw new RuntimeException("Undefined benchmark column name: " + colName);
return values[index].trim();
}
String getName() {
var name = "";
for (int i = 0, n = lookupColumns.length; i < n; i++) {
var v = getValue(lookupColumns[i]);
name += (i == 0) ? v : (">>" + v);
}
return name;
}
boolean isNewerThan(Row other) {
return (other == null) ? true : (getValue("run-id").compareTo(other.getValue("run-id")) > 0);
}
}
}