XSVResultFormat.java

/*
 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.openjdk.jmh.results.format;

import org.openjdk.jmh.infra.BenchmarkParams;
import org.openjdk.jmh.results.Result;
import org.openjdk.jmh.results.RunResult;

import java.io.PrintStream;
import java.util.Collection;
import java.util.SortedSet;
import java.util.TreeSet;

/*
 * CSV formatter follows the provisions of http://tools.ietf.org/html/rfc4180
 */
class XSVResultFormat implements ResultFormat {

    private final PrintStream out;
    private final String delimiter;

    public XSVResultFormat(PrintStream out, String delimiter) {
        this.out = out;
        this.delimiter = delimiter;
    }

    @Override
    public void writeOut(Collection<RunResult> results) {
        SortedSet<String> params = new TreeSet<>();
        for (RunResult res : results) {
            params.addAll(res.getParams().getParamsKeys());
        }

        printHeader(params);

        for (RunResult rr : results) {
            BenchmarkParams benchParams = rr.getParams();
            Result res = rr.getPrimaryResult();

            printLine(benchParams.getBenchmark(), benchParams, params, res);

            for (String label : rr.getSecondaryResults().keySet()) {
                Result subRes = rr.getSecondaryResults().get(label);
                printLine(benchParams.getBenchmark() + ":" + subRes.getLabel(), benchParams, params, subRes);
            }
        }
    }

    private void printHeader(SortedSet<String> params) {
        out.print("\"Benchmark\"");
        out.print(delimiter);
        out.print("\"Mode\"");
        out.print(delimiter);
        out.print("\"Threads\"");
        out.print(delimiter);
        out.print("\"Samples\"");
        out.print(delimiter);
        out.print("\"Score\"");
        out.print(delimiter);
        out.printf("\"Score Error (%.1f%%)\"", 99.9);
        out.print(delimiter);
        out.print("\"Unit\"");
        for (String k : params) {
            out.print(delimiter);
            out.print("\"Param: " + k + "\"");
        }
        out.print("\r\n");
    }

    private void printLine(String label, BenchmarkParams benchmarkParams, SortedSet<String> params, Result result) {
        out.print("\"");
        out.print(label);
        out.print("\"");
        out.print(delimiter);
        out.print("\"");
        out.print(benchmarkParams.getMode().shortLabel());
        out.print("\"");
        out.print(delimiter);
        out.print(emit(benchmarkParams.getThreads()));
        out.print(delimiter);
        out.print(emit(result.getSampleCount()));
        out.print(delimiter);
        out.print(emit(result.getScore()));
        out.print(delimiter);
        out.print(emit(result.getScoreError()));
        out.print(delimiter);
        out.print("\"");
        out.print(result.getScoreUnit());
        out.print("\"");

        for (String p : params) {
            out.print(delimiter);
            String v = benchmarkParams.getParam(p);
            if (v != null) {
                out.print(emit(v));
            }
        }

        out.print("\r\n");
    }

    private String emit(String v) {
        if (v.contains(delimiter) || v.contains(" ") || v.contains("\n") || v.contains("\r") || v.contains("\"")) {
            return "\"" + v.replaceAll("\"", "\"\"") + "\"";
        } else {
            return v;
        }
    }

    private String emit(int i) {
        return emit(String.format("%d", i));
    }

    private String emit(long l) {
        return emit(String.format("%d", l));
    }

    private String emit(double d) {
        return emit(String.format("%f", d));
    }

}