info.archinnov.achilles.junit

Class AchillesTestResourceBuilder

java.lang.Object

info.archinnov.achilles.junit.AchillesTestResourceBuilder

public class AchillesTestResourceBuilder
extends Object

WARNING: this AchillesTestResource will use an unsafe Cassandra daemon, it is not suitable for production

Builder class to create an instance of AchillesTestResource

 AchillesTestResourceBuilder
 .forJunit()
 .withScript("script1.cql")
 .withScript("script2.cql")
 .tablesToTruncate("user", "account") // entityClassesToTruncate(UserEntity.class, AccountEntity.class)
 .createAndUseKeyspace("unit_test")
 .
 ...
 .build((cluster, statementsCache) -> ManagerFactoryBuilder
 .builder(cluster)
 .doForceSchemaCreation(true)
 .withStatementCache(statementsCache)
 .withDefaultKeyspaceName(DEFAULT_CASSANDRA_EMBEDDED_KEYSPACE_NAME)
 .build()
 );
 

Method Summary

Modifier and Type	Method and Description
<T extends AbstractManagerFactory> AchillesTestResource<T>	build(java.util.function.BiFunction<Cluster,StatementsCache,T> managerFactoryBuilder) Provide a lambda function to build the ManagerFactory instance with the given Cluster object
AchillesTestResourceBuilder	createAndUseKeyspace(String keyspaceName) Keyspace name to create
AchillesTestResourceBuilder	entityClassesToTruncate(Class<?>... entityClassesToTruncate) Entity classes whose table should be truncated during unit tests
static AchillesTestResourceBuilder	forJunit()
AchillesTestResourceBuilder	tablesToTruncate(String... tablesToTruncate) Tables to be truncated during unit tests
AchillesTestResourceBuilder	truncateAfterTest() Truncate tables AFTER each test
AchillesTestResourceBuilder	truncateBeforeAndAfterTest() Truncate tables BEFORE and AFTER each test
AchillesTestResourceBuilder	truncateBeforeTest() Truncate tables BEFORE each test
AchillesTestResourceBuilder	withCassandraParams(Map<String,Object> cassandraParams) Use this function to add parameters to cassandra startup.
AchillesTestResourceBuilder	withProtocolVersion(ProtocolVersion protocolVersion) Set the protocol version for the Java driver to connect to the embedded Cassandra server
AchillesTestResourceBuilder	withScript(String scriptLocation) /** Load an CQL script in the class path and execute it upon initialization of the embedded Cassandra server Call this method as many times as there are CQL scripts to be executed.
AchillesTestResourceBuilder	withScriptTemplate(String scriptTemplateLocation, Map<String,Object> values) Load an CQL script template in the class path, inject the values into the template to produce the final script and execute it upon initialization of the embedded Cassandra server Call this method as many times as there are CQL templates to be executed.

Methods inherited from class java.lang.Object

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

Method Detail

forJunit

public static AchillesTestResourceBuilder forJunit()

withScript

public AchillesTestResourceBuilder withScript(String scriptLocation)

/** Load an CQL script in the class path and execute it upon initialization of the embedded Cassandra server
Call this method as many times as there are CQL scripts to be executed.
Example:

 AchillesTestResourceBuilder
 .forJunit()
 .withScript("script1.cql")
 .withScript("script2.cql")
 ...
 .build(cluster -> ManagerFactoryBuilder
 .builder(cluster)
 .doForceSchemaCreation(true)
 .withDefaultKeyspaceName(DEFAULT_CASSANDRA_EMBEDDED_KEYSPACE_NAME)
 .build());
 

Parameters:

scriptLocation - location of the CQL script in the class path

Returns:

AchillesTestResourceBuilder

withScriptTemplate

public AchillesTestResourceBuilder withScriptTemplate(String scriptTemplateLocation,
                                                      Map<String,Object> values)

Load an CQL script template in the class path, inject the values into the template to produce the final script and execute it upon initialization of the embedded Cassandra server
Call this method as many times as there are CQL templates to be executed.
Example:

 Map<String, Object> map1 = new HashMap<>();

 map1.put("id", 100L);
 map1.put("date", new Date());
 ...

 AchillesTestResourceBuilder
 .forJunit()
 .withScriptTemplate("script1.cql", map1)
 .withScriptTemplate("script2.cql", map2)
 ...
 .build();
 

Parameters:

scriptTemplateLocation - location of the CQL script in the class path

values - values to inject into the template.

Returns:

AchillesTestResourceBuilder

withProtocolVersion

public AchillesTestResourceBuilder withProtocolVersion(ProtocolVersion protocolVersion)

Set the protocol version for the Java driver to connect to the embedded Cassandra server

Parameters:

protocolVersion - target protocol version

Returns:

AchillesTestResourceBuilder

createAndUseKeyspace

public AchillesTestResourceBuilder createAndUseKeyspace(String keyspaceName)

Keyspace name to create

Parameters:

keyspaceName - keyspace name

Returns:

AchillesTestResourceBuilder

entityClassesToTruncate

public AchillesTestResourceBuilder entityClassesToTruncate(Class<?>... entityClassesToTruncate)

Entity classes whose table should be truncated during unit tests

Parameters:

entityClassesToTruncate - list of entity classes whose table should be truncated before and/or after tests

Returns:

AchillesTestResourceBuilder

tablesToTruncate

public AchillesTestResourceBuilder tablesToTruncate(String... tablesToTruncate)

Tables to be truncated during unit tests

Parameters:

tablesToTruncate - list of tables to truncate

Returns:

AchillesTestResourceBuilder

truncateBeforeTest

public AchillesTestResourceBuilder truncateBeforeTest()

Truncate tables BEFORE each test

Returns:

AchillesTestResourceBuilder

truncateAfterTest

public AchillesTestResourceBuilder truncateAfterTest()

Truncate tables AFTER each test

Returns:

AchillesTestResourceBuilder

truncateBeforeAndAfterTest

public AchillesTestResourceBuilder truncateBeforeAndAfterTest()

Truncate tables BEFORE and AFTER each test

Returns:

AchillesTestResourceBuilder

build

public <T extends AbstractManagerFactory> AchillesTestResource<T> build(java.util.function.BiFunction<Cluster,StatementsCache,T> managerFactoryBuilder)

Provide a lambda function to build the ManagerFactory instance with the given Cluster object

Parameters:

managerFactoryBuilder - lambda function

Returns:

ManagerFactory

withCassandraParams

public AchillesTestResourceBuilder withCassandraParams(Map<String,Object> cassandraParams)

Use this function to add parameters to cassandra startup. Example:

 AchillesTestResourceBuilder
 .forJunit()
 .withCassandraParams(Collections.singletonMap(CASSANDRA_CQL_PORT, 9042))
 ...
 .build();
 

Returns:

AchillesTestResourceBuilder