org.apache.drill.exec.testing

Class Controls.Builder

java.lang.Object

org.apache.drill.exec.testing.Controls.Builder

Enclosing class:

Controls

public static class Controls.Builder
extends Object

A builder to create a controls string, a JSON that holds a list of injections that are to be injected in code for testing purposes. This string is passed through the ExecConstants.DRILLBIT_CONTROL_INJECTIONS session option.

The builder class can be reused; it is safe to call build() multiple times to build multiple controls strings in series. Each new controls string contains all the injections added to the builder before it.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Controls.Builder	addException(Class<?> siteClass, String desc, Class<? extends Throwable> exceptionClass) Adds an exception injection to the controls builder with the given parameters.
Controls.Builder	addException(Class<?> siteClass, String desc, Class<? extends Throwable> exceptionClass, int nSkip, int nFire) Adds an exception injection to the controls builder with the given parameters.
Controls.Builder	addExceptionOnBit(Class<?> siteClass, String desc, Class<? extends Throwable> exceptionClass, CoordinationProtos.DrillbitEndpoint endpoint) Adds an exception injection (for the specified drillbit) to the controls builder with the given parameters.
Controls.Builder	addExceptionOnBit(Class<?> siteClass, String desc, Class<? extends Throwable> exceptionClass, CoordinationProtos.DrillbitEndpoint endpoint, int nSkip, int nFire) Adds an exception injection (for the specified drillbit) to the controls builder with the given parameters.
Controls.Builder	addLatch(Class<?> siteClass, String desc) Adds a count down latch to the controls builder with the given parameters.
Controls.Builder	addPause(Class<?> siteClass, String desc) Adds a pause injection to the controls builder with the given parameters.
Controls.Builder	addPause(Class<?> siteClass, String desc, int nSkip) Adds a pause injection to the controls builder with the given parameters.
Controls.Builder	addPauseOnBit(Class<?> siteClass, String desc, CoordinationProtos.DrillbitEndpoint endpoint) Adds a pause injection (for the specified drillbit) to the controls builder with the given parameters.
Controls.Builder	addPauseOnBit(Class<?> siteClass, String desc, CoordinationProtos.DrillbitEndpoint endpoint, int nSkip) Adds a pause injection (for the specified drillbit) to the controls builder with the given parameters.
Controls.Builder	addTimedPause(Class<?> siteClass, String desc, int nSkip, long msPause) Adds a time-bound pause injection to the controls builder with the given parameters.
Controls.Builder	addTimedPauseOnBit(Class<?> siteClass, String desc, CoordinationProtos.DrillbitEndpoint endpoint, int nSkip, long msPause) Adds a time-bound pause injection (for the specified drillbit) to the controls builder with the given parameters.
String	build() Builds the controls string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

addException

public Controls.Builder addException(Class<?> siteClass,
                                     String desc,
                                     Class<? extends Throwable> exceptionClass,
                                     int nSkip,
                                     int nFire)

Adds an exception injection to the controls builder with the given parameters.

Parameters:

siteClass - class where the exception should be thrown

desc - descriptor for the exception site in the site class

exceptionClass - class of the exception to throw

nSkip - number of times to skip before firing

nFire - number of times to fire the exception

Returns:

this builder

addException

public Controls.Builder addException(Class<?> siteClass,
                                     String desc,
                                     Class<? extends Throwable> exceptionClass)

Adds an exception injection to the controls builder with the given parameters. The injection is not skipped, and the exception is thrown when execution reaches the site.

Parameters:

siteClass - class where the exception should be thrown

desc - descriptor for the exception site in the site class

exceptionClass - class of the exception to throw

Returns:

this builder

addExceptionOnBit

public Controls.Builder addExceptionOnBit(Class<?> siteClass,
                                          String desc,
                                          Class<? extends Throwable> exceptionClass,
                                          CoordinationProtos.DrillbitEndpoint endpoint,
                                          int nSkip,
                                          int nFire)

Adds an exception injection (for the specified drillbit) to the controls builder with the given parameters.

Parameters:

siteClass - class where the exception should be thrown

desc - descriptor for the exception site in the site class

exceptionClass - class of the exception to throw

endpoint - the endpoint of the drillbit on which to inject

nSkip - number of times to skip before firing

nFire - number of times to fire the exception

Returns:

this builder

addExceptionOnBit

public Controls.Builder addExceptionOnBit(Class<?> siteClass,
                                          String desc,
                                          Class<? extends Throwable> exceptionClass,
                                          CoordinationProtos.DrillbitEndpoint endpoint)

Adds an exception injection (for the specified drillbit) to the controls builder with the given parameters. The injection is not skipped, and the exception is thrown when execution reaches the site on the specified drillbit.

Parameters:

siteClass - class where the exception should be thrown

desc - descriptor for the exception site in the site class

exceptionClass - class of the exception to throw

endpoint - endpoint of the drillbit on which to inject

Returns:

this builder

addPause

public Controls.Builder addPause(Class<?> siteClass,
                                 String desc,
                                 int nSkip)

Adds a pause injection to the controls builder with the given parameters.

Parameters:

siteClass - class where the pause should happen

desc - descriptor for the pause site in the site class

nSkip - number of times to skip before firing

Returns:

this builder

addTimedPause

public Controls.Builder addTimedPause(Class<?> siteClass,
                                      String desc,
                                      int nSkip,
                                      long msPause)

Adds a time-bound pause injection to the controls builder with the given parameters.

Parameters:

siteClass - class where the pause should happen

desc - descriptor for the pause site in the site class

nSkip - number of times to skip before firing

msPause - duration of the pause in millisec

Returns:

this builder

addPause

public Controls.Builder addPause(Class<?> siteClass,
                                 String desc)

Adds a pause injection to the controls builder with the given parameters. The pause is not skipped i.e. the pause happens when execution reaches the site.

Parameters:

siteClass - class where the pause should happen

desc - descriptor for the pause site in the site class

Returns:

this builder

addPauseOnBit

public Controls.Builder addPauseOnBit(Class<?> siteClass,
                                      String desc,
                                      CoordinationProtos.DrillbitEndpoint endpoint,
                                      int nSkip)

Adds a pause injection (for the specified drillbit) to the controls builder with the given parameters.

Parameters:

siteClass - class where the pause should happen

desc - descriptor for the pause site in the site class

nSkip - number of times to skip before firing

Returns:

this builder

addTimedPauseOnBit

public Controls.Builder addTimedPauseOnBit(Class<?> siteClass,
                                           String desc,
                                           CoordinationProtos.DrillbitEndpoint endpoint,
                                           int nSkip,
                                           long msPause)

Adds a time-bound pause injection (for the specified drillbit) to the controls builder with the given parameters.

Parameters:

siteClass - class where the pause should happen

desc - descriptor for the pause site in the site class

nSkip - number of times to skip before firing

msPause - duration of the pause in millisec

Returns:

this builder

addPauseOnBit

public Controls.Builder addPauseOnBit(Class<?> siteClass,
                                      String desc,
                                      CoordinationProtos.DrillbitEndpoint endpoint)

Adds a pause injection (for the specified drillbit) to the controls builder with the given parameters. The pause is not skipped i.e. the pause happens when execution reaches the site.

Parameters:

siteClass - class where the pause should happen

desc - descriptor for the pause site in the site class

Returns:

this builder

addLatch

public Controls.Builder addLatch(Class<?> siteClass,
                                 String desc)

Adds a count down latch to the controls builder with the given parameters.

Parameters:

siteClass - class where the latch should be injected

desc - descriptor for the latch in the site class

Returns:

this builder

build

public String build()

Builds the controls string.

Returns:

a validated controls string with the added injections

Throws:

AssertionError - if controls cannot be validated using ExecutionControls.controlsOptionMapper