com.thinkaurelius.titan.testutil

Class JUnitBenchmarkProvider

java.lang.Object

com.thinkaurelius.titan.testutil.JUnitBenchmarkProvider

public class JUnitBenchmarkProvider
extends Object

JUB can write the results of a single JVM run to an XML file, but it does not support appending to an existing file. When given a path to an existing file, it silently overwrites the old contents. This is unusable in a fork-per-test-class surefire configuration. The results of each test class overwrite those previous, so that the only results still readable at the end of a test run are those of the final class executed.

This class exists to configure JUB programmatically and avoid the annoying behavior of the system-property-configured XMLConsumer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EFFORT_FILE
static int	DEFAULT_ROUNDS
static String	ENV_DEFAULT_ROUNDS
static String	ENV_EFFORT_FILE
static String	ENV_EFFORT_GENERATE
static String	ENV_TARGET_RUNTIME_MS
static String	ENV_WARMUP_ROUNDS
static long	TARGET_RUNTIME_MS
static int	WARMUP_ROUNDS

Constructor Summary

Constructors

Constructor and Description
JUnitBenchmarkProvider()

Method Summary

Modifier and Type	Method and Description
static org.junit.rules.TestRule	get() Get a JUnitBenchmarks rule configured for Titan performance testing.
static org.junit.rules.TestRule	get(com.carrotsearch.junitbenchmarks.IResultsConsumer... additionalConsumers) Like get(), except extra JUB Results consumers can be attached to the returned rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENV_EFFORT_GENERATE

public static final String ENV_EFFORT_GENERATE

See Also:

Constant Field Values

ENV_EFFORT_FILE

public static final String ENV_EFFORT_FILE

See Also:

Constant Field Values

ENV_DEFAULT_ROUNDS

public static final String ENV_DEFAULT_ROUNDS

See Also:

Constant Field Values

ENV_WARMUP_ROUNDS

public static final String ENV_WARMUP_ROUNDS

See Also:

Constant Field Values

ENV_TARGET_RUNTIME_MS

public static final String ENV_TARGET_RUNTIME_MS

See Also:

Constant Field Values

DEFAULT_EFFORT_FILE

public static final String DEFAULT_EFFORT_FILE

See Also:

Constant Field Values

TARGET_RUNTIME_MS

public static final long TARGET_RUNTIME_MS

DEFAULT_ROUNDS

public static final int DEFAULT_ROUNDS

WARMUP_ROUNDS

public static final int WARMUP_ROUNDS

Constructor Detail

JUnitBenchmarkProvider

public JUnitBenchmarkProvider()

Method Detail

get

public static org.junit.rules.TestRule get()

Get a JUnitBenchmarks rule configured for Titan performance testing.

The returned rule will write results to an XML file named jub.(abs(current nanotime)).xml and to the console.

This method concentrates our JUB configuration in a single code block and gives us programmatic flexibility that exceeds the limited flexibility of configuring JUB through its hardcoded global system properties. It also converts the IOException that XMLConsumer's constructor can throw into a RuntimeException. In test classes, this conversion is the difference between:

  @Rule
 public TestRule benchmark; // Can't initialize here b/c of IOException
 ...
 public TestClassConstructor() throws IOException {
     benchmark = new BenchmarkRule(new XMLConsumer(...));
 }

 // or, if there are extant subclass constructors we want to leave alone...

 public TestClassConstructor() {
     try {
         benchmark = new BenchmarkRule(new XMLConsumer(...));
     } catch (IOException e) {
         throw new RuntimeException(e);
     }
 }
 

versus, with this method,

  @Rule
 public TestRule benchmark = JUnitBenchmarkProvider.get(); // done
 

Returns:

a BenchmarkRule ready for use with the JUnit @Rule annotation

get

public static org.junit.rules.TestRule get(com.carrotsearch.junitbenchmarks.IResultsConsumer... additionalConsumers)

Like get(), except extra JUB Results consumers can be attached to the returned rule.

Parameters:

additionalConsumers - extra JUB results consumers to apply in the returned rule object

Returns:

a BenchmarkRule ready for use with the JUnit @Rule annotation