BenchmarkRule

class BenchmarkRule : TestRule

JUnit rule for benchmarking code on an Android device.

In Kotlin, benchmark with measureRepeated:

@get:Rule
val benchmarkRule = BenchmarkRule();

@Test
fun myBenchmark() {
    ...
    benchmarkRule.measureRepeated {
        doSomeWork()
    }
    ...
}

In Java, use getState():

@Rule
public BenchmarkRule benchmarkRule = new BenchmarkRule();

@Test
public void myBenchmark() {
    ...
    BenchmarkState state = benchmarkRule.getState();
    while (state.keepRunning()) {
        doSomeWork();
    }
    ...
}

Benchmark results will be output:

• Summary in AndroidStudio in the test log
• In JSON format, on the host
• In simple form in Logcat with the tag "Benchmark"
• To the instrumentation status result Bundle on the gradle command line

Every test in the Class using this @Rule must contain a single benchmark.

Summary

Public constructors

BenchmarkRule()

Public methods

fun apply(
    base: Statement, 
    description: Description
): Statement

fun getState(): BenchmarkState

@Rule
public BenchmarkRule benchmarkRule = new BenchmarkRule();

@Test
public void myBenchmark() {
    ...
    BenchmarkState state = benchmarkRule.getBenchmarkState();
    while (state.keepRunning()) {
        doSomeWork();
    }
    ...
}