io.deephaven.benchmark.run.BenchmarkMain Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deephaven-benchmark Show documentation
Deephaven Benchmark
The newest version!
/* Copyright (c) 2022-2023 Deephaven Data Labs and Patent Pending */
package io.deephaven.benchmark.run;

import java.net.URL;
import java.nio.file.Path;
import org.junit.platform.console.ConsoleLauncher;
import io.deephaven.benchmark.api.Bench;

/**
 * Main class for running the benchmark framework from the deephaven-benchmark artifact. This wraps the JUnit standalone
 * console launcher.
 * 
 * ex. java -Dbenchmark.profile=my-benchmark.properties -jar deephaven-benchmark-1.0-SNAPSHOT.jar -cp my-tests.jar -p
 * my.tests
 * 
 * In addition to running benchmark tests using the console launcher, this class creates a
 * benchmark-summary-results.csv that is a merge of any per-run results files that match
 * results/run-[A-za-z0-9]+/benchmark-results.csv relative to the working directory
 */
public class BenchmarkMain {
    /**
     * Main method for executing the benchmark framework from the command line. Accepts the same arguments as the JUnit
     * standalone console launcher
     * 
     * @param args standalone console launcher arguments
     */
    static public void main(String[] args) {
        System.exit(main1(args));
    }

    static int main1(String[] args) {
        setSystemProperties();
        if (args.length > 0 && args[0].equals("publish"))
            return publish(Bench.rootOutputDir);

        int exitCode = ConsoleLauncher.execute(System.out, System.err, args).getExitCode();
        if (exitCode == 0) {
            Path d = Bench.rootOutputDir;
            URL platformCsv = new ResultSummary(d, "platform-summary-results.csv", Bench.platformFileName).summarize();
            URL benchmarkCsv = new ResultSummary(d, "benchmark-summary-results.csv", Bench.resultFileName).summarize();
            toSummarySvg(platformCsv, benchmarkCsv, "standard", d, "nightly");
            toSummarySvg(platformCsv, benchmarkCsv, "standard", d, "release");
            toSummarySvg(platformCsv, benchmarkCsv, "standard", d, "adhoc");
            toSummarySvg(platformCsv, benchmarkCsv, "compare", d, "compare");
        }
        return exitCode;
    }

    static void toSummarySvg(URL platformCsv, URL benchCsv, String tmpPrefix, Path outputDir, String outputPrefix) {
        URL svgTemplate = resource("profile/" + tmpPrefix + "-benchmark-summary.template.svg");
        Path outSvg = outputDir.resolve(outputPrefix + "-benchmark-summary.svg");
        new SvgSummary(platformCsv, benchCsv, svgTemplate, outSvg).summarize();
    }

    static int publish(Path outputDir) {
        URL svgTemplate = resource("profile/deephaven-table.template.svg");
        URL query = resource("profile/queries/publish.py");
        new PublishNotification(query, svgTemplate, outputDir).publish();
        return 0;
    }

    static URL resource(String name) {
        return BenchmarkMain.class.getResource(name);
    }

    // Set system properties for running from the command line
    static void setSystemProperties() {
        System.setProperty("timestamp.test.results", "true");
    }

}