org.helenus.driver.junit

Class HelenusJUnit

java.lang.Object

org.helenus.driver.junit.HelenusJUnit

All Implemented Interfaces:

org.junit.rules.MethodRule

public class HelenusJUnit
extends Object
implements org.junit.rules.MethodRule

The HelenusJUnit class provides the JUnit 4 definition for a @Rule service that will take care of initializing an embedded Cassandra server and the Helenus driver.

Note: This file is largely based on cassandra-unit.

Since:

1.0

Version:

1 - Jun 27, 2015 - paouelle - Creation

Author:

The Helenus Driver Project Authors

Copyright:

2015-2016 The Helenus Driver Project Authors

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CFG_FILE Constant for the default Cassandra configuration file which starts the Cassandra daemon on a random free port.
static long	DEFAULT_READ_TIMEOUT Constant for the default timeout for read operations to the Cassandra daemon before failing.
static long	DEFAULT_STARTUP_TIMEOUT Constant for the default timeout to wait for the Cassandra daemon to start before failing.

Constructor Summary

Constructors

Constructor and Description
HelenusJUnit() Instantiates a new HelenusJUnit object.
HelenusJUnit(long startupTimeout) Instantiates a new HelenusJUnit object.
HelenusJUnit(long startupTimeout, long readTimeout) Instantiates a new HelenusJUnit object.
HelenusJUnit(String cfgname, long startupTimeout) Instantiates a new HelenusJUnit object.
HelenusJUnit(String cfgname, long startupTimeout, long readTimeout) Instantiates a new HelenusJUnit object.

Method Summary

Modifier and Type	Method and Description
protected void	after(org.junit.runners.model.FrameworkMethod method, Object target) Called to tear down the Helenus/Cassandra environment.
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement base, org.junit.runners.model.FrameworkMethod method, Object target)
protected void	before(org.junit.runners.model.FrameworkMethod method, Object target) Called to initialize the Helenus/Cassandra environment.
HelenusJUnit	clear() Clears the database and the Helenus layer by resetting them to the same state they were before the previous test case.
HelenusJUnit	createSchema(Class<?> clazz) Creates the schema for the specified pojo class onto the embedded Cassandra database.
void	disableAllStatementsTraces() Disables all statements to be traced automatically regardless of the statement tracing setting (see GenericStatement.isTracing()).
void	disableFullTraces() Disables tracing large statements beyond 2K.
void	disableInternalCQLTracing() Disables internal CQL statements tracing.
boolean	dumpCaptures(Logger logger, Level level) Dumps the content of all the capture lists.
void	enableAllStatementsTraces() Enables all statements to be traced regardless of the statement tracing setting (see GenericStatement.isTracing()).
void	enableFullTraces() Enables tracing large statements beyond 2K.
void	enableInternalCQLTracing() Enables internal CQL statements tracing.
HelenusJUnit	execute(Iterable<String> statements) Executes the specified simple statements.
HelenusJUnit	execute(Iterator<String> statements) Execute the specified simple statements in sequence.
HelenusJUnit	execute(java.util.stream.Stream<String> statements) Executes the specified simple statements in sequence.
HelenusJUnit	execute(String... statements) Executes the specified simple statements.
<E extends Throwable> HelenusJUnit	inhibitCapturing(ERunnable<E> cmd) Executes a command while disabling all capture lists.
static boolean	isCassandraDaemonThread(Thread thread) Checks if the specified thread is a Cassandra daemon thread.
HelenusJUnit	populate(java.util.function.Function<Map<String,String>,? super Object> objs) Populates the database with objects returned by the specified function.
HelenusJUnit	populate(Iterable<? super Object> objs) Populates the database with the specified objects.
HelenusJUnit	populate(Iterator<? super Object> objs) Populates the database with the specified objects.
HelenusJUnit	populate(Object... objs) Populates the database with the specified objects.
HelenusJUnit	populate(java.util.stream.Stream<? super Object> objs) Populates the database with the specified objects.
HelenusJUnit	populate(java.util.function.Supplier<? super Object> objs) Populates the database with objects returned by the specified supplier.
HelenusJUnit	schema(Class<?>... classes) Initializes the schema for the specified pojo classes in the database.
HelenusJUnit	schema(Iterable<Class<?>> classes) Initializes the schema for the specified pojo classes in the database.
HelenusJUnit	schema(Iterator<Class<?>> classes) Initializes the schema for the specified pojo classes in the database.
HelenusJUnit	schema(java.util.stream.Stream<Class<?>> classes) Initializes the schema for the specified pojo classes in the database.
void	setNumberReadRetries(int retries) Sets the number of times to retry a read operation that timed out.
void	setNumberRetries(int retries) Sets the number of times to retry a read or write operation that timed out.
void	setNumberWriteRetries(int retries) Sets the number of times to retry a write operation that timed out.
HelenusJUnit	truncate(Class<?>... classes) Truncates all tables for the specified pojo classes from the database.
HelenusJUnit	truncate(Iterable<Class<?>> classes) Truncates all tables for the specified pojo classes from the database.
HelenusJUnit	truncate(Iterator<Class<?>> classes) Truncates all tables for the specified pojo classes from the database.
HelenusJUnit	truncate(java.util.stream.Stream<Class<?>> classes) Truncates all tables for the specified pojo classes from the database.
HelenusJUnit	whenSent(java.util.function.Consumer<GenericStatement<?,?>> consumer) Registers a callback to be notified when a statement is sent to Cassandra.
StatementCaptureList<GenericStatement>	withCapture() Starts capturing all object statements that have had their executions requested with the Helenus statement manager in the order they are occurring to the returned list.
<T extends GenericStatement> StatementCaptureList<T>	withCapture(Class<T> clazz) Starts capturing all statements of the specified class that have had their executions requested with the Helenus statement manager in the order they are occurring to the returned list.
HelenusJUnit	withoutCapture() Stops capturing object statements with all capture lists.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STARTUP_TIMEOUT

public static final long DEFAULT_STARTUP_TIMEOUT

Constant for the default timeout to wait for the Cassandra daemon to start before failing.

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final long DEFAULT_READ_TIMEOUT

Constant for the default timeout for read operations to the Cassandra daemon before failing.

See Also:

Constant Field Values

DEFAULT_CFG_FILE

public static final String DEFAULT_CFG_FILE

Constant for the default Cassandra configuration file which starts the Cassandra daemon on a random free port.

See Also:

Constant Field Values

Constructor Detail

HelenusJUnit

public HelenusJUnit()

Instantiates a new HelenusJUnit object.

Note: Defaults to 60 seconds timeout to wait for the Cassandra daemon to start on a free port and 12 seconds for read operations before failing.

HelenusJUnit

public HelenusJUnit(long startupTimeout)

Instantiates a new HelenusJUnit object.

Note: Defaults to 12 seconds for read operations on the Cassandra daemon before failing.

Parameters:

startupTimeout - the maximum amount of time in milliseconds to wait for Cassandra daemon to start before failing

HelenusJUnit

public HelenusJUnit(long startupTimeout,
                    long readTimeout)

Instantiates a new HelenusJUnit object.

Parameters:

startupTimeout - the maximum amount of time in milliseconds to wait for Cassandra daemon to start before failing

readTimeout - the maximum amount of time in milliseconds to wait for read operations on the Cassandra daemon before failing

HelenusJUnit

public HelenusJUnit(String cfgname,
                    long startupTimeout)

Instantiates a new HelenusJUnit object.

Note: Defaults to 12 seconds for read operations on the Cassandra daemon before failing.

Parameters:

cfgname - the config file resource name to use to initialize the Cassandra daemon

startupTimeout - the maximum amount of time in milliseconds to wait for Cassandra daemon to start before failing

Throws:

NullPointerException - if cfgname is null

HelenusJUnit

public HelenusJUnit(String cfgname,
                    long startupTimeout,
                    long readTimeout)

Instantiates a new HelenusJUnit object.

Parameters:

cfgname - the config file resource name to use to initialize the Cassandra daemon

startupTimeout - the maximum amount of time in milliseconds to wait for Cassandra daemon to start before failing

readTimeout - the maximum amount of time in milliseconds to wait for read operations on the Cassandra daemon before failing

Throws:

NullPointerException - if cfgname is null

Method Detail

isCassandraDaemonThread

public static boolean isCassandraDaemonThread(Thread thread)

Checks if the specified thread is a Cassandra daemon thread.

Parameters:

thread - the thread to check if it is a Cassandra daemon thread

Returns:

true if the specified is a Cassandra daemon thread; false if it is not

before

protected void before(org.junit.runners.model.FrameworkMethod method,
                      Object target)

Called to initialize the Helenus/Cassandra environment.

Parameters:

method - the test method to be run

target - the test object on which the method will be run

Throws:

AssertionError - if an error occurs while initializing the cassandra daemon or the helenus statement manager

after

protected void after(org.junit.runners.model.FrameworkMethod method,
                     Object target)

Called to tear down the Helenus/Cassandra environment.

Parameters:

method - the test method to be run

target - the test object on which the method will be run

setNumberRetries

public void setNumberRetries(int retries)

Sets the number of times to retry a read or write operation that timed out.

Note: Defaults to none.

Parameters:

retries - the number of times to retry a read or write operation that timed out

setNumberReadRetries

public void setNumberReadRetries(int retries)

Sets the number of times to retry a read operation that timed out.

Note: Defaults to none.

Parameters:

retries - the number of times to retry a read operation that timed out

setNumberWriteRetries

public void setNumberWriteRetries(int retries)

Sets the number of times to retry a write operation that timed out.

Note: Defaults to none.

Parameters:

retries - the number of times to retry a write operation that timed out

enableInternalCQLTracing

public void enableInternalCQLTracing()

Enables internal CQL statements tracing.

disableInternalCQLTracing

public void disableInternalCQLTracing()

Disables internal CQL statements tracing.

enableFullTraces

public void enableFullTraces()

Enables tracing large statements beyond 2K.

disableFullTraces

public void disableFullTraces()

Disables tracing large statements beyond 2K.

enableAllStatementsTraces

public void enableAllStatementsTraces()

Enables all statements to be traced regardless of the statement tracing setting (see GenericStatement.isTracing()).

disableAllStatementsTraces

public void disableAllStatementsTraces()

Disables all statements to be traced automatically regardless of the statement tracing setting (see GenericStatement.isTracing()).

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runners.model.FrameworkMethod method,
                                               Object target)

Specified by:

apply in interface org.junit.rules.MethodRule

See Also:

MethodRule.apply(org.junit.runners.model.Statement, org.junit.runners.model.FrameworkMethod, java.lang.Object)

clear

public HelenusJUnit clear()

Clears the database and the Helenus layer by resetting them to the same state they were before the previous test case.

Returns:

this for chaining

Throws:

AssertionError - if a failure occurs while cleanup

createSchema

public HelenusJUnit createSchema(Class<?> clazz)

Creates the schema for the specified pojo class onto the embedded Cassandra database.

Parameters:

clazz - the pojo class for which to create the schema

Returns:

this for chaining

Throws:

NullPointerException - if clazz is null

AssertionError - if a failure occurs while creating the schema

populate

public HelenusJUnit populate(java.util.function.Supplier<? super Object> objs)

Populates the database with objects returned by the specified supplier.

Note: The supplier can return an array, a Collection, an Iterable, an Iterator, an Enumeration, or a Stream of pojo objects or a single object to insert in the database.

Parameters:

objs - the supplier of objects to populate the database with

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

populate

public HelenusJUnit populate(java.util.function.Function<Map<String,String>,? super Object> objs)

Populates the database with objects returned by the specified function. This version of the populate() allows one to receive a map of all keyspace key values defined in the test environment using the PartitionKeyValues annotations. As such, the function might be called multiple times with each combination of keyspace key values.

Note: The function can return an array, a Collection, an Iterable, an Iterator, an Enumeration, or a Stream of pojo objects or a single object to insert in the database.

Parameters:

objs - the function to receive a map of keyspace key values and return objects to populate the database with

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

populate

public HelenusJUnit populate(Object... objs)

Populates the database with the specified objects.

Parameters:

objs - the objects to populate the database with

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

populate

public HelenusJUnit populate(Iterable<? super Object> objs)

Populates the database with the specified objects.

Parameters:

objs - the objects to populate the database with

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

populate

public HelenusJUnit populate(Iterator<? super Object> objs)

Populates the database with the specified objects.

Parameters:

objs - the objects to populate the database with

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

populate

public HelenusJUnit populate(java.util.stream.Stream<? super Object> objs)

Populates the database with the specified objects.

Parameters:

objs - the objects to populate the database with

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

truncate

public HelenusJUnit truncate(Class<?>... classes)

Truncates all tables for the specified pojo classes from the database.

Parameters:

classes - the pojo classes for which to truncate all the tables content

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

truncate

public HelenusJUnit truncate(Iterable<Class<?>> classes)

Truncates all tables for the specified pojo classes from the database.

Parameters:

classes - the pojo classes for which to truncate all the tables content

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

truncate

public HelenusJUnit truncate(Iterator<Class<?>> classes)

Truncates all tables for the specified pojo classes from the database.

Parameters:

classes - the pojo classes for which to truncate all the tables content

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

truncate

public HelenusJUnit truncate(java.util.stream.Stream<Class<?>> classes)

Truncates all tables for the specified pojo classes from the database.

Parameters:

classes - the pojo classes for which to truncate all the tables content

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

execute

public HelenusJUnit execute(String... statements)

Executes the specified simple statements.

Parameters:

statements - the simple statements to execute

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

execute

public HelenusJUnit execute(Iterable<String> statements)

Executes the specified simple statements.

Parameters:

statements - the simple statements to execute

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

execute

public HelenusJUnit execute(Iterator<String> statements)

Execute the specified simple statements in sequence.

Parameters:

statements - the simple statements to execute

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

execute

public HelenusJUnit execute(java.util.stream.Stream<String> statements)

Executes the specified simple statements in sequence.

Parameters:

statements - the simple statements to execute

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

schema

public HelenusJUnit schema(Class<?>... classes)

Initializes the schema for the specified pojo classes in the database.

Parameters:

classes - the pojo classes for which to initialize the schema

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

schema

public HelenusJUnit schema(Iterable<Class<?>> classes)

Initializes the schema for the specified pojo classes in the database.

Parameters:

classes - the pojo classes for which to initialize the schema

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

schema

public HelenusJUnit schema(Iterator<Class<?>> classes)

Initializes the schema for the specified pojo classes in the database.

Parameters:

classes - the pojo classes for which to initialize the schema

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

schema

public HelenusJUnit schema(java.util.stream.Stream<Class<?>> classes)

Initializes the schema for the specified pojo classes in the database.

Parameters:

classes - the pojo classes for which to initialize the schema

Returns:

this for chaining

Throws:

AssertionError - if any error occurs

withCapture

public StatementCaptureList<GenericStatement> withCapture()

Starts capturing all object statements that have had their executions requested with the Helenus statement manager in the order they are occurring to the returned list. Capture lists are automatically removed at the end of and right before a test execution.

Note: In the case of Group-based statements, all grouped statements will be captured individually.

Returns:

a non-null statements capture list where the statements will be recorded

withCapture

public <T extends GenericStatement> StatementCaptureList<T> withCapture(Class<T> clazz)

Starts capturing all statements of the specified class that have had their executions requested with the Helenus statement manager in the order they are occurring to the returned list. Capture lists are automatically removed at the end of and right before a test execution.

Note: In the case of Group-based statements, all grouped statements will be captured individually.

Type Parameters:

T - the type of statements to capture

Parameters:

clazz - the class of object statements to capture

Returns:

a non-null statements capture list where the statements will be recorded

Throws:

NullPointerException - if clazz is null

withoutCapture

public HelenusJUnit withoutCapture()

Stops capturing object statements with all capture lists.

Returns:

this for chaining

inhibitCapturing

public <E extends Throwable> HelenusJUnit inhibitCapturing(ERunnable<E> cmd)
                                                    throws E extends Throwable

Executes a command while disabling all capture lists.

Type Parameters:

E - the type of exceptions that can be thrown out

Parameters:

cmd - the command to execute while capturing is inhibited

Returns:

this for chaining

Throws:

E - if thrown by the command

E extends Throwable

dumpCaptures

public boolean dumpCaptures(Logger logger,
                            Level level)

Dumps the content of all the capture lists.

Parameters:

logger - the logger where to dump the content of the capture lists

level - the log level to use when dumping

Returns:

true if anything was dumped; false otherwise

whenSent

public HelenusJUnit whenSent(java.util.function.Consumer<GenericStatement<?,?>> consumer)

Registers a callback to be notified when a statement is sent to Cassandra.

Parameters:

consumer - the consumer to register to be notified every time a statement is sent to Cassandra

Returns:

this for chaining