io.github.glytching.junit.extension.benchmark

Class BenchmarkExtension

java.lang.Object

io.github.glytching.junit.extension.benchmark.BenchmarkExtension

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterTestExecutionCallback, org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.Extension

public class BenchmarkExtension
extends Object
implements org.junit.jupiter.api.extension.BeforeTestExecutionCallback, org.junit.jupiter.api.extension.AfterTestExecutionCallback

The benchmark extension publishes elapsed time to the execution listener. By default, this produces output like so:

 timestamp = 2018-08-30T16:28:47.701, Elapsed time in MICROSECONDS for canBenchmark = 13213
 

Your own implementation of the EngineExecutionListener could adopt a different template for the event string or it could collect and aggregate results for all tests in a test case or it could write results to somewhere other than the console etc.

By default, elapsed times are reported in TimeUnit.MILLISECONDS but you can use RegisterExtension to choose a different TimeUnit.

Usage example:

 @ExtendWith(BenchmarkExtension.class)
 public class MyTest {

  @Test
  public void aTest() {
      // ...
  }
 }
 

 public class MyTest {

  // report elapsed times in a non default time unit
  @@RegisterExtension
  static BenchmarkExtension benchmarkExtension = new BenchmarkExtension(TimeUnit.MICROSECONDS);

  @Test
  public void aTest() {
      // ...
  }
 }
 

Since:

2.4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	REPORT_EVENT_FORMAT

Constructor Summary

Constructors

Constructor and Description
BenchmarkExtension() Constructs an instance of this class which will report using the default time unit.
BenchmarkExtension(TimeUnit timeUnit) Constructs an instance of this class which will report using the given timeUnit.

Method Summary

Modifier and Type	Method and Description
void	afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext) Gather the elapsed time, using StopWatch stored by beforeTestExecution(ExtensionContext).
void	beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext) Store a StopWatch instance against the test method name for use in afterTestExecution(ExtensionContext).

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_EVENT_FORMAT

public static final String REPORT_EVENT_FORMAT

See Also:

Constant Field Values

Constructor Detail

BenchmarkExtension

public BenchmarkExtension()

Constructs an instance of this class which will report using the default time unit.

BenchmarkExtension

public BenchmarkExtension(TimeUnit timeUnit)

Constructs an instance of this class which will report using the given timeUnit.

Parameters:

timeUnit - the time unit in which benchmarks will be reported

Method Detail

beforeTestExecution

public void beforeTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                         throws Exception

Store a StopWatch instance against the test method name for use in afterTestExecution(ExtensionContext).

Specified by:

beforeTestExecution in interface org.junit.jupiter.api.extension.BeforeTestExecutionCallback

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception

afterTestExecution

public void afterTestExecution(org.junit.jupiter.api.extension.ExtensionContext extensionContext)
                        throws Exception

Gather the elapsed time, using StopWatch stored by beforeTestExecution(ExtensionContext).

Specified by:

afterTestExecution in interface org.junit.jupiter.api.extension.AfterTestExecutionCallback

Parameters:

extensionContext - the context in which the current test or container is being executed

Throws:

Exception