org.apache.jackrabbit.oak.scalability.suites

Class ScalabilityAbstractSuite

java.lang.Object

org.apache.jackrabbit.oak.scalability.suites.ScalabilityAbstractSuite

All Implemented Interfaces:

CSVResultGenerator, ScalabilitySuite

Direct Known Subclasses:

ScalabilityNodeSuite

public abstract class ScalabilityAbstractSuite
extends Object
implements ScalabilitySuite, CSVResultGenerator

Abstract class which defines a lot of the boiler-plate code needed to run the suite of tests. Any test suite extending from this class has the following entry points

beforeSuite() - To configure the whole suite before the tests are started.

afterSuite() - To shutdown the whole suite after all tests are finished.

beforeIteration(ExecutionContext) - Any initialization to be performed before each of the test run. Typically, this can be configured to create additional loads for each iteration. This method will be called before each test iteration begins.

afterIteration() - To configure any post test steps to be executed after each iteration of the test. This method will be called after each test iteration completes.

executeBenchmark(ScalabilityBenchmark, ExecutionContext) - Actual benchmark/test to be executed. This method will be called in each iteration of the test run.

The following system JVM properties can be defined to configure the suite.

• profile - Controls whether to profile the benchmark or not. Defaults to false.
• noWarmup - Controls whether to run warmup or not before each benchmark. Defaults to false.
• increments - Comma separated list which controls the incremental load for each iteration. Defaults to 1,2,5.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScalabilityAbstractSuite.ExecutionContext Execution context to be pass information to and from the suite to the benchmarks.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,ScalabilityBenchmark>	benchmarks
protected static Credentials	CREDENTIALS
static String	CTX_SEARCH_PATHS_PROP
protected static List<String>	INCREMENTS Controls the incremental load for each iteration
protected static org.slf4j.Logger	LOG
protected static boolean	PROFILE
protected static String	TEST_ID A random string to guarantee concurrently running tests don't overwrite each others changes (for example in a cluster).
protected static boolean	WARMUP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScalabilityAbstractSuite()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBackgroundJob(Runnable job) Adds a background thread that repeatedly executes the given job until all the iterations of this test have been executed.
protected void	afterIteration() Run after all iterations of this test have been executed.
protected void	afterSuite() Cleanup after the benchmarks are run.
void	beforeIteration(ScalabilityAbstractSuite.ExecutionContext context) Executes once for each iteration.
protected void	beforeSuite() Setup any options before the benchmarks.
protected Repository[]	createRepository(RepositoryFixture fixture)
protected abstract void	executeBenchmark(ScalabilityBenchmark benchmark, ScalabilityAbstractSuite.ExecutionContext context) Runs the benchmark.
Map<String,ScalabilityBenchmark>	getBenchmarks()
protected Repository	getRepository()
protected void	initBackgroundJobs() Sets the running flag to true.
protected Session	loginWriter() Returns a new writer session that will be automatically closed once all the iterations of this test have been executed.
boolean	removeBenchmark(String benchmark) Removes the benchmark.
void	run(Iterable<RepositoryFixture> fixtures)
void	setPrintStream(PrintStream out)
void	setUp(Repository repository, RepositoryFixture fixture, Credentials credentials) Prepares this performance benchmark.
protected void	shutdownBackgroundJobs() Shutdown the background threads.
void	tearDown() Cleans up after this performance benchmark.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jackrabbit.oak.scalability.ScalabilitySuite

addBenchmarks

Field Detail

CTX_SEARCH_PATHS_PROP

public static final String CTX_SEARCH_PATHS_PROP

See Also:

Constant Field Values

LOG

protected static final org.slf4j.Logger LOG

TEST_ID

protected static final String TEST_ID

A random string to guarantee concurrently running tests don't overwrite each others changes (for example in a cluster).

The probability of duplicates, for 50 concurrent processes, is less than 1 in 1 million.

PROFILE

protected static final boolean PROFILE

WARMUP

protected static final boolean WARMUP

INCREMENTS

protected static final List<String> INCREMENTS

Controls the incremental load for each iteration

CREDENTIALS

protected static final Credentials CREDENTIALS

benchmarks

protected Map<String,ScalabilityBenchmark> benchmarks

Constructor Detail

ScalabilityAbstractSuite

protected ScalabilityAbstractSuite()

Method Detail

run

public void run(Iterable<RepositoryFixture> fixtures)

Specified by:

run in interface ScalabilitySuite

beforeSuite

protected void beforeSuite()
                    throws Exception

Setup any options before the benchmarks.

Throws:

Exception

setUp

public void setUp(Repository repository,
         RepositoryFixture fixture,
         Credentials credentials)
           throws Exception

Prepares this performance benchmark.

Parameters:

repository - the repository to use

fixture - credentials of a user with write access

Throws:

Exception - if the benchmark can not be prepared

afterSuite

protected void afterSuite()
                   throws Exception

Cleanup after the benchmarks are run.

Throws:

Exception

tearDown

public void tearDown()
              throws Exception

Cleans up after this performance benchmark.

Throws:

Exception - if the benchmark can not be cleaned up

removeBenchmark

public boolean removeBenchmark(String benchmark)

Removes the benchmark.

Specified by:

removeBenchmark in interface ScalabilitySuite

getBenchmarks

public Map<String,ScalabilityBenchmark> getBenchmarks()

Specified by:

getBenchmarks in interface ScalabilitySuite

executeBenchmark

protected abstract void executeBenchmark(ScalabilityBenchmark benchmark,
                    ScalabilityAbstractSuite.ExecutionContext context)
                                  throws Exception

Runs the benchmark.

Parameters:

benchmark - the benchmark to execute

Throws:

Exception

beforeIteration

public void beforeIteration(ScalabilityAbstractSuite.ExecutionContext context)
                     throws Exception

Executes once for each iteration.

Parameters:

context - the context

Throws:

Exception - the repository exception

afterIteration

protected void afterIteration()
                       throws Exception

Run after all iterations of this test have been executed. Subclasses can override this method to clean up static test content.

Throws:

Exception - if an error occurs

addBackgroundJob

protected void addBackgroundJob(Runnable job)

Adds a background thread that repeatedly executes the given job until all the iterations of this test have been executed.

Parameters:

job - background job

initBackgroundJobs

protected void initBackgroundJobs()

Sets the running flag to true.

shutdownBackgroundJobs

protected void shutdownBackgroundJobs()
                               throws InterruptedException

Shutdown the background threads.

Throws:

InterruptedException

createRepository

protected Repository[] createRepository(RepositoryFixture fixture)
                                 throws Exception

Throws:

Exception

loginWriter

protected Session loginWriter()

Returns a new writer session that will be automatically closed once all the iterations of this test have been executed.

Returns:

writer session

toString

public String toString()

Overrides:

toString in class Object

setPrintStream

public void setPrintStream(PrintStream out)

Specified by:

setPrintStream in interface CSVResultGenerator

getRepository

protected Repository getRepository()