de.undercouch.citeproc.script.ScriptRunnerBenchmark.java Source code

Introduction

Here is the source code for de.undercouch.citeproc.script.ScriptRunnerBenchmark.java

Source

// Copyright 2013 Michel Kraemer
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package de.undercouch.citeproc.script;

import static org.junit.Assert.assertEquals;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.JavaVersion;
import org.apache.commons.lang3.SystemUtils;
import org.jbibtex.BibTeXDatabase;
import org.jbibtex.Key;
import org.junit.BeforeClass;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TestRule;

import com.carrotsearch.junitbenchmarks.BenchmarkOptions;
import com.carrotsearch.junitbenchmarks.BenchmarkRule;

import de.undercouch.citeproc.CSL;
import de.undercouch.citeproc.bibtex.AbstractBibTeXTest;
import de.undercouch.citeproc.bibtex.BibTeXItemDataProvider;
import de.undercouch.citeproc.output.Citation;
import de.undercouch.citeproc.script.ScriptRunnerFactory.RunnerType;

/**
 * Tests the performance of different {@link ScriptRunner} implementations
 * @author Michel Kraemer
 */
public class ScriptRunnerBenchmark extends AbstractBibTeXTest {
    /**
     * Configures this benchmark test
     */
    @Rule
    public TestRule benchmarkRun = new BenchmarkRule();

    private static BibTeXDatabase db;
    private static BibTeXItemDataProvider sys = new BibTeXItemDataProvider();
    private static List<Integer> rnds = new ArrayList<Integer>();

    /**
     * Set up this test
     * @throws Exception if something goes wrong
     */
    @BeforeClass
    public static void setUp() throws Exception {
        db = loadUnixDatabase();
        sys.addDatabase(db);

        for (int i = 0; i < 10; ++i) {
            int j = (int) (Math.random() * db.getEntries().size());
            rnds.add(j);
        }
    }

    private void runTest() throws Exception {
        CSL citeproc = new CSL(sys, "ieee");
        citeproc.setOutputFormat("text");

        List<Key> keys = new ArrayList<Key>(db.getEntries().keySet());
        List<String> result = new ArrayList<String>();

        for (Integer r : rnds) {
            Key k = keys.get(r);
            List<Citation> cs = citeproc.makeCitation(k.getValue());
            for (Citation c : cs) {
                while (result.size() <= c.getIndex()) {
                    result.add("");
                }
                result.set(c.getIndex(), c.getText());
            }
        }

        int c = 0;
        for (Integer r : rnds) {
            Key k = keys.get(r);
            List<Citation> cs = citeproc.makeCitation(k.getValue());
            assertEquals(1, cs.size());
            String nc = cs.get(0).getText();
            String pc = result.get(c);
            assertEquals(nc, pc);
            ++c;
        }
    }

    /**
     * Tests the JRE script runner
     * @throws Exception if something goes wrong
     */
    @BenchmarkOptions(benchmarkRounds = 10, warmupRounds = 1)
    @Test
    public void jre() throws Exception {
        if (!SystemUtils.isJavaVersionAtLeast(JavaVersion.JAVA_1_7)) {
            //skip test for Java 1.6. It would fail anyway
            return;
        }

        RunnerType prev = ScriptRunnerFactory.setRunnerType(RunnerType.JRE);
        try {
            runTest();
        } finally {
            ScriptRunnerFactory.setRunnerType(prev);
        }
    }

    /**
     * Tests the Rhino script runner
     * @throws Exception if something goes wrong
     */
    @BenchmarkOptions(benchmarkRounds = 10, warmupRounds = 1)
    @Test
    public void rhino() throws Exception {
        RunnerType prev = ScriptRunnerFactory.setRunnerType(RunnerType.RHINO);
        try {
            runTest();
        } finally {
            ScriptRunnerFactory.setRunnerType(prev);
        }
    }
}